Sign in

v3

latestOpenAPI 3.0.02026-07-31800117.7 KB
Capabilities

exports.create

Preview or queue document exports using the same behavior as the in-app Export dropdown. Supports CSV/PDF/ZIP to the user's registered email, email forwarding, and connected export integrations. Use filters or viewId for broad exports. Use docIds only for exact selections of 10 or fewer documents.

post/capabilities/exports.create

Request body

format'csv' | 'pdf' | 'zip' | 'forward' | 'xero' | 'quickbooks' | 'mercury' | 'google-drive' | 'dropbox' required

Export destination/format to queue

dryRunboolean

Preview matching documents when true; queue the export when false

docIdsstring[]

Specific document IDs to export. Maximum 10; use export filters for larger exports.

viewIdstring

Saved document view ID to use as the export filter source

docTypestring

Comma-separated document type filter, e.g. receipt,invoice

paymentStatusstring

Comma-separated payment status filter, e.g. paid,unpaid

dateFromstring

Start date filter (ISO format)

dateTostring

End date filter (ISO format)

searchstring

Search query filter

merchantsstring

Comma-separated merchant filter

labelsstring

Comma-separated label filter

timeCapsuleIdstring

Retroactive Scan/time capsule ID

integrationIdstring

Integration ID for accounting/storage exports

targetIdstring

Tenant/company/account target ID for integrations

forwardTostring[]

Recipient emails for forward exports

storageNamingFormatstring

ZIP storage naming format

includeLineItemsboolean

Include line items in CSV export

csvTemplateIdstring

CSV template ID

customFieldsstring[]

Custom CSV field names

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}