Department

Department - Get

HTTP Request

GET /api/v1/departments/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific department within the financial organization structure, identified by the provided department ID. This operation supports the understanding of organizational hierarchy and structure for effective financial 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	ResponseDepartmentDto

Example Responses

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

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

Department - Update

HTTP Request

PUT /api/v1/departments/{id}

Interactive Demo

📋 Description: Updates the details of a specific department within the financial organization structure, allowing for modifications to the hierarchy and organizational attributes of the entity identified by the provided ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	DepartmentDto	true	Request body containing updated details for the specified department, including its name, hierarchy level, and associated financial entity attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepartmentDto

Example Responses

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

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

Department - Delete

HTTP Request

DELETE /api/v1/departments/{id}

Interactive Demo

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

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

Department - Delete Or Decommission

HTTP Request

PUT /api/v1/departments/remove/{id}

Interactive Demo

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

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

Department - Delete Or Decommission All

HTTP Request

PUT /api/v1/departments/remove/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of department identifiers to be removed in bulk from the financial organization structure, ensuring an updated hierarchy within the 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

Department - Decommission

HTTP Request

PUT /api/v1/departments/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified department within the financial organization structure, effectively removing it from the active hierarchy and ensuring alignment with organizational changes. This operation is essential for maintaining an accurate representation of the entity’s structure.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepartmentDto

Example Responses

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

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

Department - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/departments/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions departments within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with organizational goals.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning departments 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	ResponseListDepartmentDto

Example Responses

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

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

Department - Decommission Before Now

HTTP Request

PUT /api/v1/departments/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions departments within the financial organization structure that were modified before the current timestamp, ensuring an updated and accurate hierarchy of the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepartmentDto

Example Responses

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

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

Department - Decommission All

HTTP Request

PUT /api/v1/departments/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple departments to ‘decommissioned’ within the financial organization structure, facilitating the management of organizational hierarchy and ensuring accurate representation of active entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of department identifiers and their corresponding decommissioning details to facilitate the restructuring of the financial organization hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepartmentDto

Example Responses

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

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

Department - Create Or Update Bulk

HTTP Request

PUT /api/v1/departments/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple departments 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	DepartmentDto	true	Request body containing bulk data for creating or updating departmental structures within the financial organization hierarchy, including relevant attributes and identifiers.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepartmentDto

Example Responses

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

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

Department - Create Or Update

HTTP Request

PUT /api/v1/departments/createOrUpdate

Interactive Demo

📋 Description: Creates or updates department information within the financial organization structure, ensuring accurate representation of the organizational hierarchy for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	DepartmentDto	true	Request body containing the department information, including hierarchy details and financial entity attributes, for creating or updating organizational structures within the financial organization.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepartmentDto

Example Responses

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

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

Department - Bulk Update

HTTP Request

PUT /api/v1/departments/bulk

Interactive Demo

📋 Description: Updates multiple departments within the financial organization structure in a single request, allowing for efficient management of organizational hierarchy and alignment with business objectives.

Parameters

Name	In	Type	Required	Description
body	body	DepartmentDto	true	Request body containing a bulk update of department data, including hierarchical relationships and financial entity attributes, to enhance the organizational structure within the financial organization.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepartmentDto

Example Responses

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

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

Department - Bulk Create

HTTP Request

POST /api/v1/departments/bulk

Interactive Demo

📋 Description: Creates multiple departments within the financial organization structure in a single request, facilitating efficient management of organizational hierarchy and enhancing the overall structure of the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	DepartmentDto	true	Request body containing a collection of department data, including organizational hierarchy and financial entity attributes, for bulk creation or updates within the financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepartmentDto

Example Responses

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

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

Department - Bulk Delete

HTTP Request

DELETE /api/v1/departments/bulk

Interactive Demo

📋 Description: Deletes multiple departments within the financial organization structure, allowing for efficient management of the organizational hierarchy and ensuring alignment with the evolving needs of the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of department identifiers to facilitate the bulk deletion of organizational units within the financial entity’s 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

Department - Search

HTTP Request

POST /api/v1/departments/search

Interactive Demo

📋 Description: Submits a search query to retrieve specific department information within the financial organization structure, enabling users to navigate and understand the hierarchy of 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	DepartmentDtoFilter	false	Request body containing search criteria for identifying specific departments within the financial organization structure, including attributes such as department name, hierarchy level, and organizational unit.

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepartmentDto

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

Department - Detach Company

HTTP Request

POST /api/v1/departments/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from its associated department within the financial organization structure, facilitating adjustments to the organizational hierarchy. This operation is essential for maintaining accurate relationships between financial entities.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to specify which company’s department is being detached.
body	body	DepartmentDto	true	Request body containing the details of the department to be detached from the specified company, including relevant identifiers and hierarchical information within the financial organization structure.

Body Parameters

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

Department - Attach Company

HTTP Request

POST /api/v1/departments/attach/company/{company_id}

Interactive Demo

📋 Description: Attaches a specified company to a department within the financial organization structure, facilitating the establishment of hierarchical relationships and enhancing organizational clarity.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity to which the department will be attached within the organizational structure.
body	body	DepartmentDto	true	Request body containing the department details to be attached to the specified company, including organizational hierarchy and structural attributes relevant to the financial entity.

Body Parameters

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

Department - Find All

HTTP Request

GET /api/v1/departments

Interactive Demo

📋 Description: Retrieves a comprehensive list of departments within the financial organization structure, enabling users to understand the hierarchy and relationships among various financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepartmentDto

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

Department - Create

HTTP Request

POST /api/v1/departments

Interactive Demo

📋 Description: Creates a new department within the financial organization structure, enabling the establishment of a hierarchical framework for managing financial entities.

Parameters

Name	In	Type	Required	Description
body	body	DepartmentDto	true	Request body containing the details of a new department, including its name, hierarchy level, and associated financial entity attributes within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepartmentDto

Example Responses

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

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

Department - Get Metadata

HTTP Request

GET /api/v1/departments/meta

Interactive Demo

📋 Description: Retrieves metadata related to the organizational structure of financial entities, providing insights into departmental hierarchy and relationships within the organization.

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

Department - Get All By Company

HTTP Request

GET /api/v1/departments/company/{id}

Interactive Demo

📋 Description: Retrieves the hierarchical structure of departments within a specified financial organization, allowing users to understand the organizational framework and relationships among various entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of departmental information within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepartmentDto

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

---