Lease Determination

Retrieves A Lease Determination

HTTP Request

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

📋 Description: Retrieves detailed information about a specific lease determination identified by the provided ID, facilitating insights into contractual 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

Example Values

Parameter

Example

Type

id

10000044

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved the lease determination

ResponseLeaseDeterminationDto

400

Bad Request

Invalid input

None

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000044,
 8    "displayId": "1065029663-20250820-110107",
 9    "principalPositionType": {
10      "name": "LESSEE",
11      "captionKey": "enum.principalpositiontype.lessee",
12      "caption": "Lessee"
13    },
14    "systemDeterminedLeaseType": {
15      "name": "LEASE_CONTRACT_FIX",
16      "captionKey": "enum.leaseType.fix",
17      "principalPositionType": "LESSEE",
18      "caption": "Fixed Lease Contract"
19    },
20    "userDeterminedLeaseType": {
21      "name": "LEASE_CONTRACT_FIX",
22      "captionKey": "enum.leaseType.fix",
23      "principalPositionType": "LESSEE",
24      "caption": "Fixed Lease Contract"
25    },
26    "contractRevisionId": 10000044,
27    "contractId": 10000046,
28    "contractDisplayId": "CT-100001316",
29    "type": "LESSEE",
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": false
38  }
39}

Response Schema

Updates A Lease Determination (PUT)

HTTP Request

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

📋 Description: Updates the lease determination details for a specified lease contract, ensuring accurate 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

body

body

LeaseDeterminationDto

false

Request body containing the updated lease determination data, including contract details and financial obligations, essential for accurate accounting entries.

Example Values

Parameter

Example

Type

id

10000044

path

Body Parameters

 1{
 2  "id": 10000044,
 3  "displayId": "1065029663-20250820-110107",
 4  "principalPositionType": {
 5    "name": "LESSEE",
 6    "captionKey": "enum.principalpositiontype.lessee",
 7    "caption": "Lessee"
 8  },
 9  "systemDeterminedLeaseType": {
10    "name": "LEASE_CONTRACT_FIX",
11    "captionKey": "enum.leaseType.fix",
12    "principalPositionType": "LESSEE",
13    "caption": "Fixed Lease Contract"
14  },
15  "userDeterminedLeaseType": {
16    "name": "LEASE_CONTRACT_FIX",
17    "captionKey": "enum.leaseType.fix",
18    "principalPositionType": "LESSEE",
19    "caption": "Fixed Lease Contract"
20  },
21  "contractRevisionId": 10000044,
22  "contractId": 10000046,
23  "contractDisplayId": "CT-100001316",
24  "type": "LESSEE",
25  "numberRangeIdentifierValue": "COMP-0001",
26  "numberRangeIdentifierType": {
27    "name": "COMPANY_CODE"
28  },
29  "numberRangeType": {
30    "name": "CONTRACT"
31  },
32  "allowsSystemGenerateNewId": false
33}

Responses

Status

Meaning

Description

Schema

200

OK

Lease Determination successfully updated.

ResponseLeaseDeterminationDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000044,
 8    "displayId": "1065029663-20250820-110107",
 9    "principalPositionType": {
10      "name": "LESSEE",
11      "captionKey": "enum.principalpositiontype.lessee",
12      "caption": "Lessee"
13    },
14    "systemDeterminedLeaseType": {
15      "name": "LEASE_CONTRACT_FIX",
16      "captionKey": "enum.leaseType.fix",
17      "principalPositionType": "LESSEE",
18      "caption": "Fixed Lease Contract"
19    },
20    "userDeterminedLeaseType": {
21      "name": "LEASE_CONTRACT_FIX",
22      "captionKey": "enum.leaseType.fix",
23      "principalPositionType": "LESSEE",
24      "caption": "Fixed Lease Contract"
25    },
26    "contractRevisionId": 10000044,
27    "contractId": 10000046,
28    "contractDisplayId": "CT-100001316",
29    "type": "LESSEE",
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": false
38  }
39}

Updates A Lease Determination (PATCH)

HTTP Request

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

📋 Description: Updates the specified lease determination in the Nakisa Lease Accounting Suite, allowing for modifications to financial obligations and accounting entries associated with the lease contract. This operation ensures that lease data remains accurate and compliant with accounting standards.

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 determination details, including financial obligations and contract adjustments, to ensure accurate accounting entries.

Example Values

Parameter

Example

Type

id

123

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

ResponseLeaseDeterminationDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000044,
 8    "displayId": "1065029663-20250820-110107",
 9    "principalPositionType": {
10      "name": "LESSEE",
11      "captionKey": "enum.principalpositiontype.lessee",
12      "caption": "Lessee"
13    },
14    "systemDeterminedLeaseType": {
15      "name": "LEASE_CONTRACT_FIX",
16      "captionKey": "enum.leaseType.fix",
17      "principalPositionType": "LESSEE",
18      "caption": "Fixed Lease Contract"
19    },
20    "userDeterminedLeaseType": {
21      "name": "LEASE_CONTRACT_FIX",
22      "captionKey": "enum.leaseType.fix",
23      "principalPositionType": "LESSEE",
24      "caption": "Fixed Lease Contract"
25    },
26    "contractRevisionId": 10000044,
27    "contractId": 10000046,
28    "contractDisplayId": "CT-100001316",
29    "type": "LESSEE",
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": false
38  }
39}

Update Lease Determinations In Bulk

HTTP Request

PUT /api/v1/lease-determinations/bulk

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

LeaseDeterminationDto

false

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

Body Parameters

 1[
 2  {
 3    "id": 10000044,
 4    "displayId": "1065029663-20250820-110107",
 5    "principalPositionType": {
 6      "name": "LESSEE",
 7      "captionKey": "enum.principalpositiontype.lessee",
 8      "caption": "Lessee"
 9    },
10    "systemDeterminedLeaseType": {
11      "name": "LEASE_CONTRACT_FIX",
12      "captionKey": "enum.leaseType.fix",
13      "principalPositionType": "LESSEE",
14      "caption": "Fixed Lease Contract"
15    },
16    "userDeterminedLeaseType": {
17      "name": "LEASE_CONTRACT_FIX",
18      "captionKey": "enum.leaseType.fix",
19      "principalPositionType": "LESSEE",
20      "caption": "Fixed Lease Contract"
21    },
22    "contractRevisionId": 10000044,
23    "contractId": 10000046,
24    "contractDisplayId": "CT-100001316",
25    "type": "LESSEE",
26    "numberRangeIdentifierValue": "COMP-0001",
27    "numberRangeIdentifierType": {
28      "name": "COMPANY_CODE"
29    },
30    "numberRangeType": {
31      "name": "CONTRACT"
32    },
33    "allowsSystemGenerateNewId": false
34  }
35]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all Lease Determinations.

ResponseListLeaseDeterminationDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000044,
 9      "displayId": "1065029663-20250820-110107",
10      "principalPositionType": {
11        "name": "LESSEE",
12        "captionKey": "enum.principalpositiontype.lessee",
13        "caption": "Lessee"
14      },
15      "systemDeterminedLeaseType": {
16        "name": "LEASE_CONTRACT_FIX",
17        "captionKey": "enum.leaseType.fix",
18        "principalPositionType": "LESSEE",
19        "caption": "Fixed Lease Contract"
20      },
21      "userDeterminedLeaseType": {
22        "name": "LEASE_CONTRACT_FIX",
23        "captionKey": "enum.leaseType.fix",
24        "principalPositionType": "LESSEE",
25        "caption": "Fixed Lease Contract"
26      },
27      "contractRevisionId": 10000044,
28      "contractId": 10000046,
29      "contractDisplayId": "CT-100001316",
30      "type": "LESSEE",
31      "numberRangeIdentifierValue": "COMP-0001",
32      "numberRangeIdentifierType": {
33        "name": "COMPANY_CODE"
34      },
35      "numberRangeType": {
36        "name": "CONTRACT"
37      },
38      "allowsSystemGenerateNewId": false
39    }
40  ]
41}

Search A Lease Determination

HTTP Request

POST /api/v1/lease-determinations/search

📋 Description: Submits a search request to retrieve lease determinations based on specified criteria, facilitating efficient management of contracts and financial obligations 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

LeaseDeterminationDtoFilter

false

Request body containing the lease determination search criteria, including relevant contract details and financial obligations for accurate accounting entry retrieval.

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    101,
 4    102,
 5    103
 6  ],
 7  "idEqual": 101,
 8  "idLike": "LSD-2025-%",
 9  "createdAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
