PEpennylane
Ledger Accounts

List ledger accounts

Changed on

⚠️ This endpoint is deprecated. Use List Ledger Accounts from the Company API v2 instead. Your firm token can call it for any company of your firm through the X-Company-Id header. Learn how to use your firm token with the Company API v2.

List ledger accounts

ℹ️ This endpoint requires one of the following scopes: ledger_accounts:all, ledger_accounts:readonly

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

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/firm/v1/companies/{company_id}/ledger_accounts
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: ledger_accounts:all, ledger_accounts:readonly

Path parameters

company_idinteger required

Existing company identifier (id)

Query parameters

cursorstring
Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

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
Example:20

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

filterstring
Example:[{"field": "number", "operator": "start_with", "value": "411"}]

You can choose to filter items on specific fields. Available fields and values:

  • id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • number: start_with, eq, in
  • enabled: eq

Response

Returns a list of 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

{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 124,
      "number": "512",
      "label": "Secondary Account",
      "vat_rate": "any",
      "country_alpha2": "FR",
      "enabled": true,
      "archived_at": "2023-08-30T10:08:08.146343Z"
    }
  ]
}

Changes