Business Unit

Business Unit - Get

HTTP Request

GET /api/v1/business-units/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific business unit within the financial organization structure, identified by the provided unit ID. This operation supports users in understanding the hierarchy and organizational context 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	ResponseBusinessUnitDto

Example Responses

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

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

Business Unit - Update

HTTP Request

PUT /api/v1/business-units/{id}

Interactive Demo

📋 Description: Updates the details of a specified business unit within the financial organization structure, allowing for modifications to its hierarchy and attributes as needed.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	BusinessUnitDto	true	Request body containing the updated details of the specified business unit, including its hierarchical structure and financial attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBusinessUnitDto

Example Responses

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

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

Business Unit - Delete

HTTP Request

DELETE /api/v1/business-units/{id}

Interactive Demo

📋 Description: Deletes a specified business unit from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date.

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

Business Unit - Delete Or Decommission

HTTP Request

PUT /api/v1/business-units/remove/{id}

Interactive Demo

📋 Description: Removes a specified business unit from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date.

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

Business Unit - Delete Or Decommission All

HTTP Request

PUT /api/v1/business-units/remove/bulk

Interactive Demo

📋 Description: Removes multiple business units from the financial organization structure in a single operation, ensuring efficient management of the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of business unit identifiers to facilitate the bulk removal of specified units within 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

Business Unit - Decommission

HTTP Request

PUT /api/v1/business-units/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified business unit within the financial organization structure, effectively removing it from the active hierarchy and ensuring accurate representation of the organization’s operational 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	ResponseBusinessUnitDto

Example Responses

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

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

Business Unit - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/business-units/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions business units within the financial organization structure that have been modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with current operational needs.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning business units that were modified before the given date, ensuring alignment with the organization’s financial structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Decommission Before Now

HTTP Request

PUT /api/v1/business-units/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions business units that have been modified before the current timestamp, ensuring the financial organization structure remains up-to-date and aligned with strategic objectives.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Decommission All

HTTP Request

PUT /api/v1/business-units/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple business units within the financial organization structure, allowing for efficient management of organizational hierarchy and streamlining of financial entity operations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of business unit identifiers and their corresponding decommissioning details for bulk processing within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Create Or Update Bulk

HTTP Request

PUT /api/v1/business-units/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple business units within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities in bulk.

Parameters

Name	In	Type	Required	Description
body	body	BusinessUnitDto	true	Request body containing bulk data for creating or updating business units within the financial organization structure, including details on hierarchy and organizational attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Create Or Update

HTTP Request

PUT /api/v1/business-units/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a business unit within the financial organization structure, ensuring alignment with the existing hierarchy and organizational framework. This operation facilitates the management of financial entities by allowing for seamless adjustments to their structural representation.

Parameters

Name	In	Type	Required	Description
body	body	BusinessUnitDto	true	Request body containing the financial entity details necessary for creating or updating a business unit within the organizational structure and hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBusinessUnitDto

Example Responses

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

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

Business Unit - Bulk Update

HTTP Request

PUT /api/v1/business-units/bulk

Interactive Demo

📋 Description: Updates multiple business units within the financial organization structure, allowing for efficient management of organizational hierarchy and alignment of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	BusinessUnitDto	true	Request body containing a bulk update of business unit information, including organizational hierarchy and financial entity details.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Bulk Create

HTTP Request

POST /api/v1/business-units/bulk

Interactive Demo

📋 Description: Creates multiple business units within the financial organization structure, enabling efficient management of organizational hierarchy and alignment of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	BusinessUnitDto	true	Request body containing an array of business unit definitions, including hierarchical relationships and financial attributes, to facilitate bulk creation within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBusinessUnitDto

Example Responses

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

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

Business Unit - Bulk Delete

HTTP Request

DELETE /api/v1/business-units/bulk

Interactive Demo

📋 Description: Deletes multiple business units within the financial organization structure, allowing for efficient management of organizational hierarchy and streamlining of financial entity operations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the business units 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

Business Unit - Search

HTTP Request

POST /api/v1/business-units/search

Interactive Demo

📋 Description: Submits a search request for business units within the financial organization structure, enabling users to identify and analyze organizational hierarchies and relationships effectively.

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	BusinessUnitDtoExtendedFilter	false	Request body containing search criteria for identifying specific business units within the financial organization structure, including parameters related to organizational hierarchy and entity classification.

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",
  "leaseAreaIdEqual": 0,
  "leaseAreaIdIn": [
    0
  ],
  "companyIdEqual": 0,
  "leaseAreaIdInOrNull": [
    0
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageBusinessUnitDto

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",
      "leaseAreaId": 0,
      "companyId": 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

Business Unit - Detach Lease Area

HTTP Request

POST /api/v1/business-units/detach/lease-area/{lease_area_id}

Interactive Demo

📋 Description: Detaches a specified lease area from the financial organization structure, facilitating updates to the hierarchy and organization of business units within the financial entity.

Parameters

Name	In	Type	Required	Description
lease_area_id	path	integer(int64)	true	Unique identifier for the lease area to be detached from the specified business unit within the financial organization structure.
body	body	BusinessUnitDto	true	Request body containing the details of the business unit to be detached from the specified lease area, including relevant identifiers and metadata for organizational hierarchy within the financial entity.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "leaseAreaId": 0,
    "companyId": 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

Business Unit - Attach Lease Area

HTTP Request

POST /api/v1/business-units/attach/lease-area/{lease_area_id}

Interactive Demo

📋 Description: Attaches a specified lease area to a business unit within the financial organization structure, facilitating the alignment of organizational hierarchy and resource management.

Parameters

Name	In	Type	Required	Description
lease_area_id	path	integer(int64)	true	Unique identifier for the lease area within the financial organization structure, used to attach a business unit to the specified lease area.
body	body	BusinessUnitDto	true	Request body containing the details of the business unit to be attached to the specified lease area, including relevant organizational hierarchy and financial entity information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "leaseAreaId": 0,
    "companyId": 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

Business Unit - Find All

HTTP Request

GET /api/v1/business-units

Interactive Demo

📋 Description: Retrieves a list of business units within the financial organization structure, providing insights into the hierarchical arrangement of financial entities. This operation supports effective management and analysis of organizational resources.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of financial organization structure data for business units.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageBusinessUnitDto

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",
      "leaseAreaId": 0,
      "companyId": 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

Business Unit - Create

HTTP Request

POST /api/v1/business-units

Interactive Demo

📋 Description: Creates a new business unit within the financial organization structure, allowing for the establishment of hierarchical relationships and organizational alignment within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	BusinessUnitDto	true	Request body containing the details of the new business unit, including its name, hierarchy level, and associated financial entity information.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBusinessUnitDto

Example Responses

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

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

Business Unit - Get Metadata

HTTP Request

GET /api/v1/business-units/meta

Interactive Demo

📋 Description: Retrieves metadata for business units 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

Business Unit - Get All By Lease Area

HTTP Request

GET /api/v1/business-units/lease-area/{id}

Interactive Demo

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

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, allowing for efficient retrieval of business unit lease area data within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageBusinessUnitDto

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",
      "leaseAreaId": 0,
      "companyId": 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

---