10  "createdAtLessThanOrEqual": "2025-12-31T23:59:59Z",
11  "createdByLike": "admin%",
12  "createdByEqual": "systemUser",
13  "modifiedAtGreaterThanOrEqual": "2025-06-01T00:00:00Z",
14  "modifiedAtLessThanOrEqual": "2025-07-01T23:59:59Z",
15  "modifiedByLike": "editor%",
16  "modifiedByEqual": "editorUser",
17  "displayIdIn": [
18    "LSD-1001",
19    "LSD-1002"
20  ],
21  "displayIdLike": "LSD-2025-%",
22  "principalPositionTypeEqual": "LESSEE",
23  "systemDeterminedLeaseTypeIn": [
24    "NON_LEASE",
25    "LEASE_CONTRACT_FIX"
26  ],
27  "userDeterminedLeaseTypeIn": [
28    "NON_LEASE"
29  ],
30  "contractRevisionIdIn": [
31    5001,
32    5002
33  ],
34  "contractIdIn": [
35    20001,
36    20002
37  ],
38  "contractDisplayIdIn": [
39    "CTR-2025-001",
40    "CTR-2025-002"
41  ],
42  "type": "LEASE_DETERMINATION"
43}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageLeaseDeterminationDto

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": 10000044,
21      "displayId": "1065029663-20250820-110107",
22      "principalPositionType": {
23        "name": "LESSEE",
24        "captionKey": "enum.principalpositiontype.lessee",
25        "caption": "Lessee"
26      },
27      "systemDeterminedLeaseType": {
28        "name": "LEASE_CONTRACT_FIX",
29        "captionKey": "enum.leaseType.fix",
30        "principalPositionType": "LESSEE",
31        "caption": "Fixed Lease Contract"
32      },
33      "userDeterminedLeaseType": {
34        "name": "LEASE_CONTRACT_FIX",
35        "captionKey": "enum.leaseType.fix",
36        "principalPositionType": "LESSEE",
37        "caption": "Fixed Lease Contract"
38      },
39      "contractRevisionId": 10000044,
40      "contractId": 10000046,
41      "contractDisplayId": "CT-100001316",
42      "type": "LESSEE",
43      "numberRangeIdentifierValue": "COMP-0001",
44      "numberRangeIdentifierType": {
45        "name": "COMPANY_CODE"
46      },
47      "numberRangeType": {
48        "name": "CONTRACT"
49      },
50      "allowsSystemGenerateNewId": false
51    }
52  ],
53  "number": 0,
54  "sort": {
55    "unsorted": false,
56    "sorted": true,
57    "empty": false
58  },
59  "first": true,
60  "last": true,
61  "empty": false
62}

List All Lease Determinations

HTTP Request

GET /api/v1/lease-determinations

📋 Description: Retrieves lease determination records, providing insights into financial obligations and accounting entries associated with contracts within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

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

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease determinations.

PageLeaseDeterminationDto

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": 10000044,
21      "displayId": "1065029663-20250820-110107",
22      "principalPositionType": {
23        "name": "LESSEE",
24        "captionKey": "enum.principalpositiontype.lessee",
25        "caption": "Lessee"
26      },
27      "systemDeterminedLeaseType": {
28        "name": "LEASE_CONTRACT_FIX",
29        "captionKey": "enum.leaseType.fix",
30        "principalPositionType": "LESSEE",
31        "caption": "Fixed Lease Contract"
32      },
33      "userDeterminedLeaseType": {
34        "name": "LEASE_CONTRACT_FIX",
35        "captionKey": "enum.leaseType.fix",
36        "principalPositionType": "LESSEE",
37        "caption": "Fixed Lease Contract"
38      },
39      "contractRevisionId": 10000044,
40      "contractId": 10000046,
41      "contractDisplayId": "CT-100001316",
42      "type": "LESSEE",
43      "numberRangeIdentifierValue": "COMP-0001",
44      "numberRangeIdentifierType": {
45        "name": "COMPANY_CODE"
46      },
47      "numberRangeType": {
48        "name": "CONTRACT"
49      },
50      "allowsSystemGenerateNewId": false
51    }
52  ],
53  "number": 0,
54  "sort": {
55    "unsorted": false,
56    "sorted": true,
57    "empty": false
58  },
59  "first": true,
60  "last": true,
61  "empty": false
62}

Get Lease Determinations Contracts

HTTP Request

GET /api/v1/lease-determinations/contract/{contractRevisionId}

📋 Description: Retrieves lease determination details for a specified contract revision, providing essential information for managing financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer

true

Unique identifier for the contract revision

Example Values

Parameter

Example

Type

contractRevisionId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved lease determinations contracts.

ResponseLeaseDeterminationDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000044,
 8    "displayId": "1065029663-20250820-110107",
 9    "principalPositionType": {
10      "name": "LESSEE",
11      "captionKey": "enum.principalpositiontype.lessee",
12      "caption": "Lessee"
13    },
14    "systemDeterminedLeaseType": {
15      "name": "LEASE_CONTRACT_FIX",
16      "captionKey": "enum.leaseType.fix",
17      "principalPositionType": "LESSEE",
18      "caption": "Fixed Lease Contract"
19    },
20    "userDeterminedLeaseType": {
21      "name": "LEASE_CONTRACT_FIX",
22      "captionKey": "enum.leaseType.fix",
23      "principalPositionType": "LESSEE",
24      "caption": "Fixed Lease Contract"
25    },
26    "contractRevisionId": 10000044,
27    "contractId": 10000046,
28    "contractDisplayId": "CT-100001316",
29    "type": "LESSEE",
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": false
38  }
39}