GET
/
api
/
external
/
v2
/
ledger_accounts
List Ledger Accounts
curl --request GET \
  --url https://app.pennylane.com/api/external/v2/ledger_accounts \
  --header 'Authorization: Bearer <token>'
{
  "total_pages": 5,
  "current_page": 1,
  "total_items": 12,
  "per_page": 20,
  "items": [
    {
      "id": 124,
      "number": "512",
      "label": "Secondary Account",
      "vat_rate": "any",
      "country_alpha2": "FR",
      "enabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
page
integer

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

Example:

1

​
per_page
integer

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

Required range: 1 <= x <= 1000
Example:

20

​
filter
string

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
  • enabled: eq
Example:

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

Response

Returns a list of ledger accounts

​
total_pages
integer
required

The total number of pages available

Example:

5

​
current_page
integer
required

The current page returned

Example:

1

​
total_items
integer
required

The total number of items available

Example:

12

​
per_page
integer
required

The number of items returned per page

Example:

20

​
items
object[]
required