API changelog
Every change to the Kintsugi API and every release, newest first. Breaking changes carry the Breaking change mark. Tenanted releases are dated, and you choose one with the Api-Version header.
Changes
2026-11-11
Breaking changesTurns off Saleor tax collection when you delete or disable a Saleor connectionConnectionsBreaking change
DELETE /connections/{conn_id} on a Saleor connection now turns its tax collection off before archiving it. If the store still has Kintsugi's tax setup afterwards, the connection is not archived and the request answers 503; retrying may succeed. POST /connections/{conn_id}/disable-tax-collection on a Saleor connection that is already disabled retries any tax setup an earlier disable left behind, and answers 503, leaving tax collection enabled, while another tax change for the same store is running. A Saleor outage during that cleanup does not fail the request, so call disable again to retry it. POST /connections/vertex-o-series/{conn_id}/mark-installed answers 400 for a Saleor connection, because Saleor tax collection is turned on from the connection's own tax setting.
- DELETE/connections/{conn_id}2026-07-21
- DELETE/connections/{conn_id}2026-10-06
- POST/connections/{conn_id}/disable-tax-collection2026-07-21
- POST/connections/{conn_id}/disable-tax-collection2026-10-06
- POST/connections/vertex-o-series/{conn_id}/mark-installed2026-07-21
- POST/connections/vertex-o-series/{conn_id}/mark-installed2026-10-06
- On
503fromDELETE /connections/{conn_id}orPOST /connections/{conn_id}/disable-tax-collection, wait a moment and send the same request again. - Do not call
POST /connections/vertex-o-series/{conn_id}/mark-installedfor a Saleor connection.
2026-11-05
Breaking changesAnswers 409 when you delete or disconnect a connection that has filed historyConnectionsBreaking change
DELETE /connections/{conn_id} and POST /connections/quickbooks/disconnect now refuse to archive a connection that owns filed tax history, and answer 409 with the error code connection_has_filed_history, a new value of the error code enum. Before, both archived the connection. The connection is left unchanged, and sending the request again returns the same 409. POST /connections/quickbooks/disconnect already answers 409 when realmId matches more than one connection, so read code to tell the two apart.
- Handle
409withcodeconnection_has_filed_historyfrom both endpoints, and do not retry it. - Branch on
codewhen you handle409fromPOST /connections/quickbooks/disconnect, since it also answers409for an ambiguousrealmId. - Show the user that the connection cannot be removed and point them to Kintsugi support.
2026-10-29
Breaking changesMatches an existing ERP connection when activating an Apideck connectionConnectionsBreaking change
POST /connections/apideck/{conn_id}/activate now finds an existing live connection for the same ERP account, not only by shopId: the NetSuite subsidiary, the DualEntry company, or the QuickBooks, Xero or Dynamics 365 entity. When this connection holds no data, the existing one is reactivated and this one is deleted, and the call answers 400 with code already_connected. When only the existing connection is empty, it is removed and this one is activated. When both hold data, the call answers 409 and both connections stay. A 409 was not possible on this endpoint for these sources before.
- Handle
409from this endpoint by keeping the existing connection and disconnecting the one you do not need withDELETE /connections/{connId}. - Send
netsuiteAccountId,netsuiteSubsidiaryIdordualentryCompanyIdon this call, not in an earlier settings update, so they land on the connection that stays.
2026-10-15
Breaking changesRequires a Shopware Admin link to connect ShopwareConnectionsBreaking change
POST /connections/apideck/{service_id}/connect with shopware now answers 400 unless the connection was first started from a link opened in Shopware Admin. A call made without that link, which succeeded before, is rejected. Other services are unchanged. This applies to every Api-Version.
- Start a Shopware connection from Kintsugi in Shopware Admin instead of calling
connectdirectly.
2026-10-14
Breaking changesRefreshes a Bunny connection with POST on 2026-10-06 and rejects a null nameConnectionsBreaking change
On Api-Version: 2026-10-06, POST /connections/bunny/{conn_id}/refresh replaces PATCH, which now answers 405. The request body is unchanged. 2026-07-21 keeps PATCH. On every Api-Version, name is written as sent, including an empty string, and is left unchanged when omitted. Sending name as null now answers 422.
- On
Api-Version: 2026-10-06, callPOSTinstead ofPATCHto refresh the connection. - Leave out
nameto keep the current name, and do not send it asnull.
Clears connection settings with null and rejects an empty idConnectionsBreaking change
PATCH /connections/{conn_id}/settings now clears a nullable field when you send it as null; before, null was ignored and no field could be cleared. That covers airwallexHistoricalSyncStartDate, woocommerceHistoricalSyncStartDate, netsuiteHistoricalSyncStartDate, microsoftD365HistoricalSyncStartDate, amazonHistoricalSyncStartDate, apideckConnectionState, dualentryCompanyId, netsuiteAccountId and netsuiteSubsidiaryId. null on needsUpdate, isOneworldAccount or netsuiteSyncMode answers 422; before, it answered 200 and changed nothing. An empty string for dualentryCompanyId, netsuiteAccountId or netsuiteSubsidiaryId now answers 422; before, it cleared the value, so send null instead. This applies to every Api-Version.
- Send
null, not an empty string, to cleardualentryCompanyId,netsuiteAccountIdornetsuiteSubsidiaryId. - Leave out
needsUpdate,isOneworldAccountandnetsuiteSyncModewhen they should not change.
2026-10-05
Breaking changesReturns already_connected when an activated store is already connectedConnectionsBreaking change
When POST /connections/apideck/{conn_id}/activate finds that the shopId belongs to a connection your organization already has, it reactivates that existing connection, removes the one being activated, and answers 400 as before. The error code is now already_connected instead of invalid_request, with the message This store is already connected. The existing connection was reactivated. The store is connected and nothing more is needed. already_connected is a new value of the code field in error responses.
- Treat
400with codealready_connectedas success, and list your connections again to find the one that remains. - Stop relying on
invalid_requestto detect an already connected store. - If your client accepts only known
codevalues, addalready_connected.
Releases
2026-10-06
LatestTenanted APIConsistent country codes, empty values and status casing
2026-10-06 makes the Tenanted API more predictable to build on. Every country code is now countryCode, a value that is not set is null rather than an empty string, and status and type values are uppercase throughout. Integrations pinned to 2026-07-21 are unaffected until you choose to move, and the table below lists everything that changes when you do.
Compared with 2026-07-21
| Change | Applies to | 2026-07-21 | 2026-10-06 |
|---|---|---|---|
| Country code field | Addresses, customers, transactions, tax estimates and billing usage, in requests and responses | country | countryCode. Query parameters named country keep their name. |
| Batch address update method | /addresses/transactions | PUT | PATCH. The other method returns 405. |
| Omitted fields in a batch address update | PATCH /addresses/transactions | A field you leave out is cleared | Kept. null clears a text field, and isUnincorporated: null or an unknown countryCode returns 422. |
| Address revalidation method | /addresses/revalidation | PUT | POST. The other method returns 405. |
| Registration credentials method | /registrations/{registration_id}/credentials | PUT, where null leaves a credential unchanged | PATCH, where null clears a credential. The other method returns 405. |
| Filing submission methods | /filings/{filing_id}/submission | PUT with action | PATCH saves a draft and POST /filings/{filing_id}/mark-filed marks it filed. PUT returns 405. |
| Bunny connection refresh method | /connections/bunny/{conn_id}/refresh | PATCH | POST. The other method returns 405. |
| Default country field on connections | Connections, connection settings, PATCH /connections/{conn_id}/settings and POST /connections/apideck/{service_id}/connect | defaultCountry | defaultCountryCode |
| Incorporation country field | GET /organization-details and PATCH /organization-details | incorporationCountry | incorporationCountryCode |
| State on nexus exposure events | GET /nexus/{nexus_id}/exposure-history | state | stateCode, always present |
| State of a country-level filing | stateCode and stateName on every filing | Empty string | null |
| Organization state and country when not set | state and countryCode on organizations, and state in organization lists | Empty string, always present | null, and may be omitted |
| Exemption with no match on a certificate upload | exemptionId on missing-certificate upload results | Empty string | null |
| Missing-certificate status values | Upload, upload status and public confirm-upload results | Lowercase: processing, satisfied, rejected | Uppercase: PROCESSING, SATISFIED, REJECTED, plus PENDING on the public landing page |
| Exemption type when approving certificate imports | POST /certificate-imports/{certificate_import_id}/approve and POST /certificate-imports/bulk-approve | Any text, defaulting to customer | CUSTOMER, WHOLESALE, TRANSACTION or REVERSE_CHARGE, defaulting to CUSTOMER. Any other value returns 422. |
| Security questions in a credential reveal | fields on POST /registrations/{registration_id}/credentials/reveal | security_questions | securityQuestions |
| Line item with no product name | productName on transaction lines | null | Empty string |
| Help article label on back-filing options | GET /filings/backFilingRequest/options | Text or null | Always text |
| Job ID on bulk filing results | POST /filings/bulk/approve and POST /filings/bulk/pause | jobId, always null | Removed |
Moving an integration from 2026-07-21
- Send
Api-Version: 2026-10-06with each request you move. Requests without it keep running against 2026-07-21. - Rename
countrytocountryCodewherever you send or read an address, customer, transaction or tax estimate, and renamedefaultCountryandincorporationCountrytodefaultCountryCodeandincorporationCountryCode. - Call
PATCH /addresses/transactionsfor batch address updates, sendingnullfor any text field you want cleared, andPOST /addresses/revalidationto re-queue invalid addresses. - Treat
nullas "not set" for filing and organization locations and for an unmatchedexemptionId, and an emptyproductNameas "no product name". - Compare missing-certificate statuses in uppercase, and send
exemptionTypein uppercase when you approve certificate imports. - Read
stateCodeon nexus exposure events, requestsecurityQuestionswhen you reveal registration credentials, and stop readingjobIdon bulk filing results. - Call
PATCHto save registration credentials,PATCHandPOST /filings/{filing_id}/mark-filedin place ofPUTfor a filing submission, andPOSTto refresh a Bunny connection.
2026-07-21
Tenanted APIIntroducing the Tenanted API
A fresh foundation for building on Kintsugi. The Tenanted API is versioned by date, and you choose the release you build against. It speaks one consistent dialect from end to end: clean paths, camelCase fields, exact decimal amounts, and a single error format. And it is built for scale, with one credential reaching every organization it owns.
Compared with v1
| Topic | v1 | 2026-07-21 |
|---|---|---|
| Versioning | The /v1 path prefix | The Api-Version header, dated YYYY-MM-DD. Optional; without it, a request runs against the launch release |
| Paths | /v1/transactions | /transactions |
| Authentication | x-api-key | Api-Key. Endpoints that manage people accept a signed-in session token instead |
| Choosing an organization | x-organization-id, required on almost every request | One credential reaches every organization it owns. Narrow a request with Organization-Id, Connection-Id, or Entity-Id |
| Field names | snake_case | camelCase |
| Money and rates | Decimal strings out, numbers or strings in | Decimal strings at a fixed scale: amounts to 2 places, rates to 9 |
| Timestamps | No single documented format | RFC 3339 in UTC, always ending in Z |
| Errors | Shapes vary by endpoint | One envelope everywhere: code, message, requestId, and errors |
| Portfolio | Not available | Portfolio and Portfolio Reseller endpoints, for partner accounts |
Moving an integration from v1
- Send
Api-Versionwith every request, pinned to the release you build against (the newest is2026-10-06), so your integration stays on it until you decide to move. - Drop
/v1from your paths. - Send your key as
Api-Key, and replacex-organization-idwithOrganization-Idwherever you target one organization. - Rename fields to camelCase, and read every amount as a decimal string, never a float.
- Branch on the error
code, not the message or the HTTP status, and quoterequestIdwhen you contact support.
Creating a transaction answers 202 Accepted straight away, and tax is calculated just after. Check processingStatus before you read the tax totals.
v1
LegacyThe original Kintsugi API, versioned in the path. It is documented exactly as before, so existing integrations can keep running with confidence. New integrations should start on the newest Tenanted API release.