Operating Cost Expense Type

Get Operating Cost Expense Type

HTTP Request

GET /api/operating-cost-expense-types/{id}

📋 Description: Retrieves detailed information about a specific operating cost expense type identified by the provided ID, facilitating informed decision-making in 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

OperatingCostExpenseTypeDto

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  "operatingCostExpenseTypeId": 0,
10  "expenseGroupId": 0,
11  "operatingCostExpenseTypeOption": {
12    "createdBy": "string",
13    "lastModifiedBy": "string",
14    "createdDate": "2019-08-24T14:15:22Z",
15    "lastModifiedDate": "2019-08-24T14:15:22Z",
16    "archived": true,
17    "externalId": "string",
18    "id": 0,
19    "priority": 0,
20    "internalId": 0,
21    "pickListCode": "string",
22    "pickListLabel": "string",
23    "label": "string",
24    "cultureId": 0,
25    "labelDtos": [
26      {
27        "createdBy": "string",
28        "lastModifiedBy": "string",
29        "createdDate": "2019-08-24T14:15:22Z",
30        "lastModifiedDate": "2019-08-24T14:15:22Z",
31        "archived": true,
32        "externalId": "string",
33        "id": 0,
34        "cultureId": 0,
35        "value": "string"
36      }
37    ]
38  }
39}

Update Operating Cost Expense Type

HTTP Request

PUT /api/operating-cost-expense-types/{id}

📋 Description: Updates the details of a specified operating cost expense type within the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial analytics for portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

OperatingCostExpenseTypeDto

true

Request body containing the updated operating cost expense type data, including relevant attributes for portfolio and asset management within the Nakisa Portfolio Management Suite.

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  "operatingCostExpenseTypeId": 0,
10  "expenseGroupId": 0,
11  "operatingCostExpenseTypeOption": {
12    "createdBy": "string",
13    "lastModifiedBy": "string",
14    "createdDate": "2019-08-24T14:15:22Z",
15    "lastModifiedDate": "2019-08-24T14:15:22Z",
16    "archived": true,
17    "externalId": "string",
18    "id": 0,
19    "priority": 0,
20    "internalId": 0,
21    "pickListCode": "string",
22    "pickListLabel": "string",
23    "label": "string",
24    "cultureId": 0,
25    "labelDtos": [
26      {
27        "createdBy": "string",
28        "lastModifiedBy": "string",
29        "createdDate": "2019-08-24T14:15:22Z",
30        "lastModifiedDate": "2019-08-24T14:15:22Z",
31        "archived": true,
32        "externalId": "string",
33        "id": 0,
34        "cultureId": 0,
35        "value": "string"
36      }
37    ]
38  }
39}

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostExpenseTypeDto

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  "operatingCostExpenseTypeId": 0,
10  "expenseGroupId": 0,
11  "operatingCostExpenseTypeOption": {
12    "createdBy": "string",
13    "lastModifiedBy": "string",
14    "createdDate": "2019-08-24T14:15:22Z",
15    "lastModifiedDate": "2019-08-24T14:15:22Z",
16    "archived": true,
17    "externalId": "string",
18    "id": 0,
19    "priority": 0,
20    "internalId": 0,
21    "pickListCode": "string",
22    "pickListLabel": "string",
23    "label": "string",
24    "cultureId": 0,
25    "labelDtos": [
26      {
27        "createdBy": "string",
28        "lastModifiedBy": "string",
29        "createdDate": "2019-08-24T14:15:22Z",
30        "lastModifiedDate": "2019-08-24T14:15:22Z",
31        "archived": true,
32        "externalId": "string",
33        "id": 0,
34        "cultureId": 0,
35        "value": "string"
36      }
37    ]
38  }
39}

Delete Operating Cost Expense Type

HTTP Request

DELETE /api/operating-cost-expense-types/{id}

📋 Description: Deletes a specified operating cost expense type from the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant financial data related to portfolio and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Get Operating Cost Expense Types

HTTP Request

GET /api/operating-cost-expense-types

📋 Description: Retrieves a list of operating cost expense types relevant to portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the operating cost expense types query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

expenes-type-id

query

string

false

Unique identifier for the specific type of operating cost expense, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

expense-group-id

query

string

false

Unique identifier for the expense group, used to filter and retrieve specific operating cost expense types within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelOperatingCostExpenseTypeDto

Example Responses

 1{
 2  "_embedded": {
 3    "operatingCostExpenseTypes": [
 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        "operatingCostExpenseTypeId": 0,
13        "expenseGroupId": 0,
14        "operatingCostExpenseTypeOption": {
15          "createdBy": "string",
16          "lastModifiedBy": "string",
17          "createdDate": "2019-08-24T14:15:22Z",
18          "lastModifiedDate": "2019-08-24T14:15:22Z",
19          "archived": true,
20          "externalId": "string",
21          "id": 0,
22          "priority": 0,
23          "internalId": 0,
24          "pickListCode": "string",
25          "pickListLabel": "string",
26          "label": "string",
27          "cultureId": 0,
28          "labelDtos": [
29            {
30              "createdBy": "string",
31              "lastModifiedBy": "string",
32              "createdDate": "2019-08-24T14:15:22Z",
33              "lastModifiedDate": "2019-08-24T14:15:22Z",
34              "archived": true,
35              "externalId": "string",
36              "id": 0,
37              "cultureId": 0,
38              "value": "string"
39            }
40          ]
41        }
42      }
43    ]
44  },
45  "page": {
46    "size": 0,
47    "totalElements": 0,
48    "totalPages": 0,
49    "number": 0
50  }
51}

