Receipts

List Receipts

Retrieves a paginated list of receipts for a given AgencyRef and all permissible branches, ordered by receipt id. Returns the same detail as GET /receipts/{receiptId}.

get/receipts

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/receipts
  • Auth: appAuth (a scheme the document does not define)

Query parameters

next-tokenstring

Token used to retrieve the next page of results. This is returned in the response of the previous page.

max-resultsinteger

Maximum number of results to return per page, from 1 to 100. Defaults to 10 if not specified.

sort-order'Asc' | 'Desc'

The order of results by receipt id. Ascending by default. A next-token can only be used with the sort order it was issued for.

reversalboolean

Only return receipts that reverse another receipt when true, or exclude them when false. Both are returned when not specified.

reversedboolean

Only return receipts that have been reversed when true, or that have not when false. Both are returned when not specified.

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.