v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Trial balance

Get the trial balance of a company

This endpoint returns the trial balance of the company for the given period.

ℹ️ This endpoint requires the following scope: trial_balance:readonly

get/api/external/firm/v1/companies/{company_id}/trial_balance

Path parameters

company_idinteger required
Example:1

Existing company identifier (id)

Query parameters

period_startstring required
Example:2022-01-01

The start of the period you want the trial balance for.

period_endstring required
Example:2022-12-31

The end of the period you want the trial balance for.

is_auxiliaryboolean
Example:true

Whether to include auxiliary accounts or not.

pageinteger
Example:1

Items are paginated, this is the current page which will be returned. The page index is starting at 1.

per_pageinteger
Example:20

Items are paginated. By default, you get 500 items per page. You can specify another number of items per page.

Response

Returns a list of balances grouped by ledger account.

total_pagesinteger required

The total number of pages available

current_pageinteger required

The current page returned

total_itemsinteger required

The total number of items available

per_pageinteger required

The number of items per page

Example response

{
  "items": [
    {
      "number": "512",
      "label": "Capital souscrit - appelé, versé",
      "debits": "45353.95",
      "credits": "2343.05",
      "formatted_number": "51200000"
    }
  ],
  "total_pages": 5,
  "current_page": 1,
  "total_items": 12,
  "per_page": 40
}