ActivationGroupFinancialTermDto¶
Example Json Object
1{
2 "id": 101,
3 "displayId": "FT-2025-001",
4 "name": "Monthly Rent Payment",
5 "expenseCategory": {
6 "id": 101,
7 "displayId": "EC-2025-001",
8 "status": {
9 "name": "ACTIVE",
10 "captionKey": "enum.objectStatus.active",
11 "active": true,
12 "caption": "Active"
13 },
14 "name": "Lease Payment",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "amount": 12000.5,
18 "amountFrequency": "MONTH",
19 "paymentMode": "ADVANCE",
20 "paymentCalculationMode": "PAYMENT_FOR_MONTH",
21 "firstSpecialPaymentDate": "2025-03-01",
22 "lastSpecialPaymentDate": "2025-08-01",
23 "paymentFrequency": "MONTHLY",
24 "firstPaymentDate": "2025-01-15",
25 "lastPaymentDate": "2030-01-15",
26 "firstPaymentAmount": 15000,
27 "lastPaymentAmount": 10000,
28 "months": 60,
29 "days": 15,
30 "notificationDate": "2025-12-01",
31 "monthEnd": true,
32 "paymentTiming": "END_OF_DAY",
33 "escalatingRent": true,
34 "stopEscalatingAtZero": false,
35 "escalatingRentAmount": 500,
36 "escalatingRentType": "PERCENTAGE",
37 "escalationFrequencyOffset": 12,
38 "escalationFrequency": "string",
39 "escalationFastForward": true,
40 "termStartDate": "2025-01-01",
41 "termEndDate": "2030-01-01",
42 "expenseCategoryType": "PAYMENT",
43 "spreadingFrequency": "STRAIGHT_LINE",
44 "firstSpreadingAmount": 2000,
45 "lastSpreadingAmount": 2500,
46 "valid": true,
47 "parentFinancialTermId": 55,
48 "termStatus": "LOCKED",
49 "lockReason": "NO_PAYMENT",
50 "vendorPaymentSplits": [
51 {
52 "percentage": 50,
53 "calculateTax": true,
54 "taxExemptionPercentage": 10,
55 "partner": {
56 "id": 10000012,
57 "displayId": "0000100003",
58 "status": {
59 "name": "ACTIVE",
60 "captionKey": "enum.objectStatus.active",
61 "active": true,
62 "caption": "Active"
63 },
64 "name": "TEST VENDOR GB",
65 "erpSystemDisplayId": "FINQ8S-300"
66 },
67 "partnerRole": {
68 "id": 10000004,
69 "displayId": "40",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "Lessor"
77 },
78 "taxCodeDetermination": {
79 "id": 101,
80 "displayId": "TX-2025-001",
81 "companyId": 1001,
82 "partnerId": 0,
83 "taxJurisdictionId": 2001,
84 "taxJurisdictionDisplayId": "US-NY",
85 "defaultTaxCodeId": 301,
86 "defaultTaxCodeDisplayId": "TAX-001",
87 "defaultExemptionTaxCodeId": 302,
88 "defaultExemptionTaxCodeDisplayId": "TAX-EX-001",
89 "defaultExemptionPercentage": 100,
90 "mapping": {
91 "isLeaseExpense": true,
92 "nonLeaseTaxCodeId": 401,
93 "nonLeaseTaxCodeDisplayId": "NL-TAX-001",
94 "nonLeaseExemptionTaxCodeId": 402,
95 "nonLeaseExemptionTaxCodeDisplayId": "NL-TAX-EX-001",
96 "nonLeaseExemptionTaxPercentage": 50,
97 "principalTaxCodeId": 403,
98 "principalTaxCodeDisplayId": "PR-TAX-001",
99 "principalExemptionTaxCodeId": 404,
100 "principalExemptionTaxCodeDisplayId": "PR-TAX-EX-001",
101 "principalExemptionTaxPercentage": 100
102 }
103 }
104 }
105 ],
106 "revisionDisplayId": "REV-2025-01",
107 "termType": "PAYMENT_TERM",
108 "exercise": false,
109 "leaseComponentFinancialTermId": 2025,
110 "revisionId": 3001,
111 "activationGroupDisplayId": "AG-2025-001",
112 "activationGroupId": 4001,
113 "applyIndexation": true,
114 "indexationType": "CPI_LOCAL",
115 "indexationTypeNonLease": "NONE",
116 "consumerPriceIndexCategory": {
117 "id": 101,
118 "displayId": "CPI-2025-001",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Consumer Price Index - City A",
126 "city": "New York",
127 "country": "USA",
128 "province": "NY",
129 "erpSystemId": 0
130 },
131 "consumerPriceIndexCategoryNonLease": {
132 "id": 101,
133 "displayId": "CPI-2025-001",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "Consumer Price Index - City A",
141 "city": "New York",
142 "country": "USA",
143 "province": "NY",
144 "erpSystemId": 0
145 },
146 "baseIndexationDate": "2025-01-01",
147 "baseIndexationDateNonLease": "2025-01-01",
148 "baseIndexationRate": 2.5,
149 "baseIndexationRateNonLease": 1.8,
150 "referenceIndexationDate": "2026-01-01",
151 "referenceIndexationDateNonLease": "2026-01-01",
152 "referenceIndexationRate": 2.8,
153 "referenceIndexationRateNonLease": 2,
154 "indexationStartDate": "2025-06-01",
155 "indexationStartDateNonLease": "2025-06-01",
156 "indexationLeasePercentage": 3,
157 "indexationNonLeasePercentage": 1.5,
158 "termState": "ACTIVE",
159 "type": "RENT",
160 "numberRangeIdentifierValue": "FT-SEQ-1001",
161 "numberRangeIdentifierType": {
162 "name": "COMPANY_CODE"
163 },
164 "numberRangeType": {
165 "name": "CONTRACT"
166 },
167 "allowsSystemGenerateNewId": true
168}
📄 Description: Data transfer object representing the financial terms associated with an activation group within the Nakisa Lease Accounting Suite, encompassing key elements related to leases, contracts, financial obligations, and accounting entries.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
displayId |
string |
false |
none |
Unique identifier for the display |
name |
string |
false |
none |
Name of the resource |
expenseCategory |
false |
none |
Category of the expense |
|
amount |
number(double) |
false |
none |
Amount value |
amountFrequency |
string |
false |
none |
Specifies the frequency at which financial obligations are incurred for a lease or contract within the Nakisa Lease Accounting Suite. |
paymentMode |
string |
false |
none |
Specifies the method of payment associated with a lease or contract, essential for managing financial obligations and accounting entries within the Nakisa Lease Accounting Suite. |
paymentCalculationMode |
string |
false |
none |
Specifies the method used to calculate payments associated with lease contracts and financial obligations within the Nakisa Lease Accounting Suite. |
firstSpecialPaymentDate |
string(date) |
false |
none |
Date of the first special payment |
lastSpecialPaymentDate |
string(date) |
false |
none |
Date of the last special payment |
paymentFrequency |
string |
false |
none |
Specifies the interval at which payments are scheduled to be made for a lease or contract, reflecting the financial obligations within the Nakisa Lease Accounting Suite. |
firstPaymentDate |
string(date) |
false |
none |
Date of the first payment |
lastPaymentDate |
string(date) |
false |
none |
Date of the last payment |
firstPaymentAmount |
number(double) |
false |
none |
Amount of first payment |
lastPaymentAmount |
number(double) |
false |
none |
Amount of last payment |
months |
integer(int64) |
false |
none |
Numeric value representing months |
days |
integer(int32) |
false |
none |
Numeric value representing days |
notificationDate |
string(date) |
false |
none |
Date of the notification |
monthEnd |
boolean |
false |
none |
Boolean flag indicating monthEnd status |
paymentTiming |
string |
false |
none |
Specifies the timing of payment obligations associated with a lease or contract within the Nakisa Lease Accounting Suite. |
escalatingRent |
boolean |
false |
none |
Boolean flag indicating escalatingRent status |
stopEscalatingAtZero |
boolean |
false |
none |
Boolean flag indicating stopEscalatingAtZero status |
escalatingRentAmount |
number(double) |
false |
none |
Amount of escalating rent |
escalatingRentType |
string |
false |
none |
Type of the escalating rent |
escalationFrequencyOffset |
integer(int32) |
false |
none |
Numeric value representing escalationFrequencyOffset |
escalationFrequency |
string(int32) |
false |
none |
Numeric value representing escalationFrequency |
escalationFastForward |
boolean(int32) |
false |
none |
Numeric value representing escalationFastForward |
termStartDate |
string(date) |
false |
none |
Date of the term start |
termEndDate |
string(date) |
false |
none |
Date of the term end |
expenseCategoryType |
string |
false |
none |
Type of the expense category |
spreadingFrequency |
string |
false |
none |
Specifies the frequency at which financial obligations are spread over the duration of a lease or contract within the Nakisa Lease Accounting Suite. |
firstSpreadingAmount |
number(double) |
false |
none |
Amount of first spreading |
lastSpreadingAmount |
number(double) |
false |
none |
Amount of last spreading |
valid |
boolean |
false |
none |
Unique identifier for the lease |
parentFinancialTermId |
integer(int64) |
false |
none |
Unique identifier for the parent financial term |
termStatus |
string |
false |
none |
Status of the term |
lockReason |
string |
false |
none |
Describes the reason for locking a financial term within the lease accounting framework, ensuring clarity in contract management and compliance with financial obligations. |
vendorPaymentSplits |
false |
none |
List of vendorPaymentSplits items |
|
revisionDisplayId |
string |
false |
none |
Unique identifier for the revision display |
termType |
string |
false |
none |
Type of the term |
exercise |
boolean |
false |
none |
Boolean flag indicating exercise status |
leaseComponentFinancialTermId |
integer(int64) |
false |
none |
Unique identifier for the lease component financial term |
revisionId |
integer(int64) |
false |
none |
Unique identifier for the revision |
activationGroupDisplayId |
string |
false |
none |
Unique identifier for the activation group display |
activationGroupId |
integer(int64) |
false |
none |
Unique identifier for the activation group |
applyIndexation |
boolean |
false |
none |
Boolean flag indicating applyIndexation status |
indexationType |
string |
false |
none |
Type of the indexation |
indexationTypeNonLease |
string |
false |
none |
Specifies the type of indexation applied to non-lease financial obligations within the Nakisa Lease Accounting Suite, ensuring accurate accounting entries and contract management. |
consumerPriceIndexCategory |
false |
none |
Category of the consumer price index |
|
consumerPriceIndexCategoryNonLease |
false |
none |
Value for consumerPriceIndexCategoryNonLease field |
|
baseIndexationDate |
string(date) |
false |
none |
Date of the base indexation |
baseIndexationDateNonLease |
string(date) |
false |
none |
The baseIndexationDateNonLease field represents the date used for indexing financial obligations related to non-lease contracts within the Nakisa Lease Accounting Suite. |
baseIndexationRate |
number(double) |
false |
none |
Rate of base indexation |
baseIndexationRateNonLease |
number(double) |
false |
none |
Value for baseIndexationRateNonLease field |
referenceIndexationDate |
string(date) |
false |
none |
Date of the reference indexation |
referenceIndexationDateNonLease |
string(date) |
false |
none |
Date indicating when the reference indexation for non-lease financial obligations was last updated, relevant for accurate lease accounting and contract management. |
referenceIndexationRate |
number(double) |
false |
none |
Rate of reference indexation |
referenceIndexationRateNonLease |
number(double) |
false |
none |
Value for referenceIndexationRateNonLease field |
indexationStartDate |
string(date) |
false |
none |
Date of the indexation start |
indexationStartDateNonLease |
string(date) |
false |
none |
Specifies the start date for indexation adjustments related to non-lease financial obligations within the Nakisa Lease Accounting Suite. |
indexationLeasePercentage |
number(double) |
false |
none |
Percentage of indexation lease |
indexationNonLeasePercentage |
number(double) |
false |
none |
Percentage of indexation non lease |
termState |
string |
false |
none |
Current state of the lease |
type |
string |
false |
none |
Type of the resource |
numberRangeIdentifierValue |
string |
false |
none |
Unique string identifier representing a specific range of numbers associated with lease contracts and financial obligations within the Nakisa Lease Accounting Suite. |
numberRangeIdentifierType |
false |
none |
Type of the number range identifier |
|
numberRangeType |
false |
none |
Type of the number range |
|
allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
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 |
termState |
ACTIVE, HISTORICAL, INACTIVE |
termStatus |
EDITABLE, LOCKED |
termType |
INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM |