Lease Component Financial Term

Retrieves A Specific Lease Component Financial Term

HTTP Request

GET /api/v1/lease-component-financial-terms/{id}

📋 Description: Retrieves the financial terms associated with a specific lease component, providing essential details for contract management and accounting entries related to financial obligations.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved lease component financial terms.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Update Resource

HTTP Request

PUT /api/v1/lease-component-financial-terms/{id}

📋 Description: Updates the financial terms of a specified lease component within the Nakisa Lease Accounting Suite, allowing users to modify contract details and financial obligations associated with accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

LeaseComponentFinancialTermDto

false

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

Example Values

Parameter

Example

Type

id

10000086

path

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "1495040334-20250828-085516",
 4  "name": "Base Rent",
 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": 1,
18  "amountFrequency": "ONE_TIME",
19  "paymentMode": "ADVANCE",
20  "paymentCalculationMode": "ONE_TIME",
21  "firstSpecialPaymentDate": "2019-08-24",
22  "lastSpecialPaymentDate": "2019-08-24",
23  "paymentFrequency": "MONTHLY",
24  "firstPaymentDate": "2019-08-24",
25  "lastPaymentDate": "2019-08-24",
26  "firstPaymentAmount": 0.1,
27  "lastPaymentAmount": 0.1,
28  "months": 1,
29  "days": 1,
30  "notificationDate": "2019-08-24",
31  "monthEnd": false,
32  "paymentTiming": "START_OF_DAY",
33  "escalatingRent": false,
34  "stopEscalatingAtZero": false,
35  "escalatingRentAmount": 0,
36  "escalatingRentType": "FIXED",
37  "escalationFrequencyOffset": 0,
38  "escalationFrequency": 0,
39  "escalationFastForward": 0,
40  "termStartDate": "2019-08-24",
41  "termEndDate": "2019-08-24",
42  "expenseCategoryType": "PAYMENT",
43  "spreadingFrequency": "NONE",
44  "firstSpreadingAmount": 0.1,
45  "lastSpreadingAmount": 0.1,
46  "valid": true,
47  "parentFinancialTermId": 0,
48  "termStatus": "EDITABLE",
49  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
50  "vendorPaymentSplits": [],
51  "revisionDisplayId": "2107425785-20250828-083848",
52  "termType": "PAYMENT_TERM",
53  "revisionId": 10000006,
54  "leaseComponentId": 10000006,
55  "leaseComponentDisplayId": "LC-100000100",
56  "type": "LEASE",
57  "numberRangeIdentifierValue": "string",
58  "numberRangeIdentifierType": {
59    "name": "COMPANY_CODE"
60  },
61  "numberRangeType": {
62    "name": "CONTRACT"
63  },
64  "allowsSystemGenerateNewId": false
65}

Responses

Status

Meaning

Description

Schema

200

OK

lease component financial term successfully updated.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Delete A Lease Component Financial Term

HTTP Request

DELETE /api/v1/lease-component-financial-terms/{id}

📋 Description: Deletes a specified lease component financial term by its unique identifier, ensuring the accurate management of 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

10000085

path

Responses

Status

Meaning

Description

Schema

200

OK

The lease component financial term successfully deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Updates Specified Lease Component Financial Term

HTTP Request

PATCH /api/v1/lease-component-financial-terms/{id}

📋 Description: Updates the financial terms of a specified lease component, allowing for adjustments to contract obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing updated financial terms and conditions for the specified lease component, reflecting changes in contractual obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000081

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 the lease component financial term.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Create Or Update A Lease Component Financial Term

HTTP Request

PUT /api/v1/lease-component-financial-terms/createOrUpdate

📋 Description: Creates or updates financial terms associated with lease components, ensuring accurate representation of financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentFinancialTermDto

false

Request body containing the financial terms data for lease components, including details on lease obligations and accounting entries for effective contract management.

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "1495040334-20250828-085516",
 4  "name": "Base Rent",
 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": 1,
18  "amountFrequency": "ONE_TIME",
19  "paymentMode": "ADVANCE",
20  "paymentCalculationMode": "ONE_TIME",
21  "firstSpecialPaymentDate": "2019-08-24",
22  "lastSpecialPaymentDate": "2019-08-24",
23  "paymentFrequency": "MONTHLY",
24  "firstPaymentDate": "2019-08-24",
25  "lastPaymentDate": "2019-08-24",
26  "firstPaymentAmount": 0.1,
27  "lastPaymentAmount": 0.1,
28  "months": 1,
29  "days": 1,
30  "notificationDate": "2019-08-24",
31  "monthEnd": false,
32  "paymentTiming": "START_OF_DAY",
33  "escalatingRent": false,
34  "stopEscalatingAtZero": false,
35  "escalatingRentAmount": 0,
36  "escalatingRentType": "FIXED",
37  "escalationFrequencyOffset": 0,
38  "escalationFrequency": 0,
39  "escalationFastForward": 0,
40  "termStartDate": "2019-08-24",
41  "termEndDate": "2019-08-24",
42  "expenseCategoryType": "PAYMENT",
43  "spreadingFrequency": "NONE",
44  "firstSpreadingAmount": 0.1,
45  "lastSpreadingAmount": 0.1,
46  "valid": true,
47  "parentFinancialTermId": 0,
48  "termStatus": "EDITABLE",
49  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
50  "vendorPaymentSplits": [],
51  "revisionDisplayId": "2107425785-20250828-083848",
52  "termType": "PAYMENT_TERM",
53  "revisionId": 10000006,
54  "leaseComponentId": 10000006,
55  "leaseComponentDisplayId": "LC-100000100",
56  "type": "LEASE",
57  "numberRangeIdentifierValue": "string",
58  "numberRangeIdentifierType": {
59    "name": "COMPANY_CODE"
60  },
61  "numberRangeType": {
62    "name": "CONTRACT"
63  },
64  "allowsSystemGenerateNewId": false
65}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the lease component financial term.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Creates Or Updates Lease Component Financial Terms In Bulk

