KintsugiKintsugi

Create a credit

POST/credits

Create a credit against a registration in the given organization. registrationId is required and must belong to that organization. The credit type and currency are derived from the registration, an EU OSS registration produces an IVT credit in EUR (and requires ossRegistrationCountryId), any other supported jurisdiction produces an ITC credit in the registration country's currency. A credit for an unsupported jurisdiction is rejected.

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

registrationIdstringRequired

The registration to hold the credit against.

amountstringRequired

The credit's face value, as a decimal string.

ossRegistrationCountryIdstring

The EU OSS member-state enrollment the credit applies to. Required for an EU OSS registration; leave null otherwise.

endDatestring

Date the credit expires, as YYYY-MM-DD. null for a credit that does not expire.

commentstring

An optional free-text note stored with the credit.

Response

idstringRequired

Kintsugi's unique identifier for the credit.

typePublicCreditTypeEnumRequired

The kind of credit balance: REFUND, OVERPAYMENT, ITC, or IVT.

Available options:REFUNDOVERPAYMENTITCIVT
taxTypePublicTaxTypeEnumRequired

Which tax pool this credit applies to on a combined return.

Available options:SALES_TAXUSE_TAXSALES_AND_USE_TAXRETAIL_DELIVERY_FEE
amountstringRequired

The credit's face value, as a decimal string.

amountConsumedstringRequired

How much of the credit has been applied to filings.

amountRemainingstringRequired

How much of the credit is still available.

currencystring

ISO-4217 currency code of the amounts. Every credit created through this API records one (derived from the registration); null appears only on legacy credits created before a currency was stored.

startDatestringRequired

Date the credit becomes available, as YYYY-MM-DD.

endDatestring

Date the credit expires, as YYYY-MM-DD. null when it does not expire.

registrationIdstringRequired

The registration this credit is held against.

organizationIdstringRequired

The organization that owns the credit. Always present: a portfolio-wide list spans organizations, so a row is ambiguous without it.

ossRegistrationCountryIdstring

The EU OSS member-state enrollment this credit applies to, for an EU OSS registration. null otherwise.

createdAtstringRequired

When the credit was created, as an RFC-3339 UTC timestamp.

201

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 /credits
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"registrationId": "regs_2mNpQr7Ls8f3k",
"amount": "100.00",
"ossRegistrationCountryId": "ossr_2mNpQr7Ls8f3k",
"endDate": "2026-12-31",
"comment": "Reviewed and approved."
}
Response
{
"id": "creds_2mNpQr7Ls8f3k",
"type": "REFUND",
"taxType": "SALES_TAX",
"amount": "100.00",
"amountConsumed": "25.00",
"amountRemaining": "75.00",
"currency": "USD",
"startDate": "2026-01-01",
"endDate": "2026-12-31",
"registrationId": "regs_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"ossRegistrationCountryId": "ossr_2mNpQr7Ls8f3k",
"createdAt": "2026-07-28T12:00:00Z"
}
Create a credit (2026-07-21) | Kintsugi API Reference