Functional Area

Functional Area - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific functional area within the financial organization structure, identified by the provided ID, to facilitate understanding of the organization’s hierarchy and 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	ResponseFunctionalAreaDto

Example Responses

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

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

Functional Area - Update

HTTP Request

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

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	FunctionalAreaDto	true	Request body containing the updated details of the specified financial entity’s organizational structure, including hierarchy and relevant attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFunctionalAreaDto

Example Responses

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

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

Functional Area - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified functional area within the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective organizational 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	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

Functional Area - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified functional area from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective organizational 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	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

Functional Area - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple functional areas from the financial organization structure, allowing for streamlined management of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers to be removed from the organizational structure in bulk.

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

Functional Area - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified functional area within the financial organization structure, effectively removing it from the active hierarchy and ensuring alignment with organizational 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	ResponseFunctionalAreaDto

Example Responses

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

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

Functional Area - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of financial entities within the organization structure that were modified before the specified date, facilitating the decommissioning process in alignment with organizational hierarchy management.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which any modifications to the financial organization structure are considered for decommissioning.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Updates the decommission status of financial entities within the organizational structure that were modified before the current date, ensuring accurate hierarchy management and compliance within the financial organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of multiple financial entities within the organizational structure to decommission, allowing for efficient management of hierarchy changes in the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and their associated hierarchy details for bulk decommissioning within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple financial entities within the organizational structure, ensuring alignment with the defined hierarchy and facilitating efficient management of the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	FunctionalAreaDto	true	Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and entity relationships.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Create Or Update

HTTP Request

PUT /api/v1/functional-areas/createOrUpdate

Interactive Demo

📋 Description: Creates or updates the financial organization structure by defining or modifying the hierarchy of financial entities within the organization.

Parameters

Name	In	Type	Required	Description
body	body	FunctionalAreaDto	true	Request body containing the financial organization structure data, including details for creating or updating the hierarchy and attributes of the financial entity.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFunctionalAreaDto

Example Responses

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

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

Functional Area - Bulk Update

HTTP Request

PUT /api/v1/functional-areas/bulk

Interactive Demo

📋 Description: Updates multiple functional areas 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	FunctionalAreaDto	true	Request body containing a list of financial entity structures and their hierarchical relationships for bulk updates to the organization’s financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Bulk Create

HTTP Request

POST /api/v1/functional-areas/bulk

Interactive Demo

📋 Description: Submits a bulk creation request for multiple functional areas within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	FunctionalAreaDto	true	Request body containing a collection of financial entity organizational structure data, including hierarchical relationships and associated attributes for bulk processing.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFunctionalAreaDto

Example Responses

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

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

Functional Area - Bulk Delete

HTTP Request

DELETE /api/v1/functional-areas/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for bulk deletion within the organizational structure hierarchy.

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

Functional Area - Search

HTTP Request

POST /api/v1/functional-areas/search

Interactive Demo

📋 Description: Submits a search request to retrieve financial organization structure details, enabling users to explore the hierarchy and relationships within 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	FunctionalAreaDtoFilter	false	Request body containing search criteria for financial entities within the organizational structure, including parameters for hierarchy and specific attributes related to the financial organization.

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",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFunctionalAreaDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "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

Functional Area - Find All

HTTP Request

GET /api/v1/functional-areas

Interactive Demo

📋 Description: Retrieves the hierarchical structure of financial entities within the organization, providing insights into functional areas and their relationships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFunctionalAreaDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "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

Functional Area - Create

HTTP Request

POST /api/v1/functional-areas

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	FunctionalAreaDto	true	Request body containing the financial organization structure data, including details on the hierarchy and relationships of financial entities.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFunctionalAreaDto

Example Responses

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

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

Functional Area - Get Metadata

HTTP Request

GET /api/v1/functional-areas/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, including details on organizational hierarchy and financial entities, to facilitate effective management and analysis.

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

Functional Area - Find All By System ID

HTTP Request

GET /api/v1/functional-areas/erp-system/{systemId}

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure associated with the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFunctionalAreaDto

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",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "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

---