HTTP Request

PUT /api/v1/lease-component-financial-terms/createOrUpdate/bulk

📋 Description: Updates or creates multiple lease component financial terms in bulk, facilitating efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentFinancialTermDto

false

Request body containing bulk lease component financial terms data, including details on lease contracts, financial obligations, and associated accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "1495040334-20250828-085516",
 5    "name": "Base Rent",
 6    "expenseCategory": {
 7      "id": 101,
 8      "displayId": "EC-2025-001",
 9      "status": {
10        "name": "ACTIVE",
11        "captionKey": "enum.objectStatus.active",
12        "active": true,
13        "caption": "Active"
14      },
15      "name": "Lease Payment",
16      "expenseCategoryType": "PAYMENT"
17    },
18    "amount": 1,
19    "amountFrequency": "ONE_TIME",
20    "paymentMode": "ADVANCE",
21    "paymentCalculationMode": "ONE_TIME",
22    "firstSpecialPaymentDate": "2019-08-24",
23    "lastSpecialPaymentDate": "2019-08-24",
24    "paymentFrequency": "MONTHLY",
25    "firstPaymentDate": "2019-08-24",
26    "lastPaymentDate": "2019-08-24",
27    "firstPaymentAmount": 0.1,
28    "lastPaymentAmount": 0.1,
29    "months": 1,
30    "days": 1,
31    "notificationDate": "2019-08-24",
32    "monthEnd": false,
33    "paymentTiming": "START_OF_DAY",
34    "escalatingRent": false,
35    "stopEscalatingAtZero": false,
36    "escalatingRentAmount": 0,
37    "escalatingRentType": "FIXED",
38    "escalationFrequencyOffset": 0,
39    "escalationFrequency": 0,
40    "escalationFastForward": 0,
41    "termStartDate": "2019-08-24",
42    "termEndDate": "2019-08-24",
43    "expenseCategoryType": "PAYMENT",
44    "spreadingFrequency": "NONE",
45    "firstSpreadingAmount": 0.1,
46    "lastSpreadingAmount": 0.1,
47    "valid": true,
48    "parentFinancialTermId": 0,
49    "termStatus": "EDITABLE",
50    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
51    "vendorPaymentSplits": [],
52    "revisionDisplayId": "2107425785-20250828-083848",
53    "termType": "PAYMENT_TERM",
54    "revisionId": 10000006,
55    "leaseComponentId": 10000006,
56    "leaseComponentDisplayId": "LC-100000100",
57    "type": "LEASE",
58    "numberRangeIdentifierValue": "string",
59    "numberRangeIdentifierType": {
60      "name": "COMPANY_CODE"
61    },
62    "numberRangeType": {
63      "name": "CONTRACT"
64    },
65    "allowsSystemGenerateNewId": false
66  }
67]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component financial term.

ResponseListLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "1495040334-20250828-085516",
10      "name": "Base Rent",
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": 1,
24      "amountFrequency": "ONE_TIME",
25      "paymentMode": "ADVANCE",
26      "paymentCalculationMode": "ONE_TIME",
27      "firstSpecialPaymentDate": "2019-08-24",
28      "lastSpecialPaymentDate": "2019-08-24",
29      "paymentFrequency": "MONTHLY",
30      "firstPaymentDate": "2019-08-24",
31      "lastPaymentDate": "2019-08-24",
32      "firstPaymentAmount": 0.1,
33      "lastPaymentAmount": 0.1,
34      "months": 1,
35      "days": 1,
36      "notificationDate": "2019-08-24",
37      "monthEnd": false,
38      "paymentTiming": "START_OF_DAY",
39      "escalatingRent": false,
40      "stopEscalatingAtZero": false,
41      "escalatingRentAmount": 0,
42      "escalatingRentType": "FIXED",
43      "escalationFrequencyOffset": 0,
44      "escalationFrequency": 0,
45      "escalationFastForward": 0,
46      "termStartDate": "2019-08-24",
47      "termEndDate": "2019-08-24",
48      "expenseCategoryType": "PAYMENT",
49      "spreadingFrequency": "NONE",
50      "firstSpreadingAmount": 0.1,
51      "lastSpreadingAmount": 0.1,
52      "valid": true,
53      "parentFinancialTermId": 0,
54      "termStatus": "EDITABLE",
55      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
56      "vendorPaymentSplits": [],
57      "revisionDisplayId": "2107425785-20250828-083848",
58      "termType": "PAYMENT_TERM",
59      "revisionId": 10000006,
60      "leaseComponentId": 10000006,
61      "leaseComponentDisplayId": "LC-100000100",
62      "type": "LEASE",
63      "numberRangeIdentifierValue": "string",
64      "numberRangeIdentifierType": {
65        "name": "COMPANY_CODE"
66      },
67      "numberRangeType": {
68        "name": "CONTRACT"
69      },
70      "allowsSystemGenerateNewId": false
71    }
72  ]
73}

