Internal Order

Internal Order - Get

HTTP Request

GET /api/v1/internal-orders/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific internal order within the financial organization structure, identified by the provided order ID, to facilitate effective management and oversight of organizational hierarchy 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	ResponseInternalOrderDto

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",
    "internalOrderTypeId": 0,
    "internalOrderTypeDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Internal Order - Update

HTTP Request

PUT /api/v1/internal-orders/{id}

Interactive Demo

📋 Description: Updates the details of a specific internal order identified by its unique ID, allowing for modifications within the financial organization structure to reflect changes in hierarchy or entity requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	InternalOrderDto	true	Request body containing updated financial entity details, including organizational structure and hierarchy information for the specified internal order.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "internalOrderTypeId": 0,
  "internalOrderTypeDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalOrderDto

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",
    "internalOrderTypeId": 0,
    "internalOrderTypeDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Internal Order - Delete

HTTP Request

DELETE /api/v1/internal-orders/{id}

Interactive Demo

📋 Description: Deletes a specified internal order 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

Internal Order - Delete Or Decommission

HTTP Request

PUT /api/v1/internal-orders/remove/{id}

Interactive Demo

📋 Description: Removes a specified internal order from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Internal Order - Delete Or Decommission All

HTTP Request

PUT /api/v1/internal-orders/remove/bulk

Interactive Demo

📋 Description: Removes multiple internal orders from the financial organization structure, facilitating the management of organizational hierarchy and ensuring accurate representation of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk removal from 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

Internal Order - Decommission

HTTP Request

PUT /api/v1/internal-orders/decommission/{id}

Interactive Demo

📋 Description: Decommissions an internal order within the financial organization structure by updating its status, thereby reflecting changes in the organizational hierarchy and financial entity management.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalOrderDto

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",
    "internalOrderTypeId": 0,
    "internalOrderTypeDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Internal Order - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/internal-orders/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Updates the status of internal orders within the financial organization structure that were modified before the specified date, facilitating the management of organizational hierarchy and ensuring accurate financial entity representation.

Parameters

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

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Decommission Before Now

HTTP Request

PUT /api/v1/internal-orders/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of internal orders that were modified before the current date, facilitating the management of financial entity hierarchies within the organization’s structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Decommission All

HTTP Request

PUT /api/v1/internal-orders/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple internal orders to ‘decommission’ within the financial organization structure, facilitating efficient management of organizational hierarchy and resource allocation.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of internal orders to be decommissioned in bulk, including their identifiers and relevant financial entity details for effective organizational structure management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Create Or Update Bulk

HTTP Request

PUT /api/v1/internal-orders/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple internal orders in bulk within the financial organization structure, ensuring alignment with the established hierarchy and organizational needs.

Parameters

Name	In	Type	Required	Description
body	body	InternalOrderDto	true	Request body containing bulk data for creating or updating internal orders, including details on organizational structure and financial entity hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Create Or Update

HTTP Request

PUT /api/v1/internal-orders/createOrUpdate

Interactive Demo

📋 Description: Creates or updates internal orders within the financial organization structure, ensuring alignment with the established hierarchy and organizational needs.

Parameters

Name	In	Type	Required	Description
body	body	InternalOrderDto	true	Request body containing the financial entity’s organizational structure data, including hierarchy details and relevant attributes for creating or updating internal orders.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "internalOrderTypeId": 0,
  "internalOrderTypeDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalOrderDto

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",
    "internalOrderTypeId": 0,
    "internalOrderTypeDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Internal Order - Bulk Update

HTTP Request

PUT /api/v1/internal-orders/bulk

Interactive Demo

📋 Description: Updates multiple internal orders within the financial organization structure, allowing for efficient management of hierarchical relationships and organizational adjustments.

Parameters

Name	In	Type	Required	Description
body	body	InternalOrderDto	true	Request body containing a collection of internal order data, including hierarchical relationships and financial entity details for bulk processing within the organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Bulk Create

HTTP Request

POST /api/v1/internal-orders/bulk

Interactive Demo

📋 Description: Submits multiple internal orders in bulk to streamline the management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	InternalOrderDto	true	Request body containing a collection of internal order data, including details on financial entities and their hierarchical relationships within the organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Internal Order - Bulk Delete

HTTP Request

DELETE /api/v1/internal-orders/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of internal order identifiers to be deleted, reflecting the organizational structure and hierarchy of financial entities.

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

Internal Order - Search

HTTP Request

POST /api/v1/internal-orders/search

Interactive Demo