Add Operating Cost Expense Types

HTTP Request

POST /api/operating-cost-expense-types

📋 Description: Creates a new operating cost expense type within the Nakisa Portfolio Management Suite, enabling users to categorize and analyze expenses related to portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

OperatingCostExpenseTypeDto

true

Request body containing the operating cost expense type details, including relevant attributes for portfolio and asset management within the Nakisa Portfolio Management Suite.

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    "operatingCostExpenseTypeId": 0,
11    "expenseGroupId": 0,
12    "operatingCostExpenseTypeOption": {
13      "createdBy": "string",
14      "lastModifiedBy": "string",
15      "createdDate": "2019-08-24T14:15:22Z",
16      "lastModifiedDate": "2019-08-24T14:15:22Z",
17      "archived": true,
18      "externalId": "string",
19      "id": 0,
20      "priority": 0,
21      "internalId": 0,
22      "pickListCode": "string",
23      "pickListLabel": "string",
24      "label": "string",
25      "cultureId": 0,
26      "labelDtos": [
27        {
28          "createdBy": "string",
29          "lastModifiedBy": "string",
30          "createdDate": "2019-08-24T14:15:22Z",
31          "lastModifiedDate": "2019-08-24T14:15:22Z",
32          "archived": true,
33          "externalId": "string",
34          "id": 0,
35          "cultureId": 0,
36          "value": "string"
37        }
38      ]
39    }
40  }
41]

Responses

Status

Meaning

Description

Schema

201

Created

Created

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    "operatingCostExpenseTypeId": 0,
11    "expenseGroupId": 0,
12    "operatingCostExpenseTypeOption": {
13      "createdBy": "string",
14      "lastModifiedBy": "string",
15      "createdDate": "2019-08-24T14:15:22Z",
16      "lastModifiedDate": "2019-08-24T14:15:22Z",
17      "archived": true,
18      "externalId": "string",
19      "id": 0,
20      "priority": 0,
21      "internalId": 0,
22      "pickListCode": "string",
23      "pickListLabel": "string",
24      "label": "string",
25      "cultureId": 0,
26      "labelDtos": [
27        {
28          "createdBy": "string",
29          "lastModifiedBy": "string",
30          "createdDate": "2019-08-24T14:15:22Z",
31          "lastModifiedDate": "2019-08-24T14:15:22Z",
32          "archived": true,
33          "externalId": "string",
34          "id": 0,
35          "cultureId": 0,
36          "value": "string"
37        }
38      ]
39    }
40  }
41]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[OperatingCostExpenseTypeDto]

false

none

[Data transfer object representing the classification of operating cost expenses associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics.]

» 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

» operatingCostExpenseTypeId

integer(int64)

false

none

Unique identifier for the operating cost expense type

» expenseGroupId

integer(int64)

false

none

Unique identifier for the expense group

» operatingCostExpenseTypeOption

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

Unarchive Operating Cost Expense Type

HTTP Request

POST /api/operating-cost-expense-types/{id}/unarchive

📋 Description: Unarchives a specified operating cost expense type, allowing it to be reactivated within the Nakisa Portfolio Management Suite for enhanced portfolio and asset 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

200

OK

OK

OperatingCostExpenseTypeDto

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  "operatingCostExpenseTypeId": 0,
10  "expenseGroupId": 0,
11  "operatingCostExpenseTypeOption": {
12    "createdBy": "string",
13    "lastModifiedBy": "string",
14    "createdDate": "2019-08-24T14:15:22Z",
15    "lastModifiedDate": "2019-08-24T14:15:22Z",
16    "archived": true,
17    "externalId": "string",
18    "id": 0,
19    "priority": 0,
20    "internalId": 0,
21    "pickListCode": "string",
22    "pickListLabel": "string",
23    "label": "string",
24    "cultureId": 0,
25    "labelDtos": [
26      {
27        "createdBy": "string",
28        "lastModifiedBy": "string",
29        "createdDate": "2019-08-24T14:15:22Z",
30        "lastModifiedDate": "2019-08-24T14:15:22Z",
31        "archived": true,
32        "externalId": "string",
33        "id": 0,
34        "cultureId": 0,
35        "value": "string"
36      }
37    ]
38  }
39}

Archive Operating Cost Expense Type

HTTP Request

POST /api/operating-cost-expense-types/{id}/archive

📋 Description: Archives the specified operating cost expense type within the Nakisa Portfolio Management Suite, facilitating efficient management and analytics of portfolio and asset-related expenses in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

OperatingCostExpenseTypeDto

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  "operatingCostExpenseTypeId": 0,
10  "expenseGroupId": 0,
11  "operatingCostExpenseTypeOption": {
12    "createdBy": "string",
13    "lastModifiedBy": "string",
14    "createdDate": "2019-08-24T14:15:22Z",
15    "lastModifiedDate": "2019-08-24T14:15:22Z",
16    "archived": true,
17    "externalId": "string",
18    "id": 0,
19    "priority": 0,
20    "internalId": 0,
21    "pickListCode": "string",
22    "pickListLabel": "string",
23    "label": "string",
24    "cultureId": 0,
25    "labelDtos": [
26      {
27        "createdBy": "string",
28        "lastModifiedBy": "string",
29        "createdDate": "2019-08-24T14:15:22Z",
30        "lastModifiedDate": "2019-08-24T14:15:22Z",
31        "archived": true,
32        "externalId": "string",
33        "id": 0,
34        "cultureId": 0,
35        "value": "string"
36      }
37    ]
38  }
39}