Project

Project - Get

HTTP Request

GET /api/v1/projects/{id}

📋 Description: Retrieves detailed information about a specific financial entity’s project within the organizational structure, identified by the provided project 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

ResponseProjectDto

Project - Update

HTTP Request

PUT /api/v1/projects/{id}

📋 Description: Updates the details of a specified financial entity within the organization’s structure, allowing for modifications to the project’s hierarchy and attributes.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProjectDto

true

Request body containing updated details of the financial entity’s project, including organizational structure, hierarchy adjustments, and relevant metadata.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseProjectDto

Project - Delete

HTTP Request

DELETE /api/v1/projects/{id}

📋 Description: Deletes a specified project from the financial organization structure, thereby removing it from the hierarchy 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

Project - Delete Or Decommission

HTTP Request

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

📋 Description: Removes a specified project from the financial organization structure, ensuring that 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

Project - Delete Or Decommission All

HTTP Request

PUT /api/v1/projects/remove/bulk

📋 Description: Removes multiple projects from the financial organization structure in a single operation, streamlining the 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 project identifiers to be removed in bulk from the financial organization structure, ensuring streamlined management of organizational hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Project - Decommission

HTTP Request

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

📋 Description: Decommissions a specified project within the financial organization structure, effectively removing it from the active hierarchy and ensuring accurate representation of the entity’s organizational 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

ResponseProjectDto

Project - Decommission By Modification Date Before

HTTP Request

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

📋 Description: Updates the status of financial entities within the organization structure that were modified before the specified date, facilitating effective management of the hierarchy and ensuring compliance with organizational policies.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for retrieving projects that were modified before the given date, facilitating effective management of organizational structure changes within financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Decommission Before Now

HTTP Request

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

📋 Description: Updates the status of financial organization projects that were modified before the current date, facilitating the management of the organizational structure and hierarchy within the financial entity.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Decommission All

HTTP Request

PUT /api/v1/projects/decommission/bulk

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

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity identifiers and their corresponding decommissioning details to facilitate bulk updates within the organization’s hierarchical structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Create Or Update Bulk

HTTP Request

PUT /api/v1/projects/createOrUpdate/bulk

📋 Description: Updates or creates multiple financial organization structures in bulk, enabling efficient management of hierarchies and entities within the financial domain.

Parameters

Name

In

Type

Required

Description

body

body

ProjectDto

true

Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and associated financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Create Or Update

HTTP Request

PUT /api/v1/projects/createOrUpdate

📋 Description: Creates or updates a financial organization structure within the specified hierarchy, ensuring that the project aligns with the overall organizational framework of the financial entity.

Parameters

Name

In

Type

Required

Description

body

body

ProjectDto

true

Request body containing the financial organization structure data, including details on hierarchy and entity attributes for creating or updating projects.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseProjectDto

Project - Bulk Update

HTTP Request

PUT /api/v1/projects/bulk

📋 Description: Updates the financial organization structure by allowing bulk modifications to project hierarchies within a specified financial entity, ensuring alignment with organizational goals.

Parameters

Name

In

Type

Required

Description

body

body

ProjectDto

true

Request body containing an array of financial entity project updates, including organizational structure and hierarchy details for bulk processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Bulk Create

HTTP Request

POST /api/v1/projects/bulk

📋 Description: Submits a bulk creation request for multiple financial organization structures, allowing for efficient management of hierarchical relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

ProjectDto

true

Request body containing a collection of financial entity project data, including organization structure and hierarchy details for bulk processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListProjectDto

Project - Bulk Delete

HTTP Request

DELETE /api/v1/projects/bulk

📋 Description: Deletes multiple projects within the financial organization structure, allowing for efficient management of the hierarchy and organization of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of project identifiers to facilitate the bulk deletion of financial entities within the organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Project - Detach Company

HTTP Request

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

📋 Description: Detaches a specified company from its associated project within the financial organization structure, facilitating adjustments to the organizational hierarchy and enhancing financial entity management.

Parameters

Name

In

Type

Required

Description

company_id

path

integer(int64)

true

Unique identifier for the financial entity within the organizational structure, used to detach a company from a project.

body

body

ProjectDto

true

Request body containing the financial entity details necessary to detach a company from the organizational structure, including relevant identifiers and hierarchy information.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Project - Attach Company

HTTP Request

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

📋 Description: Attaches a specified company to a project within the financial organization structure, facilitating the integration of financial entities into the established hierarchy.

Parameters

Name

In

Type

Required

Description

company_id

path

integer(int64)

true

Unique identifier for the financial entity within the organizational structure, used to associate a project with a specific company during the attachment process.

body

body

ProjectDto

true

Request body containing the financial entity details required to associate a company with the organizational structure and hierarchy of projects.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Project - Find All

HTTP Request

GET /api/v1/projects

📋 Description: Retrieves a list of financial entities within the organization’s structure, providing insights into the hierarchy and relationships among projects.

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 navigation through large datasets.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageProjectDto

Project - Create

HTTP Request

POST /api/v1/projects

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

Parameters

Name

In

Type

Required

Description

body

body

ProjectDto

true

Request body containing the financial entity’s project details, including name, description, budget, and hierarchical structure within the organization.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseProjectDto

Project - Get Metadata

HTTP Request

GET /api/v1/projects/meta

📋 Description: Retrieves metadata related to the financial organization structure, including details on hierarchy and relationships among financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Project - Find All By System ID

HTTP Request

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

📋 Description: Retrieves detailed information about a specific financial entity’s organizational structure within the ERP system, identified by the provided system ID.

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 financial organization structure query should be returned in a paginated format, facilitating efficient navigation through potentially large datasets related to the specified ERP system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageProjectDto

Project - Get All By Company

HTTP Request

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

📋 Description: Retrieves the organizational structure of financial projects associated with a specified company, providing insights into the hierarchy and relationships within the financial entity.

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 associated projects.

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

PageProjectDto