List Sales

This endpoint returns a paginated list of sales for the company.

Important Notes

  • Requires sales:read scope.
  • Sales are read-only via the public API.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks sales:read scope.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date

Filter by paid date range start (inclusive). Format: YYYY-MM-DD.

date

Filter by paid date range end (inclusive). Format: YYYY-MM-DD.

integer

Filter by location ID.

integer
≥ 1

Page number.

integer
1 to 100

Records per page.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json