Plant

Plant - Get

HTTP Request

GET /api/v1/plants/{id}

📋 Description: Retrieves detailed information about a specific financial entity within the organization’s structure and hierarchy, identified by the provided ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePlantDto

Plant - Update

HTTP Request

PUT /api/v1/plants/{id}

📋 Description: Updates the details of a specific financial entity within the organizational structure by modifying the attributes of the plant identified by the provided ID. This operation ensures that the hierarchy remains accurate and reflects any changes in the financial organization.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

PlantDto

true

Request body containing the updated financial entity details, including organizational structure and hierarchy information for the specified plant.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePlantDto

Plant - Delete

HTTP Request

DELETE /api/v1/plants/{id}

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

Plant - Delete Or Decommission

HTTP Request

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

📋 Description: Removes a specified plant 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

Plant - Delete Or Decommission All

HTTP Request

PUT /api/v1/plants/remove/bulk

📋 Description: Removes multiple plants from the financial organization structure, facilitating updates to the hierarchy of financial entities within the system.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of plant identifiers to be removed in bulk from the financial organization structure, ensuring efficient management of the entity’s hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Plant - Decommission

HTTP Request

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

📋 Description: Decommissions a specified financial entity within the organizational structure by updating its status, thereby reflecting changes in the hierarchy. This operation ensures accurate representation of the organization’s financial landscape.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePlantDto

Plant - Decommission By Modification Date Before

HTTP Request

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

📋 Description: Decommissions financial entities in the organization structure that were modified before the specified date, ensuring the hierarchy remains current and relevant.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning plants that were modified before the given date, ensuring alignment with the organization’s financial hierarchy and structural integrity.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Decommission Before Now

HTTP Request

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

📋 Description: Decommissions financial entities in the organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and compliant with operational standards.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Decommission All

HTTP Request

PUT /api/v1/plants/decommission/bulk

📋 Description: Decommissions multiple financial entities within the organizational structure by updating their status in bulk, ensuring efficient management of the hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entities to be decommissioned in bulk, including their identifiers and relevant metadata for organizational structure updates.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Create Or Update Bulk

HTTP Request

PUT /api/v1/plants/createOrUpdate/bulk

📋 Description: Updates or creates multiple plant records within the financial organization structure, ensuring that the hierarchy and organization of financial entities are accurately maintained.

Parameters

Name

In

Type

Required

Description

body

body

PlantDto

true

Request body containing bulk data for creating or updating financial entities within the organizational structure, including hierarchical relationships and relevant attributes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Create Or Update

HTTP Request

PUT /api/v1/plants/createOrUpdate

📋 Description: Creates or updates a financial entity within the organizational structure, ensuring that the hierarchy reflects the latest changes in the plant data.

Parameters

Name

In

Type

Required

Description

body

body

PlantDto

true

Request body containing the financial entity details, including organization structure and hierarchy information, for creating or updating plant records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePlantDto

Plant - Bulk Update

HTTP Request

PUT /api/v1/plants/bulk

📋 Description: Updates the financial organization structure by allowing bulk modifications to plant entities, ensuring alignment with the hierarchical framework of the financial entity.

Parameters

Name

In

Type

Required

Description

body

body

PlantDto

true

Request body containing a bulk update of financial entity plant data, including organizational hierarchy and structure details.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Bulk Create

HTTP Request

POST /api/v1/plants/bulk

📋 Description: Submits a bulk upload of plant data to the financial organization structure, enabling efficient management of hierarchical relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

PlantDto

true

Request body containing a collection of financial entity data to facilitate the bulk creation of organizational structures and hierarchies.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPlantDto

Plant - Bulk Delete

HTTP Request

DELETE /api/v1/plants/bulk

📋 Description: Deletes multiple plant records from the financial organization structure, enabling efficient management of the hierarchy within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of financial entity identifiers for bulk deletion within the organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Plant - Detach Company

HTTP Request

POST /api/v1/plants/detach/company/{companyId}

📋 Description: Detaches a specified company from its associated financial entity within the organizational structure, facilitating updates to the hierarchy as needed.

Parameters

Name

In

Type

Required

Description

companyId

path

integer(int64)

true

Unique identifier for the company

body

body

PlantDto

true

Request body containing the details of the financial entity’s plant attachment to be detached from the specified company, including relevant identifiers and metadata.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Plant - Attach Company

HTTP Request

POST /api/v1/plants/attach/company/{companyId}

📋 Description: Attaches a specified financial entity to a company within the organizational structure, facilitating the integration of hierarchical relationships in the financial organization.

Parameters

Name

In

Type

Required

Description

companyId

path

integer(int64)

true

Unique identifier for the company

body

body

PlantDto

true

Request body containing the financial entity details required to associate a plant with the specified company’s organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Plant - Find All

HTTP Request

GET /api/v1/plants

📋 Description: Retrieves a comprehensive list of financial entities within the organization’s structure, reflecting the hierarchical relationships and organizational framework.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated to facilitate efficient retrieval of financial organization structure data.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePlantDto

Plant - Create

HTTP Request

POST /api/v1/plants

📋 Description: Creates a new financial entity within the organization’s structure, enabling the establishment of a hierarchical framework for effective financial management.

Parameters

Name

In

Type

Required

Description

body

body

PlantDto

true

Request body containing the financial entity details, including organizational structure and hierarchy information necessary for effective management and reporting.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePlantDto

Plant - Get Metadata

HTTP Request

GET /api/v1/plants/meta

📋 Description: Retrieves metadata related to the financial organization structure, including details on the hierarchy and relationships between financial entities. This operation supports users in understanding and navigating the organizational framework effectively.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Plant - Find All By System ID

HTTP Request

GET /api/v1/plants/erp-system/{systemId}

📋 Description: Retrieves the financial organization structure for a specified ERP system, identified by the systemId, providing insights into the hierarchy and relationships 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 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

PagePlantDto

Plant - Get All By Company

HTTP Request

GET /api/v1/plants/company/{company_id}

📋 Description: Retrieves the hierarchical structure of financial entities associated with a specified company, providing insights into the organization’s financial organization structure.

Parameters

Name

In

Type

Required

Description

company_id

path

integer(int64)

true

Unique identifier for the financial entity within the organizational structure, used to retrieve specific plant information associated with the designated company.

pageable

query

Pageable

true

Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of the specified company.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePlantDto