Activation Group Financial Term

Retrieves A Activation Group Financial Term

HTTP Request

GET /api/v1/activation-group-financial-terms/{id}

📋 Description: Retrieves the financial terms associated with a specific activation group identified by the provided ID, facilitating the management of lease and contract financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group financial term

ResponseActivationGroupFinancialTermDto

Example Responses

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

Update Resource

HTTP Request

PUT /api/v1/activation-group-financial-terms/{id}

📋 Description: Updates the financial terms associated with a specified activation group, ensuring alignment with lease and contract obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ActivationGroupFinancialTermDto

false

Request body containing the updated financial terms associated with a specific activation group, including details on lease obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000004

path

Body Parameters

  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}

Responses

Status

Meaning

Description

Schema

200

OK

Activation group financial term successfully updated.

ResponseActivationGroupFinancialTermDto

Example Responses

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

Partially Update Resource

HTTP Request

PATCH /api/v1/activation-group-financial-terms/{id}

📋 Description: Updates the financial terms associated with a specific activation group, allowing for adjustments to lease contracts and financial obligations within the Nakisa Lease Accounting Suite. This operation ensures that accounting entries reflect the most current financial agreements.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the updated financial terms and conditions associated with the specified activation group, relevant to lease and contract management within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000048

path

body

{"op":"replace","path":"/name","value":"patched contract"}

body

Body Parameters

1{
2  "op": "replace",
3  "path": "/name",
4  "value": "patched contract"
5}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully patched activation group financial term.

ResponseActivationGroupFinancialTermDto

Example Responses

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

Update Resource (With Vendor Payment Splits And Term ID)

HTTP Request

PUT /api/v1/activation-group-financial-terms/vendor-payment-splits/{termId}

📋 Description: Updates the vendor payment splits associated with a specific financial term in the Nakisa Lease Accounting Suite, ensuring accurate alignment of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

termId

path

integer

true

Unique identifier for the term

body

body

VendorPaymentSplitDto

false

Request body containing the vendor payment split details associated with the specified financial term, including allocation percentages and relevant accounting entries.

Example Values

Parameter

Example

Type

termId

10000001

path

Body Parameters

 1[
 2  {
 3    "percentage": 50,
 4    "calculateTax": true,
 5    "taxExemptionPercentage": 10,
 6    "partner": {
 7      "id": 10000012,
 8      "displayId": "0000100003",
 9      "status": {
10        "name": "ACTIVE",
11        "captionKey": "enum.objectStatus.active",
12        "active": true,
13        "caption": "Active"
14      },
15      "name": "TEST VENDOR GB",
16      "erpSystemDisplayId": "FINQ8S-300"
17    },
18    "partnerRole": {
19      "id": 10000004,
20      "displayId": "40",
21      "status": {
22        "name": "ACTIVE",
23        "captionKey": "enum.objectStatus.active",
24        "active": true,
25        "caption": "Active"
26      },
27      "name": "Lessor"
28    },
29    "taxCodeDetermination": {
30      "id": 101,
31      "displayId": "TX-2025-001",
32      "companyId": 1001,
33      "partnerId": 0,
34      "taxJurisdictionId": 2001,
35      "taxJurisdictionDisplayId": "US-NY",
36      "defaultTaxCodeId": 301,
37      "defaultTaxCodeDisplayId": "TAX-001",
38      "defaultExemptionTaxCodeId": 302,
39      "defaultExemptionTaxCodeDisplayId": "TAX-EX-001",
40      "defaultExemptionPercentage": 100,
41      "mapping": {
42        "isLeaseExpense": true,
43        "nonLeaseTaxCodeId": 401,
44        "nonLeaseTaxCodeDisplayId": "NL-TAX-001",
45        "nonLeaseExemptionTaxCodeId": 402,
46        "nonLeaseExemptionTaxCodeDisplayId": "NL-TAX-EX-001",
47        "nonLeaseExemptionTaxPercentage": 50,
48        "principalTaxCodeId": 403,
49        "principalTaxCodeDisplayId": "PR-TAX-001",
50        "principalExemptionTaxCodeId": 404,
51        "principalExemptionTaxCodeDisplayId": "PR-TAX-EX-001",
52        "principalExemptionTaxPercentage": 100
53      }
54    }
55  }
56]

