Lease Group

Lease Group - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific lease group within the financial organization structure, identified by the provided ID, to facilitate effective management of organizational hierarchies and 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	ResponseLeaseGroupDto

Example Responses

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

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

Lease Group - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified lease group within the financial organization structure, allowing for modifications to its hierarchy and associated attributes. This operation ensures that the lease group’s information remains accurate and aligned with organizational changes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	LeaseGroupDto	true	Request body containing the updated lease group information, including financial entity details and hierarchical structure adjustments.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseGroupDto

Example Responses

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

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

Lease Group - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified lease group from the financial organization structure, effectively removing it from the hierarchy 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 Group - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified lease group from the financial organization structure, ensuring that the hierarchy reflects the current organizational needs and compliance requirements.

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 Group - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple lease groups from the financial organization structure, allowing for efficient management of organizational hierarchy and alignment with business needs.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of lease group identifiers to facilitate the bulk removal of specified financial entities from the organizational 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 Group - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified lease group within the financial organization structure, effectively removing it from the active hierarchy and ensuring accurate representation of the entity’s organizational framework.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseGroupDto

Example Responses

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

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

Lease Group - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions lease groups that were modified before the specified date, ensuring the financial organization structure remains current and aligned with operational needs. This operation is essential for maintaining an accurate hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for lease groups to be decommissioned, allowing the financial organization to manage its structure and hierarchy effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions lease groups that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational needs. This operation supports the management of organizational hierarchy within financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Decommission All

HTTP Request

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

Interactive Demo

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

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple lease groups within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseGroupDto	true	Request body containing bulk data for creating or updating lease groups, including organizational hierarchy details and associated financial entity attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Create Or Update

HTTP Request

PUT /api/v1/lease-groups/createOrUpdate

Interactive Demo

📋 Description: Creates or updates lease groups within the financial organization structure, ensuring accurate representation of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseGroupDto	true	Request body containing the financial entity’s lease group details, including organizational hierarchy and structure information for creation or update.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseGroupDto

Example Responses

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

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

Lease Group - Bulk Update

HTTP Request

PUT /api/v1/lease-groups/bulk

Interactive Demo

📋 Description: Updates multiple lease groups within the financial organization structure, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseGroupDto	true	Request body containing a collection of lease group updates, including financial entity details and hierarchical structure adjustments for effective organizational management.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Bulk Create

HTTP Request

POST /api/v1/lease-groups/bulk

Interactive Demo

📋 Description: Creates multiple lease groups in a single operation, facilitating the efficient management of organizational structures within a financial entity.

Parameters

Name	In	Type	Required	Description
body	body	LeaseGroupDto	true	Request body containing a collection of lease group data, including attributes necessary for establishing financial hierarchies within the organization.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLeaseGroupDto

Example Responses

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

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

Lease Group - Bulk Delete

HTTP Request

DELETE /api/v1/lease-groups/bulk

Interactive Demo

📋 Description: Deletes multiple lease groups within the financial organization structure, allowing for streamlined management of organizational hierarchy and entity relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of lease group identifiers to facilitate the bulk deletion of financial entity lease groups within the organizational 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 Group - Search

HTTP Request

POST /api/v1/lease-groups/search

Interactive Demo

📋 Description: Submits a search request for lease groups within the financial organization structure, allowing users to identify and retrieve relevant lease entities based on specified criteria.

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	LeaseGroupDtoFilter	false	Request body containing search criteria for lease groups, including parameters that define the organizational structure and hierarchy within the financial entity.

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",
  "departmentIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLeaseGroupDto

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",
      "departmentId": 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 Group - Detach Department

HTTP Request

POST /api/v1/lease-groups/detach/department/{department_id}

Interactive Demo

📋 Description: Detaches a specified department from its associated lease group within the financial organization structure, facilitating adjustments to the organizational hierarchy and resource allocation.

Parameters

Name	In	Type	Required	Description
department_id	path	integer(int64)	true	Unique identifier for the department within the financial organization structure, used to specify which department’s lease group is being detached.
body	body	LeaseGroupDto	true	Request body containing the department identification details necessary for detaching a lease group within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "departmentId": 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 Group - Attach Department

HTTP Request

POST /api/v1/lease-groups/attach/department/{department_id}

Interactive Demo

📋 Description: Attaches a specified department to a lease group within the financial organization structure, facilitating the alignment of organizational hierarchy and resource management. This operation ensures that financial entities can effectively manage their departmental affiliations within lease agreements.

Parameters

Name	In	Type	Required	Description
department_id	path	integer(int64)	true	Unique identifier for the department within the financial organization structure, used to associate lease groups with the specified department.
body	body	LeaseGroupDto	true	Request body containing the details of the lease group to be attached to the specified department, including relevant identifiers and financial hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "departmentId": 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 Group - Find All

HTTP Request

GET /api/v1/lease-groups

Interactive Demo

📋 Description: Retrieves a list of lease groups within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the lease groups retrieval should be paginated, facilitating efficient navigation through the organizational structure of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLeaseGroupDto

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",
      "departmentId": 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 Group - Create

HTTP Request

POST /api/v1/lease-groups

Interactive Demo

📋 Description: Creates a new lease group within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LeaseGroupDto	true	Request body containing the details of lease groups, including associated financial entities and their hierarchical structure within the organization.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLeaseGroupDto

Example Responses

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

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

Lease Group - Get Metadata

HTTP Request

GET /api/v1/lease-groups/meta

Interactive Demo

📋 Description: Retrieves metadata for lease groups 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

Lease Group - Get All By Department

HTTP Request

GET /api/v1/lease-groups/department/{id}

Interactive Demo

📋 Description: Fetches lease group details for a specified department within the financial organization structure, facilitating insights into organizational hierarchy and resource allocation.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of lease group data within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLeaseGroupDto

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",
      "departmentId": 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

---