Skip to main content
POST
Export receipts
Queues an async bulk export job. Returns immediately with status: pending. Poll GET /v1/receipt-exports/{id} for completion and a pre-signed download URL.

Request

string
required
Export format: json or csv.
object
Optional filters to narrow the export.
string
Filter by receipt type name (e.g. payment_receipt).
string
Filter by receipt status: active, revoked, superseded, redacted.
string
Start of date range (RFC 3339).
string
End of date range (RFC 3339).

Response

string
UUID of the export job.
string
pending | running | complete | failed
string
Requested format (json or csv).
string
ISO 8601 timestamp.

Polling for completion

Poll GET /v1/receipt-exports/{export_id} until status is complete. The response will include a pre-signed download_url.
This endpoint moved from /v1/receipts/export/{id} to /v1/receipt-exports/{id}. Update any polling URLs that use the old path.

Export status values

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
receipt_type
string
from
string
to
string
format
enum<string>
default:json
Available options:
json,
csv

Response

Export initiated

export_id
string
status
string
download_url
string | null