Lease Component Carry Over Balance

Retrieves A Specific Lease Component Carry Over Balance

HTTP Request

GET /api/v1/lease-component-carry-over-balances/{id}

Interactive Demo

📋 Description: Retrieves the carry-over balance details for a specific lease component identified by the provided ID, facilitating accurate tracking 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

Example Values

Parameter	Example	Type
id	10000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved lease component carry over balances.	ResponseLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Resource

HTTP Request

PUT /api/v1/lease-component-carry-over-balances/{id}

Interactive Demo

📋 Description: Updates the carry-over balance for a specified lease component within the Nakisa Lease Accounting Suite, ensuring accurate financial obligation tracking and compliance with accounting standards.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing updated lease component carry-over balance details, including financial obligations and accounting entries associated with the specified lease contract.

Example Values

Parameter	Example	Type
id	10000086	path

Body Parameters

{
  "id": 10000013,
  "displayId": "0407198317-20250828-113111",
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "mainAccountingStandard": true,
  "accountingStandard": {
    "id": 1001,
    "displayId": "GAAP-01",
    "standardType": "IFRS"
  },
  "accountingStandardPriority": "MAIN",
  "leaseComponentId": 10000007,
  "leaseComponentDisplayId": "LC-100000200",
  "type": "LESSEE",
  "numberRangeIdentifierValue": "COMPANY_CODE_001",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": false
}

Responses

Status	Meaning	Description	Schema
200	OK	lease component carry over balance successfully updated.	ResponseLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete A Lease Component Carry Over Balances

HTTP Request

DELETE /api/v1/lease-component-carry-over-balances/{id}

Interactive Demo

📋 Description: Deletes a specified lease component carry-over balance, thereby removing the associated financial obligation from the Nakisa Lease Accounting Suite, ensuring accurate accounting entries and contract management.

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 carry over balances successfully deleted.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Updates Specified Lease Component Carry Over Balances

HTTP Request

PATCH /api/v1/lease-component-carry-over-balances/{id}

Interactive Demo

📋 Description: Updates the carry-over balance for a specified lease component, allowing for adjustments to financial obligations and accounting entries within the Nakisa Lease Accounting Suite. This operation ensures accurate reflection of lease-related data in financial reporting.

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 carry-over balance details, including financial obligations and accounting entries associated with the specified lease contract.

Example Values

Parameter	Example	Type
id	10000081	path
body	{"op":"replace","path":"/name","value":"patched contract"}	body

Body Parameters

{
  "op": "replace",
  "path": "/name",
  "value": "patched contract"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully patched the lease component carry over balances.	ResponseLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Or Update A Lease Component Carry Over Balance

HTTP Request

PUT /api/v1/lease-component-carry-over-balances/createOrUpdate

Interactive Demo

📋 Description: Updates or creates lease component carry-over balances within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries associated with lease contracts. This operation facilitates the management of lease data to maintain compliance and financial integrity.

Parameters

Name	In	Type	Required	Description
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing the lease component carry-over balance data, including relevant financial obligations and accounting entries for accurate lease and contract management.

Body Parameters

{
  "id": 10000013,
  "displayId": "0407198317-20250828-113111",
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "mainAccountingStandard": true,
  "accountingStandard": {
    "id": 1001,
    "displayId": "GAAP-01",
    "standardType": "IFRS"
  },
  "accountingStandardPriority": "MAIN",
  "leaseComponentId": 10000007,
  "leaseComponentDisplayId": "LC-100000200",
  "type": "LESSEE",
  "numberRangeIdentifierValue": "COMPANY_CODE_001",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": false
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully created or updated the lease component.	ResponseLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Creates Or Updates Lease Component Carry Over Balance In Bulk

HTTP Request

PUT /api/v1/lease-component-carry-over-balances/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple lease component carry-over balances in bulk, facilitating efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing bulk data for creating or updating lease component carry-over balances, including relevant financial obligations and accounting entries associated with lease contracts.

Body Parameters

[
  {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successfully processed all lease component.	ResponseListLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000013,
      "displayId": "0407198317-20250828-113111",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "mainAccountingStandard": true,
      "accountingStandard": {
        "id": 1001,
        "displayId": "GAAP-01",
        "standardType": "IFRS"
      },
      "accountingStandardPriority": "MAIN",
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "type": "LESSEE",
      "numberRangeIdentifierValue": "COMPANY_CODE_001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Updates Lease Component Carry Over Balance In Bulk

HTTP Request

PUT /api/v1/lease-component-carry-over-balances/bulk

Interactive Demo

📋 Description: Updates multiple lease component carry-over balances in bulk within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are reflected in lease contracts.

Parameters

Name	In	Type	Required	Description
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing bulk data for lease component carry-over balances, including financial obligations and accounting entries associated with lease contracts.

Body Parameters

[
  {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successfully processed all lease component carry over balances.	ResponseListLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000013,
      "displayId": "0407198317-20250828-113111",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "mainAccountingStandard": true,
      "accountingStandard": {
        "id": 1001,
        "displayId": "GAAP-01",
        "standardType": "IFRS"
      },
      "accountingStandardPriority": "MAIN",
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "type": "LESSEE",
      "numberRangeIdentifierValue": "COMPANY_CODE_001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Creates Multiple Lease Component Carry Over Balance In Bulk.

HTTP Request

POST /api/v1/lease-component-carry-over-balances/bulk

Interactive Demo

📋 Description: Submits bulk lease component carry-over balances for processing within the Nakisa Lease Accounting Suite, facilitating accurate tracking of financial obligations and accounting entries related to lease contracts.

Parameters

Name	In	Type	Required	Description
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing bulk lease component carry-over balance data, including relevant financial obligations and accounting entries for accurate contract management.

Body Parameters

[
  {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successfully created all lease component carry over balance.	ResponseListLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000013,
      "displayId": "0407198317-20250828-113111",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "mainAccountingStandard": true,
      "accountingStandard": {
        "id": 1001,
        "displayId": "GAAP-01",
        "standardType": "IFRS"
      },
      "accountingStandardPriority": "MAIN",
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "type": "LESSEE",
      "numberRangeIdentifierValue": "COMPANY_CODE_001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Deletes Multiple Lease Component Carry Over Balance By Their IDs.

HTTP Request

DELETE /api/v1/lease-component-carry-over-balances/bulk

Interactive Demo

📋 Description: Deletes multiple lease component carry-over balances in bulk, streamlining the management of financial obligations and ensuring accurate accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	false	Request body containing an array of lease component carry-over balance identifiers to facilitate the bulk deletion of associated financial obligations and accounting entries.

Body Parameters

[
  10000013
]

Responses

Status	Meaning	Description	Schema
200	OK	lease component carry over balance deleted.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

List All Lease Component Carry Over Balances

HTTP Request

GET /api/v1/lease-component-carry-over-balances

Interactive Demo

📋 Description: Retrieves the carry-over balances for lease components, providing essential data for managing financial obligations and ensuring accurate accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	false	Indicates whether the results of the lease component carry-over balances query should be paginated, facilitating efficient retrieval of financial obligation data within the Nakisa Lease Accounting Suite.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of lease component carry over balances.	PageLeaseComponentCarryOverBalanceDto

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000013,
      "displayId": "0407198317-20250828-113111",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "mainAccountingStandard": true,
      "accountingStandard": {
        "id": 1001,
        "displayId": "GAAP-01",
        "standardType": "IFRS"
      },
      "accountingStandardPriority": "MAIN",
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "type": "LESSEE",
      "numberRangeIdentifierValue": "COMPANY_CODE_001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Lease Component Carry Over Balance

HTTP Request

POST /api/v1/lease-component-carry-over-balances

Interactive Demo

📋 Description: Submits lease component carry-over balances to the Nakisa Lease Accounting Suite, facilitating accurate financial obligation tracking and accounting entry management for lease contracts.

Parameters

Name	In	Type	Required	Description
body	body	LeaseComponentCarryOverBalanceDto	false	Request body containing the lease component carry-over balances data, including details of financial obligations and accounting entries associated with lease contracts.

Body Parameters

{
  "id": 10000013,
  "displayId": "0407198317-20250828-113111",
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "mainAccountingStandard": true,
  "accountingStandard": {
    "id": 1001,
    "displayId": "GAAP-01",
    "standardType": "IFRS"
  },
  "accountingStandardPriority": "MAIN",
  "leaseComponentId": 10000007,
  "leaseComponentDisplayId": "LC-100000200",
  "type": "LESSEE",
  "numberRangeIdentifierValue": "COMPANY_CODE_001",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": false
}

Responses

Status	Meaning	Description	Schema
200	OK	lease component carry over balance successfully created.	ResponseLeaseComponentCarryOverBalanceDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000013,
    "displayId": "0407198317-20250828-113111",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "mainAccountingStandard": true,
    "accountingStandard": {
      "id": 1001,
      "displayId": "GAAP-01",
      "standardType": "IFRS"
    },
    "accountingStandardPriority": "MAIN",
    "leaseComponentId": 10000007,
    "leaseComponentDisplayId": "LC-100000200",
    "type": "LESSEE",
    "numberRangeIdentifierValue": "COMPANY_CODE_001",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": false
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search Lease Component Carry Over Balance

HTTP Request

POST /api/v1/lease-component-carry-over-balances/search

Interactive Demo

📋 Description: Submits a request to search for lease component carry-over balances, enabling users to identify financial obligations and accounting entries associated with leases and contracts.

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	LeaseComponentCarryOverBalanceDtoFilter	false	Request body containing search criteria for lease component carry-over balances, including relevant financial obligations and accounting entries associated with contracts.

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

{
  "idIn": [
    10000013,
    10000014
  ],
  "idEqual": 10000013,
  "idLike": "1000%",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "super.admin%",
  "createdByEqual": "super.admin@nakisa.com",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "system%",
  "modifiedByEqual": "super.admin@nakisa.com",
  "displayIdIn": [
    "0407198317-20250828-113111",
    "0763130872-20250828-113111"
  ],
  "displayIdLike": "0407%",
  "principalPositionTypeEqual": "LESSEE",
  "accountingStandardIdIn": [
    10000002,
    10000004
  ],
  "accountingStandardDisplayIdIn": [
    "IAS",
    "GAAP"
  ],
  "accountingStandardTypeIn": [
    "IFRS",
    "GAAP"
  ],
  "leaseComponentIdIn": [
    10000007,
    10000008
  ],
  "leaseComponentDisplayIdIn": [
    "LC-100000200",
    "LC-100000201"
  ],
  "type": "LESSEE"
}

Responses

Status	Meaning	Description	Schema
200	OK	Search results successfully returned.	PageLeaseComponentCarryOverBalanceDto

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000013,
      "displayId": "0407198317-20250828-113111",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "mainAccountingStandard": true,
      "accountingStandard": {
        "id": 1001,
        "displayId": "GAAP-01",
        "standardType": "IFRS"
      },
      "accountingStandardPriority": "MAIN",
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "type": "LESSEE",
      "numberRangeIdentifierValue": "COMPANY_CODE_001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Lease Component Carry Over Balance

HTTP Request

GET /api/v1/lease-component-carry-over-balances/lease-component/{leaseComponentId}

Interactive Demo

📋 Description: Retrieves the carry-over balances for a specified lease component, providing essential financial data related to lease obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
leaseComponentId	path	integer	true	Unique identifier for the lease component

Example Values

Parameter	Example	Type
leaseComponentId	10000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved lease component carry over balance.	LeaseComponentCarryOverBalanceDto

Example Responses

{
  "id": 10000013,
  "displayId": "0407198317-20250828-113111",
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "mainAccountingStandard": true,
  "accountingStandard": {
    "id": 1001,
    "displayId": "GAAP-01",
    "standardType": "IFRS"
  },
  "accountingStandardPriority": "MAIN",
  "leaseComponentId": 10000007,
  "leaseComponentDisplayId": "LC-100000200",
  "type": "LESSEE",
  "numberRangeIdentifierValue": "COMPANY_CODE_001",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---