Export Tax Exemption Certificates
POST/api/tax-exemption-certificates/export
Start a background export of the certificate register as CSV — or, with include_documents, a ZIP holding the CSV plus each certificate's attached file. Returns the tracked_job_log_id at once.
customers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Poll GET /api/tracked-job-logs/{id} (scope jobs:read) until it completes; the completed log's results carry download_url, download_filename and record_count. Then fetch the file with Download Tax Exemption Certificates Export.
Body:
filters(object, optional) — the same keys as thefilter[...]parameters of List Tax Exemption Certificates (e.g.status,region_code,review_status,expiring_within_days); empty values are ignored. Omit to export every certificate.include_documents(boolean, optional, default false)
filters accepts the same keys as the report's filter[...] parameters, including id (a comma-separated list of certificate IDs) to export a hand-picked selection.
Authentication: Requires Bearer token with the customers:write scope (the request is a POST). Permission: customers.show.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.