Sales

List all sales documents of a given type (e.g invoices, quotes)

get/accounting/sales/{salesType}

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/sales/{salesType}
  • Auth: OAuth 2 (authorization code, authorization URL https://secure.clearbooks.co.uk/account/action/oauth/, token URL https://api.clearbooks.co.uk/oauth/token, scopes: accounting.sales:read)

Path parameters

salesType'invoices' | 'creditNotes' | 'quotes' required

Type of sales document

Query parameters

sortBystring

The field to sort results by

sortDirection'ascending' | 'descending'

The direction to sort the results

limitinteger

The number of results to return

pageinteger

The page of results to return

Headers

X-Business-IDinteger

ID of the business to use (required for multi-business authorisations only)

Response

An array of sales documents

OR
OR

Changes

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