ResponsePageActivationGroupFinancialTermDto¶
Example Json Object
1{
2 "code": "OK",
3 "message": "Request processed successfully.",
4 "defaultMessage": "Operation completed.",
5 "debugMessage": "No errors encountered.",
6 "errors": {
7 "all": []
8 },
9 "object": {
10 "totalElements": 76,
11 "totalPages": 1,
12 "pageable": {
13 "pageNumber": 0,
14 "unpaged": false,
15 "paged": true,
16 "pageSize": 100,
17 "offset": 0,
18 "sort": {
19 "unsorted": false,
20 "sorted": true,
21 "empty": false
22 }
23 },
24 "numberOfElements": 76,
25 "size": 100,
26 "content": [
27 {
28 "id": 101,
29 "displayId": "FT-2025-001",
30 "name": "Monthly Rent Payment",
31 "expenseCategory": {
32 "id": 101,
33 "displayId": "EC-2025-001",
34 "status": {
35 "name": "ACTIVE",
36 "captionKey": "enum.objectStatus.active",
37 "active": true,
38 "caption": "Active"
39 },
40 "name": "Lease Payment",
41 "expenseCategoryType": "PAYMENT"
42 },
43 "amount": 12000.5,
44 "amountFrequency": "MONTH",
45 "paymentMode": "ADVANCE",
46 "paymentCalculationMode": "PAYMENT_FOR_MONTH",
47 "firstSpecialPaymentDate": "2025-03-01",
48 "lastSpecialPaymentDate": "2025-08-01",
49 "paymentFrequency": "MONTHLY",
50 "firstPaymentDate": "2025-01-15",
51 "lastPaymentDate": "2030-01-15",
52 "firstPaymentAmount": 15000,
53 "lastPaymentAmount": 10000,
54 "months": 60,
55 "days": 15,
56 "notificationDate": "2025-12-01",
57 "monthEnd": true,
58 "paymentTiming": "END_OF_DAY",
59 "escalatingRent": true,
60 "stopEscalatingAtZero": false,
61 "escalatingRentAmount": 500,
62 "escalatingRentType": "PERCENTAGE",
63 "escalationFrequencyOffset": 12,
64 "escalationFrequency": "string",
65 "escalationFastForward": true,
66 "termStartDate": "2025-01-01",
67 "termEndDate": "2030-01-01",
68 "expenseCategoryType": "PAYMENT",
69 "spreadingFrequency": "STRAIGHT_LINE",
70 "firstSpreadingAmount": 2000,
71 "lastSpreadingAmount": 2500,
72 "valid": true,
73 "parentFinancialTermId": 55,
74 "termStatus": "LOCKED",
75 "lockReason": "NO_PAYMENT",
76 "vendorPaymentSplits": [
77 {
78 "percentage": 50,
79 "calculateTax": true,
80 "taxExemptionPercentage": 10,
81 "partner": {
82 "id": 10000012,
83 "displayId": "0000100003",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "name": "TEST VENDOR GB",
91 "erpSystemDisplayId": "FINQ8S-300"
92 },
93 "partnerRole": {
94 "id": 10000004,
95 "displayId": "40",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Lessor"
103 },
104 "taxCodeDetermination": {
105 "id": 101,
106 "displayId": "TX-2025-001",
107 "companyId": 1001,
108 "partnerId": 0,
109 "taxJurisdictionId": 2001,
110 "taxJurisdictionDisplayId": "US-NY",
111 "defaultTaxCodeId": 301,
112 "defaultTaxCodeDisplayId": "TAX-001",
113 "defaultExemptionTaxCodeId": 302,
114 "defaultExemptionTaxCodeDisplayId": "TAX-EX-001",
115 "defaultExemptionPercentage": 100,
116 "mapping": {
117 "isLeaseExpense": true,
118 "nonLeaseTaxCodeId": 401,
119 "nonLeaseTaxCodeDisplayId": "NL-TAX-001",
120 "nonLeaseExemptionTaxCodeId": 402,
121 "nonLeaseExemptionTaxCodeDisplayId": "NL-TAX-EX-001",
122 "nonLeaseExemptionTaxPercentage": 50,
123 "principalTaxCodeId": 403,
124 "principalTaxCodeDisplayId": "PR-TAX-001",
125 "principalExemptionTaxCodeId": 404,
126 "principalExemptionTaxCodeDisplayId": "PR-TAX-EX-001",
127 "principalExemptionTaxPercentage": 100
128 }
129 }
130 }
131 ],
132 "revisionDisplayId": "REV-2025-01",
133 "termType": "PAYMENT_TERM",
134 "exercise": false,
135 "leaseComponentFinancialTermId": 2025,
136 "revisionId": 3001,
137 "activationGroupDisplayId": "AG-2025-001",
138 "activationGroupId": 4001,
139 "applyIndexation": true,
140 "indexationType": "CPI_LOCAL",
141 "indexationTypeNonLease": "NONE",
142 "consumerPriceIndexCategory": {
143 "id": 101,
144 "displayId": "CPI-2025-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "Consumer Price Index - City A",
152 "city": "New York",
153 "country": "USA",
154 "province": "NY",
155 "erpSystemId": 0
156 },
157 "consumerPriceIndexCategoryNonLease": {
158 "id": 101,
159 "displayId": "CPI-2025-001",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Consumer Price Index - City A",
167 "city": "New York",
168 "country": "USA",
169 "province": "NY",
170 "erpSystemId": 0
171 },
172 "baseIndexationDate": "2025-01-01",
173 "baseIndexationDateNonLease": "2025-01-01",
174 "baseIndexationRate": 2.5,
175 "baseIndexationRateNonLease": 1.8,
176 "referenceIndexationDate": "2026-01-01",
177 "referenceIndexationDateNonLease": "2026-01-01",
178 "referenceIndexationRate": 2.8,
179 "referenceIndexationRateNonLease": 2,
180 "indexationStartDate": "2025-06-01",
181 "indexationStartDateNonLease": "2025-06-01",
182 "indexationLeasePercentage": 3,
183 "indexationNonLeasePercentage": 1.5,
184 "termState": "ACTIVE",
185 "type": "RENT",
186 "numberRangeIdentifierValue": "FT-SEQ-1001",
187 "numberRangeIdentifierType": {
188 "name": "COMPANY_CODE"
189 },
190 "numberRangeType": {
191 "name": "CONTRACT"
192 },
193 "allowsSystemGenerateNewId": true
194 }
195 ],
196 "number": 0,
197 "sort": {
198 "unsorted": false,
199 "sorted": true,
200 "empty": false
201 },
202 "first": true,
203 "last": true,
204 "empty": false
205 }
206}
📄 Description: Data transfer object representing the financial terms associated with a lease or contract within the Nakisa Lease Accounting Suite, detailing the financial obligations and accounting entries relevant to the activation group.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Code identifier for the resource |
message |
string |
false |
write-only |
Contains a descriptive message related to the lease or contract, providing context for the financial obligation or accounting entry within the Nakisa Lease Accounting Suite. |
defaultMessage |
string |
false |
write-only |
Default message to be displayed for lease-related notifications within the Nakisa Lease Accounting Suite, ensuring clarity in contract and financial obligation communications. |
debugMessage |
string |
false |
write-only |
Provides detailed information regarding any issues encountered during the activation of financial terms related to leases and contracts within the Nakisa Lease Accounting Suite. |
errors |
false |
none |
Value for errors field |
|
object |
false |
none |
Value for object field |
Enumerated Values
Attribute |
Value |
|---|---|
code |
API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED |