Charges

List Charges

Retrieves a paginated list of charges for a given AgencyRef and all permissible branches, ordered by charge id. Returns any kind of charge, as GET /charges/{chargeId} does.

get/charges

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/charges
  • 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 charge id. Ascending by default. A next-token can only be used with the sort order it was issued for.

raisedboolean

Only return raised charges when true, or charges not yet raised 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.