KintsugiKintsugi
API reference / Get a report job's result

Get a report job's result

GET/reports/jobs/{report_job_id}/result

Get the JSON result of a READY report job whose report is viewed rather than downloaded (today, VAT_REPORT). Searched across every organization your credential owns. A job you do not own answers 404, identical to one that does not exist; a job of a downloadable report type answers 400 (use GET /reports/jobs/{reportJobId}/download); a job that is not yet READY answers 409.

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

Narrow the request to one organization (Organization-Id selector).

Connection-Idstring

Narrow the request to a connection's organization.

Entity-Idstring

Narrow the request to a platform entity's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

report_job_idstringRequired

Id of the report job.

Response

reportJobIdstringRequired

Id of the report job.

reportTypePublicReportTypeEnumRequired

Which report the job generated.

Available options:NEXUSTRANSACTIONS_SUMMARYTRANSACTIONS_DETAILSFILINGS_SUMMARYFILINGSFILING_DETAILSBULK_FILING_REPORTSPRODUCTSCOLLECTED_TRANSACTIONSVAT_REPORT
vatReportVatReport

The VAT return report. Set when reportType is VAT_REPORT.

200

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

Validation Error

500

An unexpected error prevented the request from completing.

cURL
GET /reports/jobs/{report_job_id}/result
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/reports/jobs/{report_job_id}/result
Response
{
"reportJobId": "a1b2c3d4-e5f6-7890",
"reportType": "NEXUS",
"vatReport": {
"filingId": "file_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"countryCode": "US",
"returnForm": "return form",
"returnFormLabel": "return form label",
"filingEntityRegistrationNumber": "123456789",
"periodStart": "2026-07-21",
"periodEnd": "2026-07-21",
"currency": "USD",
"sections": [
{
"sectionLabel": "section label",
"boxes": [
{
"boxCode": "box code",
"boxLabel": "box label",
"amount": "10.00",
"category": "category",
"sourceTransactionCount": 1
}
]
}
],
"summary": {
"totalOutputVat": "10.00",
"totalInputVat": "10.00",
"netVatPayable": "10.00",
"totalSalesExVat": "10.00",
"totalPurchasesExVat": "10.00"
},
"ossDestinations": [
{
"countryCode": "US",
"countryName": "Acme Corp",
"taxableAmount": "10.00",
"vatRate": "0.082500000",
"vatAmount": "10.00"
}
],
"limitations": [
"limitation"
]
}
}
Get a report job's result (2026-07-21) | Kintsugi API Reference