ResponseActivationGroupFinancialTermDto

Example Json Object

  1{
  2  "code": "OK",
  3  "message": "Successfully retrieved an activation group subscription.",
  4  "defaultMessage": "Operation completed successfully.",
  5  "debugMessage": "No errors occurred during the query execution.",
  6  "errors": {
  7    "all": []
  8  },
  9  "object": {
 10    "id": 101,
 11    "displayId": "FT-2025-001",
 12    "name": "Monthly Rent Payment",
 13    "expenseCategory": {
 14      "id": 101,
 15      "displayId": "EC-2025-001",
 16      "status": {
 17        "name": "ACTIVE",
 18        "captionKey": "enum.objectStatus.active",
 19        "active": true,
 20        "caption": "Active"
 21      },
 22      "name": "Lease Payment",
 23      "expenseCategoryType": "PAYMENT"
 24    },
 25    "amount": 12000.5,
 26    "amountFrequency": "MONTH",
 27    "paymentMode": "ADVANCE",
 28    "paymentCalculationMode": "PAYMENT_FOR_MONTH",
 29    "firstSpecialPaymentDate": "2025-03-01",
 30    "lastSpecialPaymentDate": "2025-08-01",
 31    "paymentFrequency": "MONTHLY",
 32    "firstPaymentDate": "2025-01-15",
 33    "lastPaymentDate": "2030-01-15",
 34    "firstPaymentAmount": 15000,
 35    "lastPaymentAmount": 10000,
 36    "months": 60,
 37    "days": 15,
 38    "notificationDate": "2025-12-01",
 39    "monthEnd": true,
 40    "paymentTiming": "END_OF_DAY",
 41    "escalatingRent": true,
 42    "stopEscalatingAtZero": false,
 43    "escalatingRentAmount": 500,
 44    "escalatingRentType": "PERCENTAGE",
 45    "escalationFrequencyOffset": 12,
 46    "escalationFrequency": "string",
 47    "escalationFastForward": true,
 48    "termStartDate": "2025-01-01",
 49    "termEndDate": "2030-01-01",
 50    "expenseCategoryType": "PAYMENT",
 51    "spreadingFrequency": "STRAIGHT_LINE",
 52    "firstSpreadingAmount": 2000,
 53    "lastSpreadingAmount": 2500,
 54    "valid": true,
 55    "parentFinancialTermId": 55,
 56    "termStatus": "LOCKED",
 57    "lockReason": "NO_PAYMENT",
 58    "vendorPaymentSplits": [
 59      {
 60        "percentage": 50,
 61        "calculateTax": true,
 62        "taxExemptionPercentage": 10,
 63        "partner": {
 64          "id": 10000012,
 65          "displayId": "0000100003",
 66          "status": {
 67            "name": "ACTIVE",
 68            "captionKey": "enum.objectStatus.active",
 69            "active": true,
 70            "caption": "Active"
 71          },
 72          "name": "TEST VENDOR GB",
 73          "erpSystemDisplayId": "FINQ8S-300"
 74        },
 75        "partnerRole": {
 76          "id": 10000004,
 77          "displayId": "40",
 78          "status": {
 79            "name": "ACTIVE",
 80            "captionKey": "enum.objectStatus.active",
 81            "active": true,
 82            "caption": "Active"
 83          },
 84          "name": "Lessor"
 85        },
 86        "taxCodeDetermination": {
 87          "id": 101,
 88          "displayId": "TX-2025-001",
 89          "companyId": 1001,
 90          "partnerId": 0,
 91          "taxJurisdictionId": 2001,
 92          "taxJurisdictionDisplayId": "US-NY",
 93          "defaultTaxCodeId": 301,
 94          "defaultTaxCodeDisplayId": "TAX-001",
 95          "defaultExemptionTaxCodeId": 302,
 96          "defaultExemptionTaxCodeDisplayId": "TAX-EX-001",
 97          "defaultExemptionPercentage": 100,
 98          "mapping": {
 99            "isLeaseExpense": true,
100            "nonLeaseTaxCodeId": 401,
101            "nonLeaseTaxCodeDisplayId": "NL-TAX-001",
102            "nonLeaseExemptionTaxCodeId": 402,
103            "nonLeaseExemptionTaxCodeDisplayId": "NL-TAX-EX-001",
104            "nonLeaseExemptionTaxPercentage": 50,
105            "principalTaxCodeId": 403,
106            "principalTaxCodeDisplayId": "PR-TAX-001",
107            "principalExemptionTaxCodeId": 404,
108            "principalExemptionTaxCodeDisplayId": "PR-TAX-EX-001",
109            "principalExemptionTaxPercentage": 100
110          }
111        }
112      }
113    ],
114    "revisionDisplayId": "REV-2025-01",
115    "termType": "PAYMENT_TERM",
116    "exercise": false,
117    "leaseComponentFinancialTermId": 2025,
118    "revisionId": 3001,
119    "activationGroupDisplayId": "AG-2025-001",
120    "activationGroupId": 4001,
121    "applyIndexation": true,
122    "indexationType": "CPI_LOCAL",
123    "indexationTypeNonLease": "NONE",
124    "consumerPriceIndexCategory": {
125      "id": 101,
126      "displayId": "CPI-2025-001",
127      "status": {
128        "name": "ACTIVE",
129        "captionKey": "enum.objectStatus.active",
130        "active": true,
131        "caption": "Active"
132      },
133      "name": "Consumer Price Index - City A",
134      "city": "New York",
135      "country": "USA",
136      "province": "NY",
137      "erpSystemId": 0
138    },
139    "consumerPriceIndexCategoryNonLease": {
140      "id": 101,
141      "displayId": "CPI-2025-001",
142      "status": {
143        "name": "ACTIVE",
144        "captionKey": "enum.objectStatus.active",
145        "active": true,
146        "caption": "Active"
147      },
148      "name": "Consumer Price Index - City A",
149      "city": "New York",
150      "country": "USA",
151      "province": "NY",
152      "erpSystemId": 0
153    },
154    "baseIndexationDate": "2025-01-01",
155    "baseIndexationDateNonLease": "2025-01-01",
156    "baseIndexationRate": 2.5,
157    "baseIndexationRateNonLease": 1.8,
158    "referenceIndexationDate": "2026-01-01",
159    "referenceIndexationDateNonLease": "2026-01-01",
160    "referenceIndexationRate": 2.8,
161    "referenceIndexationRateNonLease": 2,
162    "indexationStartDate": "2025-06-01",
163    "indexationStartDateNonLease": "2025-06-01",
164    "indexationLeasePercentage": 3,
165    "indexationNonLeasePercentage": 1.5,
166    "termState": "ACTIVE",
167    "type": "RENT",
168    "numberRangeIdentifierValue": "FT-SEQ-1001",
169    "numberRangeIdentifierType": {
170      "name": "COMPANY_CODE"
171    },
172    "numberRangeType": {
173      "name": "CONTRACT"
174    },
175    "allowsSystemGenerateNewId": true
176  }
177}

📄 Description: Data transfer object representing the financial terms associated with an activation group within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and their corresponding financial obligations in accounting entries.

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 financial terms of a lease or contract, providing essential context for accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

defaultMessage

string

false

write-only

Default message associated with the financial terms of a lease or contract, providing essential context for accounting entries and financial obligations.

debugMessage

string

false

write-only

Provides detailed information regarding any issues encountered during the processing of lease-related financial terms within the Nakisa Lease Accounting Suite.

errors

Errors

false

none

Value for errors field

object

ActivationGroupFinancialTermDto

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