Work Breakdown Structure

Work Breakdown Structure - Get

HTTP Request

GET /api/v1/work-breakdown-structures/{id}

Interactive Demo

📋 Description: Retrieves the specified work breakdown structure for a financial entity, providing insights into the organization’s hierarchy and structural organization.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkBreakdownStructureDto

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",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Work Breakdown Structure - Update

HTTP Request

PUT /api/v1/work-breakdown-structures/{id}

Interactive Demo

📋 Description: Updates the specified work breakdown structure within the financial organization hierarchy, allowing for modifications to the organizational structure of the financial entity. This operation ensures that changes to the structure are accurately reflected in the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	WorkBreakdownStructureDto	true	Request body containing the updated details of the work breakdown structure, including hierarchical relationships and financial entity attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "projectId": 0,
  "projectDisplayId": "string",
  "companyId": 0,
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkBreakdownStructureDto

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",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Work Breakdown Structure - Delete

HTTP Request

DELETE /api/v1/work-breakdown-structures/{id}

Interactive Demo

📋 Description: Deletes a specified work breakdown structure from the financial organization hierarchy, ensuring the integrity and accuracy of the organizational structure 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

Work Breakdown Structure - Delete Or Decommission

HTTP Request

PUT /api/v1/work-breakdown-structures/remove/{id}

Interactive Demo

📋 Description: Removes a specified work breakdown structure from the financial organization hierarchy, ensuring the integrity and accuracy of the organizational structure 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

Work Breakdown Structure - Delete Or Decommission All

HTTP Request

PUT /api/v1/work-breakdown-structures/remove/bulk

Interactive Demo

📋 Description: Removes multiple work breakdown structures from the financial organization hierarchy, facilitating streamlined management of organizational structures within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for multiple work breakdown structures to be removed from the financial organization 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

Work Breakdown Structure - Decommission

HTTP Request

PUT /api/v1/work-breakdown-structures/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified work breakdown structure within the financial organization hierarchy, effectively removing it from active use and ensuring the integrity of the organizational 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	ResponseWorkBreakdownStructureDto

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",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Work Breakdown Structure - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/work-breakdown-structures/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions work breakdown structures that were modified before the specified date, ensuring the financial organization hierarchy remains current and aligned with operational needs. This operation is essential for maintaining an accurate and efficient organizational structure within the financial entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Decommission Before Now

HTTP Request

PUT /api/v1/work-breakdown-structures/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions work breakdown structures that have been modified before the current timestamp, ensuring that the financial organization structure remains up-to-date and aligned with the latest operational hierarchy. This operation is essential for maintaining the integrity of financial entities within the organizational framework.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Decommission All

HTTP Request

PUT /api/v1/work-breakdown-structures/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple work breakdown structures within the financial organization hierarchy, facilitating the management of organizational changes and ensuring accurate representation of the financial entity’s structure.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a bulk decommissioning list of work breakdown structures, including identifiers and relevant metadata for financial entity hierarchy management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Create Or Update Bulk

HTTP Request

PUT /api/v1/work-breakdown-structures/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple work breakdown structures within the financial organization hierarchy, enabling efficient management of organizational structures for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	WorkBreakdownStructureDto	true	Request body containing bulk data for creating or updating work breakdown structures, including hierarchical relationships and financial entity details essential for organizational structure management.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Create Or Update

HTTP Request

PUT /api/v1/work-breakdown-structures/createOrUpdate

Interactive Demo

📋 Description: Creates or updates work breakdown structures within the financial organization hierarchy, ensuring accurate representation of organizational entities and their relationships.

Parameters

Name	In	Type	Required	Description
body	body	WorkBreakdownStructureDto	true	Request body containing the details of the work breakdown structure, including organizational hierarchy and financial entity attributes, for creation or update purposes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "projectId": 0,
  "projectDisplayId": "string",
  "companyId": 0,
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkBreakdownStructureDto

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",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Work Breakdown Structure - Bulk Update

HTTP Request

PUT /api/v1/work-breakdown-structures/bulk

Interactive Demo

📋 Description: Updates multiple work breakdown structures within the financial organization hierarchy, enabling efficient management of organizational structure changes for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	WorkBreakdownStructureDto	true	Request body containing a collection of work breakdown structures for updating the financial organization hierarchy and structure within the specified entity.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Bulk Create

HTTP Request

POST /api/v1/work-breakdown-structures/bulk

Interactive Demo

📋 Description: Creates multiple work breakdown structures in bulk for financial entities, enabling efficient organization and hierarchy management within the financial organization structure.

Parameters

Name	In	Type	Required	Description
body	body	WorkBreakdownStructureDto	true	Request body containing a collection of work breakdown structures, including hierarchical relationships and financial entity classifications, to facilitate bulk updates within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

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

Work Breakdown Structure - Bulk Delete

HTTP Request

DELETE /api/v1/work-breakdown-structures/bulk

Interactive Demo

📋 Description: Deletes multiple work breakdown structures within the financial organization hierarchy, enabling efficient management of organizational structures and ensuring alignment with current business needs.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the financial organization structures to be deleted in bulk, reflecting the hierarchy and structure of the financial 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

Work Breakdown Structure - Search

HTTP Request

POST /api/v1/work-breakdown-structures/search

Interactive Demo

📋 Description: Submits a request to search for work breakdown structures within the financial organization hierarchy, enabling users to identify and analyze the organizational structure 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	WorkBreakdownStructureDtoFilter	false	Request body containing the criteria for searching work breakdown structures within the financial organization hierarchy, including relevant parameters to identify specific 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",
  "projectIdEqual": 0,
  "projectDisplayIdEqual": "string",
  "companyIdIn": [
    0
  ],
  "controllingAreaIdEqual": 0,
  "controllingAreaDisplayIdEqual": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "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

Work Breakdown Structure - Detach Project

HTTP Request

POST /api/v1/work-breakdown-structures/detach/project/{relation_id}

Interactive Demo

📋 Description: Detaches a specified project from the work breakdown structure within the financial organization hierarchy, facilitating adjustments to the organizational structure of financial entities.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the specific relationship within the financial organization structure that is to be detached from the project.
body	body	WorkBreakdownStructureDto	true	Request body containing the details required to detach a project from the work breakdown structure, including relevant identifiers and metadata related to the financial organization hierarchy.

Body Parameters

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

Work Breakdown Structure - Detach Controlling Area

HTTP Request

POST /api/v1/work-breakdown-structures/detach/controlling-area/{relation_id}

Interactive Demo

📋 Description: Detaches a specified controlling area from a work breakdown structure, facilitating the reorganization of financial entities within the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the controlling area within the financial organization structure, used to detach associated work breakdown structures.
body	body	WorkBreakdownStructureDto	true	Request body containing the details required to detach a controlling area from a work breakdown structure, including relevant identifiers and hierarchical relationships within the financial organization structure.

Body Parameters

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

Work Breakdown Structure - Attach Project

HTTP Request

POST /api/v1/work-breakdown-structures/attach/project/{relation_id}

Interactive Demo

📋 Description: Attaches a specified project to a work breakdown structure within the financial organization hierarchy, enabling enhanced management and visibility of project-related financial entities.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the specific project within the financial organization structure to which the work breakdown structure will be attached.
body	body	WorkBreakdownStructureDto	true	Request body containing the project attachment details, including the relation ID and associated financial entity information, to facilitate the integration of organizational structure within the hierarchy.

Body Parameters

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

Work Breakdown Structure - Attach Controlling Area

HTTP Request

POST /api/v1/work-breakdown-structures/attach/controlling-area/{relation_id}

Interactive Demo

📋 Description: Attaches a controlling area to a specified work breakdown structure, facilitating the alignment of financial entities within the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the controlling area within the financial organization structure, facilitating the attachment of work breakdown structures.
body	body	WorkBreakdownStructureDto	true	Request body containing the financial entity details necessary to establish a hierarchical relationship within the organization’s work breakdown structure, identified by the specified relation_id.

Body Parameters

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

Work Breakdown Structure - Find All

HTTP Request

GET /api/v1/work-breakdown-structures

Interactive Demo

📋 Description: Retrieves the work breakdown structures for financial entities, providing insights into the organization’s hierarchy and structural composition.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the work breakdown structures should be returned in a paginated format, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "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

Work Breakdown Structure - Create

HTTP Request

POST /api/v1/work-breakdown-structures

Interactive Demo

📋 Description: Creates a new work breakdown structure within the financial organization hierarchy, enabling the definition and management of financial entities and their associated organizational components.

Parameters

Name	In	Type	Required	Description
body	body	WorkBreakdownStructureDto	true	Request body containing the hierarchical data for the financial organization structure, including details on entities and their relationships.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "projectId": 0,
  "projectDisplayId": "string",
  "companyId": 0,
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkBreakdownStructureDto

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",
    "projectId": 0,
    "projectDisplayId": "string",
    "companyId": 0,
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

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

Work Breakdown Structure - Get All By Project

HTTP Request

GET /api/v1/work-breakdown-structures/project/{project_id}

Interactive Demo

📋 Description: Retrieves the work breakdown structure for a specified project, providing insights into the organizational hierarchy and financial entity structure relevant to project management.

Parameters

Name	In	Type	Required	Description
project_id	path	integer(int64)	true	Unique identifier for the specific project within the financial organization structure, used to retrieve its associated work breakdown structures.
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of structured financial data related to the specified project within the organization’s hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "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

Work Breakdown Structure - Get Metadata

HTTP Request

GET /api/v1/work-breakdown-structures/meta

Interactive Demo

📋 Description: Retrieves metadata for work breakdown structures within the financial organization hierarchy, providing essential insights into the organizational structure of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

Work Breakdown Structure - Find All By System ID

HTTP Request

GET /api/v1/work-breakdown-structures/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the work breakdown structure for a specified ERP system, providing insights into the organizational hierarchy and financial entity structure essential for effective financial 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	PageWorkBreakdownStructureDto

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",
      "projectId": 0,
      "projectDisplayId": "string",
      "companyId": 0,
      "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

---