Updates Lease Component Financial Term In Bulk

HTTP Request

PUT /api/v1/lease-component-financial-terms/bulk

📋 Description: Updates multiple lease component financial terms in bulk, enabling efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentFinancialTermDto

false

Request body containing a collection of lease component financial terms, including details on financial obligations and accounting entries for bulk updates within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "1495040334-20250828-085516",
 5    "name": "Base Rent",
 6    "expenseCategory": {
 7      "id": 101,
 8      "displayId": "EC-2025-001",
 9      "status": {
10        "name": "ACTIVE",
11        "captionKey": "enum.objectStatus.active",
12        "active": true,
13        "caption": "Active"
14      },
15      "name": "Lease Payment",
16      "expenseCategoryType": "PAYMENT"
17    },
18    "amount": 1,
19    "amountFrequency": "ONE_TIME",
20    "paymentMode": "ADVANCE",
21    "paymentCalculationMode": "ONE_TIME",
22    "firstSpecialPaymentDate": "2019-08-24",
23    "lastSpecialPaymentDate": "2019-08-24",
24    "paymentFrequency": "MONTHLY",
25    "firstPaymentDate": "2019-08-24",
26    "lastPaymentDate": "2019-08-24",
27    "firstPaymentAmount": 0.1,
28    "lastPaymentAmount": 0.1,
29    "months": 1,
30    "days": 1,
31    "notificationDate": "2019-08-24",
32    "monthEnd": false,
33    "paymentTiming": "START_OF_DAY",
34    "escalatingRent": false,
35    "stopEscalatingAtZero": false,
36    "escalatingRentAmount": 0,
37    "escalatingRentType": "FIXED",
38    "escalationFrequencyOffset": 0,
39    "escalationFrequency": 0,
40    "escalationFastForward": 0,
41    "termStartDate": "2019-08-24",
42    "termEndDate": "2019-08-24",
43    "expenseCategoryType": "PAYMENT",
44    "spreadingFrequency": "NONE",
45    "firstSpreadingAmount": 0.1,
46    "lastSpreadingAmount": 0.1,
47    "valid": true,
48    "parentFinancialTermId": 0,
49    "termStatus": "EDITABLE",
50    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
51    "vendorPaymentSplits": [],
52    "revisionDisplayId": "2107425785-20250828-083848",
53    "termType": "PAYMENT_TERM",
54    "revisionId": 10000006,
55    "leaseComponentId": 10000006,
56    "leaseComponentDisplayId": "LC-100000100",
57    "type": "LEASE",
58    "numberRangeIdentifierValue": "string",
59    "numberRangeIdentifierType": {
60      "name": "COMPANY_CODE"
61    },
62    "numberRangeType": {
63      "name": "CONTRACT"
64    },
65    "allowsSystemGenerateNewId": false
66  }
67]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component financial terms.

ResponseListLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "1495040334-20250828-085516",
10      "name": "Base Rent",
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": 1,
24      "amountFrequency": "ONE_TIME",
25      "paymentMode": "ADVANCE",
26      "paymentCalculationMode": "ONE_TIME",
27      "firstSpecialPaymentDate": "2019-08-24",
28      "lastSpecialPaymentDate": "2019-08-24",
29      "paymentFrequency": "MONTHLY",
30      "firstPaymentDate": "2019-08-24",
31      "lastPaymentDate": "2019-08-24",
32      "firstPaymentAmount": 0.1,
33      "lastPaymentAmount": 0.1,
34      "months": 1,
35      "days": 1,
36      "notificationDate": "2019-08-24",
37      "monthEnd": false,
38      "paymentTiming": "START_OF_DAY",
39      "escalatingRent": false,
40      "stopEscalatingAtZero": false,
41      "escalatingRentAmount": 0,
42      "escalatingRentType": "FIXED",
43      "escalationFrequencyOffset": 0,
44      "escalationFrequency": 0,
45      "escalationFastForward": 0,
46      "termStartDate": "2019-08-24",
47      "termEndDate": "2019-08-24",
48      "expenseCategoryType": "PAYMENT",
49      "spreadingFrequency": "NONE",
50      "firstSpreadingAmount": 0.1,
51      "lastSpreadingAmount": 0.1,
52      "valid": true,
53      "parentFinancialTermId": 0,
54      "termStatus": "EDITABLE",
55      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
56      "vendorPaymentSplits": [],
57      "revisionDisplayId": "2107425785-20250828-083848",
58      "termType": "PAYMENT_TERM",
59      "revisionId": 10000006,
60      "leaseComponentId": 10000006,
61      "leaseComponentDisplayId": "LC-100000100",
62      "type": "LEASE",
63      "numberRangeIdentifierValue": "string",
64      "numberRangeIdentifierType": {
65        "name": "COMPANY_CODE"
66      },
67      "numberRangeType": {
68        "name": "CONTRACT"
69      },
70      "allowsSystemGenerateNewId": false
71    }
72  ]
73}

Creates Multiple Lease Component Financial Term In Bulk.

HTTP Request

POST /api/v1/lease-component-financial-terms/bulk

📋 Description: Facilitates the bulk creation of financial terms for lease components, enabling efficient management of contractual obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentFinancialTermDto

false

