PEpennylane
Trial balance

Get the trial balance

Changed on

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

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

get/api/external/v2/trial_balance

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/trial_balance
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: trial_balance:readonly

Query parameters

period_startstring date required
Example:2022-01-01

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

period_endstring date 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.

cursorstring
Example:MjAyNS0wMS0wOVQwODoyNDozOC44MTI0NTha

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

limitinteger

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 1000.

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

Returns a list of balances grouped by ledger accounts.

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring nullable required

Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A null next_cursor in the response indicates no further results.

Example response

{
  "items": [
    {
      "number": "512",
      "formatted_number": "51200000",
      "label": "Capital souscrit - appelé, versé",
      "debits": "45353.95",
      "credits": "2343.05"
    }
  ],
  "has_more": true
}

Changes