Lease Component Event

Retrieves A Specific Lease Component Revision

HTTP Request

GET /api/v1/events/lease-component-revisions/{id}

📋 Description: Retrieves the details of a specific lease component revision by its unique identifier, facilitating accurate tracking of changes related to lease agreements 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 revision.

ResponseLeaseComponentRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000003,
 8    "displayId": "0461332847-20250827-142605",
 9    "name": "Inception",
10    "inception": true,
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "string",
14    "approvedAt": "2019-08-24",
15    "parentRevisionId": 0,
16    "approverComment": "string",
17    "leaseComponentId": 10000003,
18    "leaseComponentDisplayId": "LC-100000002",
19    "leaseComponentName": "Test2 lease component",
20    "contractRevisionId": 10000001,
21    "contractRevisionDisplayId": "1617141777-20250724-115809",
22    "numberRangeIdentifierValue": "string",
23    "numberRangeIdentifierType": {
24      "name": "COMPANY_CODE"
25    },
26    "numberRangeType": {
27      "name": "CONTRACT"
28    },
29    "allowsSystemGenerateNewId": false
30  }
31}

Update A Specified Lease Component Revision

HTTP Request

PUT /api/v1/events/lease-component-revisions/{id}

📋 Description: Updates the specified lease component revision within the Nakisa Lease Accounting Suite, allowing users to modify details related to lease contracts and financial obligations, ensuring accurate accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

LeaseComponentRevisionDto

false

Request body containing the updated lease component revision data, including financial obligations and accounting entries associated with the specified lease contract.

Example Values

Parameter

Example

Type

id

10000086

path

Body Parameters

 1{
 2  "id": 10000003,
 3  "displayId": "0461332847-20250827-142605",
 4  "name": "Inception",
 5  "inception": true,
 6  "revisionType": "ACTIVE",
 7  "state": "LC_DEFINE",
 8  "approvedBy": "string",
 9  "approvedAt": "2019-08-24",
10  "parentRevisionId": 0,
11  "approverComment": "string",
12  "leaseComponentId": 10000003,
13  "leaseComponentDisplayId": "LC-100000002",
14  "leaseComponentName": "Test2 lease component",
15  "contractRevisionId": 10000001,
16  "contractRevisionDisplayId": "1617141777-20250724-115809",
17  "numberRangeIdentifierValue": "string",
18  "numberRangeIdentifierType": {
19    "name": "COMPANY_CODE"
20  },
21  "numberRangeType": {
22    "name": "CONTRACT"
23  },
24  "allowsSystemGenerateNewId": false
25}

Responses

Status

Meaning

Description

Schema

200

OK

lease component revision successfully updated.

ResponseLeaseComponentRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000003,
 8    "displayId": "0461332847-20250827-142605",
 9    "name": "Inception",
10    "inception": true,
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "string",
14    "approvedAt": "2019-08-24",
15    "parentRevisionId": 0,
16    "approverComment": "string",
17    "leaseComponentId": 10000003,
18    "leaseComponentDisplayId": "LC-100000002",
19    "leaseComponentName": "Test2 lease component",
20    "contractRevisionId": 10000001,
21    "contractRevisionDisplayId": "1617141777-20250724-115809",
22    "numberRangeIdentifierValue": "string",
23    "numberRangeIdentifierType": {
24      "name": "COMPANY_CODE"
25    },
26    "numberRangeType": {
27      "name": "CONTRACT"
28    },
29    "allowsSystemGenerateNewId": false
30  }
31}

Delete A Lease Component Revision

HTTP Request

DELETE /api/v1/events/lease-component-revisions/{id}

📋 Description: Deletes a specified lease component revision from the Nakisa Lease Accounting Suite, ensuring the integrity of lease-related financial obligations and accounting entries.

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 revision successfully deleted.

ResponseVoid

Example Responses

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

Updates Specified Lease Component Revision

HTTP Request

PATCH /api/v1/events/lease-component-revisions/{id}

📋 Description: Updates the specified lease component revision in the Nakisa Lease Accounting Suite, allowing users to modify details related to financial obligations and accounting entries associated with lease contracts.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the lease component revision data, including updated financial obligations and accounting entries related to the specified lease contract.

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 revision.

ResponseLeaseComponentRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000003,
 8    "displayId": "0461332847-20250827-142605",
 9    "name": "Inception",
10    "inception": true,
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "string",
14    "approvedAt": "2019-08-24",
15    "parentRevisionId": 0,
16    "approverComment": "string",
17    "leaseComponentId": 10000003,
18    "leaseComponentDisplayId": "LC-100000002",
19    "leaseComponentName": "Test2 lease component",
20    "contractRevisionId": 10000001,
21    "contractRevisionDisplayId": "1617141777-20250724-115809",
22    "numberRangeIdentifierValue": "string",
23    "numberRangeIdentifierType": {
24      "name": "COMPANY_CODE"
25    },
26    "numberRangeType": {
27      "name": "CONTRACT"
28    },
29    "allowsSystemGenerateNewId": false
30  }
31}

Updates Lease Component Revision In Bulk

HTTP Request

PUT /api/v1/events/lease-component-revisions/bulk

📋 Description: Updates multiple lease component revisions 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

LeaseComponentRevisionDto

false

Request body containing a collection of lease component revision data, including details on financial obligations and accounting entries relevant to lease and contract management.

Body Parameters

 1[
 2  {
 3    "id": 10000003,
 4    "displayId": "0461332847-20250827-142605",
 5    "name": "Inception",
 6    "inception": true,
 7    "revisionType": "ACTIVE",
 8    "state": "LC_DEFINE",
 9    "approvedBy": "string",
10    "approvedAt": "2019-08-24",
11    "parentRevisionId": 0,
12    "approverComment": "string",
13    "leaseComponentId": 10000003,
14    "leaseComponentDisplayId": "LC-100000002",
15    "leaseComponentName": "Test2 lease component",
16    "contractRevisionId": 10000001,
17    "contractRevisionDisplayId": "1617141777-20250724-115809",
18    "numberRangeIdentifierValue": "string",
19    "numberRangeIdentifierType": {
20      "name": "COMPANY_CODE"
21    },
22    "numberRangeType": {
23      "name": "CONTRACT"
24    },
25    "allowsSystemGenerateNewId": false
26  }
27]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component revision.

ResponseListLeaseComponentRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000003,
 9      "displayId": "0461332847-20250827-142605",
10      "name": "Inception",
11      "inception": true,
12      "revisionType": "ACTIVE",
13      "state": "LC_DEFINE",
14      "approvedBy": "string",
15      "approvedAt": "2019-08-24",
16      "parentRevisionId": 0,
17      "approverComment": "string",
18      "leaseComponentId": 10000003,
19      "leaseComponentDisplayId": "LC-100000002",
20      "leaseComponentName": "Test2 lease component",
21      "contractRevisionId": 10000001,
22      "contractRevisionDisplayId": "1617141777-20250724-115809",
23      "numberRangeIdentifierValue": "string",
24      "numberRangeIdentifierType": {
25        "name": "COMPANY_CODE"
26      },
27      "numberRangeType": {
28        "name": "CONTRACT"
29      },
30      "allowsSystemGenerateNewId": false
31    }
32  ]
33}

Search Lease Component Revisions

HTTP Request

POST /api/v1/events/lease-component-revisions/search

📋 Description: Submits a request to search for lease component revisions within the Nakisa Lease Accounting Suite, enabling users to efficiently identify relevant lease and contract details related to financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

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

body

body

LeaseComponentRevisionDtoFilter

false

Request body containing search criteria and filters for retrieving lease component revisions related to contracts and financial obligations within the Nakisa Lease Accounting Suite.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

Body Parameters

 1{
 2  "idIn": [
 3    10000003,
 4    10000004
 5  ],
 6  "idEqual": 10000003,
 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": "system%",
15  "modifiedByEqual": "super.admin@nakisa.com",
16  "displayIdIn": [
17    "0461332847-20250827-142605",
18    "0461332847-20250827-152010"
19  ],
20  "displayIdLike": "0461%",
21  "nameOrDisplayIdLike": "Inception%",
22  "nameLike": "Active%",
23  "inceptionEqual": true,
24  "revisionTypeIn": [
25    "ACTIVE",
26    "DRAFT"
27  ],
28  "stateIn": [
29    "LC_DEFINE",
30    "LC_ACTIVE"
31  ],
32  "stateEqual": "LC_DEFINE",
33  "approvedByLike": "manager%",
34  "approvedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
35  "approvedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
36  "leaseComponentNameOrDisplayIdLike": "Test2%",
37  "leaseComponentIdIn": [
38    10000003,
39    10000007
40  ],
41  "leaseComponentDisplayIdIn": [
42    "LC-100000002",
43    "LC-100000200"
44  ],
45  "leaseComponentNameIn": [
46    "Test2 lease component",
47    "Office Equipment Lease"
48  ],
49  "contractRevisionIdIn": [
50    10000001,
51    10000002
52  ],
53  "contractRevisionIdEqual": 10000001,
54  "contractRevisionDisplayIdIn": [
55    "1617141777-20250724-115809",
56    "1617141777-20250724-120000"
57  ]
58}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

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}

Modify Lease Component Revision

HTTP Request

POST /api/v1/events/lease-component-revisions/modification

📋 Description: Submits modifications to lease component revisions within the Nakisa Lease Accounting Suite, ensuring accurate updates to financial obligations and accounting entries associated with lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentModificationRequest

false

Request body containing the lease component revision details, including modifications to financial obligations and accounting entries associated with the lease contract.

Body Parameters

1{
2  "name": "Amendment - Change Lease Term",
3  "leaseComponentRevisionId": 10000003
4}

Responses

Status

Meaning

Description

Schema

200

OK

Modification successfully done.

ResponseLeaseComponentRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000003,
 8    "displayId": "0461332847-20250827-142605",
 9    "name": "Inception",
10    "inception": true,
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "string",
14    "approvedAt": "2019-08-24",
15    "parentRevisionId": 0,
16    "approverComment": "string",
17    "leaseComponentId": 10000003,
18    "leaseComponentDisplayId": "LC-100000002",
19    "leaseComponentName": "Test2 lease component",
20    "contractRevisionId": 10000001,
21    "contractRevisionDisplayId": "1617141777-20250724-115809",
22    "numberRangeIdentifierValue": "string",
23    "numberRangeIdentifierType": {
24      "name": "COMPANY_CODE"
25    },
26    "numberRangeType": {
27      "name": "CONTRACT"
28    },
29    "allowsSystemGenerateNewId": false
30  }
31}

List All Lease Component Revisions

HTTP Request

GET /api/v1/events/lease-component-revisions

📋 Description: Retrieves revisions of lease components associated with contracts in the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the response should be paginated, facilitating the retrieval of lease component revisions in a manageable format for enhanced financial oversight and accounting efficiency.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease component 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 Revision

HTTP Request

GET /api/v1/events/lease-component-revisions/lease-component/{leaseComponentId}

📋 Description: Retrieves the revision history of a specified lease component, providing insights into changes made over time within the context of lease management and financial obligations. This operation supports effective contract oversight and accounting entry accuracy.

Parameters

Name

In

Type

Required

Description

leaseComponentId

path

integer

true

Unique identifier for the lease component

pageable

query

Pageable

false

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

Example Values

Parameter

Example

Type

leaseComponentId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved lease component revision.

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}