Chart Of Account

Get A Resource By ID

HTTP Request

GET /api/v1/chart-of-accounts/{id}

📋 Description: Retrieves the details of a specific chart of accounts identified by the provided ID, facilitating insights into the financial organization structure and hierarchy of 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

ResponseChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "documentType": "string",
22    "companyId": 0
23  }
24}

Update A Resource

HTTP Request

PUT /api/v1/chart-of-accounts/{id}

📋 Description: Updates the details of a specific chart of accounts entry identified by its unique ID, enabling organizations to maintain an accurate financial structure and hierarchy within their financial entity.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ChartOfAccountDto

true

Request body containing the updated financial account details, including account name, type, and hierarchy level, for the specified financial entity.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "documentType": "string",
 9  "companyId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "documentType": "string",
22    "companyId": 0
23  }
24}

Delete

HTTP Request

DELETE /api/v1/chart-of-accounts/{id}

📋 Description: Deletes a specified chart of accounts entry from the financial organization structure, ensuring the integrity of the hierarchy 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission

HTTP Request

PUT /api/v1/chart-of-accounts/remove/{id}

📋 Description: Removes a specified chart of accounts entry from the financial organization structure, ensuring the integrity of the hierarchy 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission All

HTTP Request

PUT /api/v1/chart-of-accounts/remove/bulk

📋 Description: Removes multiple entries from the chart of accounts in a financial organization structure, streamlining the hierarchy and ensuring accurate representation of the financial entity’s structure.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of financial entity identifiers to facilitate the bulk removal of specified accounts from the organizational structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Decommission

HTTP Request

PUT /api/v1/chart-of-accounts/decommission/{id}

📋 Description: Decommissions a specified chart of accounts entry within the financial organization structure, effectively removing it from the active hierarchy of the financial entity. This operation ensures that the organizational structure remains current and reflects any necessary changes in financial reporting.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "documentType": "string",
22    "companyId": 0
23  }
24}

Decommission By Modification Date Before

HTTP Request

PUT /api/v1/chart-of-accounts/decommission/modified-before/{modified_before}

📋 Description: Decommissions financial accounts that have been modified before the specified date, ensuring the organization’s financial structure remains current and aligned with operational needs. This operation supports the maintenance of a streamlined hierarchy within the financial entity.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning chart of accounts entries 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

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Decommission Before Now

HTTP Request

PUT /api/v1/chart-of-accounts/decommission/modified-before-now

📋 Description: Decommissions financial accounts that have been modified before the current date, ensuring the organization’s financial structure remains up-to-date and aligned with its operational hierarchy. This operation supports the maintenance of an accurate and efficient chart of accounts within the financial entity.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Decommission All

HTTP Request

PUT /api/v1/chart-of-accounts/decommission/bulk

📋 Description: Decommissions multiple entries in the chart of accounts, enabling organizations to maintain an accurate financial structure and hierarchy within their financial entity.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of financial entity identifiers and associated metadata for bulk decommissioning within the organizational structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/chart-of-accounts/createOrUpdate/bulk

📋 Description: Updates or creates multiple entries in the chart of accounts for a financial entity, enabling efficient management of the organization’s financial structure and hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

ChartOfAccountDto

true

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

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "documentType": "string",
10    "companyId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Create Or Update A Resource

HTTP Request

PUT /api/v1/chart-of-accounts/createOrUpdate

📋 Description: Creates or updates a chart of accounts within the financial organization structure, ensuring accurate representation of the organization’s hierarchy and financial entities.

Parameters

Name

In

Type

Required

Description

body

body

ChartOfAccountDto

true

Request body containing the financial entity’s chart of accounts data, including details for creating or updating the organization’s structure and hierarchy.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "documentType": "string",
 9  "companyId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "documentType": "string",
22    "companyId": 0
23  }
24}

Bulk-Update Resources

HTTP Request

PUT /api/v1/chart-of-accounts/bulk

📋 Description: Updates the chart of accounts in bulk for a financial entity, allowing organizations to efficiently manage their financial structure and hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

ChartOfAccountDto

true

Request body containing bulk updates for the chart of accounts, including organizational structure details and financial entity hierarchy information.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "documentType": "string",
10    "companyId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Bulk Create

