Sign in
LedgerLines

Queue an export of the ledger lines report

This endpoint queues an export of the ledger lines list report.

get/shop/reports/ledger-lines/queue

Query parameters

site_idstring uuid

Filter the list of LedgerLines by site

pageinteger

The page to retrieve results from

ledger_date_fromstring date
Example:2023-05-05

Filter the list of LedgerLines by ledger date from. This will include the given date.

ledger_date_tostring date
Example:2023-05-05

Filter the list of LedgerLines by ledger date to. This will include the given date.

type'revenue' | 'charge'
Example:revenue

Show LedgerLines of this type.

revenue_centrestring
Example:spa_retail

Filter the list of LedgerLines by the revenue centre.

payment_processorstring
Example:manual

Filter the list of LedgerLines by the payment processor.

payment_processor_type_idstring

Filter the list of LedgerLines by the payment processor type ID.

voucher_code_idstring object-id

Show LedgerLines for this voucher code.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes