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

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier of the lease determination to patch.

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  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 10000044,
19    "displayId": "1065029663-20250820-110107",
20    "principalPositionType": "LESSEE",
21    "systemDeterminedLeaseType": "NON_LEASE",
22    "userDeterminedLeaseType": "NON_LEASE",
23    "contractRevisionId": 10000044,
24    "contractId": 10000046,
25    "contractDisplayId": "CT-100001316",
26    "type": "LESSEE",
27    "numberRangeIdentifierType": {
28      "name": "COMPANY_CODE"
29    },
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeType": {
32      "name": "CONTRACT"
33    },
34    "allowsSystemGenerateNewId": false
35  }
36}

Response Schema

Updates A Lease Determination

HTTP Request

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

📋 Description: Updates the lease determination details identified by the specified ID, allowing for modifications to contractual terms and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier of the lease determination to patch.

body

body

JsonPatch

false

none

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  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 10000044,
19    "displayId": "1065029663-20250820-110107",
20    "principalPositionType": "LESSEE",
21    "systemDeterminedLeaseType": "NON_LEASE",
22    "userDeterminedLeaseType": "NON_LEASE",
23    "contractRevisionId": 10000044,
24    "contractId": 10000046,
25    "contractDisplayId": "CT-100001316",
26    "type": "LESSEE",
27    "numberRangeIdentifierType": {
28      "name": "COMPANY_CODE"
29    },
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeType": {
32      "name": "CONTRACT"
33    },
34    "allowsSystemGenerateNewId": false
35  }
36}

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

none

Body Parameters

 1[
 2  {
 3    "id": 10000044,
 4    "displayId": "1065029663-20250820-110107",
 5    "principalPositionType": "LESSEE",
 6    "systemDeterminedLeaseType": "NON_LEASE",
 7    "userDeterminedLeaseType": "NON_LEASE",
 8    "contractRevisionId": 10000044,
 9    "contractId": 10000046,
10    "contractDisplayId": "CT-100001316",
11    "type": "LESSEE",
12    "numberRangeIdentifierType": {
13      "name": "COMPANY_CODE"
14    },
15    "numberRangeIdentifierValue": "COMP-0001",
16    "numberRangeType": {
17      "name": "CONTRACT"
18    },
19    "allowsSystemGenerateNewId": false
20  }
21]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all Lease Determinations.

ResponseListLeaseDeterminationDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of Lease Determinations .",
 4  "defaultMessage": "Operation completed successfully.",
 5  "debugMessage": "No errors occurred during the query execution.",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": [
18    {
19      "id": 10000044,
20      "displayId": "1065029663-20250820-110107",
21      "principalPositionType": "LESSEE",
22      "systemDeterminedLeaseType": "NON_LEASE",
23      "userDeterminedLeaseType": "NON_LEASE",
24      "contractRevisionId": 10000044,
25      "contractId": 10000046,
26      "contractDisplayId": "CT-100001316",
27      "type": "LESSEE",
28      "numberRangeIdentifierType": {
29        "name": "COMPANY_CODE"
30      },
31      "numberRangeIdentifierValue": "COMP-0001",
32      "numberRangeType": {
33        "name": "CONTRACT"
34      },
35      "allowsSystemGenerateNewId": false
36    }
37  ]
38}

Search A Lease Determination

HTTP Request

POST /api/v1/lease-determinations/search

📋 Description: Performs a filtered search on lease determinations and returns paginated results.

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

body

body

LeaseDeterminationDtoFilter

false

none

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": "LESSOR",
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  "totalPages": 1,
 3  "totalElements": 76,
 4  "numberOfElements": 76,
 5  "size": 100,
 6  "content": [
 7    {
 8      "id": 10000044,
 9      "displayId": "1065029663-20250820-110107",
10      "principalPositionType": "LESSEE",
11      "systemDeterminedLeaseType": "NON_LEASE",
12      "userDeterminedLeaseType": "NON_LEASE",
13      "contractRevisionId": 10000044,
14      "contractId": 10000046,
15      "contractDisplayId": "CT-100001316",
16      "type": "LESSEE",
17      "numberRangeIdentifierType": {
18        "name": "COMPANY_CODE"
19      },
20      "numberRangeIdentifierValue": "COMP-0001",
21      "numberRangeType": {
22        "name": "CONTRACT"
23      },
24      "allowsSystemGenerateNewId": false
25    }
26  ],
27  "number": 0,
28  "sort": {
29    "unsorted": false,
30    "sorted": true,
31    "empty": false
32  },
33  "pageable": {
34    "unpaged": false,
35    "pageSize": 100,
36    "paged": true,
37    "offset": 0,
38    "sort": {
39      "unsorted": false,
40      "sorted": true,
41      "empty": false
42    },
43    "pageNumber": 0
44  },
45  "first": true,
46  "last": true,
47  "empty": false
48}

List All Lease Determinations

HTTP Request

GET /api/v1/lease-determinations

📋 Description: Returns a paginated list of all lease determinations.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Pagination parameters including page, size, and sort.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease determinations.

PageLeaseDeterminationDto

Example Responses

 1{
 2  "totalPages": 1,
 3  "totalElements": 76,
 4  "numberOfElements": 76,
 5  "size": 100,
 6  "content": [
 7    {
 8      "id": 10000044,
 9      "displayId": "1065029663-20250820-110107",
10      "principalPositionType": "LESSEE",
11      "systemDeterminedLeaseType": "NON_LEASE",
12      "userDeterminedLeaseType": "NON_LEASE",
13      "contractRevisionId": 10000044,
14      "contractId": 10000046,
15      "contractDisplayId": "CT-100001316",
16      "type": "LESSEE",
17      "numberRangeIdentifierType": {
18        "name": "COMPANY_CODE"
19      },
20      "numberRangeIdentifierValue": "COMP-0001",
21      "numberRangeType": {
22        "name": "CONTRACT"
23      },
24      "allowsSystemGenerateNewId": false
25    }
26  ],
27  "number": 0,
28  "sort": {
29    "unsorted": false,
30    "sorted": true,
31    "empty": false
32  },
33  "pageable": {
34    "unpaged": false,
35    "pageSize": 100,
36    "paged": true,
37    "offset": 0,
38    "sort": {
39      "unsorted": false,
40      "sorted": true,
41      "empty": false
42    },
43    "pageNumber": 0
44  },
45  "first": true,
46  "last": true,
47  "empty": false
48}

Get Lease Determinations Contracts

HTTP Request

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

📋 Description: Retrieves lease determinations contracts by contractRevision unique ID.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer

true

The unique identifier of the contract partner to effective dates .

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  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 10000044,
19    "displayId": "1065029663-20250820-110107",
20    "principalPositionType": "LESSEE",
21    "systemDeterminedLeaseType": "NON_LEASE",
22    "userDeterminedLeaseType": "NON_LEASE",
23    "contractRevisionId": 10000044,
24    "contractId": 10000046,
25    "contractDisplayId": "CT-100001316",
26    "type": "LESSEE",
27    "numberRangeIdentifierType": {
28      "name": "COMPANY_CODE"
29    },
30    "numberRangeIdentifierValue": "COMP-0001",
31    "numberRangeType": {
32      "name": "CONTRACT"
33    },
34    "allowsSystemGenerateNewId": false
35  }
36}