Sign in
Reports

Queue the deposit ledger report (v1)

Queues an asynchronous build of the v1 deposit-ledger report. Returns a QueuedJob whose output will contain a download URL once processing finishes. Exposed at the legacy v1 URL alongside the v2 counterpart at /shop/reports/deposit-ledger-v2/queue for callers that have not yet migrated.

get/shop/reports/deposit-ledger/queue

Query parameters

dateFromstring date
Example:2000-01-01

A date string to retrieve results from

dateTostring date
Example:2000-01-01

A date string to retrieve results to

site_idstring uuid
Example:5dcb47800000000000000010

Scope the deposit-ledger report to a single Site. Omit to include every site the caller has reporting access to. Useful when the report is being run on behalf of a multi-site brand.

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