KintsugiKintsugi
API reference / Changelog / 2026

API changelog: 2026

Every change to the Kintsugi API in 2026, newest first. For the latest changes and every release, see the API changelog.

2026-11-13

Adds taxBasis to VAT return reports on POST /reports/jobs
NewReports

A VAT_REPORT job accepts an optional taxBasis in reportArgs. CALCULATED shows the tax Kintsugi calculated on the return's tax line. COLLECTED shows the tax the store collected, and only Canada filings support it: a COLLECTED request for any other filing is rejected with 400. Omitted or null means CALCULATED, which is what the report showed before. Totals that add the tax line follow the basis you choose. Every other line is the same.

What to do
  • Send taxBasis: "COLLECTED" with the filingId of a Canada filing to build the return with collected tax.

2026-11-06

Adds Canada to the VAT_REPORT report, with box help text and section notes
NewReports

A VAT_REPORT job now covers a CA filing whose registration has a return form. GET /reports/jobs/{reportJobId}/result returns the filing's totals laid out on that form, named in returnForm, for example CA_BC_PST. Canada reports do not need VAT accounts payable enabled, which every other country still does (else 403), and their sourceTransactionCount is always 0. A CA filing whose registration has no return form is refused with 400. Every report now also carries tooltip on each box, short help text on what the box means on the return form, and note on each section, an instruction for filing it in the government portal. Both are null when there is nothing to say, and tooltip is null for the non-Canada forms.

What to do
  • Create a VAT_REPORT job for a CA filing to read its return form boxes.
  • Show tooltip and note beside the boxes and sections they describe when they are not null.

2026-10-06

Generates a VAT return report as a report job
NewReports

POST /reports/jobs accepts reportType VAT_REPORT with reportArgs.filingId, for a VAT filing in Germany, the United Kingdom, the Czech Republic, Spain or Singapore. Once the job is READY, GET /reports/jobs/{report_job_id}/result returns it as JSON in vatReport: the return form's boxes grouped in sections, each with its boxCode, boxLabel, amount, category and sourceTransactionCount; a summary of output VAT, input VAT, net VAT payable and sales and purchases excluding VAT; ossDestinations, the VAT owed per EU destination country, or null when there are no cross-border sales; and limitations. Amounts are decimal strings rounded to the cent. Creating the job answers 404 for a filing outside the organization, 400 for another country, for a filing with more than 100,000 transactions or with deliveryMethod EMAIL, and 403 for an organization without this feature enabled. The result endpoint answers 400 for a report you download instead, 409 before the job is READY and 404 for a job you cannot access.

What to do
  • Start the job, poll GET /reports/jobs/{reportJobId} until it is READY, then read the report from the result endpoint.

2026-10-02

Emails a report's download link on request
NewReports

POST /reports/jobs accepts an optional deliveryMethod. DOWNLOAD, the default, works as before: fetch the report from GET /reports/jobs/{reportJobId}/download once it is READY. EMAIL sends a download link, when the report is ready, to the email address of the user behind your credential; the request cannot name another address. The response echoes deliveryMethod. EMAIL answers 400 for BULK_FILING_REPORTS, for an organization with email turned off, and for a credential without an email address.

What to do
  • Send deliveryMethod: "EMAIL" to receive the report link by email.
Kintsugi API Changelog: 2026