Lease Component

Retrieves A Specific Lease Component

HTTP Request

GET /api/v1/lease-components/{id}

📋 Description: Retrieves detailed information about a specific lease component identified by the provided ID, facilitating effective management of lease contracts and 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

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved lease component.

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}

Update A Specified Lease Component

HTTP Request

PUT /api/v1/lease-components/{id}

📋 Description: Updates the specified lease component in the Nakisa Lease Accounting Suite, allowing for modifications to lease details, contract terms, and associated financial obligations to ensure accurate accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

LeaseComponentDto

false

Request body containing the updated lease component data, including financial obligations and accounting entry details, for the specified lease contract.

Example Values

Parameter

Example

Type

id

10000086

path

Body Parameters

 1{
 2  "id": 10000003,
 3  "displayId": "LC-100000002",
 4  "principalPositionType": {
 5    "name": "LESSEE",
 6    "captionKey": "enum.principalpositiontype.lessee",
 7    "caption": "Lessee"
 8  },
 9  "name": "patched lease component",
10  "description": "string",
11  "bulkAsset": false,
12  "rouStartDate": "2019-08-24",
13  "rouEndDate": "2019-08-24",
14  "approverComment": "string",
15  "fairMarketValue": 0,
16  "allocationNumber": "string",
17  "guaranteedResidualValue": 0,
18  "unitDistributions": [],
19  "revision": {
20    "id": 10000003,
21    "displayId": "0461332847-20250827-142605",
22    "name": "Inception",
23    "inception": true,
24    "revisionType": "ACTIVE",
25    "state": "LC_DEFINE",
26    "approvedBy": "string",
27    "approvedAt": "2019-08-24",
28    "parentRevisionId": 0,
29    "approverComment": "string",
30    "leaseComponentId": 10000003,
31    "leaseComponentDisplayId": "LC-100000002",
32    "leaseComponentName": "Test2 lease component",
33    "contractRevisionId": 10000001,
34    "contractRevisionDisplayId": "1617141777-20250724-115809",
35    "numberRangeIdentifierValue": "string",
36    "numberRangeIdentifierType": {
37      "name": "COMPANY_CODE"
38    },
39    "numberRangeType": {
40      "name": "CONTRACT"
41    },
42    "allowsSystemGenerateNewId": false
43  },
44  "internalAssetClass": {
45    "id": 10000001,
46    "displayId": "IAC-001",
47    "status": {
48      "name": "ACTIVE",
49      "captionKey": "enum.objectStatus.active",
50      "active": true,
51      "caption": "Active"
52    },
53    "name": "Machinery and Equipment",
54    "assetClassType": "PROPERTY",
55    "infiniteUsefulLife": false
56  },
57  "unitOfMeasure": {
58    "id": 10000198,
59    "displayId": "MPA",
60    "status": {
61      "name": "ACTIVE",
62      "captionKey": "enum.objectStatus.active",
63      "active": true,
64      "caption": "Active"
65    },
66    "name": "Megapascal",
67    "erpSystemId": 10000001
68  },
69  "notifications": [],
70  "spreadingFrequency": "NONE",
71  "contractId": 10000001,
72  "contractDisplayId": "CT-100000000",
73  "companyCodeId": 10000002,
74  "companyCodeDisplayId": "string",
75  "userDeterminedLeaseType": {
76    "name": "LEASE_CONTRACT_FIX",
77    "captionKey": "enum.leaseType.fix",
78    "principalPositionType": "LESSEE",
79    "caption": "Fixed Lease Contract"
80  },
81  "endOfTermDate": "2019-08-24",
82  "endOfTermPeriod": "string",
83  "allowsSystemGenerateNewId": false,
84  "transferInfo": {
85    "transferredFromDisplayId": "CTR-00012",
86    "transferredFromRevisionId": 20000001,
87    "transferredToDisplayId": "CTR-00015",
88    "transferredToRevisionId": 20000005
89  },
90  "numberRangeIdentifierValue": "string",
91  "numberRangeIdentifierType": {
92    "name": "COMPANY_CODE"
93  },
94  "numberRangeType": {
95    "name": "CONTRACT"
96  },
97  "type": "LESSEE"
98}

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement successfully updated.

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}

Delete A Lease Component

HTTP Request

DELETE /api/v1/lease-components/{id}

📋 Description: Deletes a specified lease component from the Nakisa Lease Accounting Suite, thereby removing its associated financial obligations and accounting entries from the system.

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

lease component successfully deleted.

ResponseVoid

Example Responses

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

Updates Specified Lease Component

HTTP Request

PATCH /api/v1/lease-components/{id}

📋 Description: Updates the specified lease component within the Nakisa Lease Accounting Suite, allowing for modifications to contract details, financial obligations, or accounting entries as necessary.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the updated lease component data, including financial obligations and contract details, necessary for accurate accounting entries within the Nakisa Lease Accounting Suite.

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 lease component.

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}

Create Or Update A Lease Component

HTTP Request

PUT /api/v1/lease-components/createOrUpdate

📋 Description: Creates or updates lease components within the Nakisa Lease Accounting Suite, ensuring accurate management of financial obligations and accounting entries related to lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentDto

false

Request body containing lease component details, including contract information, financial obligations, and associated accounting entries for creation or update within the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000003,
 3  "displayId": "LC-100000002",
 4  "principalPositionType": {
 5    "name": "LESSEE",
 6    "captionKey": "enum.principalpositiontype.lessee",
 7    "caption": "Lessee"
 8  },
 9  "name": "patched lease component",
