Export records as CSV, Excel or JSON
create_exportCreate an export of the records (default), another dataset, or all (the year-end package) for a period, or for the entire history when period is null or omitted. Returns the export object: small exports are already ready with file (name, content_type, bytes, sha256) and a signed download_url valid until download_expires_at (files are kept 7 days); while queued or processing call get_export. Vendor presets (quickbooks, xero, koinly, cointracker, coinledger) and journal need dataset=records and format=csv (otherwise 422). Verify the downloaded file against file.sha256. With a test key pass include_simulated=true to include simulated payments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | Yes | ||
| period | No | Read in `timezone`. Null or omitted exports the entire history. | |
| preset | No | Column layout for the records dataset (default generic). | |
| dataset | No | Default records. | |
| currency | No | Reporting currency of the value columns. | |
| metadata | No | Up to 50 string key/value pairs returned on the object and in webhooks. | |
| timezone | No | IANA zone, e.g. America/New_York. Default: the account's records timezone. | |
| idempotency_key | No | Stable key so a retry does not start a second export, e.g. records-2026-q3. | |
| include_simulated | No | Test mode only: include rows created by simulate_test_payment, which the sandbox hides by default. Ignored with a live key. |