Activation Group¶
Activation Group - Update Activation Group¶
HTTP Request
PUT /api/activation-groups/{id}
📋 Description: Updates the specified activation group within the Nakisa Portfolio Management Suite, allowing users to modify attributes related to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated activation group details, including portfolio associations and asset analytics relevant to real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "name": "string",
6 "description": "string",
7 "approverComment": "string",
8 "snapshotData": {
9 "isParallelCurrencyEnabled": true,
10 "isCostCenterAllocationEnabled": true,
11 "useSpotRateForGroupCurrency": true,
12 "usePostingOrDocumentDateForCurrency": true,
13 "exchangeRateTypes": [
14 {
15 "currencyDefinitionType": "CONTRACT_CURRENCY",
16 "sourceCurrencyType": "CONTRACT_CURRENCY",
17 "translationDateType": "DOCUMENT_DATE",
18 "targetCurrency": {
19 "id": 0,
20 "displayId": "string",
21 "decimalPoints": 0
22 },
23 "referenceCurrency": {
24 "id": 0,
25 "displayId": "string"
26 },
27 "currencyType": "string",
28 "exchangeRateType": "string"
29 }
30 ]
31 },
32 "revision": {
33 "id": 0,
34 "displayId": "string",
35 "name": "string",
36 "inception": true,
37 "revisionType": "REVISION",
38 "state": "MLA_DEFINE",
39 "approvedBy": "string",
40 "approvedAt": "2019-08-24T14:15:22Z",
41 "parentRevisionId": 0,
42 "approverComment": "string",
43 "rouStartDate": "2019-08-24",
44 "rouEndDate": "2019-08-24",
45 "activationGroupModification": {
46 "modificationDate": "2019-08-24",
47 "terminationType": "CASUALTY",
48 "terminationDate": {
49 "timing": "START_OF_DAY",
50 "year": 0,
51 "monthValue": 0,
52 "dayOfMonth": 0,
53 "leapYear": true,
54 "month": "JANUARY",
55 "dayOfWeek": "MONDAY",
56 "dayOfYear": 0
57 },
58 "useManualFmvValue": true,
59 "useManualAssetValues": true,
60 "enforceNonLeaseOnIndexation": true,
61 "applyIndexationLease": true,
62 "applyIndexationNonLease": true,
63 "indexationTreatmentType": "DEFAULT",
64 "indexationStartDate": "2019-08-24",
65 "indexationDateType": "ROU_ANNIVERSARY_DATE",
66 "indexationStartDateNonLease": "2019-08-24",
67 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
68 "modificationReasons": [
69 "CONTRACT_RATE_CHANGE"
70 ],
71 "modificationPerClassificationList": [
72 {
73 "accountingStandardId": 0,
74 "classificationType": "NON_LEASE",
75 "accountingStandardType": "GAAP",
76 "impairmentAmount": 0.1,
77 "recoverableAmount": 0.1,
78 "decreaseInAsset": 0.1,
79 "decreaseInTerm": 0.1
80 }
81 ],
82 "massIndexationTaskId": 0
83 },
84 "activationGroupId": 0,
85 "activationGroupDisplayId": "string",
86 "activationGroupName": "string",
87 "leaseComponentRevisionId": 0,
88 "leaseComponentRevisionDisplayId": "string",
89 "lastLeaseComponentRevisionId": 0,
90 "lastLeaseComponentRevisionDisplayId": "string",
91 "clonedFromRevisionId": 0,
92 "clonedFromRevisionDisplayId": "string",
93 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
94 "infiniteUsefulLife": true,
95 "transferOfOwnership": true,
96 "specializedAsset": true,
97 "fairMarketValue": 0.1,
98 "residualValue": 0,
99 "endOfTermIntention": "TO_BE_DETERMINED",
100 "endOfTermDate": "2019-08-24",
101 "endOfTermPeriod": 0,
102 "activationDocumentDate": "2019-08-24",
103 "activationPostingDate": "2019-08-24",
104 "closingDocumentDate": "2019-08-24",
105 "closingPostingDate": "2019-08-24",
106 "numberRangeIdentifierType": {
107 "name": "string"
108 },
109 "numberRangeIdentifierValue": "string",
110 "allowsSystemGenerateNewId": true,
111 "numberRangeType": {
112 "name": "string"
113 }
114 },
115 "leaseComponentId": 0,
116 "leaseComponentDisplayId": "string",
117 "companyCodeId": 0,
118 "companyCodeDisplayId": "string",
119 "splittedFromActivationGroupRevisionId": {
120 "id": 0,
121 "displayId": "string",
122 "name": "string",
123 "inception": true,
124 "revisionType": "REVISION",
125 "state": "MLA_DEFINE",
126 "approvedBy": "string",
127 "approvedAt": "2019-08-24T14:15:22Z",
128 "parentRevisionId": 0,
129 "approverComment": "string",
130 "rouStartDate": "2019-08-24",
131 "rouEndDate": "2019-08-24",
132 "activationGroupModification": {
133 "modificationDate": "2019-08-24",
134 "terminationType": "CASUALTY",
135 "terminationDate": {
136 "timing": "START_OF_DAY",
137 "year": 0,
138 "monthValue": 0,
139 "dayOfMonth": 0,
140 "leapYear": true,
141 "month": "JANUARY",
142 "dayOfWeek": "MONDAY",
143 "dayOfYear": 0
144 },
145 "useManualFmvValue": true,
146 "useManualAssetValues": true,
147 "enforceNonLeaseOnIndexation": true,
148 "applyIndexationLease": true,
149 "applyIndexationNonLease": true,
150 "indexationTreatmentType": "DEFAULT",
151 "indexationStartDate": "2019-08-24",
152 "indexationDateType": "ROU_ANNIVERSARY_DATE",
153 "indexationStartDateNonLease": "2019-08-24",
154 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
155 "modificationReasons": [
156 "CONTRACT_RATE_CHANGE"
157 ],
158 "modificationPerClassificationList": [
159 {
160 "accountingStandardId": 0,
161 "classificationType": "NON_LEASE",
162 "accountingStandardType": "GAAP",
163 "impairmentAmount": 0.1,
164 "recoverableAmount": 0.1,
165 "decreaseInAsset": 0.1,
166 "decreaseInTerm": 0.1
167 }
168 ],
169 "massIndexationTaskId": 0
170 },
171 "activationGroupId": 0,
172 "activationGroupDisplayId": "string",
173 "activationGroupName": "string",
174 "leaseComponentRevisionId": 0,
175 "leaseComponentRevisionDisplayId": "string",
176 "lastLeaseComponentRevisionId": 0,
177 "lastLeaseComponentRevisionDisplayId": "string",
178 "clonedFromRevisionId": 0,
179 "clonedFromRevisionDisplayId": "string",
180 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
181 "infiniteUsefulLife": true,
182 "transferOfOwnership": true,
183 "specializedAsset": true,
184 "fairMarketValue": 0.1,
185 "residualValue": 0,
186 "endOfTermIntention": "TO_BE_DETERMINED",
187 "endOfTermDate": "2019-08-24",
188 "endOfTermPeriod": 0,
189 "activationDocumentDate": "2019-08-24",
190 "activationPostingDate": "2019-08-24",
191 "closingDocumentDate": "2019-08-24",
192 "closingPostingDate": "2019-08-24",
193 "numberRangeIdentifierType": {
194 "name": "string"
195 },
196 "numberRangeIdentifierValue": "string",
197 "allowsSystemGenerateNewId": true,
198 "numberRangeType": {
199 "name": "string"
200 }
201 },
202 "notifications": [
203 {
204 "id": 0,
205 "topic": {
206 "enCaption": "string",
207 "frCaption": "string",
208 "name": "string",
209 "priority": "HIGH"
210 },
211 "username": "string",
212 "activationGroupId": 0,
213 "activationGroupDisplayId": "string",
214 "targetType": "string",
215 "targetId": "string"
216 }
217 ],
218 "transferInfo": {
219 "transferredFromDisplayId": "string",
220 "transferredFromRevisionId": 0,
221 "transferredToDisplayId": "string",
222 "transferredToRevisionId": 0
223 },
224 "numberRangeIdentifierType": {
225 "name": "string"
226 },
227 "numberRangeIdentifierValue": "string",
228 "numberRangeType": {
229 "name": "string"
230 },
231 "allowsSystemGenerateNewId": true
232}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "principalPositionType": "LESSEE",
5 "name": "string",
6 "description": "string",
7 "approverComment": "string",
8 "snapshotData": {
9 "isParallelCurrencyEnabled": true,
10 "isCostCenterAllocationEnabled": true,
11 "useSpotRateForGroupCurrency": true,
12 "usePostingOrDocumentDateForCurrency": true,
13 "exchangeRateTypes": [
14 {
15 "currencyDefinitionType": "CONTRACT_CURRENCY",
16 "sourceCurrencyType": "CONTRACT_CURRENCY",
17 "translationDateType": "DOCUMENT_DATE",
18 "targetCurrency": {
19 "id": 0,
20 "displayId": "string",
21 "decimalPoints": 0
22 },
23 "referenceCurrency": {
24 "id": 0,
25 "displayId": "string"
26 },
27 "currencyType": "string",
28 "exchangeRateType": "string"
29 }
30 ]
31 },
32 "revision": {
33 "id": 0,
34 "displayId": "string",
35 "name": "string",
36 "inception": true,
37 "revisionType": "REVISION",
38 "state": "MLA_DEFINE",
39 "approvedBy": "string",
40 "approvedAt": "2019-08-24T14:15:22Z",
41 "parentRevisionId": 0,
42 "approverComment": "string",
43 "rouStartDate": "2019-08-24",
44 "rouEndDate": "2019-08-24",
45 "activationGroupModification": {
46 "modificationDate": "2019-08-24",
47 "terminationType": "CASUALTY",
48 "terminationDate": {
49 "timing": "START_OF_DAY",
50 "year": 0,
51 "monthValue": 0,
52 "dayOfMonth": 0,
53 "leapYear": true,
54 "month": "JANUARY",
55 "dayOfWeek": "MONDAY",
56 "dayOfYear": 0
57 },
58 "useManualFmvValue": true,
59 "useManualAssetValues": true,
60 "enforceNonLeaseOnIndexation": true,
61 "applyIndexationLease": true,
62 "applyIndexationNonLease": true,
63 "indexationTreatmentType": "DEFAULT",
64 "indexationStartDate": "2019-08-24",
65 "indexationDateType": "ROU_ANNIVERSARY_DATE",
66 "indexationStartDateNonLease": "2019-08-24",
67 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
68 "modificationReasons": [
69 "CONTRACT_RATE_CHANGE"
70 ],
71 "modificationPerClassificationList": [
72 {
73 "accountingStandardId": 0,
74 "classificationType": "NON_LEASE",
75 "accountingStandardType": "GAAP",
76 "impairmentAmount": 0.1,
77 "recoverableAmount": 0.1,
78 "decreaseInAsset": 0.1,
79 "decreaseInTerm": 0.1
80 }
81 ],
82 "massIndexationTaskId": 0
83 },
84 "activationGroupId": 0,
85 "activationGroupDisplayId": "string",
86 "activationGroupName": "string",
87 "leaseComponentRevisionId": 0,
88 "leaseComponentRevisionDisplayId": "string",
89 "lastLeaseComponentRevisionId": 0,
90 "lastLeaseComponentRevisionDisplayId": "string",
91 "clonedFromRevisionId": 0,
92 "clonedFromRevisionDisplayId": "string",
93 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
94 "infiniteUsefulLife": true,
95 "transferOfOwnership": true,
96 "specializedAsset": true,
97 "fairMarketValue": 0.1,
98 "residualValue": 0,
99 "endOfTermIntention": "TO_BE_DETERMINED",
100 "endOfTermDate": "2019-08-24",
101 "endOfTermPeriod": 0,
102 "activationDocumentDate": "2019-08-24",
103 "activationPostingDate": "2019-08-24",
104 "closingDocumentDate": "2019-08-24",
105 "closingPostingDate": "2019-08-24",
106 "numberRangeIdentifierType": {
107 "name": "string"
108 },
109 "numberRangeIdentifierValue": "string",
110 "allowsSystemGenerateNewId": true,
111 "numberRangeType": {
112 "name": "string"
113 }
114 },
115 "leaseComponentId": 0,
116 "leaseComponentDisplayId": "string",
117 "companyCodeId": 0,
118 "companyCodeDisplayId": "string",
119 "splittedFromActivationGroupRevisionId": {
120 "id": 0,
121 "displayId": "string",
122 "name": "string",
123 "inception": true,
124 "revisionType": "REVISION",
125 "state": "MLA_DEFINE",
126 "approvedBy": "string",
127 "approvedAt": "2019-08-24T14:15:22Z",
128 "parentRevisionId": 0,
129 "approverComment": "string",
130 "rouStartDate": "2019-08-24",
131 "rouEndDate": "2019-08-24",
132 "activationGroupModification": {
133 "modificationDate": "2019-08-24",
134 "terminationType": "CASUALTY",
135 "terminationDate": {
136 "timing": "START_OF_DAY",
137 "year": 0,
138 "monthValue": 0,
139 "dayOfMonth": 0,
140 "leapYear": true,
141 "month": "JANUARY",
142 "dayOfWeek": "MONDAY",
143 "dayOfYear": 0
144 },
145 "useManualFmvValue": true,
146 "useManualAssetValues": true,
147 "enforceNonLeaseOnIndexation": true,
148 "applyIndexationLease": true,
149 "applyIndexationNonLease": true,
150 "indexationTreatmentType": "DEFAULT",
151 "indexationStartDate": "2019-08-24",
152 "indexationDateType": "ROU_ANNIVERSARY_DATE",
153 "indexationStartDateNonLease": "2019-08-24",
154 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
155 "modificationReasons": [
156 "CONTRACT_RATE_CHANGE"
157 ],
158 "modificationPerClassificationList": [
159 {
160 "accountingStandardId": 0,
161 "classificationType": "NON_LEASE",
162 "accountingStandardType": "GAAP",
163 "impairmentAmount": 0.1,
164 "recoverableAmount": 0.1,
165 "decreaseInAsset": 0.1,
166 "decreaseInTerm": 0.1
167 }
168 ],
169 "massIndexationTaskId": 0
170 },
171 "activationGroupId": 0,
172 "activationGroupDisplayId": "string",
173 "activationGroupName": "string",
174 "leaseComponentRevisionId": 0,
175 "leaseComponentRevisionDisplayId": "string",
176 "lastLeaseComponentRevisionId": 0,
177 "lastLeaseComponentRevisionDisplayId": "string",
178 "clonedFromRevisionId": 0,
179 "clonedFromRevisionDisplayId": "string",
180 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
181 "infiniteUsefulLife": true,
182 "transferOfOwnership": true,
183 "specializedAsset": true,
184 "fairMarketValue": 0.1,
185 "residualValue": 0,
186 "endOfTermIntention": "TO_BE_DETERMINED",
187 "endOfTermDate": "2019-08-24",
188 "endOfTermPeriod": 0,
189 "activationDocumentDate": "2019-08-24",
190 "activationPostingDate": "2019-08-24",
191 "closingDocumentDate": "2019-08-24",
192 "closingPostingDate": "2019-08-24",
193 "numberRangeIdentifierType": {
194 "name": "string"
195 },
196 "numberRangeIdentifierValue": "string",
197 "allowsSystemGenerateNewId": true,
198 "numberRangeType": {
199 "name": "string"
200 }
201 },
202 "notifications": [
203 {
204 "id": 0,
205 "topic": {
206 "enCaption": "string",
207 "frCaption": "string",
208 "name": "string",
209 "priority": "HIGH"
210 },
211 "username": "string",
212 "activationGroupId": 0,
213 "activationGroupDisplayId": "string",
214 "targetType": "string",
215 "targetId": "string"
216 }
217 ],
218 "transferInfo": {
219 "transferredFromDisplayId": "string",
220 "transferredFromRevisionId": 0,
221 "transferredToDisplayId": "string",
222 "transferredToRevisionId": 0
223 },
224 "numberRangeIdentifierType": {
225 "name": "string"
226 },
227 "numberRangeIdentifierValue": "string",
228 "numberRangeType": {
229 "name": "string"
230 },
231 "allowsSystemGenerateNewId": true
232}
Activation Group - Update Activation Group Revision¶
HTTP Request
PUT /api/activation-group-revisions/{id}
📋 Description: Updates the specified activation group revision within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset configurations effectively for enhanced analytics and real estate property insights.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated activation group revision data, including portfolio identifiers, asset details, and relevant analytics for real estate property management. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "inception": true,
6 "revisionType": "REVISION",
7 "state": "MLA_DEFINE",
8 "approvedBy": "string",
9 "approvedAt": "2019-08-24T14:15:22Z",
10 "parentRevisionId": 0,
11 "approverComment": "string",
12 "rouStartDate": "2019-08-24",
13 "rouEndDate": "2019-08-24",
14 "activationGroupModification": {
15 "modificationDate": "2019-08-24",
16 "terminationType": "CASUALTY",
17 "terminationDate": {
18 "timing": "START_OF_DAY",
19 "year": 0,
20 "monthValue": 0,
21 "dayOfMonth": 0,
22 "leapYear": true,
23 "month": "JANUARY",
24 "dayOfWeek": "MONDAY",
25 "dayOfYear": 0
26 },
27 "useManualFmvValue": true,
28 "useManualAssetValues": true,
29 "enforceNonLeaseOnIndexation": true,
30 "applyIndexationLease": true,
31 "applyIndexationNonLease": true,
32 "indexationTreatmentType": "DEFAULT",
33 "indexationStartDate": "2019-08-24",
34 "indexationDateType": "ROU_ANNIVERSARY_DATE",
35 "indexationStartDateNonLease": "2019-08-24",
36 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
37 "modificationReasons": [
38 "CONTRACT_RATE_CHANGE"
39 ],
40 "modificationPerClassificationList": [
41 {
42 "accountingStandardId": 0,
43 "classificationType": "NON_LEASE",
44 "accountingStandardType": "GAAP",
45 "impairmentAmount": 0.1,
46 "recoverableAmount": 0.1,
47 "decreaseInAsset": 0.1,
48 "decreaseInTerm": 0.1
49 }
50 ],
51 "massIndexationTaskId": 0
52 },
53 "activationGroupId": 0,
54 "activationGroupDisplayId": "string",
55 "activationGroupName": "string",
56 "leaseComponentRevisionId": 0,
57 "leaseComponentRevisionDisplayId": "string",
58 "lastLeaseComponentRevisionId": 0,
59 "lastLeaseComponentRevisionDisplayId": "string",
60 "clonedFromRevisionId": 0,
61 "clonedFromRevisionDisplayId": "string",
62 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
63 "infiniteUsefulLife": true,
64 "transferOfOwnership": true,
65 "specializedAsset": true,
66 "fairMarketValue": 0.1,
67 "residualValue": 0,
68 "endOfTermIntention": "TO_BE_DETERMINED",
69 "endOfTermDate": "2019-08-24",
70 "endOfTermPeriod": 0,
71 "activationDocumentDate": "2019-08-24",
72 "activationPostingDate": "2019-08-24",
73 "closingDocumentDate": "2019-08-24",
74 "closingPostingDate": "2019-08-24",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83}
Activation Group - Financial Term Bulk Exercise¶
HTTP Request
PUT /api/activation-group-financial-terms/exercise
📋 Description: Updates the financial terms associated with an activation group within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset analytics for real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial terms and conditions for activating a portfolio asset within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "activationGroupRevisionId": 0,
4 "termId": 0,
5 "exercise": true
6 }
7]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "expenseCategory": {
7 "id": 0,
8 "displayId": "string",
9 "status": "CREATED",
10 "name": "string",
11 "expenseCategoryType": "PAYMENT"
12 },
13 "amount": 0.1,
14 "amountFrequency": "DAY",
15 "paymentMode": "ADVANCE",
16 "paymentCalculationMode": "ONE_TIME",
17 "firstSpecialPaymentDate": "2019-08-24",
18 "lastSpecialPaymentDate": "2019-08-24",
19 "paymentFrequency": "ONE_TIME",
20 "firstPaymentDate": "2019-08-24",
21 "lastPaymentDate": "2019-08-24",
22 "firstPaymentAmount": 0.1,
23 "lastPaymentAmount": 0.1,
24 "months": 0,
25 "days": 0,
26 "notificationDate": "2019-08-24",
27 "monthEnd": true,
28 "paymentTiming": "START_OF_DAY",
29 "escalatingRent": true,
30 "stopEscalatingAtZero": true,
31 "escalatingRentAmount": 0.1,
32 "escalatingRentType": "FIXED",
33 "escalationFrequencyOffset": 0,
34 "escalationFrequency": 0,
35 "escalationFastForward": 0,
36 "termStartDate": "2019-08-24",
37 "termEndDate": "2019-08-24",
38 "expenseCategoryType": "PAYMENT",
39 "spreadingFrequency": "NONE",
40 "firstSpreadingAmount": 0.1,
41 "lastSpreadingAmount": 0.1,
42 "valid": true,
43 "parentFinancialTermId": 0,
44 "termStatus": "EDITABLE",
45 "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
46 "vendorPaymentSplits": [
47 {
48 "percentage": 0,
49 "calculateTax": true,
50 "taxExemptionPercentage": 0,
51 "partner": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string",
56 "erpSystemDisplayId": "string"
57 },
58 "partnerRole": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string"
63 },
64 "taxCodeDetermination": {
65 "id": 0,
66 "displayId": "string",
67 "companyId": 0,
68 "partnerId": 0,
69 "taxJurisdictionId": 0,
70 "taxJurisdictionDisplayId": "string",
71 "defaultTaxCodeId": 0,
72 "defaultTaxCodeDisplayId": "string",
73 "defaultExemptionTaxCodeId": 0,
74 "defaultExemptionTaxCodeDisplayId": "string",
75 "defaultExemptionPercentage": 0,
76 "mapping": {
77 "isLeaseExpense": true,
78 "nonLeaseTaxCodeId": 0,
79 "nonLeaseTaxCodeDisplayId": "string",
80 "nonLeaseExemptionTaxCodeId": 0,
81 "nonLeaseExemptionTaxCodeDisplayId": "string",
82 "nonLeaseExemptionTaxPercentage": 0.1,
83 "principalTaxCodeId": 0,
84 "principalTaxCodeDisplayId": "string",
85 "principalExemptionTaxCodeId": 0,
86 "principalExemptionTaxCodeDisplayId": "string",
87 "principalExemptionTaxPercentage": 0.1
88 }
89 }
90 }
91 ],
92 "revisionDisplayId": "string",
93 "termType": "PAYMENT_TERM",
94 "exercise": true,
95 "leaseComponentFinancialTermId": 0,
96 "revisionId": 0,
97 "activationGroupDisplayId": "string",
98 "activationGroupId": 0,
99 "applyIndexation": true,
100 "indexationType": "NONE",
101 "indexationTypeNonLease": "NONE",
102 "consumerPriceIndexCategory": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "city": "string",
108 "country": "string",
109 "province": "string",
110 "erpSystemId": 0
111 },
112 "consumerPriceIndexCategoryNonLease": {
113 "id": 0,
114 "displayId": "string",
115 "status": "CREATED",
116 "name": "string",
117 "city": "string",
118 "country": "string",
119 "province": "string",
120 "erpSystemId": 0
121 },
122 "baseIndexationDate": "2019-08-24",
123 "baseIndexationDateNonLease": "2019-08-24",
124 "baseIndexationRate": 0.1,
125 "baseIndexationRateNonLease": 0.1,
126 "referenceIndexationDate": "2019-08-24",
127 "referenceIndexationDateNonLease": "2019-08-24",
128 "referenceIndexationRate": 0.1,
129 "referenceIndexationRateNonLease": 0.1,
130 "indexationStartDate": "2019-08-24",
131 "indexationStartDateNonLease": "2019-08-24",
132 "indexationLeasePercentage": 0.1,
133 "indexationNonLeasePercentage": 0.1,
134 "termState": "HISTORICAL",
135 "type": "string",
136 "numberRangeIdentifierType": {
137 "name": "string"
138 },
139 "numberRangeIdentifierValue": "string",
140 "allowsSystemGenerateNewId": true,
141 "numberRangeType": {
142 "name": "string"
143 }
144 }
145]
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
amountFrequency |
DAY, MONTH, ONE_TIME, YEAR |
escalatingRentType |
FIXED, PERCENTAGE |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
lockReason |
ENDS_BEFORE_MODIFICATION_DATE, EXERCISED_IN_ACTIVATION_GROUP, NO_PAYMENT |
paymentCalculationMode |
DAILY, ONE_TIME, PAYMENT_FOR_MONTH |
paymentFrequency |
ANNUALLY, BI_MONTHLY, BI_WEEKLY, DAILY, MONTHLY, ONE_TIME, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY, WEEKLY |
paymentMode |
ADVANCE, ARREARS |
paymentTiming |
END_OF_DAY, START_OF_DAY |
spreadingFrequency |
NONE, PERIODIC, STRAIGHT_LINE |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
termState |
ACTIVE, HISTORICAL, INACTIVE |
termStatus |
EDITABLE, LOCKED |
termType |
INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM |
Activation Group - Send To Assessment¶
HTTP Request
POST /api/activation-groups/send-to-assessment
📋 Description: Submits selected activation groups for assessment within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and decision-making for real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the activation group details, including portfolio identifiers and asset analytics, for initiating the assessment process within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Search Activation Groups¶
HTTP Request
POST /api/activation-groups/search
📋 Description: Submits a request to search for activation groups within the Nakisa Portfolio Management Suite, enabling users to efficiently analyze and manage portfolios, assets, and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for identifying specific activation groups within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
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 "principalPositionTypeEqual": "LESSEE",
21 "nameLike": "string",
22 "revisionIdEqual": 0,
23 "revisionTypeEqual": "REVISION",
24 "revisionStateEqual": "MLA_DEFINE",
25 "revisionStateIn": [
26 "MLA_DEFINE"
27 ],
28 "leaseComponentIdIn": [
29 0
30 ],
31 "leaseComponentDisplayIdIn": [
32 "string"
33 ],
34 "companyCodeIdIn": [
35 0
36 ],
37 "companyCodeDisplayIdIn": [
38 "string"
39 ]
40}
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 "principalPositionType": "LESSEE",
23 "name": "string",
24 "description": "string",
25 "approverComment": "string",
26 "snapshotData": {
27 "isParallelCurrencyEnabled": true,
28 "isCostCenterAllocationEnabled": true,
29 "useSpotRateForGroupCurrency": true,
30 "usePostingOrDocumentDateForCurrency": true,
31 "exchangeRateTypes": [
32 {
33 "currencyDefinitionType": "CONTRACT_CURRENCY",
34 "sourceCurrencyType": "CONTRACT_CURRENCY",
35 "translationDateType": "DOCUMENT_DATE",
36 "targetCurrency": {
37 "id": 0,
38 "displayId": "string",
39 "decimalPoints": 0
40 },
41 "referenceCurrency": {
42 "id": 0,
43 "displayId": "string"
44 },
45 "currencyType": "string",
46 "exchangeRateType": "string"
47 }
48 ]
49 },
50 "revision": {
51 "id": 0,
52 "displayId": "string",
53 "name": "string",
54 "inception": true,
55 "revisionType": "REVISION",
56 "state": "MLA_DEFINE",
57 "approvedBy": "string",
58 "approvedAt": "2019-08-24T14:15:22Z",
59 "parentRevisionId": 0,
60 "approverComment": "string",
61 "rouStartDate": "2019-08-24",
62 "rouEndDate": "2019-08-24",
63 "activationGroupModification": {
64 "modificationDate": "2019-08-24",
65 "terminationType": "CASUALTY",
66 "terminationDate": {
67 "timing": "START_OF_DAY",
68 "year": 0,
69 "monthValue": 0,
70 "dayOfMonth": 0,
71 "leapYear": true,
72 "month": "JANUARY",
73 "dayOfWeek": "MONDAY",
74 "dayOfYear": 0
75 },
76 "useManualFmvValue": true,
77 "useManualAssetValues": true,
78 "enforceNonLeaseOnIndexation": true,
79 "applyIndexationLease": true,
80 "applyIndexationNonLease": true,
81 "indexationTreatmentType": "DEFAULT",
82 "indexationStartDate": "2019-08-24",
83 "indexationDateType": "ROU_ANNIVERSARY_DATE",
84 "indexationStartDateNonLease": "2019-08-24",
85 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
86 "modificationReasons": [
87 "CONTRACT_RATE_CHANGE"
88 ],
89 "modificationPerClassificationList": [
90 {
91 "accountingStandardId": 0,
92 "classificationType": "NON_LEASE",
93 "accountingStandardType": "GAAP",
94 "impairmentAmount": 0.1,
95 "recoverableAmount": 0.1,
96 "decreaseInAsset": 0.1,
97 "decreaseInTerm": 0.1
98 }
99 ],
100 "massIndexationTaskId": 0
101 },
102 "activationGroupId": 0,
103 "activationGroupDisplayId": "string",
104 "activationGroupName": "string",
105 "leaseComponentRevisionId": 0,
106 "leaseComponentRevisionDisplayId": "string",
107 "lastLeaseComponentRevisionId": 0,
108 "lastLeaseComponentRevisionDisplayId": "string",
109 "clonedFromRevisionId": 0,
110 "clonedFromRevisionDisplayId": "string",
111 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
112 "infiniteUsefulLife": true,
113 "transferOfOwnership": true,
114 "specializedAsset": true,
115 "fairMarketValue": 0.1,
116 "residualValue": 0,
117 "endOfTermIntention": "TO_BE_DETERMINED",
118 "endOfTermDate": "2019-08-24",
119 "endOfTermPeriod": 0,
120 "activationDocumentDate": "2019-08-24",
121 "activationPostingDate": "2019-08-24",
122 "closingDocumentDate": "2019-08-24",
123 "closingPostingDate": "2019-08-24",
124 "numberRangeIdentifierType": {
125 "name": "string"
126 },
127 "numberRangeIdentifierValue": "string",
128 "allowsSystemGenerateNewId": true,
129 "numberRangeType": {
130 "name": "string"
131 }
132 },
133 "leaseComponentId": 0,
134 "leaseComponentDisplayId": "string",
135 "companyCodeId": 0,
136 "companyCodeDisplayId": "string",
137 "splittedFromActivationGroupRevisionId": {
138 "id": 0,
139 "displayId": "string",
140 "name": "string",
141 "inception": true,
142 "revisionType": "REVISION",
143 "state": "MLA_DEFINE",
144 "approvedBy": "string",
145 "approvedAt": "2019-08-24T14:15:22Z",
146 "parentRevisionId": 0,
147 "approverComment": "string",
148 "rouStartDate": "2019-08-24",
149 "rouEndDate": "2019-08-24",
150 "activationGroupModification": {
151 "modificationDate": "2019-08-24",
152 "terminationType": "CASUALTY",
153 "terminationDate": {
154 "timing": "START_OF_DAY",
155 "year": 0,
156 "monthValue": 0,
157 "dayOfMonth": 0,
158 "leapYear": true,
159 "month": "JANUARY",
160 "dayOfWeek": "MONDAY",
161 "dayOfYear": 0
162 },
163 "useManualFmvValue": true,
164 "useManualAssetValues": true,
165 "enforceNonLeaseOnIndexation": true,
166 "applyIndexationLease": true,
167 "applyIndexationNonLease": true,
168 "indexationTreatmentType": "DEFAULT",
169 "indexationStartDate": "2019-08-24",
170 "indexationDateType": "ROU_ANNIVERSARY_DATE",
171 "indexationStartDateNonLease": "2019-08-24",
172 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
173 "modificationReasons": [
174 "CONTRACT_RATE_CHANGE"
175 ],
176 "modificationPerClassificationList": [
177 {
178 "accountingStandardId": 0,
179 "classificationType": "NON_LEASE",
180 "accountingStandardType": "GAAP",
181 "impairmentAmount": 0.1,
182 "recoverableAmount": 0.1,
183 "decreaseInAsset": 0.1,
184 "decreaseInTerm": 0.1
185 }
186 ],
187 "massIndexationTaskId": 0
188 },
189 "activationGroupId": 0,
190 "activationGroupDisplayId": "string",
191 "activationGroupName": "string",
192 "leaseComponentRevisionId": 0,
193 "leaseComponentRevisionDisplayId": "string",
194 "lastLeaseComponentRevisionId": 0,
195 "lastLeaseComponentRevisionDisplayId": "string",
196 "clonedFromRevisionId": 0,
197 "clonedFromRevisionDisplayId": "string",
198 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
199 "infiniteUsefulLife": true,
200 "transferOfOwnership": true,
201 "specializedAsset": true,
202 "fairMarketValue": 0.1,
203 "residualValue": 0,
204 "endOfTermIntention": "TO_BE_DETERMINED",
205 "endOfTermDate": "2019-08-24",
206 "endOfTermPeriod": 0,
207 "activationDocumentDate": "2019-08-24",
208 "activationPostingDate": "2019-08-24",
209 "closingDocumentDate": "2019-08-24",
210 "closingPostingDate": "2019-08-24",
211 "numberRangeIdentifierType": {
212 "name": "string"
213 },
214 "numberRangeIdentifierValue": "string",
215 "allowsSystemGenerateNewId": true,
216 "numberRangeType": {
217 "name": "string"
218 }
219 },
220 "notifications": [
221 {
222 "id": 0,
223 "topic": {
224 "enCaption": "string",
225 "frCaption": "string",
226 "name": "string",
227 "priority": "HIGH"
228 },
229 "username": "string",
230 "activationGroupId": 0,
231 "activationGroupDisplayId": "string",
232 "targetType": "string",
233 "targetId": "string"
234 }
235 ],
236 "transferInfo": {
237 "transferredFromDisplayId": "string",
238 "transferredFromRevisionId": 0,
239 "transferredToDisplayId": "string",
240 "transferredToRevisionId": 0
241 },
242 "numberRangeIdentifierType": {
243 "name": "string"
244 },
245 "numberRangeIdentifierValue": "string",
246 "numberRangeType": {
247 "name": "string"
248 },
249 "allowsSystemGenerateNewId": true
250 }
251 ],
252 "number": 0,
253 "sort": {
254 "sorted": true,
255 "unsorted": true,
256 "empty": true
257 },
258 "first": true,
259 "last": true,
260 "empty": true
261}
Activation Group - Rework Pending Classification¶
HTTP Request
POST /api/activation-groups/rework-pending-classification
📋 Description: Submits a request to reclassify pending activation groups within the Nakisa Portfolio Management Suite, enhancing asset management and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of activation groups pending classification, including relevant asset and portfolio identifiers for effective analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Rework Classified¶
HTTP Request
POST /api/activation-groups/rework-classified
📋 Description: Submits a request to rework classified activation groups within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the rework classification data for portfolio assets, including relevant analytics and metadata for real estate property management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Rework Assessment¶
HTTP Request
POST /api/activation-groups/rework-assessment
📋 Description: Submits a rework assessment for activation groups within the Nakisa Portfolio Management Suite, enabling enhanced analytics and decision-making for portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the rework assessment data for portfolio and asset evaluation, including relevant metrics and analytics for real estate property management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Reject¶
HTTP Request
POST /api/activation-groups/reject
📋 Description: Rejects specified activation groups within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management by allowing users to dismiss unwanted proposals related to real estate properties and analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the activation group to be rejected, including relevant identifiers and reasons for rejection, within the context of portfolio and asset management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Generate Schedules¶
HTTP Request
POST /api/activation-groups/generate-schedules
📋 Description: Generates activation schedules for specified asset groups within the Nakisa Portfolio Management Suite, enabling enhanced portfolio analytics and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the activation group details and scheduling parameters necessary for generating asset management schedules within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Create Activation Group Revision¶
HTTP Request
POST /api/activation-groups/event
📋 Description: Creates a new activation group event within the Nakisa Portfolio Management Suite, enabling users to manage and analyze portfolio and asset-related activities for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
any |
true |
Request body containing the activation group event data, including portfolio identifiers, asset details, and analytics metrics relevant to real estate property management. |
Body Parameters
1{
2 "activationGroupId": 0,
3 "name": "string",
4 "modificationDate": "2019-08-24",
5 "modificationReasons": [
6 "CONTRACT_RATE_CHANGE"
7 ],
8 "terminationType": "CASUALTY",
9 "terminationDate": "2019-08-24",
10 "terminationDateTiming": "START_OF_DAY",
11 "useManualFmvValue": true,
12 "fairMarketValue": 0.1,
13 "applyIndexationLease": true,
14 "applyIndexationNonLease": true,
15 "indexationTreatmentType": "DEFAULT",
16 "indexationStartDate": "2019-08-24",
17 "indexationDateType": "ROU_ANNIVERSARY_DATE",
18 "indexationStartDateNonLease": "2019-08-24",
19 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
20 "modificationInfo": {
21 "property1": {
22 "property1": {
23 "impairmentAmount": 0.1,
24 "recoverableAmount": 0.1,
25 "decreaseInTerm": 0.1,
26 "decreaseInAsset": 0.1,
27 "accountingStandardId": 0,
28 "classificationType": "NON_LEASE"
29 },
30 "property2": {
31 "impairmentAmount": 0.1,
32 "recoverableAmount": 0.1,
33 "decreaseInTerm": 0.1,
34 "decreaseInAsset": 0.1,
35 "accountingStandardId": 0,
36 "classificationType": "NON_LEASE"
37 }
38 },
39 "property2": {
40 "property1": {
41 "impairmentAmount": 0.1,
42 "recoverableAmount": 0.1,
43 "decreaseInTerm": 0.1,
44 "decreaseInAsset": 0.1,
45 "accountingStandardId": 0,
46 "classificationType": "NON_LEASE"
47 },
48 "property2": {
49 "impairmentAmount": 0.1,
50 "recoverableAmount": 0.1,
51 "decreaseInTerm": 0.1,
52 "decreaseInAsset": 0.1,
53 "accountingStandardId": 0,
54 "classificationType": "NON_LEASE"
55 }
56 }
57 },
58 "decreaseInAssetOperating": 0.1,
59 "decreaseInAssetNonOperating": 0.1,
60 "decreaseInTermIFRS": 0.1,
61 "casualtyPenalty": 0.1,
62 "updateContractRateIBR": true,
63 "type": "string"
64}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "inception": true,
6 "revisionType": "REVISION",
7 "state": "MLA_DEFINE",
8 "approvedBy": "string",
9 "approvedAt": "2019-08-24T14:15:22Z",
10 "parentRevisionId": 0,
11 "approverComment": "string",
12 "rouStartDate": "2019-08-24",
13 "rouEndDate": "2019-08-24",
14 "activationGroupModification": {
15 "modificationDate": "2019-08-24",
16 "terminationType": "CASUALTY",
17 "terminationDate": {
18 "timing": "START_OF_DAY",
19 "year": 0,
20 "monthValue": 0,
21 "dayOfMonth": 0,
22 "leapYear": true,
23 "month": "JANUARY",
24 "dayOfWeek": "MONDAY",
25 "dayOfYear": 0
26 },
27 "useManualFmvValue": true,
28 "useManualAssetValues": true,
29 "enforceNonLeaseOnIndexation": true,
30 "applyIndexationLease": true,
31 "applyIndexationNonLease": true,
32 "indexationTreatmentType": "DEFAULT",
33 "indexationStartDate": "2019-08-24",
34 "indexationDateType": "ROU_ANNIVERSARY_DATE",
35 "indexationStartDateNonLease": "2019-08-24",
36 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
37 "modificationReasons": [
38 "CONTRACT_RATE_CHANGE"
39 ],
40 "modificationPerClassificationList": [
41 {
42 "accountingStandardId": 0,
43 "classificationType": "NON_LEASE",
44 "accountingStandardType": "GAAP",
45 "impairmentAmount": 0.1,
46 "recoverableAmount": 0.1,
47 "decreaseInAsset": 0.1,
48 "decreaseInTerm": 0.1
49 }
50 ],
51 "massIndexationTaskId": 0
52 },
53 "activationGroupId": 0,
54 "activationGroupDisplayId": "string",
55 "activationGroupName": "string",
56 "leaseComponentRevisionId": 0,
57 "leaseComponentRevisionDisplayId": "string",
58 "lastLeaseComponentRevisionId": 0,
59 "lastLeaseComponentRevisionDisplayId": "string",
60 "clonedFromRevisionId": 0,
61 "clonedFromRevisionDisplayId": "string",
62 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
63 "infiniteUsefulLife": true,
64 "transferOfOwnership": true,
65 "specializedAsset": true,
66 "fairMarketValue": 0.1,
67 "residualValue": 0,
68 "endOfTermIntention": "TO_BE_DETERMINED",
69 "endOfTermDate": "2019-08-24",
70 "endOfTermPeriod": 0,
71 "activationDocumentDate": "2019-08-24",
72 "activationPostingDate": "2019-08-24",
73 "closingDocumentDate": "2019-08-24",
74 "closingPostingDate": "2019-08-24",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeIdentifierValue": "string",
79 "allowsSystemGenerateNewId": true,
80 "numberRangeType": {
81 "name": "string"
82 }
83}
Activation Group - Search Event Initial Data¶
HTTP Request
POST /api/activation-groups/event/initial-data
📋 Description: Submits initial data for activation groups within the Nakisa Portfolio Management Suite, facilitating the integration of portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing initial data for activation groups, including portfolio details, asset information, and analytics relevant to real estate properties. |
Body Parameters
1{
2 "activationGroupId": 0,
3 "modificationDate": "2019-08-24",
4 "modificationReasons": [
5 "CONTRACT_RATE_CHANGE"
6 ],
7 "applyIndexationLease": true,
8 "applyIndexationNonLease": true
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "activationGroupId": 0,
3 "principalPositionType": "LESSEE",
4 "modificationDateUpperLimit": "2019-08-24",
5 "modificationDateLowerLimit": "2019-08-24",
6 "indexationStartDateLowerLimit": "2019-08-24",
7 "indexationStartDateUpperLimit": "2019-08-24",
8 "indexationStartDateNonLeaseLowerLimit": "2019-08-24",
9 "indexationStartDateNonLeaseUpperLimit": "2019-08-24",
10 "terminationDateUpperLimit": "2019-08-24",
11 "terminationDateLowerLimit": "2019-08-24",
12 "latestPostedDate": "2019-08-24",
13 "nextRouAnniversary": "2019-08-24",
14 "fairMarketValue": 0.1,
15 "assetLossInHistory": true,
16 "modificationInfo": {
17 "property1": {
18 "property1": {
19 "periodStartDate": {
20 "timing": "START_OF_DAY",
21 "year": 0,
22 "monthValue": 0,
23 "dayOfMonth": 0,
24 "leapYear": true,
25 "month": "JANUARY",
26 "dayOfWeek": "MONDAY",
27 "dayOfYear": 0
28 },
29 "periodEndDate": {
30 "timing": "START_OF_DAY",
31 "year": 0,
32 "monthValue": 0,
33 "dayOfMonth": 0,
34 "leapYear": true,
35 "month": "JANUARY",
36 "dayOfWeek": "MONDAY",
37 "dayOfYear": 0
38 },
39 "accountingStandardDisplayId": "string",
40 "accountingStandardId": 0,
41 "eventDate": "2019-08-24",
42 "numberOfDays": 0,
43 "openingNbvAmount": 0,
44 "closingNbvAmount": 0,
45 "monthlyDepreciation": 0,
46 "dailyDepreciation": 0,
47 "generatedNbvOnEventDate": 0,
48 "applicableResidualValue": 0,
49 "impairmentReserveClosingBalance": 0,
50 "maximumGainAmount": 0,
51 "nonRecoverableImpairmentLoss": 0,
52 "accountingStandardType": "GAAP",
53 "leaseClassificationType": "NON_LEASE",
54 "decreaseInTermAmountNeeded": true
55 },
56 "property2": {
57 "periodStartDate": {
58 "timing": "START_OF_DAY",
59 "year": 0,
60 "monthValue": 0,
61 "dayOfMonth": 0,
62 "leapYear": true,
63 "month": "JANUARY",
64 "dayOfWeek": "MONDAY",
65 "dayOfYear": 0
66 },
67 "periodEndDate": {
68 "timing": "START_OF_DAY",
69 "year": 0,
70 "monthValue": 0,
71 "dayOfMonth": 0,
72 "leapYear": true,
73 "month": "JANUARY",
74 "dayOfWeek": "MONDAY",
75 "dayOfYear": 0
76 },
77 "accountingStandardDisplayId": "string",
78 "accountingStandardId": 0,
79 "eventDate": "2019-08-24",
80 "numberOfDays": 0,
81 "openingNbvAmount": 0,
82 "closingNbvAmount": 0,
83 "monthlyDepreciation": 0,
84 "dailyDepreciation": 0,
85 "generatedNbvOnEventDate": 0,
86 "applicableResidualValue": 0,
87 "impairmentReserveClosingBalance": 0,
88 "maximumGainAmount": 0,
89 "nonRecoverableImpairmentLoss": 0,
90 "accountingStandardType": "GAAP",
91 "leaseClassificationType": "NON_LEASE",
92 "decreaseInTermAmountNeeded": true
93 }
94 },
95 "property2": {
96 "property1": {
97 "periodStartDate": {
98 "timing": "START_OF_DAY",
99 "year": 0,
100 "monthValue": 0,
101 "dayOfMonth": 0,
102 "leapYear": true,
103 "month": "JANUARY",
104 "dayOfWeek": "MONDAY",
105 "dayOfYear": 0
106 },
107 "periodEndDate": {
108 "timing": "START_OF_DAY",
109 "year": 0,
110 "monthValue": 0,
111 "dayOfMonth": 0,
112 "leapYear": true,
113 "month": "JANUARY",
114 "dayOfWeek": "MONDAY",
115 "dayOfYear": 0
116 },
117 "accountingStandardDisplayId": "string",
118 "accountingStandardId": 0,
119 "eventDate": "2019-08-24",
120 "numberOfDays": 0,
121 "openingNbvAmount": 0,
122 "closingNbvAmount": 0,
123 "monthlyDepreciation": 0,
124 "dailyDepreciation": 0,
125 "generatedNbvOnEventDate": 0,
126 "applicableResidualValue": 0,
127 "impairmentReserveClosingBalance": 0,
128 "maximumGainAmount": 0,
129 "nonRecoverableImpairmentLoss": 0,
130 "accountingStandardType": "GAAP",
131 "leaseClassificationType": "NON_LEASE",
132 "decreaseInTermAmountNeeded": true
133 },
134 "property2": {
135 "periodStartDate": {
136 "timing": "START_OF_DAY",
137 "year": 0,
138 "monthValue": 0,
139 "dayOfMonth": 0,
140 "leapYear": true,
141 "month": "JANUARY",
142 "dayOfWeek": "MONDAY",
143 "dayOfYear": 0
144 },
145 "periodEndDate": {
146 "timing": "START_OF_DAY",
147 "year": 0,
148 "monthValue": 0,
149 "dayOfMonth": 0,
150 "leapYear": true,
151 "month": "JANUARY",
152 "dayOfWeek": "MONDAY",
153 "dayOfYear": 0
154 },
155 "accountingStandardDisplayId": "string",
156 "accountingStandardId": 0,
157 "eventDate": "2019-08-24",
158 "numberOfDays": 0,
159 "openingNbvAmount": 0,
160 "closingNbvAmount": 0,
161 "monthlyDepreciation": 0,
162 "dailyDepreciation": 0,
163 "generatedNbvOnEventDate": 0,
164 "applicableResidualValue": 0,
165 "impairmentReserveClosingBalance": 0,
166 "maximumGainAmount": 0,
167 "nonRecoverableImpairmentLoss": 0,
168 "accountingStandardType": "GAAP",
169 "leaseClassificationType": "NON_LEASE",
170 "decreaseInTermAmountNeeded": true
171 }
172 }
173 },
174 "indexationTreatmentType": "DEFAULT",
175 "indexationTreatmentTypeOptions": [
176 "DEFAULT"
177 ],
178 "indexationDateTypeOptions": [
179 "ROU_ANNIVERSARY_DATE"
180 ],
181 "gaapAccountingStandardLite": {
182 "id": 0,
183 "displayId": "string",
184 "standardType": "GAAP"
185 },
186 "indexedCurrency": true,
187 "type": "string"
188}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
accountingStandardType |
GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET |
dayOfWeek |
FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY |
indexationTreatmentType |
DEFAULT, ENFORCE_LEASE, ENFORCE_NON_LEASE, STANDARD |
leaseClassificationType |
DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM |
month |
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
principalPositionType |
LESSEE, LESSOR |
standardType |
GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET |
timing |
END_OF_DAY, START_OF_DAY |
Activation Group - Confirm Classification¶
HTTP Request
POST /api/activation-groups/confirm-classification
📋 Description: Confirms the classification of activation groups within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the classification confirmation data for activation groups, including relevant portfolio and asset identifiers, to facilitate analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Approve¶
HTTP Request
POST /api/activation-groups/approve
📋 Description: Approves specified activation groups within the Nakisa Portfolio Management Suite, facilitating the management and analysis of portfolio assets in the context of real estate properties. This operation streamlines the approval process, enhancing overall portfolio analytics and decision-making efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the approval details for activation groups, including relevant portfolio and asset identifiers, to facilitate analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Activate¶
HTTP Request
POST /api/activation-groups/activate
📋 Description: Activates specified activation groups within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics for real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the activation group details, including portfolio identifiers and asset attributes, necessary for activating real estate property analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "activationDate": "2019-08-24",
5 "postingDate": "2019-08-24",
6 "documentDate": "2019-08-24",
7 "cascadeParentClosure": true,
8 "manageTransactionsManually": true,
9 "processingTaskId": 0,
10 "processingJobType": "string",
11 "objectId": 0
12}
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}
Activation Group - Search Activation Group Financial Terms¶
HTTP Request
POST /api/activation-group-financial-terms/search
📋 Description: Submits a request to search for financial terms associated with activation groups within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset data relevant to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
any |
true |
Request body containing the financial terms and conditions relevant to activation groups within the portfolio management context, facilitating asset analytics for real estate properties. |
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 "nameLike": "string",
20 "expenseCategoryIdIn": [
21 0
22 ],
23 "expenseCategoryDisplayIdIn": [
24 "string"
25 ],
26 "amountGreaterThanOrEqual": 0.1,
27 "amountLessThanOrEqual": 0.1,
28 "amountFrequencyIn": [
29 "DAY"
30 ],
31 "paymentModeIn": [
32 "ADVANCE"
33 ],
34 "paymentCalculationModeIn": [
35 "ONE_TIME"
36 ],
37 "paymentFrequencyIn": [
38 "ONE_TIME"
39 ],
40 "firstPaymentDateGreaterThanOrEqual": "2019-08-24",
41 "firstPaymentDateLessThanOrEqual": "2019-08-24",
42 "lastPaymentDateGreaterThanOrEqual": "2019-08-24",
43 "lastPaymentDateLessThanOrEqual": "2019-08-24",
44 "notificationDateGreaterThanOrEqual": "2019-08-24",
45 "notificationDateLessThanOrEqual": "2019-08-24",
46 "termStartDateGreaterThanOrEqual": "2019-08-24",
47 "termStartDateLessThanOrEqual": "2019-08-24",
48 "termEndDateGreaterThanOrEqual": "2019-08-24",
49 "termEndDateLessThanOrEqual": "2019-08-24",
50 "expenseCategoryTypeIn": [
51 "PAYMENT"
52 ],
53 "expenseCategoryTypeEqual": "PAYMENT",
54 "revisionDisplayIdIn": [
55 "string"
56 ],
57 "exerciseEqual": true,
58 "leaseComponentFinancialTermIdEqual": 0,
59 "revisionIdIn": [
60 0
61 ],
62 "activationGroupDisplayIdIn": [
63 "string"
64 ],
65 "activationGroupIdIn": [
66 0
67 ],
68 "applyIndexationEqual": true,
69 "consumerPriceIndexCategoryIdIn": [
70 0
71 ],
72 "consumerPriceIndexCategoryDisplayIdIn": [
73 "string"
74 ],
75 "consumerPriceIndexCategoryIdNonLeaseIn": [
76 0
77 ],
78 "consumerPriceIndexCategoryDisplayIdNonLeaseIn": [
79 "string"
80 ],
81 "termStateIn": [
82 "HISTORICAL"
83 ],
84 "type": "string"
85}
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 "expenseCategory": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "expenseCategoryType": "PAYMENT"
29 },
30 "amount": 0.1,
31 "amountFrequency": "DAY",
32 "paymentMode": "ADVANCE",
33 "paymentCalculationMode": "ONE_TIME",
34 "firstSpecialPaymentDate": "2019-08-24",
35 "lastSpecialPaymentDate": "2019-08-24",
36 "paymentFrequency": "ONE_TIME",
37 "firstPaymentDate": "2019-08-24",
38 "lastPaymentDate": "2019-08-24",
39 "firstPaymentAmount": 0.1,
40 "lastPaymentAmount": 0.1,
41 "months": 0,
42 "days": 0,
43 "notificationDate": "2019-08-24",
44 "monthEnd": true,
45 "paymentTiming": "START_OF_DAY",
46 "escalatingRent": true,
47 "stopEscalatingAtZero": true,
48 "escalatingRentAmount": 0.1,
49 "escalatingRentType": "FIXED",
50 "escalationFrequencyOffset": 0,
51 "escalationFrequency": 0,
52 "escalationFastForward": 0,
53 "termStartDate": "2019-08-24",
54 "termEndDate": "2019-08-24",
55 "expenseCategoryType": "PAYMENT",
56 "spreadingFrequency": "NONE",
57 "firstSpreadingAmount": 0.1,
58 "lastSpreadingAmount": 0.1,
59 "valid": true,
60 "parentFinancialTermId": 0,
61 "termStatus": "EDITABLE",
62 "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
63 "vendorPaymentSplits": [
64 {
65 "percentage": 0,
66 "calculateTax": true,
67 "taxExemptionPercentage": 0,
68 "partner": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemDisplayId": "string"
74 },
75 "partnerRole": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string"
80 },
81 "taxCodeDetermination": {
82 "id": 0,
83 "displayId": "string",
84 "companyId": 0,
85 "partnerId": 0,
86 "taxJurisdictionId": 0,
87 "taxJurisdictionDisplayId": "string",
88 "defaultTaxCodeId": 0,
89 "defaultTaxCodeDisplayId": "string",
90 "defaultExemptionTaxCodeId": 0,
91 "defaultExemptionTaxCodeDisplayId": "string",
92 "defaultExemptionPercentage": 0,
93 "mapping": {
94 "isLeaseExpense": true,
95 "nonLeaseTaxCodeId": 0,
96 "nonLeaseTaxCodeDisplayId": "string",
97 "nonLeaseExemptionTaxCodeId": 0,
98 "nonLeaseExemptionTaxCodeDisplayId": "string",
99 "nonLeaseExemptionTaxPercentage": 0.1,
100 "principalTaxCodeId": 0,
101 "principalTaxCodeDisplayId": "string",
102 "principalExemptionTaxCodeId": 0,
103 "principalExemptionTaxCodeDisplayId": "string",
104 "principalExemptionTaxPercentage": 0.1
105 }
106 }
107 }
108 ],
109 "revisionDisplayId": "string",
110 "termType": "PAYMENT_TERM",
111 "exercise": true,
112 "leaseComponentFinancialTermId": 0,
113 "revisionId": 0,
114 "activationGroupDisplayId": "string",
115 "activationGroupId": 0,
116 "applyIndexation": true,
117 "indexationType": "NONE",
118 "indexationTypeNonLease": "NONE",
119 "consumerPriceIndexCategory": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "city": "string",
125 "country": "string",
126 "province": "string",
127 "erpSystemId": 0
128 },
129 "consumerPriceIndexCategoryNonLease": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "city": "string",
135 "country": "string",
136 "province": "string",
137 "erpSystemId": 0
138 },
139 "baseIndexationDate": "2019-08-24",
140 "baseIndexationDateNonLease": "2019-08-24",
141 "baseIndexationRate": 0.1,
142 "baseIndexationRateNonLease": 0.1,
143 "referenceIndexationDate": "2019-08-24",
144 "referenceIndexationDateNonLease": "2019-08-24",
145 "referenceIndexationRate": 0.1,
146 "referenceIndexationRateNonLease": 0.1,
147 "indexationStartDate": "2019-08-24",
148 "indexationStartDateNonLease": "2019-08-24",
149 "indexationLeasePercentage": 0.1,
150 "indexationNonLeasePercentage": 0.1,
151 "termState": "HISTORICAL",
152 "type": "string",
153 "numberRangeIdentifierType": {
154 "name": "string"
155 },
156 "numberRangeIdentifierValue": "string",
157 "allowsSystemGenerateNewId": true,
158 "numberRangeType": {
159 "name": "string"
160 }
161 }
162 ],
163 "number": 0,
164 "sort": {
165 "sorted": true,
166 "unsorted": true,
167 "empty": true
168 },
169 "first": true,
170 "last": true,
171 "empty": true
172}
Activation Group - Can Generate Schedule Activation Group¶
HTTP Request
GET /api/activation-groups/{revisionId}
📋 Description: Retrieves activation group details for a specified revision ID, enabling users to analyze portfolio and asset configurations 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 |
boolean |
Example Responses
1true
Activation Group - Get Min Rou End Date By Activation Group Revision ID¶
HTTP Request
GET /api/activation-groups/{revisionId}/min-rou-end-date
📋 Description: Retrieves the minimum round-end date for activation groups associated with a specified revision ID, facilitating effective 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 |
string |
Example Responses
1"2019-08-24"
Activation Group - Get Activation Group Revisions¶
HTTP Request
GET /api/activation-groups/{id}/activation-group-revisions
📋 Description: Fetches the revision history of a specified activation group, providing insights into changes and updates relevant to 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 "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 "rouStartDate": "2019-08-24",
31 "rouEndDate": "2019-08-24",
32 "activationGroupModification": {
33 "modificationDate": "2019-08-24",
34 "terminationType": "CASUALTY",
35 "terminationDate": {
36 "timing": "START_OF_DAY",
37 "year": 0,
38 "monthValue": 0,
39 "dayOfMonth": 0,
40 "leapYear": true,
41 "month": "JANUARY",
42 "dayOfWeek": "MONDAY",
43 "dayOfYear": 0
44 },
45 "useManualFmvValue": true,
46 "useManualAssetValues": true,
47 "enforceNonLeaseOnIndexation": true,
48 "applyIndexationLease": true,
49 "applyIndexationNonLease": true,
50 "indexationTreatmentType": "DEFAULT",
51 "indexationStartDate": "2019-08-24",
52 "indexationDateType": "ROU_ANNIVERSARY_DATE",
53 "indexationStartDateNonLease": "2019-08-24",
54 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
55 "modificationReasons": [
56 "CONTRACT_RATE_CHANGE"
57 ],
58 "modificationPerClassificationList": [
59 {
60 "accountingStandardId": 0,
61 "classificationType": "NON_LEASE",
62 "accountingStandardType": "GAAP",
63 "impairmentAmount": 0.1,
64 "recoverableAmount": 0.1,
65 "decreaseInAsset": 0.1,
66 "decreaseInTerm": 0.1
67 }
68 ],
69 "massIndexationTaskId": 0
70 },
71 "activationGroupId": 0,
72 "activationGroupDisplayId": "string",
73 "activationGroupName": "string",
74 "leaseComponentRevisionId": 0,
75 "leaseComponentRevisionDisplayId": "string",
76 "lastLeaseComponentRevisionId": 0,
77 "lastLeaseComponentRevisionDisplayId": "string",
78 "clonedFromRevisionId": 0,
79 "clonedFromRevisionDisplayId": "string",
80 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
81 "infiniteUsefulLife": true,
82 "transferOfOwnership": true,
83 "specializedAsset": true,
84 "fairMarketValue": 0.1,
85 "residualValue": 0,
86 "endOfTermIntention": "TO_BE_DETERMINED",
87 "endOfTermDate": "2019-08-24",
88 "endOfTermPeriod": 0,
89 "activationDocumentDate": "2019-08-24",
90 "activationPostingDate": "2019-08-24",
91 "closingDocumentDate": "2019-08-24",
92 "closingPostingDate": "2019-08-24",
93 "numberRangeIdentifierType": {
94 "name": "string"
95 },
96 "numberRangeIdentifierValue": "string",
97 "allowsSystemGenerateNewId": true,
98 "numberRangeType": {
99 "name": "string"
100 }
101 }
102 ],
103 "number": 0,
104 "sort": {
105 "sorted": true,
106 "unsorted": true,
107 "empty": true
108 },
109 "first": true,
110 "last": true,
111 "empty": true
112}
Activation Group - Get By Revision ID Activation Group¶
HTTP Request
GET /api/activation-groups/revision/{revisionId}
📋 Description: Retrieves the details of a specific activation group revision by its unique identifier, enabling users to analyze changes within the portfolio and asset management context.
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 "principalPositionType": "LESSEE",
5 "name": "string",
6 "description": "string",
7 "approverComment": "string",
8 "snapshotData": {
9 "isParallelCurrencyEnabled": true,
10 "isCostCenterAllocationEnabled": true,
11 "useSpotRateForGroupCurrency": true,
12 "usePostingOrDocumentDateForCurrency": true,
13 "exchangeRateTypes": [
14 {
15 "currencyDefinitionType": "CONTRACT_CURRENCY",
16 "sourceCurrencyType": "CONTRACT_CURRENCY",
17 "translationDateType": "DOCUMENT_DATE",
18 "targetCurrency": {
19 "id": 0,
20 "displayId": "string",
21 "decimalPoints": 0
22 },
23 "referenceCurrency": {
24 "id": 0,
25 "displayId": "string"
26 },
27 "currencyType": "string",
28 "exchangeRateType": "string"
29 }
30 ]
31 },
32 "revision": {
33 "id": 0,
34 "displayId": "string",
35 "name": "string",
36 "inception": true,
37 "revisionType": "REVISION",
38 "state": "MLA_DEFINE",
39 "approvedBy": "string",
40 "approvedAt": "2019-08-24T14:15:22Z",
41 "parentRevisionId": 0,
42 "approverComment": "string",
43 "rouStartDate": "2019-08-24",
44 "rouEndDate": "2019-08-24",
45 "activationGroupModification": {
46 "modificationDate": "2019-08-24",
47 "terminationType": "CASUALTY",
48 "terminationDate": {
49 "timing": "START_OF_DAY",
50 "year": 0,
51 "monthValue": 0,
52 "dayOfMonth": 0,
53 "leapYear": true,
54 "month": "JANUARY",
55 "dayOfWeek": "MONDAY",
56 "dayOfYear": 0
57 },
58 "useManualFmvValue": true,
59 "useManualAssetValues": true,
60 "enforceNonLeaseOnIndexation": true,
61 "applyIndexationLease": true,
62 "applyIndexationNonLease": true,
63 "indexationTreatmentType": "DEFAULT",
64 "indexationStartDate": "2019-08-24",
65 "indexationDateType": "ROU_ANNIVERSARY_DATE",
66 "indexationStartDateNonLease": "2019-08-24",
67 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
68 "modificationReasons": [
69 "CONTRACT_RATE_CHANGE"
70 ],
71 "modificationPerClassificationList": [
72 {
73 "accountingStandardId": 0,
74 "classificationType": "NON_LEASE",
75 "accountingStandardType": "GAAP",
76 "impairmentAmount": 0.1,
77 "recoverableAmount": 0.1,
78 "decreaseInAsset": 0.1,
79 "decreaseInTerm": 0.1
80 }
81 ],
82 "massIndexationTaskId": 0
83 },
84 "activationGroupId": 0,
85 "activationGroupDisplayId": "string",
86 "activationGroupName": "string",
87 "leaseComponentRevisionId": 0,
88 "leaseComponentRevisionDisplayId": "string",
89 "lastLeaseComponentRevisionId": 0,
90 "lastLeaseComponentRevisionDisplayId": "string",
91 "clonedFromRevisionId": 0,
92 "clonedFromRevisionDisplayId": "string",
93 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
94 "infiniteUsefulLife": true,
95 "transferOfOwnership": true,
96 "specializedAsset": true,
97 "fairMarketValue": 0.1,
98 "residualValue": 0,
99 "endOfTermIntention": "TO_BE_DETERMINED",
100 "endOfTermDate": "2019-08-24",
101 "endOfTermPeriod": 0,
102 "activationDocumentDate": "2019-08-24",
103 "activationPostingDate": "2019-08-24",
104 "closingDocumentDate": "2019-08-24",
105 "closingPostingDate": "2019-08-24",
106 "numberRangeIdentifierType": {
107 "name": "string"
108 },
109 "numberRangeIdentifierValue": "string",
110 "allowsSystemGenerateNewId": true,
111 "numberRangeType": {
112 "name": "string"
113 }
114 },
115 "leaseComponentId": 0,
116 "leaseComponentDisplayId": "string",
117 "companyCodeId": 0,
118 "companyCodeDisplayId": "string",
119 "splittedFromActivationGroupRevisionId": {
120 "id": 0,
121 "displayId": "string",
122 "name": "string",
123 "inception": true,
124 "revisionType": "REVISION",
125 "state": "MLA_DEFINE",
126 "approvedBy": "string",
127 "approvedAt": "2019-08-24T14:15:22Z",
128 "parentRevisionId": 0,
129 "approverComment": "string",
130 "rouStartDate": "2019-08-24",
131 "rouEndDate": "2019-08-24",
132 "activationGroupModification": {
133 "modificationDate": "2019-08-24",
134 "terminationType": "CASUALTY",
135 "terminationDate": {
136 "timing": "START_OF_DAY",
137 "year": 0,
138 "monthValue": 0,
139 "dayOfMonth": 0,
140 "leapYear": true,
141 "month": "JANUARY",
142 "dayOfWeek": "MONDAY",
143 "dayOfYear": 0
144 },
145 "useManualFmvValue": true,
146 "useManualAssetValues": true,
147 "enforceNonLeaseOnIndexation": true,
148 "applyIndexationLease": true,
149 "applyIndexationNonLease": true,
150 "indexationTreatmentType": "DEFAULT",
151 "indexationStartDate": "2019-08-24",
152 "indexationDateType": "ROU_ANNIVERSARY_DATE",
153 "indexationStartDateNonLease": "2019-08-24",
154 "indexationDateTypeNonLease": "ROU_ANNIVERSARY_DATE",
155 "modificationReasons": [
156 "CONTRACT_RATE_CHANGE"
157 ],
158 "modificationPerClassificationList": [
159 {
160 "accountingStandardId": 0,
161 "classificationType": "NON_LEASE",
162 "accountingStandardType": "GAAP",
163 "impairmentAmount": 0.1,
164 "recoverableAmount": 0.1,
165 "decreaseInAsset": 0.1,
166 "decreaseInTerm": 0.1
167 }
168 ],
169 "massIndexationTaskId": 0
170 },
171 "activationGroupId": 0,
172 "activationGroupDisplayId": "string",
173 "activationGroupName": "string",
174 "leaseComponentRevisionId": 0,
175 "leaseComponentRevisionDisplayId": "string",
176 "lastLeaseComponentRevisionId": 0,
177 "lastLeaseComponentRevisionDisplayId": "string",
178 "clonedFromRevisionId": 0,
179 "clonedFromRevisionDisplayId": "string",
180 "lockReason": "CLOSED_CLOSING_RECLOSE_REJECTED",
181 "infiniteUsefulLife": true,
182 "transferOfOwnership": true,
183 "specializedAsset": true,
184 "fairMarketValue": 0.1,
185 "residualValue": 0,
186 "endOfTermIntention": "TO_BE_DETERMINED",
187 "endOfTermDate": "2019-08-24",
188 "endOfTermPeriod": 0,
189 "activationDocumentDate": "2019-08-24",
190 "activationPostingDate": "2019-08-24",
191 "closingDocumentDate": "2019-08-24",
192 "closingPostingDate": "2019-08-24",
193 "numberRangeIdentifierType": {
194 "name": "string"
195 },
196 "numberRangeIdentifierValue": "string",
197 "allowsSystemGenerateNewId": true,
198 "numberRangeType": {
199 "name": "string"
200 }
201 },
202 "notifications": [
203 {
204 "id": 0,
205 "topic": {
206 "enCaption": "string",
207 "frCaption": "string",
208 "name": "string",
209 "priority": "HIGH"
210 },
211 "username": "string",
212 "activationGroupId": 0,
213 "activationGroupDisplayId": "string",
214 "targetType": "string",
215 "targetId": "string"
216 }
217 ],
218 "transferInfo": {
219 "transferredFromDisplayId": "string",
220 "transferredFromRevisionId": 0,
221 "transferredToDisplayId": "string",
222 "transferredToRevisionId": 0
223 },
224 "numberRangeIdentifierType": {
225 "name": "string"
226 },
227 "numberRangeIdentifierValue": "string",
228 "numberRangeType": {
229 "name": "string"
230 },
231 "allowsSystemGenerateNewId": true
232}
Activation Group - Check Activation Group State¶
HTTP Request
GET /api/activation-groups/check/{id}
📋 Description: Retrieves the activation group details for a specified ID, enabling users to analyze portfolio and asset performance 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}
Activation Group - Get By Revision ID Activation Group Accounting¶
HTTP Request
GET /api/activation-group-accountings/activation-group/{revisionId}
📋 Description: Retrieves detailed accounting information for a specific activation group within the Nakisa Portfolio Management Suite, identified by the provided revision ID, to support portfolio and asset analytics in real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
revisionId |
path |
integer(int64) |
true |
Unique identifier for the 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 "activationGroupRevisionId": 0,
131 "activationGroupRevisionDisplayId": "string",
132 "activationGroupId": 0,
133 "activationGroupDisplayId": "string",
134 "indexationType": "NONE",
135 "currentIndexLevel": 0.1,
136 "indexationReferenceDate": "2019-08-24",
137 "conditionallyIndexed": true,
138 "applicableCurrentIndexLevel": 0.1,
139 "indexationLevelPercentageChangeLowerBound": 0.1,
140 "indexationLevelPercentageChangeUpperBound": 0.1,
141 "indexationTypeNonLease": "NONE",
142 "currentIndexLevelNonLease": 0.1,
143 "indexationReferenceDateNonLease": "2019-08-24",
144 "conditionallyIndexedNonLease": true,
145 "useNonLeaseOnIndexation": true,
146 "applicableCurrentIndexLevelNonLease": 0.1,
147 "indexationLevelPercentageChangeLowerBoundNonLease": 0.1,
148 "indexationLevelPercentageChangeUpperBoundNonLease": 0.1,
149 "spreadingFrequency": "NONE",
150 "costCenterAllocations": [
151 {
152 "id": 0,
153 "mainCostCenter": true,
154 "allocationPercentage": 0.1,
155 "costCenter": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "profitCenter": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "validTo": "2019-08-24",
168 "erpSystemId": 0,
169 "erpSystemDisplayId": "string"
170 }
171 }
172 ],
173 "ibrRate": 0,
174 "ibrRateCarryOver": 0,
175 "consumerPriceIndexCategory": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "city": "string",
181 "country": "string",
182 "province": "string",
183 "erpSystemId": 0
184 },
185 "consumerPriceIndexCategoryNonLease": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "city": "string",
191 "country": "string",
192 "province": "string",
193 "erpSystemId": 0
194 },
195 "indexationTreatmentType": "DEFAULT",
196 "consumerPriceIndexValue": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "value": 0
201 },
202 "consumerPriceIndexValueNonLease": {
203 "id": 0,
204 "displayId": "string",
205 "status": "CREATED",
206 "value": 0
207 },
208 "purchasingOrganization": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "companyId": 0,
214 "companyDisplayId": "string"
215 },
216 "purchasingOrder": {
217 "id": 0,
218 "displayId": "string",
219 "status": "CREATED",
220 "name": "string",
221 "companyId": 0
222 },
223 "type": "string",
224 "numberRangeIdentifierType": {
225 "name": "string"
226 },
227 "numberRangeIdentifierValue": "string",
228 "allowsSystemGenerateNewId": true,
229 "numberRangeType": {
230 "name": "string"
231 }
232}
Response Schema
Enumerated Values
Attribute |
Value |
|---|---|
calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
compoundingFrequency |
ANNUALLY, BI_MONTHLY, DAILY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY |
indexationTreatmentType |
DEFAULT, ENFORCE_LEASE, ENFORCE_NON_LEASE, STANDARD |
indexationType |
CPI_GLOBAL, CPI_LOCAL, NONE |
indexationTypeNonLease |
CPI_GLOBAL, CPI_LOCAL, NONE |
principalPositionType |
LESSEE, LESSOR |
spreadingFrequency |
NONE, PERIODIC, STRAIGHT_LINE |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Activation Group - Delete Activation Group Revision¶
HTTP Request
DELETE /api/activation-groups/event/{revisionId}
📋 Description: Deletes a specified activation group event by its revision ID, enabling effective management of portfolio assets and analytics 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 |
|---|---|---|---|
204 |
No Content |
None |