Request body containing a collection of lease component financial terms, including associated contract details and financial obligations, for bulk processing within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "1495040334-20250828-085516",
 5    "name": "Base Rent",
 6    "expenseCategory": {
 7      "id": 101,
 8      "displayId": "EC-2025-001",
 9      "status": {
10        "name": "ACTIVE",
11        "captionKey": "enum.objectStatus.active",
12        "active": true,
13        "caption": "Active"
14      },
15      "name": "Lease Payment",
16      "expenseCategoryType": "PAYMENT"
17    },
18    "amount": 1,
19    "amountFrequency": "ONE_TIME",
20    "paymentMode": "ADVANCE",
21    "paymentCalculationMode": "ONE_TIME",
22    "firstSpecialPaymentDate": "2019-08-24",
23    "lastSpecialPaymentDate": "2019-08-24",
24    "paymentFrequency": "MONTHLY",
25    "firstPaymentDate": "2019-08-24",
26    "lastPaymentDate": "2019-08-24",
27    "firstPaymentAmount": 0.1,
28    "lastPaymentAmount": 0.1,
29    "months": 1,
30    "days": 1,
31    "notificationDate": "2019-08-24",
32    "monthEnd": false,
33    "paymentTiming": "START_OF_DAY",
34    "escalatingRent": false,
35    "stopEscalatingAtZero": false,
36    "escalatingRentAmount": 0,
37    "escalatingRentType": "FIXED",
38    "escalationFrequencyOffset": 0,
39    "escalationFrequency": 0,
40    "escalationFastForward": 0,
41    "termStartDate": "2019-08-24",
42    "termEndDate": "2019-08-24",
43    "expenseCategoryType": "PAYMENT",
44    "spreadingFrequency": "NONE",
45    "firstSpreadingAmount": 0.1,
46    "lastSpreadingAmount": 0.1,
47    "valid": true,
48    "parentFinancialTermId": 0,
49    "termStatus": "EDITABLE",
50    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
51    "vendorPaymentSplits": [],
52    "revisionDisplayId": "2107425785-20250828-083848",
53    "termType": "PAYMENT_TERM",
54    "revisionId": 10000006,
55    "leaseComponentId": 10000006,
56    "leaseComponentDisplayId": "LC-100000100",
57    "type": "LEASE",
58    "numberRangeIdentifierValue": "string",
59    "numberRangeIdentifierType": {
60      "name": "COMPANY_CODE"
61    },
62    "numberRangeType": {
63      "name": "CONTRACT"
64    },
65    "allowsSystemGenerateNewId": false
66  }
67]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created all lease component financial term.

ResponseListLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "1495040334-20250828-085516",
10      "name": "Base Rent",
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": 1,
24      "amountFrequency": "ONE_TIME",
25      "paymentMode": "ADVANCE",
26      "paymentCalculationMode": "ONE_TIME",
27      "firstSpecialPaymentDate": "2019-08-24",
28      "lastSpecialPaymentDate": "2019-08-24",
29      "paymentFrequency": "MONTHLY",
30      "firstPaymentDate": "2019-08-24",
31      "lastPaymentDate": "2019-08-24",
32      "firstPaymentAmount": 0.1,
33      "lastPaymentAmount": 0.1,
34      "months": 1,
35      "days": 1,
36      "notificationDate": "2019-08-24",
37      "monthEnd": false,
38      "paymentTiming": "START_OF_DAY",
39      "escalatingRent": false,
40      "stopEscalatingAtZero": false,
41      "escalatingRentAmount": 0,
42      "escalatingRentType": "FIXED",
43      "escalationFrequencyOffset": 0,
44      "escalationFrequency": 0,
45      "escalationFastForward": 0,
46      "termStartDate": "2019-08-24",
47      "termEndDate": "2019-08-24",
48      "expenseCategoryType": "PAYMENT",
49      "spreadingFrequency": "NONE",
50      "firstSpreadingAmount": 0.1,
51      "lastSpreadingAmount": 0.1,
52      "valid": true,
53      "parentFinancialTermId": 0,
54      "termStatus": "EDITABLE",
55      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
56      "vendorPaymentSplits": [],
57      "revisionDisplayId": "2107425785-20250828-083848",
58      "termType": "PAYMENT_TERM",
59      "revisionId": 10000006,
60      "leaseComponentId": 10000006,
61      "leaseComponentDisplayId": "LC-100000100",
62      "type": "LEASE",
63      "numberRangeIdentifierValue": "string",
64      "numberRangeIdentifierType": {
65        "name": "COMPANY_CODE"
66      },
67      "numberRangeType": {
68        "name": "CONTRACT"
69      },
70      "allowsSystemGenerateNewId": false
71    }
72  ]
73}

Deletes Multiple Lease Component Financial Term By Their IDs.

HTTP Request

DELETE /api/v1/lease-component-financial-terms/bulk

📋 Description: Deletes multiple financial terms associated with lease components in the Nakisa Lease Accounting Suite, streamlining the management of financial obligations and ensuring accurate accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of lease component financial term identifiers to facilitate the bulk deletion of associated financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  10000013
3]

Responses

Status

Meaning

Description

Schema

200

OK

lease component financial terms deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

List All Lease Component Financial Terms

HTTP Request

GET /api/v1/lease-component-financial-terms

