KintsugiKintsugi

Start a report job

POST/reports/jobs

Start generating a report for the resolved organization and return 202 with the job's id. The report is generated asynchronously: poll GET /reports/jobs/{reportJobId} for its status, then GET /reports/jobs/{reportJobId}/download once it is READY. reportArgs is shaped by reportType; an organization may have at most 5 report jobs queued or processing at once. Set deliveryMethod to EMAIL to get a download link by email instead of fetching it yourself. A VAT_REPORT job is read back as JSON from GET /reports/jobs/{reportJobId}/result; it needs VAT accounts payable enabled on the organization (else 403) and a DE, GB, CZ, ES, or SG filing (else 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-10-06.

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

deliveryMethodReportDeliveryMethodEnum

DOWNLOAD (default) stores the report for GET /reports/jobs/{reportJobId}/download. EMAIL emails a download link to the address of the user behind your credential; the address cannot be set in the request. Not available for BULK_FILING_REPORTS or VAT_REPORT.

Available options:DOWNLOADEMAIL
reportTypestringRequired

Which report to generate.

reportArgsNexusReportArgs

No filters for this report type.

Response

reportJobIdstringRequired

Id of the new report job.

statusPublicReportJobStatusEnum

Always QUEUED on creation.

Available options:QUEUEDPROCESSINGREADYFAILED
reportTypePublicReportTypeEnumRequired

The report type this job will generate, echoed back from the request.

Available options:NEXUSTRANSACTIONS_SUMMARYTRANSACTIONS_DETAILSFILINGS_SUMMARYFILINGSFILING_DETAILSBULK_FILING_REPORTSPRODUCTSCOLLECTED_TRANSACTIONSVAT_REPORT
deliveryMethodReportDeliveryMethodEnum

How the report will be delivered, echoed back from the request.

Available options:DOWNLOADEMAIL
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.

422

The request failed validation.

429

The caller is over a rate or usage limit.

503

A service this request depends on was unavailable. Retry the request.

cURL
POST /reports/jobs
-H "Api-Key: ***"
-H "Api-Version: 2026-10-06"
{
"deliveryMethod": "DOWNLOAD",
"reportType": "NEXUS",
"reportArgs": {}
}
Response
{
"reportJobId": "a1b2c3d4-e5f6-7890",
"status": "QUEUED",
"reportType": "NEXUS",
"deliveryMethod": "DOWNLOAD"
}
Start a report job (2026-10-06) | Kintsugi API Reference