Cancel Sale

This endpoint cancels (voids) a paid or partially paid sale.

Important Notes

  • Requires sales:write scope.
  • The sale is kept with status canceled; its items are removed and the payment records it
    created are cancelled. It cannot be undone.
  • Only sales with status paid or partially_paid can be cancelled.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks sales:write scope.
404invalid_sale—Sale not found, or it belongs to another company.
422invalid_sale—The sale is not paid or partially paid (for example, already cancelled).
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Sale unique identifier.

Responses
204

Sale cancelled.

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