BObookingexperts
JournalTransactions

GET journal_transactions

Changed on

Returns journal transactions

get/v3/administrations/{administration_id}/journal_transactions

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

periodstring

Deprecated, see aggregated_journal_transactions

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, date, created_at, updated_at

fields[journal_transaction]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[date]string

Filter on date

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[document_type]string

Filter on document_type

filter[transaction_type]string

Filter on transaction_type

filter[transaction_text]string

Filter on transaction_text

filter[debit_ledger_account]string

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

filter[credit_ledger_account]string

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

filter[debit_vat_code]string

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

filter[credit_vat_code]string

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

filter[receipt]string

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

filter[invoice]string

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

filter[payment]string

Filter on payment. 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

JournalTransactionCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "journal_transaction",
      "relationships": {
        "debit_ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "credit_ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "debit_vat_code": {
          "data": {
            "type": "vat_code"
          }
        },
        "credit_vat_code": {
          "data": {
            "type": "vat_code"
          }
        },
        "receipt": {
          "data": {
            "type": "receipt"
          }
        },
        "invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "payment": {
          "data": {
            "type": "payment"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "ledger_account",
      "attributes": {
        "current_vat_rate": 25
      },
      "relationships": {
        "vat_code": {
          "data": {
            "type": "vat_code"
          }
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the optional property /////// to the response with the status