Expense Type Category

Find Expense Type

HTTP Request

GET /api/expense-type-categories/{id}

📋 Description: Retrieves detailed information about a specific expense type category identified by the provided ID, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ExpenseTypeCategoryDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "expenseCategoryId": 0,
10  "expenseGroupId": 0,
11  "displayId": "string",
12  "expenseCategory": {
13    "id": 0,
14    "status": "CREATED",
15    "displayId": "string",
16    "name": "string",
17    "editable": true,
18    "expenseCategoryType": "PAYMENT"
19  },
20  "expenseGroup": {
21    "createdBy": "string",
22    "lastModifiedBy": "string",
23    "createdDate": "2019-08-24T14:15:22Z",
24    "lastModifiedDate": "2019-08-24T14:15:22Z",
25    "archived": true,
26    "externalId": "string",
27    "id": 0,
28    "priority": 0,
29    "internalId": 0,
30    "pickListCode": "string",
31    "pickListLabel": "string",
32    "label": "string",
33    "cultureId": 0,
34    "labelDtos": [
35      {
36        "createdBy": "string",
37        "lastModifiedBy": "string",
38        "createdDate": "2019-08-24T14:15:22Z",
39        "lastModifiedDate": "2019-08-24T14:15:22Z",
40        "archived": true,
41        "externalId": "string",
42        "id": 0,
43        "cultureId": 0,
44        "value": "string"
45      }
46    ]
47  }
48}

Update Expense Type Category

HTTP Request

PUT /api/expense-type-categories/{id}

📋 Description: Updates the specified expense type category within the Nakisa Portfolio Management Suite, enabling users to manage and refine portfolio, asset, and real estate property analytics effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ExpenseTypeCategoryDto

true

Request body containing updated details for the specified expense type category, including attributes relevant to portfolio management and asset analytics.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "expenseCategoryId": 0,
10  "expenseGroupId": 0,
11  "displayId": "string",
12  "expenseCategory": {
13    "id": 0,
14    "status": "CREATED",
15    "displayId": "string",
16    "name": "string",
17    "editable": true,
18    "expenseCategoryType": "PAYMENT"
19  },
20  "expenseGroup": {
21    "createdBy": "string",
22    "lastModifiedBy": "string",
23    "createdDate": "2019-08-24T14:15:22Z",
24    "lastModifiedDate": "2019-08-24T14:15:22Z",
25    "archived": true,
26    "externalId": "string",
27    "id": 0,
28    "priority": 0,
29    "internalId": 0,
30    "pickListCode": "string",
31    "pickListLabel": "string",
32    "label": "string",
33    "cultureId": 0,
34    "labelDtos": [
35      {
36        "createdBy": "string",
37        "lastModifiedBy": "string",
38        "createdDate": "2019-08-24T14:15:22Z",
39        "lastModifiedDate": "2019-08-24T14:15:22Z",
40        "archived": true,
41        "externalId": "string",
42        "id": 0,
43        "cultureId": 0,
44        "value": "string"
45      }
46    ]
47  }
48}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ExpenseTypeCategoryDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "expenseCategoryId": 0,
10  "expenseGroupId": 0,
11  "displayId": "string",
12  "expenseCategory": {
13    "id": 0,
14    "status": "CREATED",
15    "displayId": "string",
16    "name": "string",
17    "editable": true,
18    "expenseCategoryType": "PAYMENT"
19  },
20  "expenseGroup": {
21    "createdBy": "string",
22    "lastModifiedBy": "string",
23    "createdDate": "2019-08-24T14:15:22Z",
24    "lastModifiedDate": "2019-08-24T14:15:22Z",
25    "archived": true,
26    "externalId": "string",
27    "id": 0,
28    "priority": 0,
29    "internalId": 0,
30    "pickListCode": "string",
31    "pickListLabel": "string",
32    "label": "string",
33    "cultureId": 0,
34    "labelDtos": [
35      {
36        "createdBy": "string",
37        "lastModifiedBy": "string",
38        "createdDate": "2019-08-24T14:15:22Z",
39        "lastModifiedDate": "2019-08-24T14:15:22Z",
40        "archived": true,
41        "externalId": "string",
42        "id": 0,
43        "cultureId": 0,
44        "value": "string"
45      }
46    ]
47  }
48}

Delete Expense Type

HTTP Request

DELETE /api/expense-type-categories/{id}

📋 Description: Deletes a specified expense type category from the Nakisa Portfolio Management Suite, streamlining portfolio and asset management by ensuring only relevant categories are maintained for accurate analytics in real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

List Expense Type Categories

HTTP Request

GET /api/expense-type-categories

📋 Description: Retrieves a list of expense type categories relevant to portfolio management, asset tracking, and real estate property analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve and manage expense type categories within the Nakisa Portfolio Management Suite.

expense-category-id

query

string

false

Unique identifier for the expense category, used to filter and retrieve specific expense type categories within the Nakisa Portfolio Management Suite for portfolio and asset analytics.

expense-group-id

query

string

false

Unique identifier for the expense group, used to filter and retrieve specific expense type categories within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelExpenseTypeCategoryDto

Example Responses

 1{
 2  "_embedded": {
 3    "expenseTypeCategories": [
 4      {
 5        "createdBy": "string",
 6        "lastModifiedBy": "string",
 7        "createdDate": "2019-08-24T14:15:22Z",
 8        "lastModifiedDate": "2019-08-24T14:15:22Z",
 9        "archived": true,
10        "externalId": "string",
11        "id": 0,
12        "expenseCategoryId": 0,
13        "expenseGroupId": 0,
14        "displayId": "string",
15        "expenseCategory": {
16          "id": 0,
17          "status": "CREATED",
18          "displayId": "string",
19          "name": "string",
20          "editable": true,
21          "expenseCategoryType": "PAYMENT"
22        },
23        "expenseGroup": {
24          "createdBy": "string",
25          "lastModifiedBy": "string",
26          "createdDate": "2019-08-24T14:15:22Z",
27          "lastModifiedDate": "2019-08-24T14:15:22Z",
28          "archived": true,
29          "externalId": "string",
30          "id": 0,
31          "priority": 0,
32          "internalId": 0,
33          "pickListCode": "string",
34          "pickListLabel": "string",
35          "label": "string",
36          "cultureId": 0,
37          "labelDtos": [
38            {
39              "createdBy": "string",
40              "lastModifiedBy": "string",
41              "createdDate": "2019-08-24T14:15:22Z",
42              "lastModifiedDate": "2019-08-24T14:15:22Z",
43              "archived": true,
44              "externalId": "string",
45              "id": 0,
46              "cultureId": 0,
47              "value": "string"
48            }
49          ]
50        }
51      }
52    ]
53  },
54  "page": {
55    "size": 0,
56    "totalElements": 0,
57    "totalPages": 0,
58    "number": 0
59  }
60}

Save Expense Type

HTTP Request

POST /api/expense-type-categories

📋 Description: Creates a new expense type category within the Nakisa Portfolio Management Suite, enabling enhanced categorization and analysis of expenses related to portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ExpenseTypeCategoryDto

true

Request body containing the details of new expense type categories, including attributes relevant to portfolio management, asset tracking, and real estate analytics.

Body Parameters

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "expenseCategoryId": 0,
11    "expenseGroupId": 0,
12    "displayId": "string",
13    "expenseCategory": {
14      "id": 0,
15      "status": "CREATED",
16      "displayId": "string",
17      "name": "string",
18      "editable": true,
19      "expenseCategoryType": "PAYMENT"
20    },
21    "expenseGroup": {
22      "createdBy": "string",
23      "lastModifiedBy": "string",
24      "createdDate": "2019-08-24T14:15:22Z",
25      "lastModifiedDate": "2019-08-24T14:15:22Z",
26      "archived": true,
27      "externalId": "string",
28      "id": 0,
29      "priority": 0,
30      "internalId": 0,
31      "pickListCode": "string",
32      "pickListLabel": "string",
33      "label": "string",
34      "cultureId": 0,
35      "labelDtos": [
36        {
37          "createdBy": "string",
38          "lastModifiedBy": "string",
39          "createdDate": "2019-08-24T14:15:22Z",
40          "lastModifiedDate": "2019-08-24T14:15:22Z",
41          "archived": true,
42          "externalId": "string",
43          "id": 0,
44          "cultureId": 0,
45          "value": "string"
46        }
47      ]
48    }
49  }
50]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "expenseCategoryId": 0,
11    "expenseGroupId": 0,
12    "displayId": "string",
13    "expenseCategory": {
14      "id": 0,
15      "status": "CREATED",
16      "displayId": "string",
17      "name": "string",
18      "editable": true,
19      "expenseCategoryType": "PAYMENT"
20    },
21    "expenseGroup": {
22      "createdBy": "string",
23      "lastModifiedBy": "string",
24      "createdDate": "2019-08-24T14:15:22Z",
25      "lastModifiedDate": "2019-08-24T14:15:22Z",
26      "archived": true,
27      "externalId": "string",
28      "id": 0,
29      "priority": 0,
30      "internalId": 0,
31      "pickListCode": "string",
32      "pickListLabel": "string",
33      "label": "string",
34      "cultureId": 0,
35      "labelDtos": [
36        {
37          "createdBy": "string",
38          "lastModifiedBy": "string",
39          "createdDate": "2019-08-24T14:15:22Z",
40          "lastModifiedDate": "2019-08-24T14:15:22Z",
41          "archived": true,
42          "externalId": "string",
43          "id": 0,
44          "cultureId": 0,
45          "value": "string"
46        }
47      ]
48    }
49  }
50]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ExpenseTypeCategoryDto]

false

none

[Data transfer object representing a classification of expense types within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of financial data related to portfolio, asset, and real estate property management.]

» createdBy

string

false

none

Username of who created this resource

» lastModifiedBy

string

false

none

Username of who last modified this resource

» createdDate

string(date-time)

false

none

Date of the created

» lastModifiedDate

string(date-time)

false

none

Date of the last modified

» archived

boolean

false

none

Boolean flag indicating archived status

» externalId

string

false

none

Unique identifier for the external

» id

integer(int64)

false

none

Unique identifier for the resource

» expenseCategoryId

integer(int64)

false

none

Unique identifier for the expense category

» expenseGroupId

integer(int64)

false

none

Unique identifier for the expense group

» displayId

string

false

none

Unique identifier for the display

» expenseCategory

ExpenseCategoryDto

false

none

Data transfer object representing an expense category within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of financial data related to portfolio, asset, and real estate property management.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» status

string

false

none

Status of the resource

»» displayId

string

true

none

Unique identifier for the display

»» name

string

true

none

Name of the resource

»» editable

boolean

true

none

Boolean flag indicating editable status

»» expenseCategoryType

string

true

none

Type of the expense category

» expenseGroup

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» priority

integer(int64)

false

none

Priority of the resource

»» internalId

integer(int64)

false

none

Unique identifier for the internal

»» pickListCode

string

false

none

Code for the pick list

»» pickListLabel

string

false

none

Label for the pick list

»» label

string

false

none

Label for the resource

»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»» labelDtos

[LabelDto]

false

none

List of labelDtos items

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»»» value

string

true

none

Text value for value in LabelDto

Enumerated Values

Attribute

Value

expenseCategoryType

CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED