Term Definition¶
Term Definition - Get Term Definition¶
HTTP Request
GET /api/term-definitions/{id}
📋 Description: Retrieves the detailed definition of a specific term related to portfolio management, asset analytics, or real estate property by its unique identifier.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "paymentFrequencyName": "string",
10 "amountFrequencyName": "string",
11 "paymentModeName": "string",
12 "expenseCategoryId": 0,
13 "currencyId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "firstPaymentDate": "2019-08-24",
17 "endOfMonthPayment": true,
18 "proRata": true,
19 "note": "string",
20 "areaId": 0,
21 "parentTermDefinitionId": 0,
22 "expenseCategory": {
23 "id": 0,
24 "status": "CREATED",
25 "displayId": "string",
26 "name": "string",
27 "editable": true,
28 "expenseCategoryType": "PAYMENT"
29 },
30 "currency": {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "erpSystemId": 0,
35 "erpSystemDisplayId": "string",
36 "name": "string",
37 "decimalPoints": 0,
38 "depreciationAreaId": 0
39 },
40 "expenseGroup": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 },
68 "costCenterId": 0,
69 "leaseComponentId": 0,
70 "leaseComponentName": "string",
71 "assignmentNumber": {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "priority": 0,
80 "internalId": 0,
81 "pickListCode": "string",
82 "pickListLabel": "string",
83 "label": "string",
84 "cultureId": 0,
85 "labelDtos": [
86 {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "cultureId": 0,
95 "value": "string"
96 }
97 ]
98 },
99 "assignmentNumberId": 0,
100 "isAdjustmentTerm": true
101}
Term Definition - Update Term Definition¶
HTTP Request
PUT /api/term-definitions/{id}
📋 Description: Updates the specified term definition within the Nakisa Portfolio Management Suite, enabling users to refine portfolio, asset, and analytics terminology relevant to real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated term definition data, including relevant attributes and analytics for effective 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 "paymentFrequencyName": "string",
10 "amountFrequencyName": "string",
11 "paymentModeName": "string",
12 "expenseCategoryId": 0,
13 "currencyId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "firstPaymentDate": "2019-08-24",
17 "endOfMonthPayment": true,
18 "proRata": true,
19 "note": "string",
20 "areaId": 0,
21 "parentTermDefinitionId": 0,
22 "expenseCategory": {
23 "id": 0,
24 "status": "CREATED",
25 "displayId": "string",
26 "name": "string",
27 "editable": true,
28 "expenseCategoryType": "PAYMENT"
29 },
30 "currency": {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "erpSystemId": 0,
35 "erpSystemDisplayId": "string",
36 "name": "string",
37 "decimalPoints": 0,
38 "depreciationAreaId": 0
39 },
40 "expenseGroup": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 },
68 "costCenterId": 0,
69 "leaseComponentId": 0,
70 "leaseComponentName": "string",
71 "assignmentNumber": {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "priority": 0,
80 "internalId": 0,
81 "pickListCode": "string",
82 "pickListLabel": "string",
83 "label": "string",
84 "cultureId": 0,
85 "labelDtos": [
86 {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "cultureId": 0,
95 "value": "string"
96 }
97 ]
98 },
99 "assignmentNumberId": 0,
100 "isAdjustmentTerm": true
101}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "paymentFrequencyName": "string",
10 "amountFrequencyName": "string",
11 "paymentModeName": "string",
12 "expenseCategoryId": 0,
13 "currencyId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "firstPaymentDate": "2019-08-24",
17 "endOfMonthPayment": true,
18 "proRata": true,
19 "note": "string",
20 "areaId": 0,
21 "parentTermDefinitionId": 0,
22 "expenseCategory": {
23 "id": 0,
24 "status": "CREATED",
25 "displayId": "string",
26 "name": "string",
27 "editable": true,
28 "expenseCategoryType": "PAYMENT"
29 },
30 "currency": {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "erpSystemId": 0,
35 "erpSystemDisplayId": "string",
36 "name": "string",
37 "decimalPoints": 0,
38 "depreciationAreaId": 0
39 },
40 "expenseGroup": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 },
68 "costCenterId": 0,
69 "leaseComponentId": 0,
70 "leaseComponentName": "string",
71 "assignmentNumber": {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "priority": 0,
80 "internalId": 0,
81 "pickListCode": "string",
82 "pickListLabel": "string",
83 "label": "string",
84 "cultureId": 0,
85 "labelDtos": [
86 {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "cultureId": 0,
95 "value": "string"
96 }
97 ]
98 },
99 "assignmentNumberId": 0,
100 "isAdjustmentTerm": true
101}
Term Definition - Delete Term Definition¶
HTTP Request
DELETE /api/term-definitions/{id}
📋 Description: Deletes a specified term definition from the Nakisa Portfolio Management Suite, ensuring that outdated or irrelevant terminology is removed from the portfolio, asset, and analytics frameworks related to 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 |
None |
Term Definition - Update Term Indexation For Term Definition¶
HTTP Request
PUT /api/term-definitions/{id}/term-indexations/{termIndexationId}
📋 Description: Updates the term indexation for a specified term definition within the Nakisa Portfolio Management Suite, enabling enhanced analytics and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
termIndexationId |
path |
integer(int64) |
true |
Unique identifier for the term indexation |
body |
body |
true |
Request body containing the updated term indexation data, including relevant attributes and metadata for effective portfolio and asset analytics 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 "parentTermIndexationId": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "rateDate": "2019-08-24",
13 "rate": 0,
14 "amount": 0,
15 "firstPaymentAmount": 0,
16 "lastPaymentAmount": 0,
17 "firstSpecialPaymentDate": "2019-08-24",
18 "lastSpecialPaymentDate": "2019-08-24",
19 "firstProvisioningAmount": 0,
20 "lastProvisioningAmount": 0,
21 "hold": true,
22 "legacy": true,
23 "termIndexationTypeId": 0,
24 "baseIndexationDate": "2019-08-24",
25 "baseIndexationRate": 0.1,
26 "referenceIndexationDate": "2019-08-24",
27 "referenceIndexationRate": 0.1,
28 "isIndexed": true,
29 "indexedAmount": 0,
30 "leaseComponentFinancialTermId": 0,
31 "termIndexationType": {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "priority": 0,
40 "internalId": 0,
41 "pickListCode": "string",
42 "pickListLabel": "string",
43 "label": "string",
44 "cultureId": 0,
45 "labelDtos": [
46 {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "cultureId": 0,
55 "value": "string"
56 }
57 ]
58 },
59 "confirmedAmount": true
60}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "parentTermIndexationId": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "rateDate": "2019-08-24",
13 "rate": 0,
14 "amount": 0,
15 "firstPaymentAmount": 0,
16 "lastPaymentAmount": 0,
17 "firstSpecialPaymentDate": "2019-08-24",
18 "lastSpecialPaymentDate": "2019-08-24",
19 "firstProvisioningAmount": 0,
20 "lastProvisioningAmount": 0,
21 "hold": true,
22 "legacy": true,
23 "termIndexationTypeId": 0,
24 "baseIndexationDate": "2019-08-24",
25 "baseIndexationRate": 0.1,
26 "referenceIndexationDate": "2019-08-24",
27 "referenceIndexationRate": 0.1,
28 "isIndexed": true,
29 "indexedAmount": 0,
30 "leaseComponentFinancialTermId": 0,
31 "termIndexationType": {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "priority": 0,
40 "internalId": 0,
41 "pickListCode": "string",
42 "pickListLabel": "string",
43 "label": "string",
44 "cultureId": 0,
45 "labelDtos": [
46 {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "cultureId": 0,
55 "value": "string"
56 }
57 ]
58 },
59 "confirmedAmount": true
60}
Term Definition - Get Term Definition Partners¶
HTTP Request
GET /api/term-definitions/{id}/partners
📋 Description: Retrieves a list of partners associated with a specific term definition in the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the partner query for the specified term definition should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
id |
path |
string |
true |
Unique identifier for the resource |
ownership |
query |
string |
false |
Specifies the ownership status of the asset within the portfolio, enabling targeted analytics for real estate property management. |
archived |
query |
string |
false |
Indicates whether the partner records retrieved from the specified term definition are archived, providing insights into the historical data relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "partners": [
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 "partner": 0,
12 "ownership": 0.1,
13 "calculateTax": true,
14 "taxExemptionPercentage": 0,
15 "taxCodeDeterminationId": 0,
16 "partnerDto": {
17 "id": 0,
18 "status": "CREATED",
19 "displayId": "string",
20 "erpSystemId": 0,
21 "erpSystemDisplayId": "string",
22 "name": "string",
23 "fax": "string",
24 "phone": "string",
25 "parentId": 0,
26 "parentName": "string",
27 "parentDisplayId": "string",
28 "companyId": 0,
29 "partnerRoleId": 0,
30 "partnerContactId": 0
31 }
32 }
33 ]
34 },
35 "page": {
36 "size": 0,
37 "totalElements": 0,
38 "totalPages": 0,
39 "number": 0
40 }
41}
Term Definition - Create Or Update Term Definition Partners¶
HTTP Request
PUT /api/term-definitions/{id}/partners
📋 Description: Updates the partner associations for a specified term definition within the Nakisa Portfolio Management Suite, enabling enhanced asset analytics and portfolio management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the partner association data for a specified term definition, including relevant attributes to enhance portfolio and asset analytics 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 "partner": 0,
10 "ownership": 0.1,
11 "calculateTax": true,
12 "taxExemptionPercentage": 0,
13 "taxCodeDeterminationId": 0,
14 "partnerDto": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "fax": "string",
22 "phone": "string",
23 "parentId": 0,
24 "parentName": "string",
25 "parentDisplayId": "string",
26 "companyId": 0,
27 "partnerRoleId": 0,
28 "partnerContactId": 0
29 }
30 }
31]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
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 "partner": 0,
10 "ownership": 0.1,
11 "calculateTax": true,
12 "taxExemptionPercentage": 0,
13 "taxCodeDeterminationId": 0,
14 "partnerDto": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "fax": "string",
22 "phone": "string",
23 "parentId": 0,
24 "parentName": "string",
25 "parentDisplayId": "string",
26 "companyId": 0,
27 "partnerRoleId": 0,
28 "partnerContactId": 0
29 }
30 }
31]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a term definition utilized within the Nakisa Portfolio Management Suite, specifically designed to enhance portfolio analytics and asset management for real estate properties.] |
|
» 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 |
» partner |
integer(int64) |
false |
none |
Numeric value representing partner |
» ownership |
number(double) |
false |
none |
Value for ownership field |
» calculateTax |
boolean |
false |
none |
Boolean flag indicating calculateTax status |
» taxExemptionPercentage |
number |
false |
none |
Percentage of tax exemption |
» taxCodeDeterminationId |
integer(int64) |
false |
none |
Unique identifier for the tax code determination |
» partnerDto |
false |
none |
Data transfer object representing a partner within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio management, asset tracking, 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 |
»» name |
string |
false |
none |
Name of the resource |
»» fax |
string |
false |
none |
Fax number associated with the partner, used for communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»» phone |
string |
false |
none |
Contact number for the partner associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» parentId |
integer(int64) |
false |
none |
Unique identifier for the parent |
»» parentName |
string |
false |
none |
Name of the parent |
»» parentDisplayId |
string |
false |
none |
Unique identifier for the parent display |
»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»» partnerRoleId |
integer(int64) |
false |
none |
Unique identifier for the partner role |
»» partnerContactId |
integer(int64) |
false |
none |
Unique identifier for the partner contact |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Term Definition - Get All Partners By Lease And Currency¶
HTTP Request
POST /api/term-definitions/{leaseId}/currency/{currencyId}
📋 Description: Creates a new term definition for a specified lease in the Nakisa Portfolio Management Suite, associating it with a designated currency to enhance asset and portfolio analytics within real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
leaseId |
path |
integer(int64) |
true |
Unique identifier for the lease |
currencyId |
path |
integer(int64) |
true |
Unique identifier for the currency |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "status": "CREATED",
6 "name": "string",
7 "erpSystemDisplayId": "string"
8 }
9]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» status |
string |
false |
none |
Status of the resource |
» name |
string |
false |
none |
Name of the resource |
» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Term Definition - Add Term Indexations To Term Definition¶
HTTP Request
POST /api/term-definitions/{id}/term-indexations
📋 Description: Creates a new term indexation for a specified term definition within the Nakisa Portfolio Management Suite, facilitating enhanced asset analytics and portfolio management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the term indexation details, including associated portfolio and asset identifiers, to enhance analytics 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 "parentTermIndexationId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "rateDate": "2019-08-24",
14 "rate": 0,
15 "amount": 0,
16 "firstPaymentAmount": 0,
17 "lastPaymentAmount": 0,
18 "firstSpecialPaymentDate": "2019-08-24",
19 "lastSpecialPaymentDate": "2019-08-24",
20 "firstProvisioningAmount": 0,
21 "lastProvisioningAmount": 0,
22 "hold": true,
23 "legacy": true,
24 "termIndexationTypeId": 0,
25 "baseIndexationDate": "2019-08-24",
26 "baseIndexationRate": 0.1,
27 "referenceIndexationDate": "2019-08-24",
28 "referenceIndexationRate": 0.1,
29 "isIndexed": true,
30 "indexedAmount": 0,
31 "leaseComponentFinancialTermId": 0,
32 "termIndexationType": {
33 "createdBy": "string",
34 "lastModifiedBy": "string",
35 "createdDate": "2019-08-24T14:15:22Z",
36 "lastModifiedDate": "2019-08-24T14:15:22Z",
37 "archived": true,
38 "externalId": "string",
39 "id": 0,
40 "priority": 0,
41 "internalId": 0,
42 "pickListCode": "string",
43 "pickListLabel": "string",
44 "label": "string",
45 "cultureId": 0,
46 "labelDtos": [
47 {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "cultureId": 0,
56 "value": "string"
57 }
58 ]
59 },
60 "confirmedAmount": true
61 }
62]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
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 "parentTermIndexationId": 0,
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "rateDate": "2019-08-24",
14 "rate": 0,
15 "amount": 0,
16 "firstPaymentAmount": 0,
17 "lastPaymentAmount": 0,
18 "firstSpecialPaymentDate": "2019-08-24",
19 "lastSpecialPaymentDate": "2019-08-24",
20 "firstProvisioningAmount": 0,
21 "lastProvisioningAmount": 0,
22 "hold": true,
23 "legacy": true,
24 "termIndexationTypeId": 0,
25 "baseIndexationDate": "2019-08-24",
26 "baseIndexationRate": 0.1,
27 "referenceIndexationDate": "2019-08-24",
28 "referenceIndexationRate": 0.1,
29 "isIndexed": true,
30 "indexedAmount": 0,
31 "leaseComponentFinancialTermId": 0,
32 "termIndexationType": {
33 "createdBy": "string",
34 "lastModifiedBy": "string",
35 "createdDate": "2019-08-24T14:15:22Z",
36 "lastModifiedDate": "2019-08-24T14:15:22Z",
37 "archived": true,
38 "externalId": "string",
39 "id": 0,
40 "priority": 0,
41 "internalId": 0,
42 "pickListCode": "string",
43 "pickListLabel": "string",
44 "label": "string",
45 "cultureId": 0,
46 "labelDtos": [
47 {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "cultureId": 0,
56 "value": "string"
57 }
58 ]
59 },
60 "confirmedAmount": true
61 }
62]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the indexation details of terms related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for 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 |
» parentTermIndexationId |
integer(int64) |
false |
none |
Unique identifier for the parent term indexation |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» rateDate |
string(date) |
false |
none |
Date of the rate |
» rate |
number |
false |
none |
Rate value |
» amount |
number |
false |
none |
Amount value |
» firstPaymentAmount |
number |
false |
none |
Amount of first payment |
» lastPaymentAmount |
number |
false |
none |
Amount of last payment |
» firstSpecialPaymentDate |
string(date) |
false |
none |
Date of the first special payment |
» lastSpecialPaymentDate |
string(date) |
false |
none |
Date of the last special payment |
» firstProvisioningAmount |
number |
false |
none |
Amount of first provisioning |
» lastProvisioningAmount |
number |
false |
none |
Amount of last provisioning |
» hold |
boolean |
false |
none |
Boolean flag indicating hold status |
» legacy |
boolean |
false |
none |
Boolean flag indicating legacy status |
» termIndexationTypeId |
integer(int64) |
false |
none |
Unique identifier for the term indexation type |
» baseIndexationDate |
string(date) |
false |
none |
Date of the base indexation |
» baseIndexationRate |
number(double) |
false |
none |
Rate of base indexation |
» referenceIndexationDate |
string(date) |
false |
none |
Date of the reference indexation |
» referenceIndexationRate |
number(double) |
false |
none |
Rate of reference indexation |
» isIndexed |
boolean |
false |
none |
Whether the resource is indexed |
» indexedAmount |
number |
false |
none |
Amount of indexed |
» leaseComponentFinancialTermId |
integer(int64) |
false |
none |
Unique identifier for the lease component financial term |
» termIndexationType |
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 |
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 |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
» confirmedAmount |
boolean |
false |
none |
none |
Term Definition - Archive Term Indexation For Term Definition¶
HTTP Request
POST /api/term-definitions/{id}/term-indexations/{termIndexationId}/archive
📋 Description: Archives the specified term indexation within the Nakisa Portfolio Management Suite, enabling enhanced management of portfolio and asset analytics related to real estate properties. This operation ensures that outdated or irrelevant term indexations are properly stored for future reference.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
termIndexationId |
path |
integer(int64) |
true |
Unique identifier for the term indexation |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "parentTermIndexationId": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "rateDate": "2019-08-24",
13 "rate": 0,
14 "amount": 0,
15 "firstPaymentAmount": 0,
16 "lastPaymentAmount": 0,
17 "firstSpecialPaymentDate": "2019-08-24",
18 "lastSpecialPaymentDate": "2019-08-24",
19 "firstProvisioningAmount": 0,
20 "lastProvisioningAmount": 0,
21 "hold": true,
22 "legacy": true,
23 "termIndexationTypeId": 0,
24 "baseIndexationDate": "2019-08-24",
25 "baseIndexationRate": 0.1,
26 "referenceIndexationDate": "2019-08-24",
27 "referenceIndexationRate": 0.1,
28 "isIndexed": true,
29 "indexedAmount": 0,
30 "leaseComponentFinancialTermId": 0,
31 "termIndexationType": {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "priority": 0,
40 "internalId": 0,
41 "pickListCode": "string",
42 "pickListLabel": "string",
43 "label": "string",
44 "cultureId": 0,
45 "labelDtos": [
46 {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "cultureId": 0,
55 "value": "string"
56 }
57 ]
58 },
59 "confirmedAmount": true
60}
Term Definition - Archive Term Definition¶
HTTP Request
POST /api/term-definitions/{id}/archive
📋 Description: Archives the specified term definition within the Nakisa Portfolio Management Suite, facilitating the effective management of portfolio and asset data in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "paymentFrequencyName": "string",
10 "amountFrequencyName": "string",
11 "paymentModeName": "string",
12 "expenseCategoryId": 0,
13 "currencyId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "firstPaymentDate": "2019-08-24",
17 "endOfMonthPayment": true,
18 "proRata": true,
19 "note": "string",
20 "areaId": 0,
21 "parentTermDefinitionId": 0,
22 "expenseCategory": {
23 "id": 0,
24 "status": "CREATED",
25 "displayId": "string",
26 "name": "string",
27 "editable": true,
28 "expenseCategoryType": "PAYMENT"
29 },
30 "currency": {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "erpSystemId": 0,
35 "erpSystemDisplayId": "string",
36 "name": "string",
37 "decimalPoints": 0,
38 "depreciationAreaId": 0
39 },
40 "expenseGroup": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 },
68 "costCenterId": 0,
69 "leaseComponentId": 0,
70 "leaseComponentName": "string",
71 "assignmentNumber": {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "priority": 0,
80 "internalId": 0,
81 "pickListCode": "string",
82 "pickListLabel": "string",
83 "label": "string",
84 "cultureId": 0,
85 "labelDtos": [
86 {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "cultureId": 0,
95 "value": "string"
96 }
97 ]
98 },
99 "assignmentNumberId": 0,
100 "isAdjustmentTerm": true
101}
Term Definition - Apply Pro Rata¶
HTTP Request
POST /api/term-definitions/{id}/apply-pro-rata
📋 Description: Applies pro-rata adjustments to the specified term definition within the Nakisa Portfolio Management Suite, ensuring accurate allocation of portfolio assets and enhancing analytics for 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 |
None |
Term Definition - Get Default Term Indexation¶
HTTP Request
GET /api/term-indexations/default/{userId}
📋 Description: Retrieves default term indexations for a specified user, facilitating enhanced portfolio and asset analytics within the Nakisa Portfolio Management Suite for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "parentTermIndexationId": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "rateDate": "2019-08-24",
13 "rate": 0,
14 "amount": 0,
15 "firstPaymentAmount": 0,
16 "lastPaymentAmount": 0,
17 "firstSpecialPaymentDate": "2019-08-24",
18 "lastSpecialPaymentDate": "2019-08-24",
19 "firstProvisioningAmount": 0,
20 "lastProvisioningAmount": 0,
21 "hold": true,
22 "legacy": true,
23 "termIndexationTypeId": 0,
24 "baseIndexationDate": "2019-08-24",
25 "baseIndexationRate": 0.1,
26 "referenceIndexationDate": "2019-08-24",
27 "referenceIndexationRate": 0.1,
28 "isIndexed": true,
29 "indexedAmount": 0,
30 "leaseComponentFinancialTermId": 0,
31 "termIndexationType": {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "priority": 0,
40 "internalId": 0,
41 "pickListCode": "string",
42 "pickListLabel": "string",
43 "label": "string",
44 "cultureId": 0,
45 "labelDtos": [
46 {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "cultureId": 0,
55 "value": "string"
56 }
57 ]
58 },
59 "confirmedAmount": true
60}
Term Definition - Get Term Definitions¶
HTTP Request
GET /api/term-definitions
📋 Description: Retrieves a comprehensive list of term definitions related to portfolio, asset, and analytics within the Nakisa Portfolio Management Suite, enhancing understanding of real estate property terminology.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the term definitions query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific portfolio, asset, or real estate property definitions within the Nakisa Portfolio Management Suite. |
lease-id |
query |
string |
false |
Unique identifier for the lease within the Nakisa Portfolio Management Suite, used to retrieve specific term definitions related to portfolio and asset analytics in real estate property management. |
payment-frequency-name |
query |
string |
false |
Specifies the name of the payment frequency associated with portfolio assets in the Nakisa Portfolio Management Suite. |
amount-frequency-name |
query |
string |
false |
Specifies the frequency name of the amount, used for defining financial metrics within the portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
expense-type-id |
query |
string |
false |
Unique identifier for the type of expense associated with portfolio analytics within the Nakisa Portfolio Management Suite. |
area-id |
query |
string |
false |
Unique identifier for the specific area within the Nakisa Portfolio Management Suite, used to retrieve term definitions relevant to portfolio, asset, analytics, and real estate property management. |
start-date |
query |
string |
false |
Specifies the starting date for retrieving term definitions related to portfolio analytics within the Nakisa Portfolio Management Suite. |
end-date-greater-than |
query |
string |
false |
Specifies the end date for term definitions that are greater than the provided value, facilitating targeted analytics for portfolio and asset management within the Nakisa Portfolio Management Suite. |
end-date |
query |
string |
false |
The end-date parameter specifies the concluding date for retrieving term definitions related to portfolio, asset, and analytics within the Nakisa Portfolio Management Suite. |
end-of-month-payment |
query |
string |
false |
Specifies the end-of-month payment date for financial analytics related to portfolio and asset management within the Nakisa Portfolio Management Suite. |
pro-rata |
query |
string |
false |
Specifies the pro-rata allocation method for assets within the portfolio, enhancing analytics for real estate property assessments. |
first-payment-date |
query |
string |
false |
Specifies the date of the first payment associated with the portfolio asset, enabling accurate financial analytics within the Nakisa Portfolio Management Suite. |
parent-term-definition-id |
query |
string |
false |
Unique identifier for the parent term definition, facilitating the retrieval of related portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
lease-id-in |
query |
string |
false |
Unique identifier for the lease, used to retrieve specific term definitions related to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "termDefinitions": [
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 "paymentFrequencyName": "string",
13 "amountFrequencyName": "string",
14 "paymentModeName": "string",
15 "expenseCategoryId": 0,
16 "currencyId": 0,
17 "startDate": "2019-08-24",
18 "endDate": "2019-08-24",
19 "firstPaymentDate": "2019-08-24",
20 "endOfMonthPayment": true,
21 "proRata": true,
22 "note": "string",
23 "areaId": 0,
24 "parentTermDefinitionId": 0,
25 "expenseCategory": {
26 "id": 0,
27 "status": "CREATED",
28 "displayId": "string",
29 "name": "string",
30 "editable": true,
31 "expenseCategoryType": "PAYMENT"
32 },
33 "currency": {
34 "id": 0,
35 "status": "CREATED",
36 "displayId": "string",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "name": "string",
40 "decimalPoints": 0,
41 "depreciationAreaId": 0
42 },
43 "expenseGroup": {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "priority": 0,
52 "internalId": 0,
53 "pickListCode": "string",
54 "pickListLabel": "string",
55 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70 },
71 "costCenterId": 0,
72 "leaseComponentId": 0,
73 "leaseComponentName": "string",
74 "assignmentNumber": {
75 "createdBy": "string",
76 "lastModifiedBy": "string",
77 "createdDate": "2019-08-24T14:15:22Z",
78 "lastModifiedDate": "2019-08-24T14:15:22Z",
79 "archived": true,
80 "externalId": "string",
81 "id": 0,
82 "priority": 0,
83 "internalId": 0,
84 "pickListCode": "string",
85 "pickListLabel": "string",
86 "label": "string",
87 "cultureId": 0,
88 "labelDtos": [
89 {
90 "createdBy": "string",
91 "lastModifiedBy": "string",
92 "createdDate": "2019-08-24T14:15:22Z",
93 "lastModifiedDate": "2019-08-24T14:15:22Z",
94 "archived": true,
95 "externalId": "string",
96 "id": 0,
97 "cultureId": 0,
98 "value": "string"
99 }
100 ]
101 },
102 "assignmentNumberId": 0,
103 "isAdjustmentTerm": true
104 }
105 ]
106 },
107 "page": {
108 "size": 0,
109 "totalElements": 0,
110 "totalPages": 0,
111 "number": 0
112 }
113}
Term Definition - Get Term Indexations¶
HTTP Request
GET /api/term-definitions/{termDefinitionId}/term-indexations
📋 Description: Fetches term indexations associated with a specific term definition, enabling users to analyze portfolio and asset data within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the term indexations for the specified term definition should be returned in a paginated format, facilitating efficient data retrieval in the context of portfolio and asset management analytics. |
|
termDefinitionId |
path |
string |
true |
Unique identifier for the term definition |
start-date |
query |
string |
false |
Specifies the starting date for retrieving term indexations related to the specified term definition within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics in the real estate property domain. |
end-date |
query |
string |
false |
Specifies the end date for retrieving term indexations related to a particular term definition within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics in the real estate property sector. |
rate-date |
query |
string |
false |
Specifies the date for which the term indexation rate is being requested, relevant for portfolio and asset analytics within the real estate property domain. |
amount |
query |
string |
false |
Amount value |
first-payment-amount |
query |
string |
false |
Specifies the initial payment amount associated with the term definition, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
last-payment-amount |
query |
string |
false |
Specifies the last recorded payment amount for the asset, providing critical financial data for portfolio and real estate property analytics. |
legacy |
query |
string |
false |
Specifies whether to retrieve legacy term indexations for the given term definition, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
hold |
query |
string |
false |
Specifies the hold status of the term indexation, allowing users to filter results relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "termIndexations": [
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 "parentTermIndexationId": 0,
13 "startDate": "2019-08-24",
14 "endDate": "2019-08-24",
15 "rateDate": "2019-08-24",
16 "rate": 0,
17 "amount": 0,
18 "firstPaymentAmount": 0,
19 "lastPaymentAmount": 0,
20 "firstSpecialPaymentDate": "2019-08-24",
21 "lastSpecialPaymentDate": "2019-08-24",
22 "firstProvisioningAmount": 0,
23 "lastProvisioningAmount": 0,
24 "hold": true,
25 "legacy": true,
26 "termIndexationTypeId": 0,
27 "baseIndexationDate": "2019-08-24",
28 "baseIndexationRate": 0.1,
29 "referenceIndexationDate": "2019-08-24",
30 "referenceIndexationRate": 0.1,
31 "isIndexed": true,
32 "indexedAmount": 0,
33 "leaseComponentFinancialTermId": 0,
34 "termIndexationType": {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "priority": 0,
43 "internalId": 0,
44 "pickListCode": "string",
45 "pickListLabel": "string",
46 "label": "string",
47 "cultureId": 0,
48 "labelDtos": [
49 {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "cultureId": 0,
58 "value": "string"
59 }
60 ]
61 },
62 "confirmedAmount": true
63 }
64 ]
65 },
66 "page": {
67 "size": 0,
68 "totalElements": 0,
69 "totalPages": 0,
70 "number": 0
71 }
72}
Term Definition - Get Default Term Definition¶
HTTP Request
GET /api/term-definitions/default/{userId}
📋 Description: Retrieves the default term definitions associated with a specified user ID, facilitating enhanced understanding and analytics of portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "paymentFrequencyName": "string",
10 "amountFrequencyName": "string",
11 "paymentModeName": "string",
12 "expenseCategoryId": 0,
13 "currencyId": 0,
14 "startDate": "2019-08-24",
15 "endDate": "2019-08-24",
16 "firstPaymentDate": "2019-08-24",
17 "endOfMonthPayment": true,
18 "proRata": true,
19 "note": "string",
20 "areaId": 0,
21 "parentTermDefinitionId": 0,
22 "expenseCategory": {
23 "id": 0,
24 "status": "CREATED",
25 "displayId": "string",
26 "name": "string",
27 "editable": true,
28 "expenseCategoryType": "PAYMENT"
29 },
30 "currency": {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "erpSystemId": 0,
35 "erpSystemDisplayId": "string",
36 "name": "string",
37 "decimalPoints": 0,
38 "depreciationAreaId": 0
39 },
40 "expenseGroup": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 },
68 "costCenterId": 0,
69 "leaseComponentId": 0,
70 "leaseComponentName": "string",
71 "assignmentNumber": {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "priority": 0,
80 "internalId": 0,
81 "pickListCode": "string",
82 "pickListLabel": "string",
83 "label": "string",
84 "cultureId": 0,
85 "labelDtos": [
86 {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "cultureId": 0,
95 "value": "string"
96 }
97 ]
98 },
99 "assignmentNumberId": 0,
100 "isAdjustmentTerm": true
101}