General Ledger Account

General Ledger Account - Get

HTTP Request

GET /api/v1/general-ledger-accounts/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific general ledger account identified by the provided ID, facilitating insights into the organization’s financial structure and hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGeneralLedgerAccountDto

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",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
}

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

General Ledger Account - Update

HTTP Request

PUT /api/v1/general-ledger-accounts/{id}

Interactive Demo

📋 Description: Updates the details of a specific general ledger account identified by the provided ID, ensuring that the financial organization structure remains accurate and aligned with the entity’s hierarchy. This operation facilitates the management of financial accounts within the organization.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	GeneralLedgerAccountDto	true	Request body containing the updated financial entity details for the specified general ledger account, including attributes related to the organization’s structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "shortName": "string",
  "longName": "string",
  "accountCategory": "BALANCESHEET",
  "accountTarget": "ALL",
  "companyId": 0,
  "openItemManagement": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGeneralLedgerAccountDto

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",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
}

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

General Ledger Account - Delete

HTTP Request

DELETE /api/v1/general-ledger-accounts/{id}

Interactive Demo

📋 Description: Deletes a specified general ledger account 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

{
  "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

General Ledger Account - Delete Or Decommission

HTTP Request

PUT /api/v1/general-ledger-accounts/remove/{id}

Interactive Demo

📋 Description: Removes a specified general ledger account 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

{
  "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

General Ledger Account - Delete Or Decommission All

HTTP Request

PUT /api/v1/general-ledger-accounts/remove/bulk

Interactive Demo

📋 Description: Removes multiple general ledger accounts in a single operation, streamlining the management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for general ledger accounts to be removed in bulk, facilitating the management of the financial organization structure.

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

General Ledger Account - Decommission

HTTP Request

PUT /api/v1/general-ledger-accounts/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified general ledger account within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that the organization maintains an accurate and up-to-date financial 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	ResponseGeneralLedgerAccountDto

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",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
}

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

General Ledger Account - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/general-ledger-accounts/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions general ledger accounts modified before the specified date, ensuring the financial organization structure remains current and aligned with organizational hierarchy requirements. This operation helps maintain the integrity of financial entities by removing outdated accounts.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning general ledger accounts, ensuring that only accounts modified before this date are processed within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Decommission Before Now

HTTP Request

PUT /api/v1/general-ledger-accounts/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions general ledger accounts that have been modified before the current date, ensuring the financial organization structure remains accurate and up-to-date. This operation is essential for maintaining the integrity of the financial entity’s hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Decommission All

HTTP Request

PUT /api/v1/general-ledger-accounts/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple general ledger accounts in a single operation, facilitating the management of financial entity structures within the organization’s hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of general ledger account identifiers to be decommissioned in bulk, facilitating the management of the financial organization structure and hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Create Or Update Bulk

HTTP Request

PUT /api/v1/general-ledger-accounts/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple general ledger accounts in bulk, ensuring alignment with the financial organization structure and hierarchy of the specified financial entity.

Parameters

Name	In	Type	Required	Description
body	body	GeneralLedgerAccountDto	true	Request body containing bulk data for creating or updating general ledger accounts, including organizational structure details and financial entity attributes.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Create Or Update

HTTP Request

PUT /api/v1/general-ledger-accounts/createOrUpdate

Interactive Demo

📋 Description: Creates or updates general ledger accounts within the financial organization structure, ensuring accurate representation of the hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	GeneralLedgerAccountDto	true	Request body containing the financial entity details necessary for creating or updating general ledger accounts within the organizational structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "shortName": "string",
  "longName": "string",
  "accountCategory": "BALANCESHEET",
  "accountTarget": "ALL",
  "companyId": 0,
  "openItemManagement": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGeneralLedgerAccountDto

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",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
}

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

General Ledger Account - Bulk Update

HTTP Request

PUT /api/v1/general-ledger-accounts/bulk

Interactive Demo

📋 Description: Updates multiple general ledger accounts in bulk, allowing organizations to efficiently manage their financial entity structures and hierarchies within the financial organization framework.

Parameters

Name	In	Type	Required	Description
body	body	GeneralLedgerAccountDto	true	Request body containing a collection of general ledger account details, including account identifiers, descriptions, and hierarchy information, to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Bulk Create

HTTP Request

POST /api/v1/general-ledger-accounts/bulk

Interactive Demo

📋 Description: Creates multiple general ledger accounts in bulk, enabling efficient management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	GeneralLedgerAccountDto	true	Request body containing an array of general ledger account details, including account identifiers, descriptions, and hierarchical relationships, essential for structuring financial entities within the organization.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ]
}

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

General Ledger Account - Bulk Delete

HTTP Request

DELETE /api/v1/general-ledger-accounts/bulk

Interactive Demo

📋 Description: Deletes multiple general ledger accounts in a single operation, streamlining the management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the general ledger accounts to be deleted in bulk, facilitating efficient management of the financial organization structure.

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

General Ledger Account - Search

HTTP Request

POST /api/v1/general-ledger-accounts/search

Interactive Demo

📋 Description: Submits a request to search for general ledger accounts within the financial organization structure, allowing users to filter results based on specific criteria related to the organization and its hierarchical 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	GeneralLedgerAccountDtoFilter	false	Request body containing search criteria and filters for retrieving general ledger 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

{
  "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",
  "shortNameLike": "string",
  "longNameLike": "string",
  "accountCategoryIn": [
    "BALANCESHEET"
  ],
  "accountTargetIn": [
    "ALL"
  ],
  "companyIdEqual": 0,
  "openItemManagementEqual": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ],
  "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

General Ledger Account - Detach Company

HTTP Request

POST /api/v1/general-ledger-accounts/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified general ledger account from a financial entity within the organization’s structure, ensuring the integrity of the hierarchy is maintained. This operation is essential for managing financial relationships and organizational alignment.

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 general ledger accounts from the specified company.
body	body	GeneralLedgerAccountDto	true	Request body containing the financial entity identifiers and relevant metadata required to detach a general ledger account from the specified company within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
]

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

General Ledger Account - Attach Company

HTTP Request

POST /api/v1/general-ledger-accounts/attach/company/{company_id}

Interactive Demo

📋 Description: Attaches a specified general ledger account to a designated company within the financial organization structure, facilitating the alignment of financial entities within the organizational 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 attach general ledger accounts to the specified company.
body	body	GeneralLedgerAccountDto	true	Request body containing the financial entity details required to associate a general ledger account with the specified company within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
]

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

General Ledger Account - Find All

HTTP Request

GET /api/v1/general-ledger-accounts

Interactive Demo

📋 Description: Retrieves a list of general ledger accounts within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the general ledger accounts retrieval should be paginated, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ],
  "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

General Ledger Account - Create

HTTP Request

POST /api/v1/general-ledger-accounts

Interactive Demo

📋 Description: Creates a new general ledger account within the financial organization structure, enabling the establishment of a hierarchical framework for managing financial entities.

Parameters

Name	In	Type	Required	Description
body	body	GeneralLedgerAccountDto	true	Request body containing the details for creating a new general ledger account, including account name, type, hierarchy level, and associated financial entity information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "shortName": "string",
  "longName": "string",
  "accountCategory": "BALANCESHEET",
  "accountTarget": "ALL",
  "companyId": 0,
  "openItemManagement": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseGeneralLedgerAccountDto

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",
    "shortName": "string",
    "longName": "string",
    "accountCategory": "BALANCESHEET",
    "accountTarget": "ALL",
    "companyId": 0,
    "openItemManagement": true
  }
}

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

General Ledger Account - Get Metadata

HTTP Request

GET /api/v1/general-ledger-accounts/meta

Interactive Demo

📋 Description: Retrieves metadata for general ledger accounts within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports users in understanding the organizational framework for effective financial management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "SHORT_NAME"
]

Response Schema

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

General Ledger Account - Find All By System ID

HTTP Request

GET /api/v1/general-ledger-accounts/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves general ledger account details for a specified ERP system, facilitating insights into the financial organization structure and hierarchy of the 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 entity’s general ledger accounts within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ],
  "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

General Ledger Account - Get All By Company

HTTP Request

GET /api/v1/general-ledger-accounts/company/{company_id}

Interactive Demo

📋 Description: Retrieves general ledger accounts for a specified company, providing insights into the financial structure and hierarchy of the organization. This operation supports effective management of financial entities within the broader organizational context.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organization’s structure, used to retrieve general ledger accounts associated with the specified company.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of general ledger accounts within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGeneralLedgerAccountDto

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",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL",
      "companyId": 0,
      "openItemManagement": true
    }
  ],
  "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

---