BObookingexperts
AggregatedJournalTransactions

GET aggregated_journal_transactions

Returns aggregate journal transactions for the provided :period

get/v3/administrations/{administration_id}/aggregated_journal_transactions

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

periodstring required

End date exclusive. So 2021-01-01..2021-01-02 means 2021-01-01 00:00 until 2021-01-02 00:00

ledger_account_idinteger

Filter on ledger_account_id

fields[aggregated_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.

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

AggregatedJournalTransactionCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "aggregated_journal_transaction",
      "relationships": {
        "ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "contra_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "vat_code": {
          "data": {
            "type": "vat_code"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "ledger_account",
      "attributes": {
        "current_vat_rate": 25
      },
      "relationships": {
        "vat_code": {
          "data": {
            "type": "vat_code"
          }
        }
      }
    }
  ]
}

Changes

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