📋 Description: Retrieves financial terms associated with lease components, enabling users to access detailed information regarding contractual obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the lease component financial terms query should be paginated, facilitating efficient retrieval of large datasets related to lease contracts and financial obligations.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease component financial terms.

PageLeaseComponentFinancialTermDto

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": 10000001,
21      "displayId": "1495040334-20250828-085516",
22      "name": "Base Rent",
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": 1,
36      "amountFrequency": "ONE_TIME",
37      "paymentMode": "ADVANCE",
38      "paymentCalculationMode": "ONE_TIME",
39      "firstSpecialPaymentDate": "2019-08-24",
40      "lastSpecialPaymentDate": "2019-08-24",
41      "paymentFrequency": "MONTHLY",
42      "firstPaymentDate": "2019-08-24",
43      "lastPaymentDate": "2019-08-24",
44      "firstPaymentAmount": 0.1,
45      "lastPaymentAmount": 0.1,
46      "months": 1,
47      "days": 1,
48      "notificationDate": "2019-08-24",
49      "monthEnd": false,
50      "paymentTiming": "START_OF_DAY",
51      "escalatingRent": false,
52      "stopEscalatingAtZero": false,
53      "escalatingRentAmount": 0,
54      "escalatingRentType": "FIXED",
55      "escalationFrequencyOffset": 0,
56      "escalationFrequency": 0,
57      "escalationFastForward": 0,
58      "termStartDate": "2019-08-24",
59      "termEndDate": "2019-08-24",
60      "expenseCategoryType": "PAYMENT",
61      "spreadingFrequency": "NONE",
62      "firstSpreadingAmount": 0.1,
63      "lastSpreadingAmount": 0.1,
64      "valid": true,
65      "parentFinancialTermId": 0,
66      "termStatus": "EDITABLE",
67      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
68      "vendorPaymentSplits": [],
69      "revisionDisplayId": "2107425785-20250828-083848",
70      "termType": "PAYMENT_TERM",
71      "revisionId": 10000006,
72      "leaseComponentId": 10000006,
73      "leaseComponentDisplayId": "LC-100000100",
74      "type": "LEASE",
75      "numberRangeIdentifierValue": "string",
76      "numberRangeIdentifierType": {
77        "name": "COMPANY_CODE"
78      },
79      "numberRangeType": {
80        "name": "CONTRACT"
81      },
82      "allowsSystemGenerateNewId": false
83    }
84  ],
85  "number": 0,
86  "sort": {
87    "unsorted": false,
88    "sorted": true,
89    "empty": false
90  },
91  "first": true,
92  "last": true,
93  "empty": false
94}

Create A Lease Component Financial Term

HTTP Request

POST /api/v1/lease-component-financial-terms

📋 Description: Creates a new lease component financial term within the Nakisa Lease Accounting Suite, facilitating the management of financial obligations associated with lease contracts and ensuring accurate accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentFinancialTermDto

false

Request body containing the financial terms and conditions associated with a lease component, including details on contractual obligations and accounting entries.

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "1495040334-20250828-085516",
 4  "name": "Base Rent",
 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": 1,
18  "amountFrequency": "ONE_TIME",
19  "paymentMode": "ADVANCE",
20  "paymentCalculationMode": "ONE_TIME",
21  "firstSpecialPaymentDate": "2019-08-24",
22  "lastSpecialPaymentDate": "2019-08-24",
23  "paymentFrequency": "MONTHLY",
24  "firstPaymentDate": "2019-08-24",
25  "lastPaymentDate": "2019-08-24",
26  "firstPaymentAmount": 0.1,
27  "lastPaymentAmount": 0.1,
28  "months": 1,
29  "days": 1,
30  "notificationDate": "2019-08-24",
31  "monthEnd": false,
32  "paymentTiming": "START_OF_DAY",
33  "escalatingRent": false,
34  "stopEscalatingAtZero": false,
35  "escalatingRentAmount": 0,
36  "escalatingRentType": "FIXED",
37  "escalationFrequencyOffset": 0,
38  "escalationFrequency": 0,
39  "escalationFastForward": 0,
40  "termStartDate": "2019-08-24",
41  "termEndDate": "2019-08-24",
42  "expenseCategoryType": "PAYMENT",
43  "spreadingFrequency": "NONE",
44  "firstSpreadingAmount": 0.1,
45  "lastSpreadingAmount": 0.1,
46  "valid": true,
47  "parentFinancialTermId": 0,
48  "termStatus": "EDITABLE",
49  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
50  "vendorPaymentSplits": [],
51  "revisionDisplayId": "2107425785-20250828-083848",
52  "termType": "PAYMENT_TERM",
53  "revisionId": 10000006,
54  "leaseComponentId": 10000006,
55  "leaseComponentDisplayId": "LC-100000100",
56  "type": "LEASE",
57  "numberRangeIdentifierValue": "string",
58  "numberRangeIdentifierType": {
59    "name": "COMPANY_CODE"
60  },
61  "numberRangeType": {
62    "name": "CONTRACT"
63  },
64  "allowsSystemGenerateNewId": false
65}

Responses

Status

Meaning

Description

Schema

200

OK

lease component financial term successfully created.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Search Lease Component Financial Terms

HTTP Request

POST /api/v1/lease-component-financial-terms/search

📋 Description: Submits a search request for lease component financial terms, enabling users to identify relevant financial obligations and accounting entries associated with leases and contracts within the Nakisa Lease Accounting Suite.

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