📋 Description: Submits a search request for internal orders within the financial organization structure, allowing users to filter results based on organizational hierarchy and financial entity attributes.

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	InternalOrderDtoFilter	false	Request body containing search criteria and filters for retrieving internal orders within the financial organization structure, reflecting the hierarchical relationships of financial entities.

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",
  "internalOrderTypeIdEqual": 0,
  "internalOrderTypeDisplayIdLike": "string",
  "controllingAreaIdEqual": 0,
  "controllingAreaDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "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

Internal Order - Detach Internal Order Type

HTTP Request

POST /api/v1/internal-orders/detach/internal-order-type/{internalOrderTypeId}

Interactive Demo

📋 Description: Detaches the specified internal order type from the financial organization structure, facilitating the reorganization of hierarchy within the financial entity. This operation ensures that the internal order type is no longer associated with the current organizational framework.

Parameters

Name	In	Type	Required	Description
internalOrderTypeId	path	integer(int64)	true	Unique identifier for the internal order type
body	body	InternalOrderDto	true	Request body containing the details necessary to detach a specified internal order type from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

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

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

Internal Order - Detach Controlling Area

HTTP Request

POST /api/v1/internal-orders/detach/controlling-area/{controllingAreaId}

Interactive Demo

📋 Description: Detaches a specified controlling area from the internal order structure, facilitating adjustments to the financial organization hierarchy within the enterprise. This operation ensures accurate alignment of financial entities within the organizational framework.

Parameters

Name	In	Type	Required	Description
controllingAreaId	path	integer(int64)	true	Unique identifier for the controlling area
body	body	InternalOrderDto	true	Request body containing the details of the internal order to be detached from the specified controlling area, including relevant identifiers and metadata for accurate processing within the financial organization structure.

Body Parameters

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

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

Internal Order - Attach Internal Order Type

HTTP Request

POST /api/v1/internal-orders/attach/internal-order-type/{internalOrderTypeId}

Interactive Demo

📋 Description: Attaches a specified internal order type to the financial organization structure, facilitating the alignment of organizational hierarchy with financial entities.

Parameters

Name	In	Type	Required	Description
internalOrderTypeId	path	integer(int64)	true	Unique identifier for the internal order type
body	body	InternalOrderDto	true	Request body containing the details for attaching an internal order type, including relevant attributes and identifiers necessary for aligning with the organization’s financial structure and hierarchy.

Body Parameters

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

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

Internal Order - Attach Controlling Area

HTTP Request

POST /api/v1/internal-orders/attach/controlling-area/{controllingAreaId}

Interactive Demo

📋 Description: Attaches a specified controlling area to internal orders within the financial organization structure, facilitating enhanced management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
controllingAreaId	path	integer(int64)	true	Unique identifier for the controlling area
body	body	InternalOrderDto	true	Request body containing the financial entity’s internal order details, including associated metadata and hierarchical structure information for the specified controlling area.

Body Parameters

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

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

Internal Order - Find All

HTTP Request

GET /api/v1/internal-orders

Interactive Demo

📋 Description: Retrieves a list of internal orders within the financial organization structure, providing insights into the hierarchical relationships and financial entities involved.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of internal orders within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "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

Internal Order - Create

HTTP Request

POST /api/v1/internal-orders

Interactive Demo

📋 Description: Creates a new internal order within the financial organization structure, enabling the establishment of hierarchical relationships and management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	InternalOrderDto	true	Request body containing the internal order details, including organizational hierarchy and financial entity attributes, necessary for processing and managing internal transactions.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "internalOrderTypeId": 0,
  "internalOrderTypeDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalOrderDto

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",
    "internalOrderTypeId": 0,
    "internalOrderTypeDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Internal Order - Get Metadata

HTTP Request

GET /api/v1/internal-orders/meta

Interactive Demo

📋 Description: Retrieves metadata related to internal orders within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports informed decision-making and enhances organizational transparency.

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

Internal Order - Get All By Internal Order Type

HTTP Request

GET /api/v1/internal-orders/internal-order-type/{internalOrderTypeId}

Interactive Demo

📋 Description: Retrieves detailed information about a specific internal order type within the financial organization structure, identified by the provided internalOrderTypeId. This operation supports the management of organizational hierarchy and structure for financial entities.

Parameters

Name	In	Type	Required	Description
internalOrderTypeId	path	integer(int64)	true	Unique identifier for the internal order type
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "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

Internal Order - Find All By System ID

HTTP Request

GET /api/v1/internal-orders/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves internal order details for a specified ERP system identified by {systemId}, facilitating the understanding of the organization’s financial structure and hierarchy. This operation supports effective management of financial entities within the organization.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the results of the internal orders query should be paginated, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalOrderDto

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",
      "internalOrderTypeId": 0,
      "internalOrderTypeDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "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

---