BObookingexperts
LedgerAccounts

GET ledger_accounts

Returns ledger_accounts of the administration

get/v3/administrations/{administration_id}/ledger_accounts

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[ledger_account]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[number]string

Filter on number

filter[name]string

Filter on name

filter[report_type]string

Filter on report_type

filter[fixed_type]string

Filter on fixed_type

filter[vat_code]string

Filter on vat_code. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

LedgerAccountCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "ledger_account",
      "attributes": {
        "current_vat_rate": 25
      },
      "relationships": {
        "vat_code": {
          "data": {
            "type": "vat_code"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "vat_code",
      "relationships": {
        "vat_tariffs": {
          "data": [
            {
              "type": "vat_tariff"
            }
          ]
        },
        "current_vat_account": {
          "data": {
            "type": "ledger_account"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.