LeaseComponentFinancialTermDtoFilter

false

Request body containing search criteria for lease component financial terms, including relevant contract details and financial obligations for accurate accounting entries.

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    10000001,
 4    10000002
 5  ],
 6  "idEqual": 10000001,
 7  "idLike": "1000%",
 8  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10  "createdByLike": "%super.admin%",
11  "createdByEqual": "super.admin@nakisa.com",
12  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14  "modifiedByLike": "%super.admin%",
15  "modifiedByEqual": "super.admin@nakisa.com",
16  "displayIdIn": [
17    "1495040334-20250828-085516",
18    "2107425785-20250828-083848"
19  ],
20  "displayIdLike": "1495%",
21  "nameLike": "%Rent%",
22  "expenseCategoryIdIn": [
23    10000001,
24    10000002
25  ],
26  "expenseCategoryDisplayIdIn": [
27    "Base Rent",
28    "Operating Cost"
29  ],
30  "amountGreaterThanOrEqual": 1000,
31  "amountLessThanOrEqual": 5000,
32  "amountFrequencyIn": [
33    "ONE_TIME",
34    "YEAR"
35  ],
36  "paymentModeIn": [
37    "ADVANCE",
38    "ARREARS"
39  ],
40  "paymentCalculationModeIn": [
41    "ONE_TIME",
42    "DAILY"
43  ],
44  "paymentFrequencyIn": [
45    "ANNUALLY",
46    "MONTHLY"
47  ],
48  "firstPaymentDateGreaterThanOrEqual": "2025-08-01",
49  "firstPaymentDateLessThanOrEqual": "2025-09-01",
50  "lastPaymentDateGreaterThanOrEqual": "2025-09-01",
51  "lastPaymentDateLessThanOrEqual": "2025-12-31",
52  "notificationDateGreaterThanOrEqual": "2025-07-01",
53  "notificationDateLessThanOrEqual": "2025-07-31",
54  "termStartDateGreaterThanOrEqual": "2025-08-01",
55  "termStartDateLessThanOrEqual": "2025-09-01",
56  "termEndDateGreaterThanOrEqual": "2025-12-01",
57  "termEndDateLessThanOrEqual": "2026-01-01",
58  "expenseCategoryTypeIn": [
59    "PAYMENT",
60    "CASUALTY"
61  ],
62  "expenseCategoryTypeEqual": "PAYMENT",
63  "revisionDisplayIdIn": [
64    "2107425785-20250828-083848"
65  ],
66  "revisionIdIn": [
67    10000006,
68    10000007
69  ],
70  "leaseComponentIdIn": [
71    10000006,
72    10000007
73  ],
74  "leaseComponentDisplayIdIn": [
75    "LC-100000100",
76    "LC-100000101"
77  ],
78  "type": "LEASE"
79}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageLeaseComponentFinancialTermDto

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": 10000001,
21      "displayId": "1495040334-20250828-085516",
22      "name": "Base Rent",
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": 1,
36      "amountFrequency": "ONE_TIME",
37      "paymentMode": "ADVANCE",
38      "paymentCalculationMode": "ONE_TIME",
39      "firstSpecialPaymentDate": "2019-08-24",
40      "lastSpecialPaymentDate": "2019-08-24",
41      "paymentFrequency": "MONTHLY",
42      "firstPaymentDate": "2019-08-24",
43      "lastPaymentDate": "2019-08-24",
44      "firstPaymentAmount": 0.1,
45      "lastPaymentAmount": 0.1,
46      "months": 1,
47      "days": 1,
48      "notificationDate": "2019-08-24",
49      "monthEnd": false,
50      "paymentTiming": "START_OF_DAY",
51      "escalatingRent": false,
52      "stopEscalatingAtZero": false,
53      "escalatingRentAmount": 0,
54      "escalatingRentType": "FIXED",
55      "escalationFrequencyOffset": 0,
56      "escalationFrequency": 0,
57      "escalationFastForward": 0,
58      "termStartDate": "2019-08-24",
59      "termEndDate": "2019-08-24",
60      "expenseCategoryType": "PAYMENT",
61      "spreadingFrequency": "NONE",
62      "firstSpreadingAmount": 0.1,
63      "lastSpreadingAmount": 0.1,
64      "valid": true,
65      "parentFinancialTermId": 0,
66      "termStatus": "EDITABLE",
67      "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
68      "vendorPaymentSplits": [],
69      "revisionDisplayId": "2107425785-20250828-083848",
70      "termType": "PAYMENT_TERM",
71      "revisionId": 10000006,
72      "leaseComponentId": 10000006,
73      "leaseComponentDisplayId": "LC-100000100",
74      "type": "LEASE",
75      "numberRangeIdentifierValue": "string",
76      "numberRangeIdentifierType": {
77        "name": "COMPANY_CODE"
78      },
79      "numberRangeType": {
80        "name": "CONTRACT"
81      },
82      "allowsSystemGenerateNewId": false
83    }
84  ],
85  "number": 0,
86  "sort": {
87    "unsorted": false,
88    "sorted": true,
89    "empty": false
90  },
91  "first": true,
92  "last": true,
93  "empty": false
94}

Clone A Lease Component Financial Term

HTTP Request

POST /api/v1/lease-component-financial-terms/clone/{id}

📋 Description: Clones the financial terms associated with a specified lease component, facilitating the efficient management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite. This operation streamlines the process of creating new accounting entries based on existing terms.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

Lease component financial term successfully cloned.

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}

Bulk Clone Lease Component Financial Terms

HTTP Request

POST /api/v1/lease-component-financial-terms/clone/bulk

📋 Description: Clones multiple lease component financial terms in bulk, facilitating efficient management of lease contracts and their associated financial obligations within the Nakisa Lease Accounting Suite. This operation streamlines the process of replicating accounting entries, ensuring consistency and accuracy across multiple leases.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing the financial terms data for multiple lease components to facilitate bulk cloning of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

Lease component financial terms successfully cloned in bulk.

Inline

Example Responses

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "1495040334-20250828-085516",
 5    "name": "Base Rent",
 6    "expenseCategory": {
 7      "id": 101,
 8      "displayId": "EC-2025-001",
 9      "status": {
10        "name": "ACTIVE",
11        "captionKey": "enum.objectStatus.active",
12        "active": true,
13        "caption": "Active"
14      },
15      "name": "Lease Payment",
16      "expenseCategoryType": "PAYMENT"
17    },
18    "amount": 1,
19    "amountFrequency": "ONE_TIME",
20    "paymentMode": "ADVANCE",
21    "paymentCalculationMode": "ONE_TIME",
22    "firstSpecialPaymentDate": "2019-08-24",
23    "lastSpecialPaymentDate": "2019-08-24",
24    "paymentFrequency": "MONTHLY",
25    "firstPaymentDate": "2019-08-24",
26    "lastPaymentDate": "2019-08-24",
27    "firstPaymentAmount": 0.1,
28    "lastPaymentAmount": 0.1,
29    "months": 1,
30    "days": 1,
31    "notificationDate": "2019-08-24",
32    "monthEnd": false,
33    "paymentTiming": "START_OF_DAY",
34    "escalatingRent": false,
35    "stopEscalatingAtZero": false,
36    "escalatingRentAmount": 0,
37    "escalatingRentType": "FIXED",
38    "escalationFrequencyOffset": 0,
39    "escalationFrequency": 0,
40    "escalationFastForward": 0,
41    "termStartDate": "2019-08-24",
42    "termEndDate": "2019-08-24",
43    "expenseCategoryType": "PAYMENT",
44    "spreadingFrequency": "NONE",
45    "firstSpreadingAmount": 0.1,
46    "lastSpreadingAmount": 0.1,
47    "valid": true,
48    "parentFinancialTermId": 0,
49    "termStatus": "EDITABLE",
50    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
51    "vendorPaymentSplits": [],
52    "revisionDisplayId": "2107425785-20250828-083848",
53    "termType": "PAYMENT_TERM",
54    "revisionId": 10000006,
55    "leaseComponentId": 10000006,
56    "leaseComponentDisplayId": "LC-100000100",
57    "type": "LEASE",
58    "numberRangeIdentifierValue": "string",
59    "numberRangeIdentifierType": {
60      "name": "COMPANY_CODE"
61    },
62    "numberRangeType": {
63      "name": "CONTRACT"
64    },
65    "allowsSystemGenerateNewId": false
66  }
67]

Response Schema

Status Code 200

Array of cloned lease component financial terms

Name

Type

Required

Restrictions

Description

anonymous

[LeaseComponentFinancialTermDto]

false

none

Array of cloned lease component financial terms

» 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

ExpenseCategoryLite

false

none

Data transfer object representing a simplified categorization of expenses related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating efficient tracking and management of financial obligations and accounting entries.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

»» status

Status

false

none

Represents the object status with localized captions and activity state.

»»» name

string

false

none

Enum name representing the object status.

»»» captionKey

string

false

none

Localization key for the object status caption.

»»» active

boolean

false

none

Indicates whether the status is active.

»»» caption

string

false

none

Localized caption of the object status.

»» name

string

false

none

Name of the resource

»» expenseCategoryType

string

false

none

Type of the expense category

» amount

number(double)

false

none

Amount value

» amountFrequency

string

false

none

Specifies the frequency at which lease payments are due, facilitating accurate tracking of financial obligations within the Nakisa Lease Accounting Suite.

» paymentMode

string

false

none

Indicates the method of payment for financial obligations associated with a lease contract within the Nakisa Lease Accounting Suite.

» paymentCalculationMode

string

false

none

Specifies the method used to calculate payments associated with lease contracts, ensuring accurate financial obligations and accounting entries 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 frequency of payment obligations associated with a lease contract 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 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

integer(int32)

false

none

Numeric value representing escalationFrequency

» escalationFastForward

integer(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 lease payments are spread over the term of the contract, impacting financial obligations and accounting entries 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

Specifies the reason for locking a lease contract, ensuring clarity in the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

» vendorPaymentSplits

[VendorPaymentSplitDto]

false

none

List of vendorPaymentSplits items

»» percentage

number(double)

false

none

Percentage value

»» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

»» taxExemptionPercentage

number(double)

false

none

Percentage of tax exemption

»» partner

PartnerLite

false

none

Data transfer object representing a simplified partner profile within the Nakisa Lease Accounting Suite, encompassing essential details related to lease agreements, financial obligations, and accounting entries.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» status

Status

false

none

Represents the object status with localized captions and activity state.

»»» name

string

false

none

Name of the resource

»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified partner role within the Nakisa Lease Accounting Suite, encompassing essential attributes related to lease agreements, contracts, and financial obligations for streamlined accounting entry management.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» status

Status

false

none

Represents the object status with localized captions and activity state.

»»» name

string

false

none

Name of the resource

»» taxCodeDetermination

TaxCodeDeterminationDetails

false

none

Data structure representing the details of tax code determination related to leases and contracts within the Nakisa Lease Accounting Suite, facilitating accurate financial obligation tracking and accounting entry management.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» companyId

integer(int64)

false

none

Unique identifier for the company

»»» partnerId

integer(int64)

false

none

none

»»» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

»»» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

»»» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

»»» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

»»» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

»»» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

»»» defaultExemptionPercentage

number(double)

false

none

Percentage of default exemption

»»» mapping

TaxCodeExpenseCategoryMappingDetails

false

none

Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Lease Accounting Suite, facilitating accurate accounting entries and compliance with financial obligations related to leases and contracts.

»»»» isLeaseExpense

boolean

false

none

Whether the resource is lease expense

»»»» nonLeaseTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease tax code

»»»» nonLeaseTaxCodeDisplayId

string

false

none

Unique identifier for the non lease tax code display

»»»» nonLeaseExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease exemption tax code

»»»» nonLeaseExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the non lease exemption tax code display

»»»» nonLeaseExemptionTaxPercentage

number(double)

false

none

Percentage of non lease exemption tax

»»»» principalTaxCodeId

integer(int64)

false

none

Unique identifier for the principal tax code

»»»» principalTaxCodeDisplayId

string

false

none

Unique identifier for the principal tax code display

»»»» principalExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the principal exemption tax code

»»»» principalExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the principal exemption tax code display

»»»» principalExemptionTaxPercentage

number(double)

false

none

Percentage of principal exemption tax

» revisionDisplayId

string

false

none

Unique identifier for the revision display

» termType

string

false

none

Type of the term

» revisionId

integer(int64)

false

none

Unique identifier for the revision

» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

» leaseComponentDisplayId

string

false

none

Unique identifier for the lease component display

» type

string

false

none

Type of the resource

» numberRangeIdentifierValue

string

false

none

Unique string identifier representing a specific range of numbers associated with lease components in the Nakisa Lease Accounting Suite.

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data structure representing a numerical range identifier used in the Nakisa Lease Accounting Suite to categorize and manage leases, contracts, and financial obligations within accounting entries.

»» name

string

true

none

Name of the resource

» numberRangeType

INumberRangeType

false

none

Data structure representing a numerical range utilized in the Nakisa Lease Accounting Suite, essential for defining financial obligations and accounting entries associated with leases and contracts.

»» name

string

true

none

Name of the resource

» 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

lockReason

ENDS_BEFORE_MODIFICATION_DATE, EXERCISED_IN_ACTIVATION_GROUP, NO_PAYMENT

name

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

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

termStatus

EDITABLE, LOCKED

termType

INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM

Retrieves A Lease Component Financial Term

HTTP Request

GET /api/v1/lease-component-financial-terms/revision/{revisionId}

📋 Description: Retrieves the financial terms associated with a specific lease component revision, identified by the provided revision ID, to facilitate accurate accounting entries and contract management within the Nakisa Lease Accounting Suite.

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 lease component financial term

ResponseLeaseComponentFinancialTermDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "1495040334-20250828-085516",
 9    "name": "Base Rent",
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": 1,
23    "amountFrequency": "ONE_TIME",
24    "paymentMode": "ADVANCE",
25    "paymentCalculationMode": "ONE_TIME",
26    "firstSpecialPaymentDate": "2019-08-24",
27    "lastSpecialPaymentDate": "2019-08-24",
28    "paymentFrequency": "MONTHLY",
29    "firstPaymentDate": "2019-08-24",
30    "lastPaymentDate": "2019-08-24",
31    "firstPaymentAmount": 0.1,
32    "lastPaymentAmount": 0.1,
33    "months": 1,
34    "days": 1,
35    "notificationDate": "2019-08-24",
36    "monthEnd": false,
37    "paymentTiming": "START_OF_DAY",
38    "escalatingRent": false,
39    "stopEscalatingAtZero": false,
40    "escalatingRentAmount": 0,
41    "escalatingRentType": "FIXED",
42    "escalationFrequencyOffset": 0,
43    "escalationFrequency": 0,
44    "escalationFastForward": 0,
45    "termStartDate": "2019-08-24",
46    "termEndDate": "2019-08-24",
47    "expenseCategoryType": "PAYMENT",
48    "spreadingFrequency": "NONE",
49    "firstSpreadingAmount": 0.1,
50    "lastSpreadingAmount": 0.1,
51    "valid": true,
52    "parentFinancialTermId": 0,
53    "termStatus": "EDITABLE",
54    "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
55    "vendorPaymentSplits": [],
56    "revisionDisplayId": "2107425785-20250828-083848",
57    "termType": "PAYMENT_TERM",
58    "revisionId": 10000006,
59    "leaseComponentId": 10000006,
60    "leaseComponentDisplayId": "LC-100000100",
61    "type": "LEASE",
62    "numberRangeIdentifierValue": "string",
63    "numberRangeIdentifierType": {
64      "name": "COMPANY_CODE"
65    },
66    "numberRangeType": {
67      "name": "CONTRACT"
68    },
69    "allowsSystemGenerateNewId": false
70  }
71}