Contract¶
Contract - Update Lessor Lease Determination¶
HTTP Request
PUT /api/lessor-lease-determinations/{id}
📋 Description: Updates the lease determination details for a specified lessor within the Nakisa Portfolio Management Suite, enabling accurate portfolio and asset analytics 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 updated lease determination data, including asset details and relevant analytics for effective portfolio management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "systemDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
6 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
7 "contractRevisionId": 0,
8 "contractId": 0,
9 "contractDisplayId": "string",
10 "type": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeIdentifierValue": "string",
15 "allowsSystemGenerateNewId": true,
16 "numberRangeType": {
17 "name": "string"
18 },
19 "contractIsNonLease": true,
20 "transferOfOwnershipTest": true,
21 "leasePurchaseOptionTest": true,
22 "leaseTermTest": true,
23 "presentValueTestA": true,
24 "alternativeUseTest": true,
25 "presentValueTestB": true,
26 "collectibilityTest": true
27}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "systemDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
6 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
7 "contractRevisionId": 0,
8 "contractId": 0,
9 "contractDisplayId": "string",
10 "type": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeIdentifierValue": "string",
15 "allowsSystemGenerateNewId": true,
16 "numberRangeType": {
17 "name": "string"
18 }
19}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
principalPositionType |
LESSEE, LESSOR |
systemDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
userDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
Contract - Update Lessee Lease Determination¶
HTTP Request
PUT /api/lessee-lease-determinations/{id}
📋 Description: Updates the lease determination details for a specified lessee within the Nakisa Portfolio Management Suite, enabling accurate portfolio and asset analytics 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 updated lease determination data for a specific lessee, including relevant portfolio and asset analytics for real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "systemDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
6 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
7 "contractRevisionId": 0,
8 "contractId": 0,
9 "contractDisplayId": "string",
10 "type": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeIdentifierValue": "string",
15 "allowsSystemGenerateNewId": true,
16 "numberRangeType": {
17 "name": "string"
18 },
19 "hasIdentifiedAsset": true,
20 "isServiceContract": true,
21 "hasEconomicBenefit": true,
22 "whoHasRightToDirect": "string",
23 "canCustomerOperate": true,
24 "isUsagePredetermined": true,
25 "isShortTermNoPurchase": true,
26 "isLowValueAsset": true
27}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "systemDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
6 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
7 "contractRevisionId": 0,
8 "contractId": 0,
9 "contractDisplayId": "string",
10 "type": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeIdentifierValue": "string",
15 "allowsSystemGenerateNewId": true,
16 "numberRangeType": {
17 "name": "string"
18 }
19}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
principalPositionType |
LESSEE, LESSOR |
systemDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
userDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
Contract - Create Or Update Contract¶
HTTP Request
PUT /api/contracts/createOrUpdate
📋 Description: Creates or updates contract details within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio assets and real estate properties for enhanced analytics and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the contract details for creating or updating portfolio assets, including relevant analytics and real estate property information. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "principalPositionType": "LESSEE",
6 "validFrom": "2019-08-24",
7 "validTo": "2019-08-24",
8 "amendmentDate": "2019-08-24",
9 "approverComment": "string",
10 "contractPhase": "INITIAL",
11 "dataCreationInfo": {
12 "id": 0,
13 "idGenerationType": "AUTO",
14 "source": "string",
15 "type": "MIGRATION",
16 "startDateTime": "2019-08-24T14:15:22Z",
17 "endDateTime": "2019-08-24T14:15:22Z"
18 },
19 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
20 "revision": {
21 "id": 0,
22 "displayId": "string",
23 "name": "string",
24 "inception": true,
25 "revisionType": "REVISION",
26 "state": "MLA_DEFINE",
27 "approvedBy": "string",
28 "approvedAt": "2019-08-24T14:15:22Z",
29 "parentRevisionId": 0,
30 "approverComment": "string",
31 "contractId": 0,
32 "contractDisplayId": "string",
33 "contractName": "string",
34 "principalPositionType": "LESSEE",
35 "mlaId": 0,
36 "companyId": 0,
37 "description": "string",
38 "externalReference": "string",
39 "internalReference": "string",
40 "formOfLease": "FULL",
41 "jointVentureLeaseType": "GROSS_LEASE",
42 "businessPlace": "string",
43 "tradingPartner": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string"
50 },
51 "contractCategoryGroup": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "contractGroup1": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string"
62 },
63 "contractGroup2": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string"
68 },
69 "group3": "string",
70 "group4": "string",
71 "signingPerson": "string",
72 "placeOfSignature": "string",
73 "dateOfSignature": "2019-08-24",
74 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83 },
84 "currency": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "decimalPoints": 0
90 },
91 "companyCurrency": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "decimalPoints": 0
97 },
98 "indexedCurrency": true,
99 "assetValueCurrencyType": "CONTRACT_CURRENCY",
100 "currencyLocked": true,
101 "leaseArea": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string"
106 },
107 "businessUnit": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string"
112 },
113 "businessUnitLocked": true,
114 "companyCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "erpSystemId": 0,
119 "erpSystemDisplayId": "string",
120 "countryId": 0,
121 "countryDisplayId": "string",
122 "name": "string",
123 "postingPeriodVariantId": 0,
124 "fiscalVariantId": 0
125 },
126 "companyCodeLocked": true,
127 "department": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string"
132 },
133 "departmentLocked": true,
134 "leaseGroup": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string"
139 },
140 "leaseGroupLocked": true,
141 "subleasingInternalAssetClass": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "assetClassType": "PROPERTY",
147 "infiniteUsefulLife": true
148 },
149 "contractGroup1": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string"
154 },
155 "contractGroup2": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string"
160 },
161 "subleasing": true,
162 "subleasingContractRevisionInfo": {
163 "id": 0,
164 "contractId": 0,
165 "contractDisplayId": "string",
166 "contractName": "string"
167 },
168 "subleasingLeaseComponentRevisionInfo": {
169 "id": 0,
170 "leaseComponentId": 0,
171 "leaseComponentDisplayId": "string",
172 "leaseComponentName": "string"
173 },
174 "subleasingActivationGroupRevisionInfo": {
175 "id": 0,
176 "activationGroupId": 0,
177 "activationGroupDisplayId": "string",
178 "activationGroupName": "string"
179 },
180 "notifications": [
181 {
182 "id": 0,
183 "topic": {
184 "enCaption": "string",
185 "frCaption": "string",
186 "name": "string",
187 "priority": "HIGH"
188 },
189 "username": "string",
190 "contractId": 0,
191 "contractDisplayId": "string",
192 "targetType": "string",
193 "targetId": "string"
194 }
195 ],
196 "masterAgreementId": 0,
197 "masterAgreementDisplayId": "string",
198 "allowsSystemGenerateNewId": true,
199 "transferInfo": {
200 "transferredFromDisplayId": "string",
201 "transferredFromRevisionId": 0,
202 "transferredToDisplayId": "string",
203 "transferredToRevisionId": 0
204 },
205 "numberRangeIdentifierType": {
206 "name": "string"
207 },
208 "numberRangeIdentifierValue": "string",
209 "numberRangeType": {
210 "name": "string"
211 }
212}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "principalPositionType": "LESSEE",
6 "validFrom": "2019-08-24",
7 "validTo": "2019-08-24",
8 "amendmentDate": "2019-08-24",
9 "approverComment": "string",
10 "contractPhase": "INITIAL",
11 "dataCreationInfo": {
12 "id": 0,
13 "idGenerationType": "AUTO",
14 "source": "string",
15 "type": "MIGRATION",
16 "startDateTime": "2019-08-24T14:15:22Z",
17 "endDateTime": "2019-08-24T14:15:22Z"
18 },
19 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
20 "revision": {
21 "id": 0,
22 "displayId": "string",
23 "name": "string",
24 "inception": true,
25 "revisionType": "REVISION",
26 "state": "MLA_DEFINE",
27 "approvedBy": "string",
28 "approvedAt": "2019-08-24T14:15:22Z",
29 "parentRevisionId": 0,
30 "approverComment": "string",
31 "contractId": 0,
32 "contractDisplayId": "string",
33 "contractName": "string",
34 "principalPositionType": "LESSEE",
35 "mlaId": 0,
36 "companyId": 0,
37 "description": "string",
38 "externalReference": "string",
39 "internalReference": "string",
40 "formOfLease": "FULL",
41 "jointVentureLeaseType": "GROSS_LEASE",
42 "businessPlace": "string",
43 "tradingPartner": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string"
50 },
51 "contractCategoryGroup": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "contractGroup1": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string"
62 },
63 "contractGroup2": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string"
68 },
69 "group3": "string",
70 "group4": "string",
71 "signingPerson": "string",
72 "placeOfSignature": "string",
73 "dateOfSignature": "2019-08-24",
74 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83 },
84 "currency": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "decimalPoints": 0
90 },
91 "companyCurrency": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "decimalPoints": 0
97 },
98 "indexedCurrency": true,
99 "assetValueCurrencyType": "CONTRACT_CURRENCY",
100 "currencyLocked": true,
101 "leaseArea": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string"
106 },
107 "businessUnit": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string"
112 },
113 "businessUnitLocked": true,
114 "companyCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "erpSystemId": 0,
119 "erpSystemDisplayId": "string",
120 "countryId": 0,
121 "countryDisplayId": "string",
122 "name": "string",
123 "postingPeriodVariantId": 0,
124 "fiscalVariantId": 0
125 },
126 "companyCodeLocked": true,
127 "department": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string"
132 },
133 "departmentLocked": true,
134 "leaseGroup": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string"
139 },
140 "leaseGroupLocked": true,
141 "subleasingInternalAssetClass": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "assetClassType": "PROPERTY",
147 "infiniteUsefulLife": true
148 },
149 "contractGroup1": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string"
154 },
155 "contractGroup2": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string"
160 },
161 "subleasing": true,
162 "subleasingContractRevisionInfo": {
163 "id": 0,
164 "contractId": 0,
165 "contractDisplayId": "string",
166 "contractName": "string"
167 },
168 "subleasingLeaseComponentRevisionInfo": {
169 "id": 0,
170 "leaseComponentId": 0,
171 "leaseComponentDisplayId": "string",
172 "leaseComponentName": "string"
173 },
174 "subleasingActivationGroupRevisionInfo": {
175 "id": 0,
176 "activationGroupId": 0,
177 "activationGroupDisplayId": "string",
178 "activationGroupName": "string"
179 },
180 "notifications": [
181 {
182 "id": 0,
183 "topic": {
184 "enCaption": "string",
185 "frCaption": "string",
186 "name": "string",
187 "priority": "HIGH"
188 },
189 "username": "string",
190 "contractId": 0,
191 "contractDisplayId": "string",
192 "targetType": "string",
193 "targetId": "string"
194 }
195 ],
196 "masterAgreementId": 0,
197 "masterAgreementDisplayId": "string",
198 "allowsSystemGenerateNewId": true,
199 "transferInfo": {
200 "transferredFromDisplayId": "string",
201 "transferredFromRevisionId": 0,
202 "transferredToDisplayId": "string",
203 "transferredToRevisionId": 0
204 },
205 "numberRangeIdentifierType": {
206 "name": "string"
207 },
208 "numberRangeIdentifierValue": "string",
209 "numberRangeType": {
210 "name": "string"
211 }
212}
Contract - Update Contract Accounting¶
HTTP Request
PUT /api/contract-accountings/{id}
📋 Description: Updates the specified contract accounting details within the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial records 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 |
any |
true |
Request body containing updated contract accounting details, including portfolio identifiers, asset allocations, and relevant analytics for real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "contractRate": 0.1,
6 "straightLineNonLeaseIncomeForPosting": true,
7 "compoundingFrequency": "DAILY",
8 "lessorPaymentReference": "string",
9 "trackCost": true,
10 "generateVendorInvoice": true,
11 "calculateTax": true,
12 "calendarType": "REGULAR_CALENDAR",
13 "fiscalVariant": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "isCalendarYear": true,
18 "yearDependent": true,
19 "erpSystemDisplayId": "string",
20 "isErpSystemDefault": true
21 },
22 "workBreakdownStructure": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "functionalArea": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "businessArea": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemId": 0
42 },
43 "taxJurisdiction": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "schema": "string",
50 "countryDisplayId": "string"
51 },
52 "taxCode": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0
58 },
59 "paymentTerm": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string"
64 },
65 "paymentBlock": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "paymentMethod": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "type": "string"
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "network": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "internalOrder": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0,
107 "internalOrderTypeId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "costCenter": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "responsibleCostCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "contractId": 0,
131 "contractDisplayId": "string",
132 "contractRevisionId": 0,
133 "taxCalculationType": "NET",
134 "transactionTypePosting": true,
135 "costCenterAllocations": [
136 {
137 "id": 0,
138 "mainCostCenter": true,
139 "allocationPercentage": 0.1,
140 "costCenter": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "profitCenter": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "validTo": "2019-08-24",
153 "erpSystemId": 0,
154 "erpSystemDisplayId": "string"
155 }
156 }
157 ],
158 "type": "string",
159 "numberRangeIdentifierType": {
160 "name": "string"
161 },
162 "numberRangeIdentifierValue": "string",
163 "allowsSystemGenerateNewId": true,
164 "numberRangeType": {
165 "name": "string"
166 }
167}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "contractRate": 0.1,
6 "straightLineNonLeaseIncomeForPosting": true,
7 "compoundingFrequency": "DAILY",
8 "lessorPaymentReference": "string",
9 "trackCost": true,
10 "generateVendorInvoice": true,
11 "calculateTax": true,
12 "calendarType": "REGULAR_CALENDAR",
13 "fiscalVariant": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "isCalendarYear": true,
18 "yearDependent": true,
19 "erpSystemDisplayId": "string",
20 "isErpSystemDefault": true
21 },
22 "workBreakdownStructure": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "functionalArea": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "businessArea": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemId": 0
42 },
43 "taxJurisdiction": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "schema": "string",
50 "countryDisplayId": "string"
51 },
52 "taxCode": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0
58 },
59 "paymentTerm": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string"
64 },
65 "paymentBlock": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "paymentMethod": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "type": "string"
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "network": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "internalOrder": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0,
107 "internalOrderTypeId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "costCenter": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "responsibleCostCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "contractId": 0,
131 "contractDisplayId": "string",
132 "contractRevisionId": 0,
133 "taxCalculationType": "NET",
134 "transactionTypePosting": true,
135 "costCenterAllocations": [
136 {
137 "id": 0,
138 "mainCostCenter": true,
139 "allocationPercentage": 0.1,
140 "costCenter": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "profitCenter": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "validTo": "2019-08-24",
153 "erpSystemId": 0,
154 "erpSystemDisplayId": "string"
155 }
156 }
157 ],
158 "type": "string",
159 "numberRangeIdentifierType": {
160 "name": "string"
161 },
162 "numberRangeIdentifierValue": "string",
163 "allowsSystemGenerateNewId": true,
164 "numberRangeType": {
165 "name": "string"
166 }
167}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
compoundingFrequency |
ANNUALLY, BI_MONTHLY, DAILY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY |
principalPositionType |
LESSEE, LESSOR |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
taxCalculationType |
NET |
Contract - Patch Contract Accounting¶
HTTP Request
PATCH /api/contract-accountings/{id}
📋 Description: Updates the specified contract accounting details within the Nakisa Portfolio Management Suite, enabling users to refine financial data related to portfolio assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
any |
true |
Request body containing the updated financial and analytical data for the specified contract accounting, including portfolio and asset details relevant to real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "contractRate": 0.1,
6 "straightLineNonLeaseIncomeForPosting": true,
7 "compoundingFrequency": "DAILY",
8 "lessorPaymentReference": "string",
9 "trackCost": true,
10 "generateVendorInvoice": true,
11 "calculateTax": true,
12 "calendarType": "REGULAR_CALENDAR",
13 "fiscalVariant": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "isCalendarYear": true,
18 "yearDependent": true,
19 "erpSystemDisplayId": "string",
20 "isErpSystemDefault": true
21 },
22 "workBreakdownStructure": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "functionalArea": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "businessArea": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemId": 0
42 },
43 "taxJurisdiction": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "schema": "string",
50 "countryDisplayId": "string"
51 },
52 "taxCode": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0
58 },
59 "paymentTerm": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string"
64 },
65 "paymentBlock": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "paymentMethod": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "type": "string"
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "network": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "internalOrder": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0,
107 "internalOrderTypeId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "costCenter": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "responsibleCostCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "contractId": 0,
131 "contractDisplayId": "string",
132 "contractRevisionId": 0,
133 "taxCalculationType": "NET",
134 "transactionTypePosting": true,
135 "costCenterAllocations": [
136 {
137 "id": 0,
138 "mainCostCenter": true,
139 "allocationPercentage": 0.1,
140 "costCenter": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "profitCenter": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "validTo": "2019-08-24",
153 "erpSystemId": 0,
154 "erpSystemDisplayId": "string"
155 }
156 }
157 ],
158 "type": "string",
159 "numberRangeIdentifierType": {
160 "name": "string"
161 },
162 "numberRangeIdentifierValue": "string",
163 "allowsSystemGenerateNewId": true,
164 "numberRangeType": {
165 "name": "string"
166 }
167}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "contractRate": 0.1,
6 "straightLineNonLeaseIncomeForPosting": true,
7 "compoundingFrequency": "DAILY",
8 "lessorPaymentReference": "string",
9 "trackCost": true,
10 "generateVendorInvoice": true,
11 "calculateTax": true,
12 "calendarType": "REGULAR_CALENDAR",
13 "fiscalVariant": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "isCalendarYear": true,
18 "yearDependent": true,
19 "erpSystemDisplayId": "string",
20 "isErpSystemDefault": true
21 },
22 "workBreakdownStructure": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "functionalArea": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "businessArea": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemId": 0
42 },
43 "taxJurisdiction": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "schema": "string",
50 "countryDisplayId": "string"
51 },
52 "taxCode": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0
58 },
59 "paymentTerm": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string"
64 },
65 "paymentBlock": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "paymentMethod": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "type": "string"
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "network": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "internalOrder": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0,
107 "internalOrderTypeId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "costCenter": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "responsibleCostCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "contractId": 0,
131 "contractDisplayId": "string",
132 "contractRevisionId": 0,
133 "taxCalculationType": "NET",
134 "transactionTypePosting": true,
135 "costCenterAllocations": [
136 {
137 "id": 0,
138 "mainCostCenter": true,
139 "allocationPercentage": 0.1,
140 "costCenter": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "profitCenter": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "validTo": "2019-08-24",
153 "erpSystemId": 0,
154 "erpSystemDisplayId": "string"
155 }
156 }
157 ],
158 "type": "string",
159 "numberRangeIdentifierType": {
160 "name": "string"
161 },
162 "numberRangeIdentifierValue": "string",
163 "allowsSystemGenerateNewId": true,
164 "numberRangeType": {
165 "name": "string"
166 }
167}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
compoundingFrequency |
ANNUALLY, BI_MONTHLY, DAILY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY |
principalPositionType |
LESSEE, LESSOR |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
taxCalculationType |
NET |
Contract - Get Contracts¶
HTTP Request
GET /api/contracts
📋 Description: Retrieves a list of contracts associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset performance.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "displayId": "string",
22 "name": "string",
23 "principalPositionType": "LESSEE",
24 "validFrom": "2019-08-24",
25 "validTo": "2019-08-24",
26 "amendmentDate": "2019-08-24",
27 "approverComment": "string",
28 "contractPhase": "INITIAL",
29 "dataCreationInfo": {
30 "id": 0,
31 "idGenerationType": "AUTO",
32 "source": "string",
33 "type": "MIGRATION",
34 "startDateTime": "2019-08-24T14:15:22Z",
35 "endDateTime": "2019-08-24T14:15:22Z"
36 },
37 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
38 "revision": {
39 "id": 0,
40 "displayId": "string",
41 "name": "string",
42 "inception": true,
43 "revisionType": "REVISION",
44 "state": "MLA_DEFINE",
45 "approvedBy": "string",
46 "approvedAt": "2019-08-24T14:15:22Z",
47 "parentRevisionId": 0,
48 "approverComment": "string",
49 "contractId": 0,
50 "contractDisplayId": "string",
51 "contractName": "string",
52 "principalPositionType": "LESSEE",
53 "mlaId": 0,
54 "companyId": 0,
55 "description": "string",
56 "externalReference": "string",
57 "internalReference": "string",
58 "formOfLease": "FULL",
59 "jointVentureLeaseType": "GROSS_LEASE",
60 "businessPlace": "string",
61 "tradingPartner": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "erpSystemId": 0,
67 "erpSystemDisplayId": "string"
68 },
69 "contractCategoryGroup": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string"
74 },
75 "contractGroup1": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string"
80 },
81 "contractGroup2": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string"
86 },
87 "group3": "string",
88 "group4": "string",
89 "signingPerson": "string",
90 "placeOfSignature": "string",
91 "dateOfSignature": "2019-08-24",
92 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
93 "numberRangeIdentifierType": {
94 "name": "string"
95 },
96 "numberRangeIdentifierValue": "string",
97 "allowsSystemGenerateNewId": true,
98 "numberRangeType": {
99 "name": "string"
100 }
101 },
102 "currency": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "decimalPoints": 0
108 },
109 "companyCurrency": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "decimalPoints": 0
115 },
116 "indexedCurrency": true,
117 "assetValueCurrencyType": "CONTRACT_CURRENCY",
118 "currencyLocked": true,
119 "leaseArea": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string"
124 },
125 "businessUnit": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string"
130 },
131 "businessUnitLocked": true,
132 "companyCode": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string",
138 "countryId": 0,
139 "countryDisplayId": "string",
140 "name": "string",
141 "postingPeriodVariantId": 0,
142 "fiscalVariantId": 0
143 },
144 "companyCodeLocked": true,
145 "department": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string"
150 },
151 "departmentLocked": true,
152 "leaseGroup": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string"
157 },
158 "leaseGroupLocked": true,
159 "subleasingInternalAssetClass": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "assetClassType": "PROPERTY",
165 "infiniteUsefulLife": true
166 },
167 "contractGroup1": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string"
172 },
173 "contractGroup2": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string"
178 },
179 "subleasing": true,
180 "subleasingContractRevisionInfo": {
181 "id": 0,
182 "contractId": 0,
183 "contractDisplayId": "string",
184 "contractName": "string"
185 },
186 "subleasingLeaseComponentRevisionInfo": {
187 "id": 0,
188 "leaseComponentId": 0,
189 "leaseComponentDisplayId": "string",
190 "leaseComponentName": "string"
191 },
192 "subleasingActivationGroupRevisionInfo": {
193 "id": 0,
194 "activationGroupId": 0,
195 "activationGroupDisplayId": "string",
196 "activationGroupName": "string"
197 },
198 "notifications": [
199 {
200 "id": 0,
201 "topic": {
202 "enCaption": "string",
203 "frCaption": "string",
204 "name": "string",
205 "priority": "HIGH"
206 },
207 "username": "string",
208 "contractId": 0,
209 "contractDisplayId": "string",
210 "targetType": "string",
211 "targetId": "string"
212 }
213 ],
214 "masterAgreementId": 0,
215 "masterAgreementDisplayId": "string",
216 "allowsSystemGenerateNewId": true,
217 "transferInfo": {
218 "transferredFromDisplayId": "string",
219 "transferredFromRevisionId": 0,
220 "transferredToDisplayId": "string",
221 "transferredToRevisionId": 0
222 },
223 "numberRangeIdentifierType": {
224 "name": "string"
225 },
226 "numberRangeIdentifierValue": "string",
227 "numberRangeType": {
228 "name": "string"
229 }
230 }
231 ],
232 "number": 0,
233 "sort": {
234 "sorted": true,
235 "unsorted": true,
236 "empty": true
237 },
238 "first": true,
239 "last": true,
240 "empty": true
241}
Contract - Create Contracts¶
HTTP Request
POST /api/contracts
📋 Description: Creates a new contract within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and real estate properties effectively while leveraging analytics for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the contract details, including portfolio identifiers, asset information, and relevant analytics for real estate property management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "principalPositionType": "LESSEE",
7 "validFrom": "2019-08-24",
8 "validTo": "2019-08-24",
9 "amendmentDate": "2019-08-24",
10 "approverComment": "string",
11 "contractPhase": "INITIAL",
12 "dataCreationInfo": {
13 "id": 0,
14 "idGenerationType": "AUTO",
15 "source": "string",
16 "type": "MIGRATION",
17 "startDateTime": "2019-08-24T14:15:22Z",
18 "endDateTime": "2019-08-24T14:15:22Z"
19 },
20 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
21 "revision": {
22 "id": 0,
23 "displayId": "string",
24 "name": "string",
25 "inception": true,
26 "revisionType": "REVISION",
27 "state": "MLA_DEFINE",
28 "approvedBy": "string",
29 "approvedAt": "2019-08-24T14:15:22Z",
30 "parentRevisionId": 0,
31 "approverComment": "string",
32 "contractId": 0,
33 "contractDisplayId": "string",
34 "contractName": "string",
35 "principalPositionType": "LESSEE",
36 "mlaId": 0,
37 "companyId": 0,
38 "description": "string",
39 "externalReference": "string",
40 "internalReference": "string",
41 "formOfLease": "FULL",
42 "jointVentureLeaseType": "GROSS_LEASE",
43 "businessPlace": "string",
44 "tradingPartner": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0,
50 "erpSystemDisplayId": "string"
51 },
52 "contractCategoryGroup": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string"
57 },
58 "contractGroup1": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string"
63 },
64 "contractGroup2": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "group3": "string",
71 "group4": "string",
72 "signingPerson": "string",
73 "placeOfSignature": "string",
74 "dateOfSignature": "2019-08-24",
75 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
76 "numberRangeIdentifierType": {
77 "name": "string"
78 },
79 "numberRangeIdentifierValue": "string",
80 "allowsSystemGenerateNewId": true,
81 "numberRangeType": {
82 "name": "string"
83 }
84 },
85 "currency": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "decimalPoints": 0
91 },
92 "companyCurrency": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "decimalPoints": 0
98 },
99 "indexedCurrency": true,
100 "assetValueCurrencyType": "CONTRACT_CURRENCY",
101 "currencyLocked": true,
102 "leaseArea": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string"
107 },
108 "businessUnit": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string"
113 },
114 "businessUnitLocked": true,
115 "companyCode": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "erpSystemId": 0,
120 "erpSystemDisplayId": "string",
121 "countryId": 0,
122 "countryDisplayId": "string",
123 "name": "string",
124 "postingPeriodVariantId": 0,
125 "fiscalVariantId": 0
126 },
127 "companyCodeLocked": true,
128 "department": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string"
133 },
134 "departmentLocked": true,
135 "leaseGroup": {
136 "id": 0,
137 "displayId": "string",
138 "status": "CREATED",
139 "name": "string"
140 },
141 "leaseGroupLocked": true,
142 "subleasingInternalAssetClass": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "assetClassType": "PROPERTY",
148 "infiniteUsefulLife": true
149 },
150 "contractGroup1": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string"
155 },
156 "contractGroup2": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string"
161 },
162 "subleasing": true,
163 "subleasingContractRevisionInfo": {
164 "id": 0,
165 "contractId": 0,
166 "contractDisplayId": "string",
167 "contractName": "string"
168 },
169 "subleasingLeaseComponentRevisionInfo": {
170 "id": 0,
171 "leaseComponentId": 0,
172 "leaseComponentDisplayId": "string",
173 "leaseComponentName": "string"
174 },
175 "subleasingActivationGroupRevisionInfo": {
176 "id": 0,
177 "activationGroupId": 0,
178 "activationGroupDisplayId": "string",
179 "activationGroupName": "string"
180 },
181 "notifications": [
182 {
183 "id": 0,
184 "topic": {
185 "enCaption": "string",
186 "frCaption": "string",
187 "name": "string",
188 "priority": "HIGH"
189 },
190 "username": "string",
191 "contractId": 0,
192 "contractDisplayId": "string",
193 "targetType": "string",
194 "targetId": "string"
195 }
196 ],
197 "masterAgreementId": 0,
198 "masterAgreementDisplayId": "string",
199 "allowsSystemGenerateNewId": true,
200 "transferInfo": {
201 "transferredFromDisplayId": "string",
202 "transferredFromRevisionId": 0,
203 "transferredToDisplayId": "string",
204 "transferredToRevisionId": 0
205 },
206 "numberRangeIdentifierType": {
207 "name": "string"
208 },
209 "numberRangeIdentifierValue": "string",
210 "numberRangeType": {
211 "name": "string"
212 }
213 }
214]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "principalPositionType": "LESSEE",
7 "validFrom": "2019-08-24",
8 "validTo": "2019-08-24",
9 "amendmentDate": "2019-08-24",
10 "approverComment": "string",
11 "contractPhase": "INITIAL",
12 "dataCreationInfo": {
13 "id": 0,
14 "idGenerationType": "AUTO",
15 "source": "string",
16 "type": "MIGRATION",
17 "startDateTime": "2019-08-24T14:15:22Z",
18 "endDateTime": "2019-08-24T14:15:22Z"
19 },
20 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
21 "revision": {
22 "id": 0,
23 "displayId": "string",
24 "name": "string",
25 "inception": true,
26 "revisionType": "REVISION",
27 "state": "MLA_DEFINE",
28 "approvedBy": "string",
29 "approvedAt": "2019-08-24T14:15:22Z",
30 "parentRevisionId": 0,
31 "approverComment": "string",
32 "contractId": 0,
33 "contractDisplayId": "string",
34 "contractName": "string",
35 "principalPositionType": "LESSEE",
36 "mlaId": 0,
37 "companyId": 0,
38 "description": "string",
39 "externalReference": "string",
40 "internalReference": "string",
41 "formOfLease": "FULL",
42 "jointVentureLeaseType": "GROSS_LEASE",
43 "businessPlace": "string",
44 "tradingPartner": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0,
50 "erpSystemDisplayId": "string"
51 },
52 "contractCategoryGroup": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string"
57 },
58 "contractGroup1": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string"
63 },
64 "contractGroup2": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "group3": "string",
71 "group4": "string",
72 "signingPerson": "string",
73 "placeOfSignature": "string",
74 "dateOfSignature": "2019-08-24",
75 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
76 "numberRangeIdentifierType": {
77 "name": "string"
78 },
79 "numberRangeIdentifierValue": "string",
80 "allowsSystemGenerateNewId": true,
81 "numberRangeType": {
82 "name": "string"
83 }
84 },
85 "currency": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "decimalPoints": 0
91 },
92 "companyCurrency": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "decimalPoints": 0
98 },
99 "indexedCurrency": true,
100 "assetValueCurrencyType": "CONTRACT_CURRENCY",
101 "currencyLocked": true,
102 "leaseArea": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string"
107 },
108 "businessUnit": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string"
113 },
114 "businessUnitLocked": true,
115 "companyCode": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "erpSystemId": 0,
120 "erpSystemDisplayId": "string",
121 "countryId": 0,
122 "countryDisplayId": "string",
123 "name": "string",
124 "postingPeriodVariantId": 0,
125 "fiscalVariantId": 0
126 },
127 "companyCodeLocked": true,
128 "department": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string"
133 },
134 "departmentLocked": true,
135 "leaseGroup": {
136 "id": 0,
137 "displayId": "string",
138 "status": "CREATED",
139 "name": "string"
140 },
141 "leaseGroupLocked": true,
142 "subleasingInternalAssetClass": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "assetClassType": "PROPERTY",
148 "infiniteUsefulLife": true
149 },
150 "contractGroup1": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string"
155 },
156 "contractGroup2": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string"
161 },
162 "subleasing": true,
163 "subleasingContractRevisionInfo": {
164 "id": 0,
165 "contractId": 0,
166 "contractDisplayId": "string",
167 "contractName": "string"
168 },
169 "subleasingLeaseComponentRevisionInfo": {
170 "id": 0,
171 "leaseComponentId": 0,
172 "leaseComponentDisplayId": "string",
173 "leaseComponentName": "string"
174 },
175 "subleasingActivationGroupRevisionInfo": {
176 "id": 0,
177 "activationGroupId": 0,
178 "activationGroupDisplayId": "string",
179 "activationGroupName": "string"
180 },
181 "notifications": [
182 {
183 "id": 0,
184 "topic": {
185 "enCaption": "string",
186 "frCaption": "string",
187 "name": "string",
188 "priority": "HIGH"
189 },
190 "username": "string",
191 "contractId": 0,
192 "contractDisplayId": "string",
193 "targetType": "string",
194 "targetId": "string"
195 }
196 ],
197 "masterAgreementId": 0,
198 "masterAgreementDisplayId": "string",
199 "allowsSystemGenerateNewId": true,
200 "transferInfo": {
201 "transferredFromDisplayId": "string",
202 "transferredFromRevisionId": 0,
203 "transferredToDisplayId": "string",
204 "transferredToRevisionId": 0
205 },
206 "numberRangeIdentifierType": {
207 "name": "string"
208 },
209 "numberRangeIdentifierValue": "string",
210 "numberRangeType": {
211 "name": "string"
212 }
213 }
214]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a contract within the Nakisa Portfolio Management Suite, encapsulating essential details related to portfolio management, asset tracking, and real estate property analytics.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» principalPositionType |
string |
true |
none |
Type of the principal position |
» validFrom |
string(date) |
false |
none |
Date from which the resource is valid |
» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
» amendmentDate |
string(date) |
false |
none |
Date of the amendment |
» approverComment |
string |
false |
none |
Comment provided by the approver regarding the contract, facilitating transparency and communication within the portfolio management process. |
» contractPhase |
string |
false |
none |
Indicates the current phase of the contract within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate property analytics. |
» dataCreationInfo |
false |
none |
DataCreationSettingLite is a streamlined data transfer object that encapsulates essential settings for creating and managing portfolio and asset data within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties. |
|
»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»» idGenerationType |
string |
true |
none |
Type of the id generation |
»» source |
string |
false |
none |
Indicates the origin of the data entry within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management. |
»» type |
string |
true |
none |
Type of the resource |
»» startDateTime |
string(date-time) |
true |
none |
Time of the start date |
»» endDateTime |
string(date-time) |
false |
none |
Time of the end date |
» leaseType |
string |
false |
none |
Type of the lease |
» revision |
false |
none |
Data transfer object representing a revision of a contract within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio and asset management in the context of real estate property analytics. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
true |
none |
Name of the resource |
»» inception |
boolean |
false |
none |
Boolean flag indicating inception status |
»» revisionType |
string |
false |
none |
Type of the revision |
»» state |
string |
false |
none |
Current state of the portfolio |
»» approvedBy |
string |
false |
none |
Identifier of the individual or entity that has approved the contract revision, ensuring compliance and accountability within the portfolio management process. |
»» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the contract revision was approved, relevant for portfolio and asset management analytics within the Nakisa Portfolio Management Suite. |
»» parentRevisionId |
integer(int64) |
false |
none |
Unique identifier for the parent revision |
»» approverComment |
string |
false |
none |
Comment provided by the approver to offer feedback or rationale regarding the contract revision within the Nakisa Portfolio Management Suite. |
»» contractId |
integer(int64) |
false |
none |
Unique identifier for the contract |
»» contractDisplayId |
string |
false |
none |
Unique identifier for the contract display |
»» contractName |
string |
false |
none |
Name of the contract |
»» principalPositionType |
string |
false |
none |
Type of the principal position |
»» mlaId |
integer(int64) |
false |
none |
Unique identifier for the mla |
»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»» description |
string |
false |
none |
Description of the resource |
»» externalReference |
string |
false |
none |
String representing an external reference associated with the contract revision, facilitating integration and tracking within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics. |
»» internalReference |
string |
false |
none |
Unique identifier for the internal reference associated with a contract revision, facilitating streamlined management and analytics of portfolio assets within the Nakisa Portfolio Management Suite. |
»» formOfLease |
string |
false |
none |
Indicates the type of lease agreement associated with the real estate property within the portfolio, facilitating asset management and analytics in the Nakisa Portfolio Management Suite. |
»» jointVentureLeaseType |
string |
false |
none |
Type of the joint venture lease |
»» businessPlace |
string |
false |
none |
Represents the designated location of the business entity within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate analytics. |
»» tradingPartner |
false |
none |
Data transfer object representing a trading partner within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset, and analytics for real estate property management. |
|
»»» 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 |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»» contractCategoryGroup |
false |
none |
Data transfer object representing a grouping of contract categories within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio and asset analytics for real estate properties. |
|
»»» 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 |
»» contractGroup1 |
false |
none |
Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio. |
|
»»» 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 |
»» contractGroup2 |
false |
none |
Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties. |
|
»»» 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 |
»» group3 |
string |
false |
none |
Represents a categorization or classification within the portfolio management framework, facilitating enhanced analytics and reporting for real estate assets. |
»» group4 |
string |
false |
none |
Represents a categorization label for a specific group within the portfolio, asset, or analytics domains in the Nakisa Portfolio Management Suite. |
»» signingPerson |
string |
false |
none |
Represents the name of the individual authorized to sign the contract, essential for validating agreements within the Nakisa Portfolio Management Suite’s real estate property and asset management processes. |
»» placeOfSignature |
string |
false |
none |
Indicates the location where the contract revision is signed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»» dateOfSignature |
string(date) |
false |
none |
Date of signature indicating when the contract revision was formally executed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
»» leaseType |
string |
false |
none |
none |
»» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
»»» name |
string |
false |
none |
Name of the resource |
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite. |
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
|
»»» name |
string |
true |
none |
Name of the resource |
» currency |
false |
none |
Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios. |
|
»» 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 |
»» decimalPoints |
integer(int32) |
false |
none |
Numeric value representing decimalPoints |
» companyCurrency |
false |
none |
Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios. |
|
» indexedCurrency |
boolean |
false |
none |
Boolean flag indicating indexedCurrency status |
» assetValueCurrencyType |
string |
false |
none |
Type of the asset value currency |
» currencyLocked |
boolean |
false |
none |
Boolean flag indicating currencyLocked status |
» leaseArea |
true |
none |
Data transfer object representing a simplified view of lease areas within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»» 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 |
» businessUnit |
true |
none |
Data transfer object representing a simplified view of a business unit within the Nakisa Portfolio Management Suite, encompassing key attributes relevant to portfolio management, asset tracking, analytics, and real estate properties. |
|
»» 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 |
» businessUnitLocked |
boolean |
false |
none |
Boolean flag indicating businessUnitLocked status |
» companyCode |
true |
none |
Data transfer object representing a streamlined view of a company within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets, analytics, and real estate properties. |
|
»» 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 |
»» 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 |
»» name |
string |
false |
none |
none |
»» postingPeriodVariantId |
integer(int64) |
false |
none |
Unique identifier for the posting period variant |
»» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
» companyCodeLocked |
boolean |
false |
none |
Boolean flag indicating companyCodeLocked status |
» department |
false |
none |
Data transfer object representing a department within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio and asset analytics in the context of real estate property management. |
|
»» 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 |
» departmentLocked |
boolean |
false |
none |
Boolean flag indicating departmentLocked status |
» leaseGroup |
false |
none |
Data transfer object representing a collection of lease agreements within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties. |
|
»» 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 |
» leaseGroupLocked |
boolean |
false |
none |
Boolean flag indicating leaseGroupLocked status |
» subleasingInternalAssetClass |
false |
none |
Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties. |
|
»» 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 |
»» assetClassType |
string |
false |
none |
Type of the asset class |
»» infiniteUsefulLife |
boolean |
false |
none |
Boolean flag indicating infiniteUsefulLife status |
» contractGroup1 |
false |
none |
Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio. |
|
» contractGroup2 |
false |
none |
Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties. |
|
» subleasing |
boolean |
false |
none |
Boolean flag indicating subleasing status |
» subleasingContractRevisionInfo |
false |
none |
Data transfer object representing a simplified version of a subleasing contract revision, capturing essential details for portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making in real estate property management. |
|
»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»» contractId |
integer(int64) |
true |
none |
Unique identifier for the contract |
»» contractDisplayId |
string |
true |
none |
Unique identifier for the contract display |
»» contractName |
string |
true |
none |
Name of the contract |
» subleasingLeaseComponentRevisionInfo |
false |
none |
Data transfer object representing a revision of a subleasing lease component within the Nakisa Portfolio Management Suite, facilitating the management and analysis of real estate assets in the context of portfolio optimization. |
|
»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»» leaseComponentId |
integer(int64) |
true |
none |
Unique identifier for the lease component |
»» leaseComponentDisplayId |
string |
true |
none |
Unique identifier for the lease component display |
»» leaseComponentName |
string |
true |
none |
Name of the lease component |
» subleasingActivationGroupRevisionInfo |
false |
none |
Data transfer object representing a revision of a subleasing activation group within the Nakisa Portfolio Management Suite, providing essential insights for portfolio and asset management in the real estate sector. |
|
»» id |
integer(int64) |
true |
none |
Unique identifier for the resource |
»» activationGroupId |
integer(int64) |
true |
none |
Unique identifier for the activation group |
»» activationGroupDisplayId |
string |
true |
none |
Unique identifier for the activation group display |
»» activationGroupName |
string |
true |
none |
Name of the activation group |
» notifications |
false |
none |
List of notifications items |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» topic |
false |
none |
Data transfer object representing a notification topic type within the Nakisa Portfolio Management Suite, facilitating communication and updates related to portfolio, asset, analytics, and real estate property management. |
|
»»» enCaption |
string |
false |
none |
Textual representation of the English caption associated with a notification topic, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
»»» frCaption |
string |
false |
none |
Descriptive label for the notification topic, facilitating clear communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»» name |
string |
false |
none |
Name of the resource |
»»» priority |
string |
false |
none |
Priority of the resource |
»» username |
string |
false |
none |
Human-readable name of the portfolio |
»» contractId |
integer(int64) |
false |
none |
Unique identifier for the contract |
»» contractDisplayId |
string |
false |
none |
Unique identifier for the contract display |
»» targetType |
string |
false |
none |
Type of the target |
»» targetId |
string |
false |
none |
Unique identifier for the target |
» masterAgreementId |
integer(int64) |
true |
none |
Unique identifier for the master agreement |
» masterAgreementDisplayId |
string |
false |
none |
Unique identifier for the master agreement display |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» transferInfo |
false |
none |
Data transfer object representing the details of mass inter-company asset transfers within the Nakisa Portfolio Management Suite, facilitating portfolio management and analytics for real estate properties. |
|
»» transferredFromDisplayId |
string |
false |
none |
Unique identifier for the transferred from display |
»» transferredFromRevisionId |
integer(int64) |
false |
none |
Unique identifier for the transferred from revision |
»» transferredToDisplayId |
string |
false |
none |
Unique identifier for the transferred to display |
»» transferredToRevisionId |
integer(int64) |
false |
none |
Unique identifier for the transferred to revision |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics. |
|
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite. |
» numberRangeType |
false |
none |
Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics. |
Enumerated Values
Attribute |
Value |
|---|---|
assetClassType |
EQUIPMENT, PLANT, PROPERTY |
assetValueCurrencyType |
COMPANY_CURRENCY, CONTRACT_CURRENCY |
contractPhase |
CLOSED, DRAFT, INITIAL, REJECTED, SETUP |
formOfLease |
FULL, NET |
idGenerationType |
AUTO, MANUAL |
jointVentureLeaseType |
GROSS_LEASE, NET_LEASE |
leaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
principalPositionType |
LESSEE, LESSOR |
priority |
HIGH, LOW, MEDIUM |
revisionType |
ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION |
state |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
type |
MIGRATION, TESTING |
Contract - Send Contract To Approval¶
HTTP Request
POST /api/contracts/{id}/send-to-approval
📋 Description: Submits the specified contract for approval within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing decision-making processes in real estate portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the contract details, including approval status and relevant metadata, for initiating the approval process within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Rework Contract¶
HTTP Request
POST /api/contracts/{id}/rework
📋 Description: Initiates the rework process for a specified contract within the Nakisa Portfolio Management Suite, enabling users to update and refine contract details related to portfolio and asset management in the real estate sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated contract details and associated metadata for reworking a specific asset within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Discard Contract¶
HTTP Request
POST /api/contracts/{id}/discard
📋 Description: Discards the specified contract within the Nakisa Portfolio Management Suite, allowing users to manage their portfolio and asset analytics effectively by removing outdated or irrelevant agreements related to 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 contract details to be discarded, including relevant identifiers and metadata for accurate processing within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Close Contract¶
HTTP Request
POST /api/contracts/{id}/close
📋 Description: Closes a specified contract within the Nakisa Portfolio Management Suite, enabling effective management of portfolio assets and facilitating accurate analytics 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 closure details of the specified contract, including relevant status updates and metadata essential for portfolio and asset management within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Callback Contract¶
HTTP Request
POST /api/contracts/{id}/callback
📋 Description: Submits a callback request for a specific contract identified by its ID, enabling integration with portfolio analytics and asset management processes within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing callback data related to the specified contract, including portfolio insights and asset performance metrics for enhanced analytics in real estate property management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Approve Contract¶
HTTP Request
POST /api/contracts/{id}/approve
📋 Description: Approves a specified contract within the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing analytics 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 approval details for the specified contract, including relevant metadata and status updates essential for portfolio and asset management within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "cascadeParentClosure": true,
5 "processingTaskId": 0,
6 "processingJobType": "string",
7 "objectId": 0
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Approve Contract Accounting Off¶
HTTP Request
POST /api/contracts/{id}/approve-accounting-off
📋 Description: Approves the accounting off for a specified contract within the Nakisa Portfolio Management Suite, facilitating accurate financial reporting and analysis for real estate property assets.
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 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Contract - Search Contracts¶
HTTP Request
POST /api/contracts/search
📋 Description: Submits a search request for contracts within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze portfolio and asset-related agreements in the context of real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for retrieving 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 "displayIdIn": [
16 "string"
17 ],
18 "displayIdLike": "string",
19 "nameOrDisplayIdLike": "string",
20 "nameLike": "string",
21 "principalPositionTypeEqual": "LESSEE",
22 "revisionIdEqual": 0,
23 "revisionTypeEqual": "REVISION",
24 "revisionStateEqual": "MLA_DEFINE",
25 "currencyIdEqual": 0,
26 "leaseAreaIdIn": [
27 0
28 ],
29 "leaseAreaIdEqual": 0,
30 "businessUnitIdIn": [
31 0
32 ],
33 "businessUnitIdEqual": 0,
34 "companyCodeIdEqual": 0,
35 "companyCodeIdIn": [
36 0
37 ],
38 "departmentIdIn": [
39 0
40 ],
41 "departmentIdEqual": 0,
42 "leaseGroupIdIn": [
43 0
44 ],
45 "leaseGroupIdEqual": 0,
46 "subleasingEqual": true,
47 "masterAgreementIdIn": [
48 0
49 ],
50 "masterAgreementDisplayIdIn": [
51 "string"
52 ]
53}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "displayId": "string",
22 "name": "string",
23 "principalPositionType": "LESSEE",
24 "validFrom": "2019-08-24",
25 "validTo": "2019-08-24",
26 "amendmentDate": "2019-08-24",
27 "approverComment": "string",
28 "contractPhase": "INITIAL",
29 "dataCreationInfo": {
30 "id": 0,
31 "idGenerationType": "AUTO",
32 "source": "string",
33 "type": "MIGRATION",
34 "startDateTime": "2019-08-24T14:15:22Z",
35 "endDateTime": "2019-08-24T14:15:22Z"
36 },
37 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
38 "revision": {
39 "id": 0,
40 "displayId": "string",
41 "name": "string",
42 "inception": true,
43 "revisionType": "REVISION",
44 "state": "MLA_DEFINE",
45 "approvedBy": "string",
46 "approvedAt": "2019-08-24T14:15:22Z",
47 "parentRevisionId": 0,
48 "approverComment": "string",
49 "contractId": 0,
50 "contractDisplayId": "string",
51 "contractName": "string",
52 "principalPositionType": "LESSEE",
53 "mlaId": 0,
54 "companyId": 0,
55 "description": "string",
56 "externalReference": "string",
57 "internalReference": "string",
58 "formOfLease": "FULL",
59 "jointVentureLeaseType": "GROSS_LEASE",
60 "businessPlace": "string",
61 "tradingPartner": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "erpSystemId": 0,
67 "erpSystemDisplayId": "string"
68 },
69 "contractCategoryGroup": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string"
74 },
75 "contractGroup1": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string"
80 },
81 "contractGroup2": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string"
86 },
87 "group3": "string",
88 "group4": "string",
89 "signingPerson": "string",
90 "placeOfSignature": "string",
91 "dateOfSignature": "2019-08-24",
92 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
93 "numberRangeIdentifierType": {
94 "name": "string"
95 },
96 "numberRangeIdentifierValue": "string",
97 "allowsSystemGenerateNewId": true,
98 "numberRangeType": {
99 "name": "string"
100 }
101 },
102 "currency": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "decimalPoints": 0
108 },
109 "companyCurrency": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "decimalPoints": 0
115 },
116 "indexedCurrency": true,
117 "assetValueCurrencyType": "CONTRACT_CURRENCY",
118 "currencyLocked": true,
119 "leaseArea": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string"
124 },
125 "businessUnit": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string"
130 },
131 "businessUnitLocked": true,
132 "companyCode": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string",
138 "countryId": 0,
139 "countryDisplayId": "string",
140 "name": "string",
141 "postingPeriodVariantId": 0,
142 "fiscalVariantId": 0
143 },
144 "companyCodeLocked": true,
145 "department": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string"
150 },
151 "departmentLocked": true,
152 "leaseGroup": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string"
157 },
158 "leaseGroupLocked": true,
159 "subleasingInternalAssetClass": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "assetClassType": "PROPERTY",
165 "infiniteUsefulLife": true
166 },
167 "contractGroup1": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string"
172 },
173 "contractGroup2": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string"
178 },
179 "subleasing": true,
180 "subleasingContractRevisionInfo": {
181 "id": 0,
182 "contractId": 0,
183 "contractDisplayId": "string",
184 "contractName": "string"
185 },
186 "subleasingLeaseComponentRevisionInfo": {
187 "id": 0,
188 "leaseComponentId": 0,
189 "leaseComponentDisplayId": "string",
190 "leaseComponentName": "string"
191 },
192 "subleasingActivationGroupRevisionInfo": {
193 "id": 0,
194 "activationGroupId": 0,
195 "activationGroupDisplayId": "string",
196 "activationGroupName": "string"
197 },
198 "notifications": [
199 {
200 "id": 0,
201 "topic": {
202 "enCaption": "string",
203 "frCaption": "string",
204 "name": "string",
205 "priority": "HIGH"
206 },
207 "username": "string",
208 "contractId": 0,
209 "contractDisplayId": "string",
210 "targetType": "string",
211 "targetId": "string"
212 }
213 ],
214 "masterAgreementId": 0,
215 "masterAgreementDisplayId": "string",
216 "allowsSystemGenerateNewId": true,
217 "transferInfo": {
218 "transferredFromDisplayId": "string",
219 "transferredFromRevisionId": 0,
220 "transferredToDisplayId": "string",
221 "transferredToRevisionId": 0
222 },
223 "numberRangeIdentifierType": {
224 "name": "string"
225 },
226 "numberRangeIdentifierValue": "string",
227 "numberRangeType": {
228 "name": "string"
229 }
230 }
231 ],
232 "number": 0,
233 "sort": {
234 "sorted": true,
235 "unsorted": true,
236 "empty": true
237 },
238 "first": true,
239 "last": true,
240 "empty": true
241}
Contract - Get Lease Determination By Contract Revision ID¶
HTTP Request
GET /api/lease-determinations/contract/{contractRevisionId}
📋 Description: Retrieves lease determination details for a specified contract revision, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. This operation supports informed decision-making in real estate property management and analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
contractRevisionId |
path |
integer(int64) |
true |
Unique identifier for the contract revision |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "systemDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
6 "userDeterminedLeaseType": "LEASE_CONTRACT_FIXED_PART_A",
7 "contractRevisionId": 0,
8 "contractId": 0,
9 "contractDisplayId": "string",
10 "type": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeIdentifierValue": "string",
15 "allowsSystemGenerateNewId": true,
16 "numberRangeType": {
17 "name": "string"
18 }
19}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
principalPositionType |
LESSEE, LESSOR |
systemDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
userDeterminedLeaseType |
LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE |
Contract - Get Contract¶
HTTP Request
GET /api/contracts/{id}
📋 Description: Retrieves detailed information about a specific contract within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset 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 |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "principalPositionType": "LESSEE",
6 "validFrom": "2019-08-24",
7 "validTo": "2019-08-24",
8 "amendmentDate": "2019-08-24",
9 "approverComment": "string",
10 "contractPhase": "INITIAL",
11 "dataCreationInfo": {
12 "id": 0,
13 "idGenerationType": "AUTO",
14 "source": "string",
15 "type": "MIGRATION",
16 "startDateTime": "2019-08-24T14:15:22Z",
17 "endDateTime": "2019-08-24T14:15:22Z"
18 },
19 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
20 "revision": {
21 "id": 0,
22 "displayId": "string",
23 "name": "string",
24 "inception": true,
25 "revisionType": "REVISION",
26 "state": "MLA_DEFINE",
27 "approvedBy": "string",
28 "approvedAt": "2019-08-24T14:15:22Z",
29 "parentRevisionId": 0,
30 "approverComment": "string",
31 "contractId": 0,
32 "contractDisplayId": "string",
33 "contractName": "string",
34 "principalPositionType": "LESSEE",
35 "mlaId": 0,
36 "companyId": 0,
37 "description": "string",
38 "externalReference": "string",
39 "internalReference": "string",
40 "formOfLease": "FULL",
41 "jointVentureLeaseType": "GROSS_LEASE",
42 "businessPlace": "string",
43 "tradingPartner": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string"
50 },
51 "contractCategoryGroup": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "contractGroup1": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string"
62 },
63 "contractGroup2": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string"
68 },
69 "group3": "string",
70 "group4": "string",
71 "signingPerson": "string",
72 "placeOfSignature": "string",
73 "dateOfSignature": "2019-08-24",
74 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83 },
84 "currency": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "decimalPoints": 0
90 },
91 "companyCurrency": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "decimalPoints": 0
97 },
98 "indexedCurrency": true,
99 "assetValueCurrencyType": "CONTRACT_CURRENCY",
100 "currencyLocked": true,
101 "leaseArea": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string"
106 },
107 "businessUnit": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string"
112 },
113 "businessUnitLocked": true,
114 "companyCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "erpSystemId": 0,
119 "erpSystemDisplayId": "string",
120 "countryId": 0,
121 "countryDisplayId": "string",
122 "name": "string",
123 "postingPeriodVariantId": 0,
124 "fiscalVariantId": 0
125 },
126 "companyCodeLocked": true,
127 "department": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string"
132 },
133 "departmentLocked": true,
134 "leaseGroup": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string"
139 },
140 "leaseGroupLocked": true,
141 "subleasingInternalAssetClass": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "assetClassType": "PROPERTY",
147 "infiniteUsefulLife": true
148 },
149 "contractGroup1": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string"
154 },
155 "contractGroup2": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string"
160 },
161 "subleasing": true,
162 "subleasingContractRevisionInfo": {
163 "id": 0,
164 "contractId": 0,
165 "contractDisplayId": "string",
166 "contractName": "string"
167 },
168 "subleasingLeaseComponentRevisionInfo": {
169 "id": 0,
170 "leaseComponentId": 0,
171 "leaseComponentDisplayId": "string",
172 "leaseComponentName": "string"
173 },
174 "subleasingActivationGroupRevisionInfo": {
175 "id": 0,
176 "activationGroupId": 0,
177 "activationGroupDisplayId": "string",
178 "activationGroupName": "string"
179 },
180 "notifications": [
181 {
182 "id": 0,
183 "topic": {
184 "enCaption": "string",
185 "frCaption": "string",
186 "name": "string",
187 "priority": "HIGH"
188 },
189 "username": "string",
190 "contractId": 0,
191 "contractDisplayId": "string",
192 "targetType": "string",
193 "targetId": "string"
194 }
195 ],
196 "masterAgreementId": 0,
197 "masterAgreementDisplayId": "string",
198 "allowsSystemGenerateNewId": true,
199 "transferInfo": {
200 "transferredFromDisplayId": "string",
201 "transferredFromRevisionId": 0,
202 "transferredToDisplayId": "string",
203 "transferredToRevisionId": 0
204 },
205 "numberRangeIdentifierType": {
206 "name": "string"
207 },
208 "numberRangeIdentifierValue": "string",
209 "numberRangeType": {
210 "name": "string"
211 }
212}
Contract - Delete Contract¶
HTTP Request
DELETE /api/contracts/{id}
📋 Description: Deletes a specified contract from the Nakisa Portfolio Management Suite, ensuring the removal of associated portfolio and asset data for enhanced analytics and 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 |
Contract - Get Contract Revisions¶
HTTP Request
GET /api/contracts/{id}/revisions
📋 Description: Retrieves the revision history of a specific contract identified by its ID, enabling users to analyze changes and updates within the context of portfolio and asset management 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 |
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 "displayId": "string",
22 "name": "string",
23 "inception": true,
24 "revisionType": "REVISION",
25 "state": "MLA_DEFINE",
26 "approvedBy": "string",
27 "approvedAt": "2019-08-24T14:15:22Z",
28 "parentRevisionId": 0,
29 "approverComment": "string",
30 "contractId": 0,
31 "contractDisplayId": "string",
32 "contractName": "string",
33 "principalPositionType": "LESSEE",
34 "mlaId": 0,
35 "companyId": 0,
36 "description": "string",
37 "externalReference": "string",
38 "internalReference": "string",
39 "formOfLease": "FULL",
40 "jointVentureLeaseType": "GROSS_LEASE",
41 "businessPlace": "string",
42 "tradingPartner": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0,
48 "erpSystemDisplayId": "string"
49 },
50 "contractCategoryGroup": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string"
55 },
56 "contractGroup1": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string"
61 },
62 "contractGroup2": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string"
67 },
68 "group3": "string",
69 "group4": "string",
70 "signingPerson": "string",
71 "placeOfSignature": "string",
72 "dateOfSignature": "2019-08-24",
73 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeIdentifierValue": "string",
78 "allowsSystemGenerateNewId": true,
79 "numberRangeType": {
80 "name": "string"
81 }
82 }
83 ],
84 "number": 0,
85 "sort": {
86 "sorted": true,
87 "unsorted": true,
88 "empty": true
89 },
90 "first": true,
91 "last": true,
92 "empty": true
93}
Contract - Get Contract By Revision ID¶
HTTP Request
GET /api/contracts/revision/{revisionId}
📋 Description: Retrieves the details of a specific contract revision using the provided revision ID, enabling users to analyze changes in portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
revisionId |
path |
integer(int64) |
true |
Unique identifier for the revision |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "principalPositionType": "LESSEE",
6 "validFrom": "2019-08-24",
7 "validTo": "2019-08-24",
8 "amendmentDate": "2019-08-24",
9 "approverComment": "string",
10 "contractPhase": "INITIAL",
11 "dataCreationInfo": {
12 "id": 0,
13 "idGenerationType": "AUTO",
14 "source": "string",
15 "type": "MIGRATION",
16 "startDateTime": "2019-08-24T14:15:22Z",
17 "endDateTime": "2019-08-24T14:15:22Z"
18 },
19 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
20 "revision": {
21 "id": 0,
22 "displayId": "string",
23 "name": "string",
24 "inception": true,
25 "revisionType": "REVISION",
26 "state": "MLA_DEFINE",
27 "approvedBy": "string",
28 "approvedAt": "2019-08-24T14:15:22Z",
29 "parentRevisionId": 0,
30 "approverComment": "string",
31 "contractId": 0,
32 "contractDisplayId": "string",
33 "contractName": "string",
34 "principalPositionType": "LESSEE",
35 "mlaId": 0,
36 "companyId": 0,
37 "description": "string",
38 "externalReference": "string",
39 "internalReference": "string",
40 "formOfLease": "FULL",
41 "jointVentureLeaseType": "GROSS_LEASE",
42 "businessPlace": "string",
43 "tradingPartner": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string"
50 },
51 "contractCategoryGroup": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string"
56 },
57 "contractGroup1": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string"
62 },
63 "contractGroup2": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string"
68 },
69 "group3": "string",
70 "group4": "string",
71 "signingPerson": "string",
72 "placeOfSignature": "string",
73 "dateOfSignature": "2019-08-24",
74 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83 },
84 "currency": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "decimalPoints": 0
90 },
91 "companyCurrency": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "decimalPoints": 0
97 },
98 "indexedCurrency": true,
99 "assetValueCurrencyType": "CONTRACT_CURRENCY",
100 "currencyLocked": true,
101 "leaseArea": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string"
106 },
107 "businessUnit": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string"
112 },
113 "businessUnitLocked": true,
114 "companyCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "erpSystemId": 0,
119 "erpSystemDisplayId": "string",
120 "countryId": 0,
121 "countryDisplayId": "string",
122 "name": "string",
123 "postingPeriodVariantId": 0,
124 "fiscalVariantId": 0
125 },
126 "companyCodeLocked": true,
127 "department": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string"
132 },
133 "departmentLocked": true,
134 "leaseGroup": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string"
139 },
140 "leaseGroupLocked": true,
141 "subleasingInternalAssetClass": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "assetClassType": "PROPERTY",
147 "infiniteUsefulLife": true
148 },
149 "contractGroup1": {
150 "id": 0,
151 "displayId": "string",
152 "status": "CREATED",
153 "name": "string"
154 },
155 "contractGroup2": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string"
160 },
161 "subleasing": true,
162 "subleasingContractRevisionInfo": {
163 "id": 0,
164 "contractId": 0,
165 "contractDisplayId": "string",
166 "contractName": "string"
167 },
168 "subleasingLeaseComponentRevisionInfo": {
169 "id": 0,
170 "leaseComponentId": 0,
171 "leaseComponentDisplayId": "string",
172 "leaseComponentName": "string"
173 },
174 "subleasingActivationGroupRevisionInfo": {
175 "id": 0,
176 "activationGroupId": 0,
177 "activationGroupDisplayId": "string",
178 "activationGroupName": "string"
179 },
180 "notifications": [
181 {
182 "id": 0,
183 "topic": {
184 "enCaption": "string",
185 "frCaption": "string",
186 "name": "string",
187 "priority": "HIGH"
188 },
189 "username": "string",
190 "contractId": 0,
191 "contractDisplayId": "string",
192 "targetType": "string",
193 "targetId": "string"
194 }
195 ],
196 "masterAgreementId": 0,
197 "masterAgreementDisplayId": "string",
198 "allowsSystemGenerateNewId": true,
199 "transferInfo": {
200 "transferredFromDisplayId": "string",
201 "transferredFromRevisionId": 0,
202 "transferredToDisplayId": "string",
203 "transferredToRevisionId": 0
204 },
205 "numberRangeIdentifierType": {
206 "name": "string"
207 },
208 "numberRangeIdentifierValue": "string",
209 "numberRangeType": {
210 "name": "string"
211 }
212}
Contract - Check Contract State¶
HTTP Request
GET /api/contracts/check/{id}
📋 Description: Retrieves the status and details of a specific contract 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 |
Example Responses
1{
2 "id": "string",
3 "name": "string",
4 "captionKey": "string",
5 "latestStateHistoryFailureMessage": "string",
6 "latestStateHistoryWarningMessage": "string",
7 "initial": true,
8 "final": true,
9 "transitionState": true,
10 "caption": "string"
11}
Contract - Get Contract Accounting By Contract Revision ID¶
HTTP Request
GET /api/contract-accountings/contract/{contractRevisionId}
📋 Description: Fetches detailed accounting information for a specific contract revision, enabling users to analyze financial data related to portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
contractRevisionId |
path |
integer(int64) |
true |
Unique identifier for the contract revision |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "contractRate": 0.1,
6 "straightLineNonLeaseIncomeForPosting": true,
7 "compoundingFrequency": "DAILY",
8 "lessorPaymentReference": "string",
9 "trackCost": true,
10 "generateVendorInvoice": true,
11 "calculateTax": true,
12 "calendarType": "REGULAR_CALENDAR",
13 "fiscalVariant": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "isCalendarYear": true,
18 "yearDependent": true,
19 "erpSystemDisplayId": "string",
20 "isErpSystemDefault": true
21 },
22 "workBreakdownStructure": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "functionalArea": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "businessArea": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemId": 0
42 },
43 "taxJurisdiction": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0,
49 "schema": "string",
50 "countryDisplayId": "string"
51 },
52 "taxCode": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0
58 },
59 "paymentTerm": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string"
64 },
65 "paymentBlock": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "paymentMethod": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "type": "string"
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "network": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "internalOrder": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0,
107 "internalOrderTypeId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "costCenter": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "responsibleCostCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "contractId": 0,
131 "contractDisplayId": "string",
132 "contractRevisionId": 0,
133 "taxCalculationType": "NET",
134 "transactionTypePosting": true,
135 "costCenterAllocations": [
136 {
137 "id": 0,
138 "mainCostCenter": true,
139 "allocationPercentage": 0.1,
140 "costCenter": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "profitCenter": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "validTo": "2019-08-24",
153 "erpSystemId": 0,
154 "erpSystemDisplayId": "string"
155 }
156 }
157 ],
158 "type": "string",
159 "numberRangeIdentifierType": {
160 "name": "string"
161 },
162 "numberRangeIdentifierValue": "string",
163 "allowsSystemGenerateNewId": true,
164 "numberRangeType": {
165 "name": "string"
166 }
167}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
compoundingFrequency |
ANNUALLY, BI_MONTHLY, DAILY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY |
principalPositionType |
LESSEE, LESSOR |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
taxCalculationType |
NET |