HTTP Request

POST /api/v1/chart-of-accounts/bulk

📋 Description: Facilitates the bulk creation of chart of accounts entries within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities.

Parameters

Name

In

Type

Required

Description

body

body

ChartOfAccountDto

true

Request body containing bulk data for the chart of accounts, including account details and hierarchical structure necessary for financial organization management.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "documentType": "string",
10    "companyId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "documentType": "string",
23      "companyId": 0
24    }
25  ]
26}

Bulk Delete

HTTP Request

DELETE /api/v1/chart-of-accounts/bulk

📋 Description: Deletes multiple entries from the chart of accounts, allowing for streamlined management of the financial organization structure within a hierarchy 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 deletion within the organization’s chart of accounts structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Search Resources

HTTP Request

POST /api/v1/chart-of-accounts/search

📋 Description: Submits a request to search for specific entries within the chart of accounts, enabling organizations to efficiently navigate their financial structure and hierarchy.

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

ChartOfAccountDtoFilter

false

Request body containing search criteria and filters for retrieving specific entries from the chart of accounts within the financial organization structure.

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

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "nameLike": "string",
29  "documentTypeLike": "string",
30  "companyIdEqual": 0
31}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChartOfAccountDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "documentType": "string",
27      "companyId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Detach Company From Chart Of Account

HTTP Request

POST /api/v1/chart-of-accounts/detach/company/{company_id}

📋 Description: Detaches a specified company from the chart of accounts, thereby updating the financial organization structure and hierarchy within the system.

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 the chart of accounts.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Attach Company Tcontrolling Area

HTTP Request

POST /api/v1/chart-of-accounts/attach/company/{company_id}/{chart_of_account_id}

📋 Description: Attaches a specified chart of accounts to a designated company within the financial organization structure, facilitating the alignment of financial entities and their hierarchical frameworks.

Parameters

Name

In

Type

Required

Description

company_id

path

integer(int64)

true

Unique identifier for the financial entity within the organizational structure to which the chart of accounts will be attached.

chart_of_account_id

path

integer(int64)

true

Unique identifier for the chart of accounts to be attached to the specified company, facilitating the organization and hierarchy of financial entities within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

List All Resources

HTTP Request

GET /api/v1/chart-of-accounts

📋 Description: Retrieves the chart of accounts for the specified financial entity, providing an organized view of the organization’s financial structure and hierarchy.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response for the chart of accounts should be paginated, facilitating efficient data retrieval within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChartOfAccountDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "documentType": "string",
27      "companyId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Create

HTTP Request

POST /api/v1/chart-of-accounts

📋 Description: Creates a new chart of accounts within the financial organization structure, enabling users to define and manage the hierarchy of financial entities effectively.

Parameters

Name

In

Type

Required

Description

body

body

ChartOfAccountDto

true

Request body containing the financial entity’s chart of accounts data, including account classifications and hierarchical structure for organizational financial management.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "documentType": "string",
 9  "companyId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseChartOfAccountDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "documentType": "string",
22    "companyId": 0
23  }
24}

Get Metadata

HTTP Request

GET /api/v1/chart-of-accounts/meta

📋 Description: Retrieves metadata for the chart of accounts, providing essential information on the financial organization structure and hierarchy of the specified financial entity.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "NAME"
3]

Response Schema

Find All By System ID

HTTP Request

GET /api/v1/chart-of-accounts/erp-system/{systemId}

📋 Description: Retrieves the chart of accounts for a specified ERP system, providing insights into the financial organization structure and hierarchy of the associated financial entity.

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 of the specified ERP system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChartOfAccountDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "documentType": "string",
27      "companyId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Find All By Company

HTTP Request

GET /api/v1/chart-of-accounts/company/{company_id}

📋 Description: Retrieves the chart of accounts for a specified financial entity, providing a structured overview of the organization’s financial hierarchy and account organization.

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 the chart of accounts for the specified company.

pageable

query

Pageable

true

Indicates whether the results of the chart of accounts for the specified company should be returned in a paginated format, facilitating efficient navigation through the financial entity’s organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChartOfAccountDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "documentType": "string",
27      "companyId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}