Responses

Status

Meaning

Description

Schema

200

OK

Activation group financial term successfully updated.

ResponseActivationGroupFinancialTermDto

Example Responses

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

Update Resource (With Exercise)

HTTP Request

PUT /api/v1/activation-group-financial-terms/exercise

📋 Description: Updates the financial terms associated with an activation group, ensuring accurate reflection of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupFinancialTermExerciseDto

false

Request body containing the financial terms and conditions related to the exercise of lease contracts, including relevant accounting entries and obligations.

Body Parameters

1[
2  {
3    "activationGroupRevisionId": 10000001,
4    "termId": 20000001,
5    "exercise": true
6  }
7]

Responses

Status

Meaning

Description

Schema

200

OK

Activation group financial term successfully updated.

ResponseListActivationGroupFinancialTermDto

Example Responses

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

Create Or Update An Activation Group Financial Term

HTTP Request

PUT /api/v1/activation-group-financial-terms/createOrUpdate

📋 Description: Updates or creates financial terms associated with activation groups within the Nakisa Lease Accounting Suite, ensuring accurate alignment of lease contracts and financial obligations for effective accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupFinancialTermDto

false

Request body containing the financial terms data for lease contracts, including details on financial obligations and accounting entries, for creation or update in the Nakisa Lease Accounting Suite.

Body Parameters

  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}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the activation group financial term.

ResponseActivationGroupFinancialTermDto

Example Responses

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

Search Activation Group Financial Term

HTTP Request

POST /api/v1/activation-group-financial-terms/search

📋 Description: Submits a request to search for activation group financial terms within the Nakisa Lease Accounting Suite, enabling users to identify relevant lease and contract financial obligations for accurate accounting entries.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

ActivationGroupFinancialTermDtoFilter

false

Request body containing search criteria for financial terms related to lease contracts and accounting entries within the Nakisa Lease Accounting Suite.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

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

Search results successfully returned.

PageActivationGroupFinancialTermDto

Example Responses

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

List All Activation Group Financial Terms

HTTP Request

GET /api/v1/activation-group-financial-terms

📋 Description: Retrieves financial terms associated with activation groups within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and their corresponding financial obligations.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the response should be paginated, facilitating the retrieval of financial terms related to lease contracts and accounting entries within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of activation group financial term.

PageActivationGroupFinancialTermDto

Example Responses

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

Retrieves An Activation Group Financial Terms

HTTP Request

GET /api/v1/activation-group-financial-terms/revision/{revisionId}

📋 Description: Retrieves the financial terms associated with a specific revision of an activation group within the Nakisa Lease Accounting Suite, facilitating accurate lease and contract management in relation to financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

revisionId

path

integer

true

Unique identifier for the revision

Example Values

Parameter

Example

Type

revisionId

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group financial terms

ResponsePageActivationGroupFinancialTermDto

Example Responses

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

Retrieves The Base Indexation Rate

HTTP Request

GET /api/v1/activation-group-financial-terms/base-indexation-rate/{termId}/{baseIndexationDate}

📋 Description: Retrieves the base indexation rate for a specified financial term associated with a lease or contract, based on the provided term ID and base indexation date, facilitating accurate accounting entries and financial obligation assessments.

Parameters

Name

In

Type

Required

Description

termId

path

integer

true

Unique identifier for the term

baseIndexationDate

path

string

true

Date of the base indexation

Example Values

Parameter

Example

Type

termId

10000004

path

baseIndexationDate

2025-09-10

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group classification

number

Example Responses

10.1