Sign in
Reports

Queue the Trybe Payments balance report

Queues an asynchronous build of the Trybe Payments balance report for the given site and date range. Returns a QueuedJob whose output will carry a download URL once the job completes. Use this for larger date ranges that the synchronous endpoint (GET /shop/reports/trybe-payments-balance) would time out on.

get/shop/reports/trybe-payments-balance/queue

Query parameters

site_idstring uuid required

The site whose Trybe Payments balance is being reported on.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

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