Lease Area

Lease Area - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific lease area within the financial organization structure, identified by the provided ID, to facilitate organizational hierarchy and financial entity management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
}

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

Lease Area - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified lease area within the financial organization structure, allowing for modifications to the hierarchy and attributes of the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	LeaseAreaDto	true	Request body containing the updated financial organization structure details for the specified lease area, including attributes such as name, hierarchy, and associated financial entity information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "businessUnitId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
}

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

Lease Area - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified lease area within the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Lease Area - Delete Or Decommission

HTTP Request

PUT /api/v1/lease-areas/remove/{id}

Interactive Demo

📋 Description: Removes a specified lease area from the financial organization structure, ensuring the hierarchy accurately reflects current operational needs.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Lease Area - Delete Or Decommission All

HTTP Request

PUT /api/v1/lease-areas/remove/bulk

Interactive Demo

📋 Description: Removes multiple lease areas from the financial organization structure in a single operation, streamlining the management of organizational hierarchy within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of lease area identifiers to be removed in bulk from the financial organization structure, reflecting changes in the hierarchy of the financial entity.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Lease Area - Decommission

HTTP Request

PUT /api/v1/lease-areas/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified lease area within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures accurate management of organizational resources and compliance with structural changes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
}

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

Lease Area - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/lease-areas/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions lease areas within the financial organization structure that have been modified before the specified date, ensuring the hierarchy remains accurate and up-to-date. This operation is essential for maintaining the integrity of the organizational framework and financial entity management.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which lease areas were modified, facilitating the management of organizational structure changes within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Decommission Before Now

HTTP Request

PUT /api/v1/lease-areas/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions lease areas that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational requirements.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Decommission All

HTTP Request

PUT /api/v1/lease-areas/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple lease areas to ‘decommissioned’ in bulk, facilitating efficient management of the financial organization structure and hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of lease area identifiers and associated decommissioning details for bulk processing within the financial organization’s structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Updates or creates multiple lease areas within the financial organization structure, allowing for efficient management of organizational hierarchy and financial entity configurations.

Parameters

Name	In	Type	Required	Description
body	body	LeaseAreaDto	true	Request body containing bulk data for creating or updating lease areas within the financial organization structure, including relevant attributes and hierarchy details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Create Or Update

HTTP Request

PUT /api/v1/lease-areas/createOrUpdate

Interactive Demo

📋 Description: Creates or updates lease area information within the financial organization structure, ensuring accurate representation of the organization’s hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseAreaDto	true	Request body containing the details of lease areas, including organizational hierarchy and financial entity attributes, for creating or updating records within the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "businessUnitId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
}

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

Lease Area - Bulk Update

HTTP Request

PUT /api/v1/lease-areas/bulk

Interactive Demo

📋 Description: Updates multiple lease areas within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseAreaDto	true	Request body containing a collection of lease area data, including organizational hierarchy and financial entity details, for bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Bulk Create

HTTP Request

POST /api/v1/lease-areas/bulk

Interactive Demo

📋 Description: Facilitates the bulk creation of lease areas within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseAreaDto	true	Request body containing a collection of lease area data for bulk creation, including details on organizational structure and financial entity hierarchies.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ]
}

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

Lease Area - Bulk Delete

HTTP Request

DELETE /api/v1/lease-areas/bulk

Interactive Demo

📋 Description: Deletes multiple lease areas within the financial organization structure, allowing for streamlined management of organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of lease area identifiers to be deleted, facilitating the management of the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Lease Area - Search

HTTP Request

POST /api/v1/lease-areas/search

Interactive Demo

📋 Description: Submits a search request for lease areas within the financial organization structure, enabling users to identify and analyze hierarchical relationships among financial entities.

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	LeaseAreaDtoFilter	false	Request body containing search criteria for lease areas, including organizational hierarchy and financial entity details, to facilitate targeted retrieval of relevant lease information.

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": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string",
  "businessUnitIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLeaseAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Lease Area - Find All

HTTP Request

GET /api/v1/lease-areas

Interactive Demo

📋 Description: Retrieves a list of lease areas within the financial organization structure, providing insights into the hierarchical organization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the lease areas query should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLeaseAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "businessUnitId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Lease Area - Create

HTTP Request

POST /api/v1/lease-areas

Interactive Demo

📋 Description: Creates a new lease area within the financial organization structure, enabling the establishment of hierarchical relationships and organizational boundaries for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseAreaDto	true	Request body containing the details of lease areas, including organizational hierarchy and financial entity specifications, to facilitate structured management within the financial organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "businessUnitId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "businessUnitId": 0
  }
}

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

Lease Area - Get Metadata

HTTP Request

GET /api/v1/lease-areas/meta

Interactive Demo

📋 Description: Retrieves metadata for lease areas within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

---