10  "description": "string",
11  "bulkAsset": false,
12  "rouStartDate": "2019-08-24",
13  "rouEndDate": "2019-08-24",
14  "approverComment": "string",
15  "fairMarketValue": 0,
16  "allocationNumber": "string",
17  "guaranteedResidualValue": 0,
18  "unitDistributions": [],
19  "revision": {
20    "id": 10000003,
21    "displayId": "0461332847-20250827-142605",
22    "name": "Inception",
23    "inception": true,
24    "revisionType": "ACTIVE",
25    "state": "LC_DEFINE",
26    "approvedBy": "string",
27    "approvedAt": "2019-08-24",
28    "parentRevisionId": 0,
29    "approverComment": "string",
30    "leaseComponentId": 10000003,
31    "leaseComponentDisplayId": "LC-100000002",
32    "leaseComponentName": "Test2 lease component",
33    "contractRevisionId": 10000001,
34    "contractRevisionDisplayId": "1617141777-20250724-115809",
35    "numberRangeIdentifierValue": "string",
36    "numberRangeIdentifierType": {
37      "name": "COMPANY_CODE"
38    },
39    "numberRangeType": {
40      "name": "CONTRACT"
41    },
42    "allowsSystemGenerateNewId": false
43  },
44  "internalAssetClass": {
45    "id": 10000001,
46    "displayId": "IAC-001",
47    "status": {
48      "name": "ACTIVE",
49      "captionKey": "enum.objectStatus.active",
50      "active": true,
51      "caption": "Active"
52    },
53    "name": "Machinery and Equipment",
54    "assetClassType": "PROPERTY",
55    "infiniteUsefulLife": false
56  },
57  "unitOfMeasure": {
58    "id": 10000198,
59    "displayId": "MPA",
60    "status": {
61      "name": "ACTIVE",
62      "captionKey": "enum.objectStatus.active",
63      "active": true,
64      "caption": "Active"
65    },
66    "name": "Megapascal",
67    "erpSystemId": 10000001
68  },
69  "notifications": [],
70  "spreadingFrequency": "NONE",
71  "contractId": 10000001,
72  "contractDisplayId": "CT-100000000",
73  "companyCodeId": 10000002,
74  "companyCodeDisplayId": "string",
75  "userDeterminedLeaseType": {
76    "name": "LEASE_CONTRACT_FIX",
77    "captionKey": "enum.leaseType.fix",
78    "principalPositionType": "LESSEE",
79    "caption": "Fixed Lease Contract"
80  },
81  "endOfTermDate": "2019-08-24",
82  "endOfTermPeriod": "string",
83  "allowsSystemGenerateNewId": false,
84  "transferInfo": {
85    "transferredFromDisplayId": "CTR-00012",
86    "transferredFromRevisionId": 20000001,
87    "transferredToDisplayId": "CTR-00015",
88    "transferredToRevisionId": 20000005
89  },
90  "numberRangeIdentifierValue": "string",
91  "numberRangeIdentifierType": {
92    "name": "COMPANY_CODE"
93  },
94  "numberRangeType": {
95    "name": "CONTRACT"
96  },
97  "type": "LESSEE"
98}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the lease component.

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}

Creates Or Updates Lease Component In Bulk

HTTP Request

PUT /api/v1/lease-components/createOrUpdate/bulk

📋 Description: Creates or updates multiple lease components in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and associated financial obligations for streamlined accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentDto

false

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

Body Parameters

  1[
  2  {
  3    "id": 10000003,
  4    "displayId": "LC-100000002",
  5    "principalPositionType": {
  6      "name": "LESSEE",
  7      "captionKey": "enum.principalpositiontype.lessee",
  8      "caption": "Lessee"
  9    },
 10    "name": "patched lease component",
 11    "description": "string",
 12    "bulkAsset": false,
 13    "rouStartDate": "2019-08-24",
 14    "rouEndDate": "2019-08-24",
 15    "approverComment": "string",
 16    "fairMarketValue": 0,
 17    "allocationNumber": "string",
 18    "guaranteedResidualValue": 0,
 19    "unitDistributions": [],
 20    "revision": {
 21      "id": 10000003,
 22      "displayId": "0461332847-20250827-142605",
 23      "name": "Inception",
 24      "inception": true,
 25      "revisionType": "ACTIVE",
 26      "state": "LC_DEFINE",
 27      "approvedBy": "string",
 28      "approvedAt": "2019-08-24",
 29      "parentRevisionId": 0,
 30      "approverComment": "string",
 31      "leaseComponentId": 10000003,
 32      "leaseComponentDisplayId": "LC-100000002",
 33      "leaseComponentName": "Test2 lease component",
 34      "contractRevisionId": 10000001,
 35      "contractRevisionDisplayId": "1617141777-20250724-115809",
 36      "numberRangeIdentifierValue": "string",
 37      "numberRangeIdentifierType": {
 38        "name": "COMPANY_CODE"
 39      },
 40      "numberRangeType": {
 41        "name": "CONTRACT"
 42      },
 43      "allowsSystemGenerateNewId": false
 44    },
 45    "internalAssetClass": {
 46      "id": 10000001,
 47      "displayId": "IAC-001",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Machinery and Equipment",
 55      "assetClassType": "PROPERTY",
 56      "infiniteUsefulLife": false
 57    },
 58    "unitOfMeasure": {
 59      "id": 10000198,
 60      "displayId": "MPA",
 61      "status": {
 62        "name": "ACTIVE",
 63        "captionKey": "enum.objectStatus.active",
 64        "active": true,
 65        "caption": "Active"
 66      },
 67      "name": "Megapascal",
 68      "erpSystemId": 10000001
 69    },
 70    "notifications": [],
 71    "spreadingFrequency": "NONE",
 72    "contractId": 10000001,
 73    "contractDisplayId": "CT-100000000",
 74    "companyCodeId": 10000002,
 75    "companyCodeDisplayId": "string",
 76    "userDeterminedLeaseType": {
 77      "name": "LEASE_CONTRACT_FIX",
 78      "captionKey": "enum.leaseType.fix",
 79      "principalPositionType": "LESSEE",
 80      "caption": "Fixed Lease Contract"
 81    },
 82    "endOfTermDate": "2019-08-24",
 83    "endOfTermPeriod": "string",
 84    "allowsSystemGenerateNewId": false,
 85    "transferInfo": {
 86      "transferredFromDisplayId": "CTR-00012",
 87      "transferredFromRevisionId": 20000001,
 88      "transferredToDisplayId": "CTR-00015",
 89      "transferredToRevisionId": 20000005
 90    },
 91    "numberRangeIdentifierValue": "string",
 92    "numberRangeIdentifierType": {
 93      "name": "COMPANY_CODE"
 94    },
 95    "numberRangeType": {
 96      "name": "CONTRACT"
 97    },
 98    "type": "LESSEE"
 99  }
100]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component.

ResponseListLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": [
  7    {
  8      "id": 10000003,
  9      "displayId": "LC-100000002",
 10      "principalPositionType": {
 11        "name": "LESSEE",
 12        "captionKey": "enum.principalpositiontype.lessee",
 13        "caption": "Lessee"
 14      },
 15      "name": "patched lease component",
 16      "description": "string",
 17      "bulkAsset": false,
 18      "rouStartDate": "2019-08-24",
 19      "rouEndDate": "2019-08-24",
 20      "approverComment": "string",
 21      "fairMarketValue": 0,
 22      "allocationNumber": "string",
 23      "guaranteedResidualValue": 0,
 24      "unitDistributions": [],
 25      "revision": {
 26        "id": 10000003,
 27        "displayId": "0461332847-20250827-142605",
 28        "name": "Inception",
 29        "inception": true,
 30        "revisionType": "ACTIVE",
 31        "state": "LC_DEFINE",
 32        "approvedBy": "string",
 33        "approvedAt": "2019-08-24",
 34        "parentRevisionId": 0,
 35        "approverComment": "string",
 36        "leaseComponentId": 10000003,
 37        "leaseComponentDisplayId": "LC-100000002",
 38        "leaseComponentName": "Test2 lease component",
 39        "contractRevisionId": 10000001,
 40        "contractRevisionDisplayId": "1617141777-20250724-115809",
 41        "numberRangeIdentifierValue": "string",
 42        "numberRangeIdentifierType": {
 43          "name": "COMPANY_CODE"
 44        },
 45        "numberRangeType": {
 46          "name": "CONTRACT"
 47        },
 48        "allowsSystemGenerateNewId": false
 49      },
 50      "internalAssetClass": {
 51        "id": 10000001,
 52        "displayId": "IAC-001",
 53        "status": {
 54          "name": "ACTIVE",
 55          "captionKey": "enum.objectStatus.active",
 56          "active": true,
 57          "caption": "Active"
 58        },
 59        "name": "Machinery and Equipment",
 60        "assetClassType": "PROPERTY",
 61        "infiniteUsefulLife": false
 62      },
 63      "unitOfMeasure": {
 64        "id": 10000198,
 65        "displayId": "MPA",
 66        "status": {
 67          "name": "ACTIVE",
 68          "captionKey": "enum.objectStatus.active",
 69          "active": true,
 70          "caption": "Active"
 71        },
 72        "name": "Megapascal",
 73        "erpSystemId": 10000001
 74      },
 75      "notifications": [],
 76      "spreadingFrequency": "NONE",
 77      "contractId": 10000001,
 78      "contractDisplayId": "CT-100000000",
 79      "companyCodeId": 10000002,
 80      "companyCodeDisplayId": "string",
 81      "userDeterminedLeaseType": {
 82        "name": "LEASE_CONTRACT_FIX",
 83        "captionKey": "enum.leaseType.fix",
 84        "principalPositionType": "LESSEE",
 85        "caption": "Fixed Lease Contract"
 86      },
 87      "endOfTermDate": "2019-08-24",
 88      "endOfTermPeriod": "string",
 89      "allowsSystemGenerateNewId": false,
 90      "transferInfo": {
 91        "transferredFromDisplayId": "CTR-00012",
 92        "transferredFromRevisionId": 20000001,
 93        "transferredToDisplayId": "CTR-00015",
 94        "transferredToRevisionId": 20000005
 95      },
 96      "numberRangeIdentifierValue": "string",
 97      "numberRangeIdentifierType": {
 98        "name": "COMPANY_CODE"
 99      },
100      "numberRangeType": {
101        "name": "CONTRACT"
102      },
103      "type": "LESSEE"
104    }
105  ]
106}

Updates Lease Component In Bulk

HTTP Request

PUT /api/v1/lease-components/bulk

📋 Description: Updates multiple lease components in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of financial obligations and accounting entries associated with lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentDto

false

Request body containing an array of lease component data, including contract details and financial obligations, for bulk updates within the Nakisa Lease Accounting Suite.

Body Parameters

  1[
  2  {
  3    "id": 10000003,
  4    "displayId": "LC-100000002",
  5    "principalPositionType": {
  6      "name": "LESSEE",
  7      "captionKey": "enum.principalpositiontype.lessee",
  8      "caption": "Lessee"
  9    },
 10    "name": "patched lease component",
 11    "description": "string",
 12    "bulkAsset": false,
 13    "rouStartDate": "2019-08-24",
 14    "rouEndDate": "2019-08-24",
 15    "approverComment": "string",
 16    "fairMarketValue": 0,
 17    "allocationNumber": "string",
 18    "guaranteedResidualValue": 0,
 19    "unitDistributions": [],
 20    "revision": {
 21      "id": 10000003,
 22      "displayId": "0461332847-20250827-142605",
 23      "name": "Inception",
 24      "inception": true,
 25      "revisionType": "ACTIVE",
 26      "state": "LC_DEFINE",
 27      "approvedBy": "string",
 28      "approvedAt": "2019-08-24",
 29      "parentRevisionId": 0,
 30      "approverComment": "string",
 31      "leaseComponentId": 10000003,
 32      "leaseComponentDisplayId": "LC-100000002",
 33      "leaseComponentName": "Test2 lease component",
 34      "contractRevisionId": 10000001,
 35      "contractRevisionDisplayId": "1617141777-20250724-115809",
 36      "numberRangeIdentifierValue": "string",
 37      "numberRangeIdentifierType": {
 38        "name": "COMPANY_CODE"
 39      },
 40      "numberRangeType": {
 41        "name": "CONTRACT"
 42      },
 43      "allowsSystemGenerateNewId": false
 44    },
 45    "internalAssetClass": {
 46      "id": 10000001,
 47      "displayId": "IAC-001",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Machinery and Equipment",
 55      "assetClassType": "PROPERTY",
 56      "infiniteUsefulLife": false
 57    },
 58    "unitOfMeasure": {
 59      "id": 10000198,
 60      "displayId": "MPA",
 61      "status": {
 62        "name": "ACTIVE",
 63        "captionKey": "enum.objectStatus.active",
 64        "active": true,
 65        "caption": "Active"
 66      },
 67      "name": "Megapascal",
 68      "erpSystemId": 10000001
 69    },
 70    "notifications": [],
 71    "spreadingFrequency": "NONE",
 72    "contractId": 10000001,
 73    "contractDisplayId": "CT-100000000",
 74    "companyCodeId": 10000002,
 75    "companyCodeDisplayId": "string",
 76    "userDeterminedLeaseType": {
 77      "name": "LEASE_CONTRACT_FIX",
 78      "captionKey": "enum.leaseType.fix",
 79      "principalPositionType": "LESSEE",
 80      "caption": "Fixed Lease Contract"
 81    },
 82    "endOfTermDate": "2019-08-24",
 83    "endOfTermPeriod": "string",
 84    "allowsSystemGenerateNewId": false,
 85    "transferInfo": {
 86      "transferredFromDisplayId": "CTR-00012",
 87      "transferredFromRevisionId": 20000001,
 88      "transferredToDisplayId": "CTR-00015",
 89      "transferredToRevisionId": 20000005
 90    },
 91    "numberRangeIdentifierValue": "string",
 92    "numberRangeIdentifierType": {
 93      "name": "COMPANY_CODE"
 94    },
 95    "numberRangeType": {
 96      "name": "CONTRACT"
 97    },
 98    "type": "LESSEE"
 99  }
100]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component.

ResponseListLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": [
  7    {
  8      "id": 10000003,
  9      "displayId": "LC-100000002",
 10      "principalPositionType": {
 11        "name": "LESSEE",
 12        "captionKey": "enum.principalpositiontype.lessee",
 13        "caption": "Lessee"
 14      },
 15      "name": "patched lease component",
 16      "description": "string",
 17      "bulkAsset": false,
 18      "rouStartDate": "2019-08-24",
 19      "rouEndDate": "2019-08-24",
 20      "approverComment": "string",
 21      "fairMarketValue": 0,
 22      "allocationNumber": "string",
 23      "guaranteedResidualValue": 0,
 24      "unitDistributions": [],
 25      "revision": {
 26        "id": 10000003,
 27        "displayId": "0461332847-20250827-142605",
 28        "name": "Inception",
 29        "inception": true,
 30        "revisionType": "ACTIVE",
 31        "state": "LC_DEFINE",
 32        "approvedBy": "string",
 33        "approvedAt": "2019-08-24",
 34        "parentRevisionId": 0,
 35        "approverComment": "string",
 36        "leaseComponentId": 10000003,
 37        "leaseComponentDisplayId": "LC-100000002",
 38        "leaseComponentName": "Test2 lease component",
 39        "contractRevisionId": 10000001,
 40        "contractRevisionDisplayId": "1617141777-20250724-115809",
 41        "numberRangeIdentifierValue": "string",
 42        "numberRangeIdentifierType": {
 43          "name": "COMPANY_CODE"
 44        },
 45        "numberRangeType": {
 46          "name": "CONTRACT"
 47        },
 48        "allowsSystemGenerateNewId": false
 49      },
 50      "internalAssetClass": {
 51        "id": 10000001,
 52        "displayId": "IAC-001",
 53        "status": {
 54          "name": "ACTIVE",
 55          "captionKey": "enum.objectStatus.active",
 56          "active": true,
 57          "caption": "Active"
 58        },
 59        "name": "Machinery and Equipment",
 60        "assetClassType": "PROPERTY",
 61        "infiniteUsefulLife": false
 62      },
 63      "unitOfMeasure": {
 64        "id": 10000198,
 65        "displayId": "MPA",
 66        "status": {
 67          "name": "ACTIVE",
 68          "captionKey": "enum.objectStatus.active",
 69          "active": true,
 70          "caption": "Active"
 71        },
 72        "name": "Megapascal",
 73        "erpSystemId": 10000001
 74      },
 75      "notifications": [],
 76      "spreadingFrequency": "NONE",
 77      "contractId": 10000001,
 78      "contractDisplayId": "CT-100000000",
 79      "companyCodeId": 10000002,
 80      "companyCodeDisplayId": "string",
 81      "userDeterminedLeaseType": {
 82        "name": "LEASE_CONTRACT_FIX",
 83        "captionKey": "enum.leaseType.fix",
 84        "principalPositionType": "LESSEE",
 85        "caption": "Fixed Lease Contract"
 86      },
 87      "endOfTermDate": "2019-08-24",
 88      "endOfTermPeriod": "string",
 89      "allowsSystemGenerateNewId": false,
 90      "transferInfo": {
 91        "transferredFromDisplayId": "CTR-00012",
 92        "transferredFromRevisionId": 20000001,
 93        "transferredToDisplayId": "CTR-00015",
 94        "transferredToRevisionId": 20000005
 95      },
 96      "numberRangeIdentifierValue": "string",
 97      "numberRangeIdentifierType": {
 98        "name": "COMPANY_CODE"
 99      },
100      "numberRangeType": {
101        "name": "CONTRACT"
102      },
103      "type": "LESSEE"
104    }
105  ]
106}

Creates Multiple Lease Component In Bulk.

HTTP Request

POST /api/v1/lease-components/bulk

📋 Description: Submits multiple lease components in bulk to the Nakisa Lease Accounting Suite, facilitating efficient management of financial obligations and accounting entries related to lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentDto

false

Request body containing a collection of lease component data, including details on contracts, financial obligations, and associated accounting entries for bulk processing.

Body Parameters

  1[
  2  {
  3    "id": 10000003,
  4    "displayId": "LC-100000002",
  5    "principalPositionType": {
  6      "name": "LESSEE",
  7      "captionKey": "enum.principalpositiontype.lessee",
  8      "caption": "Lessee"
  9    },
 10    "name": "patched lease component",
 11    "description": "string",
 12    "bulkAsset": false,
 13    "rouStartDate": "2019-08-24",
 14    "rouEndDate": "2019-08-24",
 15    "approverComment": "string",
 16    "fairMarketValue": 0,
 17    "allocationNumber": "string",
 18    "guaranteedResidualValue": 0,
 19    "unitDistributions": [],
 20    "revision": {
 21      "id": 10000003,
 22      "displayId": "0461332847-20250827-142605",
 23      "name": "Inception",
 24      "inception": true,
 25      "revisionType": "ACTIVE",
 26      "state": "LC_DEFINE",
 27      "approvedBy": "string",
 28      "approvedAt": "2019-08-24",
 29      "parentRevisionId": 0,
 30      "approverComment": "string",
 31      "leaseComponentId": 10000003,
 32      "leaseComponentDisplayId": "LC-100000002",
 33      "leaseComponentName": "Test2 lease component",
 34      "contractRevisionId": 10000001,
 35      "contractRevisionDisplayId": "1617141777-20250724-115809",
 36      "numberRangeIdentifierValue": "string",
 37      "numberRangeIdentifierType": {
 38        "name": "COMPANY_CODE"
 39      },
 40      "numberRangeType": {
 41        "name": "CONTRACT"
 42      },
 43      "allowsSystemGenerateNewId": false
 44    },
 45    "internalAssetClass": {
 46      "id": 10000001,
 47      "displayId": "IAC-001",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Machinery and Equipment",
 55      "assetClassType": "PROPERTY",
 56      "infiniteUsefulLife": false
 57    },
 58    "unitOfMeasure": {
 59      "id": 10000198,
 60      "displayId": "MPA",
 61      "status": {
 62        "name": "ACTIVE",
 63        "captionKey": "enum.objectStatus.active",
 64        "active": true,
 65        "caption": "Active"
 66      },
 67      "name": "Megapascal",
 68      "erpSystemId": 10000001
 69    },
 70    "notifications": [],
 71    "spreadingFrequency": "NONE",
 72    "contractId": 10000001,
 73    "contractDisplayId": "CT-100000000",
 74    "companyCodeId": 10000002,
 75    "companyCodeDisplayId": "string",
 76    "userDeterminedLeaseType": {
 77      "name": "LEASE_CONTRACT_FIX",
 78      "captionKey": "enum.leaseType.fix",
 79      "principalPositionType": "LESSEE",
 80      "caption": "Fixed Lease Contract"
 81    },
 82    "endOfTermDate": "2019-08-24",
 83    "endOfTermPeriod": "string",
 84    "allowsSystemGenerateNewId": false,
 85    "transferInfo": {
 86      "transferredFromDisplayId": "CTR-00012",
 87      "transferredFromRevisionId": 20000001,
 88      "transferredToDisplayId": "CTR-00015",
 89      "transferredToRevisionId": 20000005
 90    },
 91    "numberRangeIdentifierValue": "string",
 92    "numberRangeIdentifierType": {
 93      "name": "COMPANY_CODE"
 94    },
 95    "numberRangeType": {
 96      "name": "CONTRACT"
 97    },
 98    "type": "LESSEE"
 99  }
100]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created all lease components.

ResponseListLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": [
  7    {
  8      "id": 10000003,
  9      "displayId": "LC-100000002",
 10      "principalPositionType": {
 11        "name": "LESSEE",
 12        "captionKey": "enum.principalpositiontype.lessee",
 13        "caption": "Lessee"
 14      },
 15      "name": "patched lease component",
 16      "description": "string",
 17      "bulkAsset": false,
 18      "rouStartDate": "2019-08-24",
 19      "rouEndDate": "2019-08-24",
 20      "approverComment": "string",
 21      "fairMarketValue": 0,
 22      "allocationNumber": "string",
 23      "guaranteedResidualValue": 0,
 24      "unitDistributions": [],
 25      "revision": {
 26        "id": 10000003,
 27        "displayId": "0461332847-20250827-142605",
 28        "name": "Inception",
 29        "inception": true,
 30        "revisionType": "ACTIVE",
 31        "state": "LC_DEFINE",
 32        "approvedBy": "string",
 33        "approvedAt": "2019-08-24",
 34        "parentRevisionId": 0,
 35        "approverComment": "string",
 36        "leaseComponentId": 10000003,
 37        "leaseComponentDisplayId": "LC-100000002",
 38        "leaseComponentName": "Test2 lease component",
 39        "contractRevisionId": 10000001,
 40        "contractRevisionDisplayId": "1617141777-20250724-115809",
 41        "numberRangeIdentifierValue": "string",
 42        "numberRangeIdentifierType": {
 43          "name": "COMPANY_CODE"
 44        },
 45        "numberRangeType": {
 46          "name": "CONTRACT"
 47        },
 48        "allowsSystemGenerateNewId": false
 49      },
 50      "internalAssetClass": {
 51        "id": 10000001,
 52        "displayId": "IAC-001",
 53        "status": {
 54          "name": "ACTIVE",
 55          "captionKey": "enum.objectStatus.active",
 56          "active": true,
 57          "caption": "Active"
 58        },
 59        "name": "Machinery and Equipment",
 60        "assetClassType": "PROPERTY",
 61        "infiniteUsefulLife": false
 62      },
 63      "unitOfMeasure": {
 64        "id": 10000198,
 65        "displayId": "MPA",
 66        "status": {
 67          "name": "ACTIVE",
 68          "captionKey": "enum.objectStatus.active",
 69          "active": true,
 70          "caption": "Active"
 71        },
 72        "name": "Megapascal",
 73        "erpSystemId": 10000001
 74      },
 75      "notifications": [],
 76      "spreadingFrequency": "NONE",
 77      "contractId": 10000001,
 78      "contractDisplayId": "CT-100000000",
 79      "companyCodeId": 10000002,
 80      "companyCodeDisplayId": "string",
 81      "userDeterminedLeaseType": {
 82        "name": "LEASE_CONTRACT_FIX",
 83        "captionKey": "enum.leaseType.fix",
 84        "principalPositionType": "LESSEE",
 85        "caption": "Fixed Lease Contract"
 86      },
 87      "endOfTermDate": "2019-08-24",
 88      "endOfTermPeriod": "string",
 89      "allowsSystemGenerateNewId": false,
 90      "transferInfo": {
 91        "transferredFromDisplayId": "CTR-00012",
 92        "transferredFromRevisionId": 20000001,
 93        "transferredToDisplayId": "CTR-00015",
 94        "transferredToRevisionId": 20000005
 95      },
 96      "numberRangeIdentifierValue": "string",
 97      "numberRangeIdentifierType": {
 98        "name": "COMPANY_CODE"
 99      },
100      "numberRangeType": {
101        "name": "CONTRACT"
102      },
103      "type": "LESSEE"
104    }
105  ]
106}

Delete Lease Component In Bulk

HTTP Request

DELETE /api/v1/lease-components/bulk

📋 Description: Deletes multiple lease components in bulk from the Nakisa Lease Accounting Suite, streamlining the management of financial obligations and ensuring accurate accounting entries related to lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of lease component identifiers to be deleted, facilitating the management 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

Master agreements successfully deleted.

ResponseVoid

Example Responses

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

List All Lease Components

HTTP Request

GET /api/v1/lease-components

📋 Description: Retrieves a list of lease components associated with financial obligations and accounting entries within the Nakisa Lease Accounting Suite, enabling users to efficiently manage and analyze lease-related data.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the response should be paginated, facilitating the retrieval of lease component data in manageable segments for efficient financial analysis and reporting.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease components.

PageLeaseComponentDto

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": 10000003,
 21      "displayId": "LC-100000002",
 22      "principalPositionType": {
 23        "name": "LESSEE",
 24        "captionKey": "enum.principalpositiontype.lessee",
 25        "caption": "Lessee"
 26      },
 27      "name": "patched lease component",
 28      "description": "string",
 29      "bulkAsset": false,
 30      "rouStartDate": "2019-08-24",
 31      "rouEndDate": "2019-08-24",
 32      "approverComment": "string",
 33      "fairMarketValue": 0,
 34      "allocationNumber": "string",
 35      "guaranteedResidualValue": 0,
 36      "unitDistributions": [],
 37      "revision": {
 38        "id": 10000003,
 39        "displayId": "0461332847-20250827-142605",
 40        "name": "Inception",
 41        "inception": true,
 42        "revisionType": "ACTIVE",
 43        "state": "LC_DEFINE",
 44        "approvedBy": "string",
 45        "approvedAt": "2019-08-24",
 46        "parentRevisionId": 0,
 47        "approverComment": "string",
 48        "leaseComponentId": 10000003,
 49        "leaseComponentDisplayId": "LC-100000002",
 50        "leaseComponentName": "Test2 lease component",
 51        "contractRevisionId": 10000001,
 52        "contractRevisionDisplayId": "1617141777-20250724-115809",
 53        "numberRangeIdentifierValue": "string",
 54        "numberRangeIdentifierType": {
 55          "name": "COMPANY_CODE"
 56        },
 57        "numberRangeType": {
 58          "name": "CONTRACT"
 59        },
 60        "allowsSystemGenerateNewId": false
 61      },
 62      "internalAssetClass": {
 63        "id": 10000001,
 64        "displayId": "IAC-001",
 65        "status": {
 66          "name": "ACTIVE",
 67          "captionKey": "enum.objectStatus.active",
 68          "active": true,
 69          "caption": "Active"
 70        },
 71        "name": "Machinery and Equipment",
 72        "assetClassType": "PROPERTY",
 73        "infiniteUsefulLife": false
 74      },
 75      "unitOfMeasure": {
 76        "id": 10000198,
 77        "displayId": "MPA",
 78        "status": {
 79          "name": "ACTIVE",
 80          "captionKey": "enum.objectStatus.active",
 81          "active": true,
 82          "caption": "Active"
 83        },
 84        "name": "Megapascal",
 85        "erpSystemId": 10000001
 86      },
 87      "notifications": [],
 88      "spreadingFrequency": "NONE",
 89      "contractId": 10000001,
 90      "contractDisplayId": "CT-100000000",
 91      "companyCodeId": 10000002,
 92      "companyCodeDisplayId": "string",
 93      "userDeterminedLeaseType": {
 94        "name": "LEASE_CONTRACT_FIX",
 95        "captionKey": "enum.leaseType.fix",
 96        "principalPositionType": "LESSEE",
 97        "caption": "Fixed Lease Contract"
 98      },
 99      "endOfTermDate": "2019-08-24",
100      "endOfTermPeriod": "string",
101      "allowsSystemGenerateNewId": false,
102      "transferInfo": {
103        "transferredFromDisplayId": "CTR-00012",
104        "transferredFromRevisionId": 20000001,
105        "transferredToDisplayId": "CTR-00015",
106        "transferredToRevisionId": 20000005
107      },
108      "numberRangeIdentifierValue": "string",
109      "numberRangeIdentifierType": {
110        "name": "COMPANY_CODE"
111      },
112      "numberRangeType": {
113        "name": "CONTRACT"
114      },
115      "type": "LESSEE"
116    }
117  ],
118  "number": 0,
119  "sort": {
120    "unsorted": false,
121    "sorted": true,
122    "empty": false
123  },
124  "first": true,
125  "last": true,
126  "empty": false
127}

Create Lease Component

HTTP Request

POST /api/v1/lease-components

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

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentDto

false

Request body containing the lease component details, including contract terms, financial obligations, and associated accounting entries for effective lease management.

Body Parameters

 1{
 2  "id": 10000003,
 3  "displayId": "LC-100000002",
 4  "principalPositionType": {
 5    "name": "LESSEE",
 6    "captionKey": "enum.principalpositiontype.lessee",
 7    "caption": "Lessee"
 8  },
 9  "name": "patched lease component",
10  "description": "string",
11  "bulkAsset": false,
12  "rouStartDate": "2019-08-24",
13  "rouEndDate": "2019-08-24",
14  "approverComment": "string",
15  "fairMarketValue": 0,
16  "allocationNumber": "string",
17  "guaranteedResidualValue": 0,
18  "unitDistributions": [],
19  "revision": {
20    "id": 10000003,
21    "displayId": "0461332847-20250827-142605",
22    "name": "Inception",
23    "inception": true,
24    "revisionType": "ACTIVE",
25    "state": "LC_DEFINE",
26    "approvedBy": "string",
27    "approvedAt": "2019-08-24",
28    "parentRevisionId": 0,
29    "approverComment": "string",
30    "leaseComponentId": 10000003,
31    "leaseComponentDisplayId": "LC-100000002",
32    "leaseComponentName": "Test2 lease component",
33    "contractRevisionId": 10000001,
34    "contractRevisionDisplayId": "1617141777-20250724-115809",
35    "numberRangeIdentifierValue": "string",
36    "numberRangeIdentifierType": {
37      "name": "COMPANY_CODE"
38    },
39    "numberRangeType": {
40      "name": "CONTRACT"
41    },
42    "allowsSystemGenerateNewId": false
43  },
44  "internalAssetClass": {
45    "id": 10000001,
46    "displayId": "IAC-001",
47    "status": {
48      "name": "ACTIVE",
49      "captionKey": "enum.objectStatus.active",
50      "active": true,
51      "caption": "Active"
52    },
53    "name": "Machinery and Equipment",
54    "assetClassType": "PROPERTY",
55    "infiniteUsefulLife": false
56  },
57  "unitOfMeasure": {
58    "id": 10000198,
59    "displayId": "MPA",
60    "status": {
61      "name": "ACTIVE",
62      "captionKey": "enum.objectStatus.active",
63      "active": true,
64      "caption": "Active"
65    },
66    "name": "Megapascal",
67    "erpSystemId": 10000001
68  },
69  "notifications": [],
70  "spreadingFrequency": "NONE",
71  "contractId": 10000001,
72  "contractDisplayId": "CT-100000000",
73  "companyCodeId": 10000002,
74  "companyCodeDisplayId": "string",
75  "userDeterminedLeaseType": {
76    "name": "LEASE_CONTRACT_FIX",
77    "captionKey": "enum.leaseType.fix",
78    "principalPositionType": "LESSEE",
79    "caption": "Fixed Lease Contract"
80  },
81  "endOfTermDate": "2019-08-24",
82  "endOfTermPeriod": "string",
83  "allowsSystemGenerateNewId": false,
84  "transferInfo": {
85    "transferredFromDisplayId": "CTR-00012",
86    "transferredFromRevisionId": 20000001,
87    "transferredToDisplayId": "CTR-00015",
88    "transferredToRevisionId": 20000005
89  },
90  "numberRangeIdentifierValue": "string",
91  "numberRangeIdentifierType": {
92    "name": "COMPANY_CODE"
93  },
94  "numberRangeType": {
95    "name": "CONTRACT"
96  },
97  "type": "LESSEE"
98}

Responses

Status

Meaning

Description

Schema

200

OK

lease component successfully created.

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}

Search Lease Component

HTTP Request

POST /api/v1/lease-components/search

📋 Description: Submits a search request for lease components within the Nakisa Lease Accounting Suite, enabling users to identify relevant leases, contracts, and financial obligations for efficient accounting entry management.

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

LeaseComponentDtoFilter

false

Request body containing search criteria and filters for lease components, including details related to contracts, financial obligations, and 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": 10000003,
 7  "idLike": "10000%",
 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": "admin%",
15  "modifiedByEqual": "super.admin@nakisa.com",
16  "displayIdIn": [
17    "LC-100000001",
18    "LC-100000002"
19  ],
20  "displayIdLike": "LC-%",
21  "nameOrDisplayIdLike": "lease%",
22  "principalPositionTypeEqual": "LESSEE",
23  "nameLike": "patched lease component%",
24  "rouStartDateGreaterThanOrEqual": "2019-08-24T14:15:22Z",
25  "rouStartDateLessThanOrEqual": "2019-08-24T14:15:22Z",
26  "rouEndDateGreaterThanOrEqual": "2019-08-24T14:15:22Z",
27  "rouEndDateLessThanOrEqual": "2019-08-24T14:15:22Z",
28  "revisionIdEqual": 10000003,
29  "revisionTypeEqual": "ACTIVE",
30  "revisionStateEqual": "LC_DEFINE",
31  "internalAssetClassIdIn": [
32    2001,
33    2002
34  ],
35  "internalAssetClassDisplayIdIn": [
36    "IAC-001",
37    "IAC-002"
38  ],
39  "unitOfMeasureIdIn": [
40    10000198
41  ],
42  "unitOfMeasureDisplayIdIn": [
43    "MPA"
44  ],
45  "spreadingFrequencyIn": [
46    "NONE",
47    "PERIODIC"
48  ],
49  "spreadingFrequencyEqual": "NONE",
50  "contractIdIn": [
51    10000001,
52    10000005
53  ],
54  "contractDisplayIdIn": [
55    "CT-100000000",
56    "CT-100000005"
57  ],
58  "companyCodeIdIn": [
59    10000002,
60    10000003
61  ],
62  "companyCodeDisplayIdIn": [
63    "CC-1000002",
64    "CC-1000003"
65  ],
66  "type": "LESSEE"
67}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageLeaseComponentDto

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": 10000003,
 21      "displayId": "LC-100000002",
 22      "principalPositionType": {
 23        "name": "LESSEE",
 24        "captionKey": "enum.principalpositiontype.lessee",
 25        "caption": "Lessee"
 26      },
 27      "name": "patched lease component",
 28      "description": "string",
 29      "bulkAsset": false,
 30      "rouStartDate": "2019-08-24",
 31      "rouEndDate": "2019-08-24",
 32      "approverComment": "string",
 33      "fairMarketValue": 0,
 34      "allocationNumber": "string",
 35      "guaranteedResidualValue": 0,
 36      "unitDistributions": [],
 37      "revision": {
 38        "id": 10000003,
 39        "displayId": "0461332847-20250827-142605",
 40        "name": "Inception",
 41        "inception": true,
 42        "revisionType": "ACTIVE",
 43        "state": "LC_DEFINE",
 44        "approvedBy": "string",
 45        "approvedAt": "2019-08-24",
 46        "parentRevisionId": 0,
 47        "approverComment": "string",
 48        "leaseComponentId": 10000003,
 49        "leaseComponentDisplayId": "LC-100000002",
 50        "leaseComponentName": "Test2 lease component",
 51        "contractRevisionId": 10000001,
 52        "contractRevisionDisplayId": "1617141777-20250724-115809",
 53        "numberRangeIdentifierValue": "string",
 54        "numberRangeIdentifierType": {
 55          "name": "COMPANY_CODE"
 56        },
 57        "numberRangeType": {
 58          "name": "CONTRACT"
 59        },
 60        "allowsSystemGenerateNewId": false
 61      },
 62      "internalAssetClass": {
 63        "id": 10000001,
 64        "displayId": "IAC-001",
 65        "status": {
 66          "name": "ACTIVE",
 67          "captionKey": "enum.objectStatus.active",
 68          "active": true,
 69          "caption": "Active"
 70        },
 71        "name": "Machinery and Equipment",
 72        "assetClassType": "PROPERTY",
 73        "infiniteUsefulLife": false
 74      },
 75      "unitOfMeasure": {
 76        "id": 10000198,
 77        "displayId": "MPA",
 78        "status": {
 79          "name": "ACTIVE",
 80          "captionKey": "enum.objectStatus.active",
 81          "active": true,
 82          "caption": "Active"
 83        },
 84        "name": "Megapascal",
 85        "erpSystemId": 10000001
 86      },
 87      "notifications": [],
 88      "spreadingFrequency": "NONE",
 89      "contractId": 10000001,
 90      "contractDisplayId": "CT-100000000",
 91      "companyCodeId": 10000002,
 92      "companyCodeDisplayId": "string",
 93      "userDeterminedLeaseType": {
 94        "name": "LEASE_CONTRACT_FIX",
 95        "captionKey": "enum.leaseType.fix",
 96        "principalPositionType": "LESSEE",
 97        "caption": "Fixed Lease Contract"
 98      },
 99      "endOfTermDate": "2019-08-24",
100      "endOfTermPeriod": "string",
101      "allowsSystemGenerateNewId": false,
102      "transferInfo": {
103        "transferredFromDisplayId": "CTR-00012",
104        "transferredFromRevisionId": 20000001,
105        "transferredToDisplayId": "CTR-00015",
106        "transferredToRevisionId": 20000005
107      },
108      "numberRangeIdentifierValue": "string",
109      "numberRangeIdentifierType": {
110        "name": "COMPANY_CODE"
111      },
112      "numberRangeType": {
113        "name": "CONTRACT"
114      },
115      "type": "LESSEE"
116    }
117  ],
118  "number": 0,
119  "sort": {
120    "unsorted": false,
121    "sorted": true,
122    "empty": false
123  },
124  "first": true,
125  "last": true,
126  "empty": false
127}

Clone A Lease Component

HTTP Request

POST /api/v1/lease-components/clone/{id}

📋 Description: Clones an existing lease component identified by the specified ID, facilitating the efficient replication of lease-related data for streamlined contract management and financial obligation tracking within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseComponentCloneRequest

false

Request body containing the lease component data to be cloned, including relevant contract details and financial obligations for accurate accounting entries.

Body Parameters

 1{
 2  "name": "Cloned Lease Component - Building A",
 3  "idGenerationType": {
 4    "name": "AUTO",
 5    "captionKey": "enum.idGenerationType.auto",
 6    "caption": "Auto"
 7  },
 8  "contractId": 10000001,
 9  "includeTermsAndConditions": true,
10  "skipVendorPaymentSplitAndValidation": true
11}

Responses

Status

Meaning

Description

Schema

200

OK

Lease component successfully cloned.

ResponseMapStringObject

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "property1": {},
 8    "property2": {}
 9  }
10}

Batch Clone Lease Components

HTTP Request

POST /api/v1/lease-components/batch-clone

📋 Description: Facilitates the batch cloning of lease components within the Nakisa Lease Accounting Suite, enabling users to efficiently replicate multiple lease-related entries, contracts, and financial obligations for streamlined accounting processes.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentBatchCloneRequest

false

Request body containing the lease component details to be cloned, including associated contract information, financial obligations, and accounting entries.

Body Parameters

 1{
 2  "leaseComponentIds": [
 3    10000001,
 4    10000002,
 5    10000003
 6  ],
 7  "contractId": 20000001,
 8  "contractDisplayId": "CT-2025-0001",
 9  "includeTermsAndConditions": true
10}

Responses

Status

Meaning

Description

Schema

200

OK

Lease components successfully cloned in batch.

ResponseListMapStringObject

Example Responses

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

Retrieves Revisions

HTTP Request

GET /api/v1/lease-components/{id}/revisions

📋 Description: Retrieves the revision history for a specific lease component identified by the provided ID, enabling users to track changes and maintain accurate records of financial 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

pageable

query

Pageable

false

Indicates whether the results of lease component revisions should be returned in a paginated format, facilitating efficient data retrieval for financial obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of revisions.

PageLeaseComponentRevisionDto

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": 10000003,
21      "displayId": "0461332847-20250827-142605",
22      "name": "Inception",
23      "inception": true,
24      "revisionType": "ACTIVE",
25      "state": "LC_DEFINE",
26      "approvedBy": "string",
27      "approvedAt": "2019-08-24",
28      "parentRevisionId": 0,
29      "approverComment": "string",
30      "leaseComponentId": 10000003,
31      "leaseComponentDisplayId": "LC-100000002",
32      "leaseComponentName": "Test2 lease component",
33      "contractRevisionId": 10000001,
34      "contractRevisionDisplayId": "1617141777-20250724-115809",
35      "numberRangeIdentifierValue": "string",
36      "numberRangeIdentifierType": {
37        "name": "COMPANY_CODE"
38      },
39      "numberRangeType": {
40        "name": "CONTRACT"
41      },
42      "allowsSystemGenerateNewId": false
43    }
44  ],
45  "number": 0,
46  "sort": {
47    "unsorted": false,
48    "sorted": true,
49    "empty": false
50  },
51  "first": true,
52  "last": true,
53  "empty": false
54}

Get Lease Component By ID

HTTP Request

GET /api/v1/lease-components/revision/{revisionId}

📋 Description: Retrieves detailed information about a specific lease component revision identified by the provided revision ID, facilitating effective management of lease contracts and associated financial obligations 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 contract

ResponseLeaseComponentDto

Example Responses

  1{
  2  "code": "OK",
  3  "errors": {
  4    "all": []
  5  },
  6  "object": {
  7    "id": 10000003,
  8    "displayId": "LC-100000002",
  9    "principalPositionType": {
 10      "name": "LESSEE",
 11      "captionKey": "enum.principalpositiontype.lessee",
 12      "caption": "Lessee"
 13    },
 14    "name": "patched lease component",
 15    "description": "string",
 16    "bulkAsset": false,
 17    "rouStartDate": "2019-08-24",
 18    "rouEndDate": "2019-08-24",
 19    "approverComment": "string",
 20    "fairMarketValue": 0,
 21    "allocationNumber": "string",
 22    "guaranteedResidualValue": 0,
 23    "unitDistributions": [],
 24    "revision": {
 25      "id": 10000003,
 26      "displayId": "0461332847-20250827-142605",
 27      "name": "Inception",
 28      "inception": true,
 29      "revisionType": "ACTIVE",
 30      "state": "LC_DEFINE",
 31      "approvedBy": "string",
 32      "approvedAt": "2019-08-24",
 33      "parentRevisionId": 0,
 34      "approverComment": "string",
 35      "leaseComponentId": 10000003,
 36      "leaseComponentDisplayId": "LC-100000002",
 37      "leaseComponentName": "Test2 lease component",
 38      "contractRevisionId": 10000001,
 39      "contractRevisionDisplayId": "1617141777-20250724-115809",
 40      "numberRangeIdentifierValue": "string",
 41      "numberRangeIdentifierType": {
 42        "name": "COMPANY_CODE"
 43      },
 44      "numberRangeType": {
 45        "name": "CONTRACT"
 46      },
 47      "allowsSystemGenerateNewId": false
 48    },
 49    "internalAssetClass": {
 50      "id": 10000001,
 51      "displayId": "IAC-001",
 52      "status": {
 53        "name": "ACTIVE",
 54        "captionKey": "enum.objectStatus.active",
 55        "active": true,
 56        "caption": "Active"
 57      },
 58      "name": "Machinery and Equipment",
 59      "assetClassType": "PROPERTY",
 60      "infiniteUsefulLife": false
 61    },
 62    "unitOfMeasure": {
 63      "id": 10000198,
 64      "displayId": "MPA",
 65      "status": {
 66        "name": "ACTIVE",
 67        "captionKey": "enum.objectStatus.active",
 68        "active": true,
 69        "caption": "Active"
 70      },
 71      "name": "Megapascal",
 72      "erpSystemId": 10000001
 73    },
 74    "notifications": [],
 75    "spreadingFrequency": "NONE",
 76    "contractId": 10000001,
 77    "contractDisplayId": "CT-100000000",
 78    "companyCodeId": 10000002,
 79    "companyCodeDisplayId": "string",
 80    "userDeterminedLeaseType": {
 81      "name": "LEASE_CONTRACT_FIX",
 82      "captionKey": "enum.leaseType.fix",
 83      "principalPositionType": "LESSEE",
 84      "caption": "Fixed Lease Contract"
 85    },
 86    "endOfTermDate": "2019-08-24",
 87    "endOfTermPeriod": "string",
 88    "allowsSystemGenerateNewId": false,
 89    "transferInfo": {
 90      "transferredFromDisplayId": "CTR-00012",
 91      "transferredFromRevisionId": 20000001,
 92      "transferredToDisplayId": "CTR-00015",
 93      "transferredToRevisionId": 20000005
 94    },
 95    "numberRangeIdentifierValue": "string",
 96    "numberRangeIdentifierType": {
 97      "name": "COMPANY_CODE"
 98    },
 99    "numberRangeType": {
100      "name": "CONTRACT"
101    },
102    "type": "LESSEE"
103  }
104}