KintsugiKintsugi

Export a transaction report

POST/transactions/export

Kick off an asynchronous transaction report for the resolved organization and return 202 with the export's id. SUMMARY is aggregated figures; DETAILS is one row per transaction; COLLECTED is imported-tax sales in a jurisdiction. deliveryMethod chooses how you get it: EMAIL emails it to email when ready (a bearer session may omit email and use the signed-in user); DOWNLOAD stores it and you poll GET /transactions/exports/{exportId} for a presigned link (so email must be omitted). An EMAIL export for an organization that has disabled email delivery answers 400.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

deliveryMethodTransactionExportDeliveryRequired

How to deliver the report. EMAIL emails it to email when ready; DOWNLOAD stores it and you poll GET /transactions/exports/{exportId} for a presigned link.

Available options:EMAILDOWNLOAD
reportTypeTransactionReportTypeRequired

Which report to generate. SUMMARY is aggregated figures; DETAILS is one row per transaction; COLLECTED is imported-tax sales in a jurisdiction (the collected-tax drawer).

Available options:SUMMARYDETAILSCOLLECTED
emailstring

Email address the report is delivered to. Required when deliveryMethod is EMAIL unless the caller is a bearer session (which defaults to the signed-in user). Must be omitted when deliveryMethod is DOWNLOAD.

countryCodestring

Restrict the report to this ISO-3166 country code. Required when reportType is COLLECTED.

stateCodestring

Restrict the report to this state or province code. When reportType is COLLECTED, FD (federal nexus sentinel) is not applied as a state filter.

startDatestring

Include transactions on or after this date (YYYY-MM-DD).

endDatestring

Include transactions on or before this date (YYYY-MM-DD). Applies to SUMMARY, DETAILS, and COLLECTED.

includeInvalidAddressesboolean

Include transactions with invalid addresses. Applies to the DETAILS report only; ignored for SUMMARY and COLLECTED.

includeRefundsboolean

When reportType is COLLECTED, include credit notes with nonzero imported tax. Ignored for SUMMARY and DETAILS.

Response

exportIdstringRequired

Id of the export job. Poll GET /transactions/exports/{exportId} for its status and, for a DOWNLOAD export, its link.

statusTransactionExportStatusRequired

State of the export. QUEUED on a successful request.

Available options:QUEUEDPROCESSINGREADYFAILED
deliveryMethodTransactionExportDeliveryRequired

How the report will be delivered.

Available options:EMAILDOWNLOAD
emailstring

Email the finished report will be sent to, or null for a DOWNLOAD export.

202

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
POST /transactions/export
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"deliveryMethod": "EMAIL",
"reportType": "SUMMARY",
"email": "ap@example.com",
"countryCode": "US",
"stateCode": "CA",
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"includeInvalidAddresses": false,
"includeRefunds": false
}
Response
{
"exportId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"status": "QUEUED",
"deliveryMethod": "EMAIL",
"email": "ap@example.com"
}
Export a transaction report (2026-07-21) | Kintsugi API Reference