Company

Company - Get Company

HTTP Request

GET /api/companies/{id}

📋 Description: Retrieves detailed information about a specific company within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio assets and real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CompanyDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "countryId": 0,
 8  "countryDisplayId": "string",
 9  "postingPeriodVariantId": 0,
10  "name": "string",
11  "postingPeriodVariantDisplayId": "string",
12  "controllingAreaId": 0,
13  "controllingAreaDisplayId": "string",
14  "chartOfAccountId": 0,
15  "chartOfAccountDisplayId": "string",
16  "fiscalVariantId": 0,
17  "fiscalVariantDisplayId": "string",
18  "chartOfDepreciationId": 0,
19  "chartOfDepreciationDisplayId": "string",
20  "purchasingOrganizationId": 0,
21  "assetId": 0,
22  "exchangeRateTypeId": 0,
23  "plantId": 0,
24  "incrementalBorrowingRateId": 0,
25  "businessUnitId": 0,
26  "projectId": 0,
27  "transferVariantId": 0,
28  "partnerId": 0,
29  "departmentId": 0,
30  "accountingStandardId": 0,
31  "generalLedgerAccountId": 0,
32  "consumerPriceIndexCategoryId": 0,
33  "costCenterId": 0,
34  "costCenterRelationValidFrom": "2019-08-24",
35  "costCenterRelationValidTo": "2019-08-24"
36}

Company - Update Company

HTTP Request

PUT /api/companies/{id}

📋 Description: Updates the details of a specified company within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

CompanyDto

true

Request body containing the updated company information, including portfolio details, asset allocations, and analytics relevant to real estate properties.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "countryId": 0,
 8  "countryDisplayId": "string",
 9  "postingPeriodVariantId": 0,
10  "name": "string",
11  "postingPeriodVariantDisplayId": "string",
12  "controllingAreaId": 0,
13  "controllingAreaDisplayId": "string",
14  "chartOfAccountId": 0,
15  "chartOfAccountDisplayId": "string",
16  "fiscalVariantId": 0,
17  "fiscalVariantDisplayId": "string",
18  "chartOfDepreciationId": 0,
19  "chartOfDepreciationDisplayId": "string",
20  "purchasingOrganizationId": 0,
21  "assetId": 0,
22  "exchangeRateTypeId": 0,
23  "plantId": 0,
24  "incrementalBorrowingRateId": 0,
25  "businessUnitId": 0,
26  "projectId": 0,
27  "transferVariantId": 0,
28  "partnerId": 0,
29  "departmentId": 0,
30  "accountingStandardId": 0,
31  "generalLedgerAccountId": 0,
32  "consumerPriceIndexCategoryId": 0,
33  "costCenterId": 0,
34  "costCenterRelationValidFrom": "2019-08-24",
35  "costCenterRelationValidTo": "2019-08-24"
36}

Responses

Status

Meaning

Description

Schema

200

OK

OK

CompanyDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "countryId": 0,
 8  "countryDisplayId": "string",
 9  "postingPeriodVariantId": 0,
10  "name": "string",
11  "postingPeriodVariantDisplayId": "string",
12  "controllingAreaId": 0,
13  "controllingAreaDisplayId": "string",
14  "chartOfAccountId": 0,
15  "chartOfAccountDisplayId": "string",
16  "fiscalVariantId": 0,
17  "fiscalVariantDisplayId": "string",
18  "chartOfDepreciationId": 0,
19  "chartOfDepreciationDisplayId": "string",
20  "purchasingOrganizationId": 0,
21  "assetId": 0,
22  "exchangeRateTypeId": 0,
23  "plantId": 0,
24  "incrementalBorrowingRateId": 0,
25  "businessUnitId": 0,
26  "projectId": 0,
27  "transferVariantId": 0,
28  "partnerId": 0,
29  "departmentId": 0,
30  "accountingStandardId": 0,
31  "generalLedgerAccountId": 0,
32  "consumerPriceIndexCategoryId": 0,
33  "costCenterId": 0,
34  "costCenterRelationValidFrom": "2019-08-24",
35  "costCenterRelationValidTo": "2019-08-24"
36}

Company - Delete Company

HTTP Request

DELETE /api/companies/{id}

📋 Description: Deletes a specified company from the Nakisa Portfolio Management Suite, ensuring the removal of associated portfolio, asset, and analytics data related to real estate properties.

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

Company - Get Companies

HTTP Request

GET /api/companies

📋 Description: Retrieves a list of companies within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio assets and real estate properties effectively.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCompanyDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "countryId": 0,
26      "countryDisplayId": "string",
27      "postingPeriodVariantId": 0,
28      "name": "string",
29      "postingPeriodVariantDisplayId": "string",
30      "controllingAreaId": 0,
31      "controllingAreaDisplayId": "string",
32      "chartOfAccountId": 0,
33      "chartOfAccountDisplayId": "string",
34      "fiscalVariantId": 0,
35      "fiscalVariantDisplayId": "string",
36      "chartOfDepreciationId": 0,
37      "chartOfDepreciationDisplayId": "string",
38      "purchasingOrganizationId": 0,
39      "assetId": 0,
40      "exchangeRateTypeId": 0,
41      "plantId": 0,
42      "incrementalBorrowingRateId": 0,
43      "businessUnitId": 0,
44      "projectId": 0,
45      "transferVariantId": 0,
46      "partnerId": 0,
47      "departmentId": 0,
48      "accountingStandardId": 0,
49      "generalLedgerAccountId": 0,
50      "consumerPriceIndexCategoryId": 0,
51      "costCenterId": 0,
52      "costCenterRelationValidFrom": "2019-08-24",
53      "costCenterRelationValidTo": "2019-08-24"
54    }
55  ],
56  "number": 0,
57  "sort": {
58    "sorted": true,
59    "unsorted": true,
60    "empty": true
61  },
62  "first": true,
63  "last": true,
64  "empty": true
65}

Company - Create Companies

HTTP Request

POST /api/companies

📋 Description: Creates a new company entry within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

CompanyDto

true

Request body containing the company profile data, including portfolio details, asset information, and analytics relevant to real estate properties.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "postingPeriodVariantId": 0,
11    "name": "string",
12    "postingPeriodVariantDisplayId": "string",
13    "controllingAreaId": 0,
14    "controllingAreaDisplayId": "string",
15    "chartOfAccountId": 0,
16    "chartOfAccountDisplayId": "string",
17    "fiscalVariantId": 0,
18    "fiscalVariantDisplayId": "string",
19    "chartOfDepreciationId": 0,
20    "chartOfDepreciationDisplayId": "string",
21    "purchasingOrganizationId": 0,
22    "assetId": 0,
23    "exchangeRateTypeId": 0,
24    "plantId": 0,
25    "incrementalBorrowingRateId": 0,
26    "businessUnitId": 0,
27    "projectId": 0,
28    "transferVariantId": 0,
29    "partnerId": 0,
30    "departmentId": 0,
31    "accountingStandardId": 0,
32    "generalLedgerAccountId": 0,
33    "consumerPriceIndexCategoryId": 0,
34    "costCenterId": 0,
35    "costCenterRelationValidFrom": "2019-08-24",
36    "costCenterRelationValidTo": "2019-08-24"
37  }
38]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "countryId": 0,
 9    "countryDisplayId": "string",
10    "postingPeriodVariantId": 0,
11    "name": "string",
12    "postingPeriodVariantDisplayId": "string",
13    "controllingAreaId": 0,
14    "controllingAreaDisplayId": "string",
15    "chartOfAccountId": 0,
16    "chartOfAccountDisplayId": "string",
17    "fiscalVariantId": 0,
18    "fiscalVariantDisplayId": "string",
19    "chartOfDepreciationId": 0,
20    "chartOfDepreciationDisplayId": "string",
21    "purchasingOrganizationId": 0,
22    "assetId": 0,
23    "exchangeRateTypeId": 0,
24    "plantId": 0,
25    "incrementalBorrowingRateId": 0,
26    "businessUnitId": 0,
27    "projectId": 0,
28    "transferVariantId": 0,
29    "partnerId": 0,
30    "departmentId": 0,
31    "accountingStandardId": 0,
32    "generalLedgerAccountId": 0,
33    "consumerPriceIndexCategoryId": 0,
34    "costCenterId": 0,
35    "costCenterRelationValidFrom": "2019-08-24",
36    "costCenterRelationValidTo": "2019-08-24"
37  }
38]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[CompanyDto]

false

none

[Data transfer object representing a company within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties.]

» 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

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» countryId

integer(int64)

false

none

Unique identifier for the country

» countryDisplayId

string

false

none

Unique identifier for the country display

» postingPeriodVariantId

integer(int64)

false

none

Unique identifier for the posting period variant

» name

string

false

none

none

» postingPeriodVariantDisplayId

string

false

none

Unique identifier for the posting period variant display

» controllingAreaId

integer(int64)

false

none

Unique identifier for the controlling area

» controllingAreaDisplayId

string

false

none

Unique identifier for the controlling area display

» chartOfAccountId

integer(int64)

false

none

Unique identifier for the chart of account

» chartOfAccountDisplayId

string

false

none

Unique identifier for the chart of account display

» fiscalVariantId

integer(int64)

false

none

Unique identifier for the fiscal variant

» fiscalVariantDisplayId

string

false

none

Unique identifier for the fiscal variant display

» chartOfDepreciationId

integer(int64)

false

none

Unique identifier for the chart of depreciation

» chartOfDepreciationDisplayId

string

false

none

Unique identifier for the chart of depreciation display

» purchasingOrganizationId

integer(int64)

false

none

Unique identifier for the purchasing organization

» assetId

integer(int64)

false

none

Unique identifier for the asset

» exchangeRateTypeId

integer(int64)

false

none

Unique identifier for the exchange rate type

» plantId

integer(int64)

false

none

Unique identifier for the plant

» incrementalBorrowingRateId

integer(int64)

false

none

Unique identifier for the incremental borrowing rate

» businessUnitId

integer(int64)

false

none

Unique identifier for the business unit

» projectId

integer(int64)

false

none

Unique identifier for the project

» transferVariantId

integer(int64)

false

none

Unique identifier for the transfer variant

» partnerId

integer(int64)

false

none

Unique identifier for the partner

» departmentId

integer(int64)

false

none

Unique identifier for the department

» accountingStandardId

integer(int64)

false

none

Unique identifier for the accounting standard

» generalLedgerAccountId

integer(int64)

false

none

Unique identifier for the general ledger account

» consumerPriceIndexCategoryId

integer(int64)

false

none

Unique identifier for the consumer price index category

» costCenterId

integer(int64)

false

none

Unique identifier for the cost center

» costCenterRelationValidFrom

string(date)

false

none

Indicates the effective date from which the cost center relationship is valid, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

» costCenterRelationValidTo

string(date)

false

none

Indicates the expiration date of the cost center relationship, essential for managing portfolio and asset allocations within the Nakisa Portfolio Management Suite.

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Company - Search Companies

HTTP Request

POST /api/companies/search

📋 Description: Submits a search query to retrieve company data related to portfolio management, asset analytics, and real estate properties, enabling informed decision-making and strategic insights.

Parameters

Name

In

Type

Required

Description

body

body

CompanyDtoFilter

true

Request body containing search criteria and filters for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "countryIdEqual": 0,
30  "countryDisplayIdLike": "string",
31  "postingPeriodVariantIdEqual": 0,
32  "nameLike": "string",
33  "postingPeriodVariantDisplayIdLike": "string",
34  "controllingAreaIdEqual": 0,
35  "controllingAreaDisplayIdLike": "string",
36  "chartOfAccountIdEqual": 0,
37  "chartOfAccountDisplayIdLike": "string",
38  "fiscalVariantIdEqual": 0,
39  "fiscalVariantDisplayIdLike": "string",
40  "chartOfDepreciationIdEqual": 0,
41  "chartOfDepreciationDisplayIdLike": "string",
42  "purchasingOrganizationIdEqual": 0,
43  "assetIdEqual": 0,
44  "exchangeRateTypeIdEqual": 0,
45  "plantIdEqual": 0,
46  "incrementalBorrowingRateIdEqual": 0,
47  "businessUnitIdEqual": 0,
48  "projectIdEqual": 0,
49  "transferVariantIdEqual": 0,
50  "partnerIdEqual": 0,
51  "departmentIdEqual": 0,
52  "accountingStandardIdEqual": 0,
53  "generalLedgerAccountIdEqual": 0,
54  "consumerPriceIndexCategoryIdEqual": 0,
55  "costCenterIdEqual": 0,
56  "costCenterRelationValidFromEqual": "2019-08-24",
57  "costCenterRelationValidFromGreaterThanOrEqual": "2019-08-24",
58  "costCenterRelationValidFromLessThanOrEqual": "2019-08-24",
59  "costCenterRelationValidToEqual": "2019-08-24",
60  "costCenterRelationValidToGreaterThanOrEqual": "2019-08-24",
61  "costCenterRelationValidToLessThanOrEqual": "2019-08-24"
62}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCompanyDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "countryId": 0,
26      "countryDisplayId": "string",
27      "postingPeriodVariantId": 0,
28      "name": "string",
29      "postingPeriodVariantDisplayId": "string",
30      "controllingAreaId": 0,
31      "controllingAreaDisplayId": "string",
32      "chartOfAccountId": 0,
33      "chartOfAccountDisplayId": "string",
34      "fiscalVariantId": 0,
35      "fiscalVariantDisplayId": "string",
36      "chartOfDepreciationId": 0,
37      "chartOfDepreciationDisplayId": "string",
38      "purchasingOrganizationId": 0,
39      "assetId": 0,
40      "exchangeRateTypeId": 0,
41      "plantId": 0,
42      "incrementalBorrowingRateId": 0,
43      "businessUnitId": 0,
44      "projectId": 0,
45      "transferVariantId": 0,
46      "partnerId": 0,
47      "departmentId": 0,
48      "accountingStandardId": 0,
49      "generalLedgerAccountId": 0,
50      "consumerPriceIndexCategoryId": 0,
51      "costCenterId": 0,
52      "costCenterRelationValidFrom": "2019-08-24",
53      "costCenterRelationValidTo": "2019-08-24"
54    }
55  ],
56  "number": 0,
57  "sort": {
58    "sorted": true,
59    "unsorted": true,
60    "empty": true
61  },
62  "first": true,
63  "last": true,
64  "empty": true
65}