KintsugiKintsugi

Get a filing by id

GET/filings/{filing_id}

Fetch a single filing by id. Searched across every organization your credential owns, so no selector is needed for a known id. Pass expand=salesBreakdown, expand=vatRecovery and/or expand=artifacts to embed those buckets; omitted otherwise. Returns 404 if the filing does not exist or belongs to an organization your credential cannot access.

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

filing_idstringRequired

The unique identifier of the filing.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/filings/{filing_id}?expand=<expand>
expandFilingExpand[]

Buckets to embed on the filing. salesBreakdown embeds the period's sales composition; vatRecovery embeds the EU/UK input-VAT recovery rate pair; artifacts embeds the filing's return/payment/additional artifacts by slot. Omitted otherwise.

Available options:salesBreakdownvatRecoveryartifacts

Response

idstringRequired

Kintsugi's unique identifier for the filing.

organizationIdstringRequired

Organization the filing belongs to.

organizationNamestring

Display name of the organization the filing belongs to. null when the organization has no name set.

registrationIdstring

The registration this filing period is filed under, if any.

statusPublicFilingStatusEnumRequired

Lifecycle status of the filing.

Available options:UNFILEDFILEDFILINGPAUSEDSKIPPEDCANCELLEDISSUE
filingCategorystringRequired

The kind of filing period: REGULAR, AMENDMENT or BACK_FILING (a legacy PREPAYMENT value may appear on historical rows).

taxTypePublicTaxTypeEnumRequired

Which taxes this filing covers, from the associated registration.

Available options:SALES_TAXUSE_TAXSALES_AND_USE_TAXRETAIL_DELIVERY_FEE
countryCodestringRequired

ISO 3166-1 alpha-2 country code of the filing jurisdiction.

stateCodestring

State or province code, or '' for a country-level filing.

stateNamestring

Human-readable jurisdiction name.

startDatestringRequired

First day of the filing period, as YYYY-MM-DD.

endDatestringRequired

Last day of the filing period, as YYYY-MM-DD.

dueDatestring

When the return is due, as YYYY-MM-DD.

dateFiledstring

When the return was filed, as YYYY-MM-DD; null until filed.

returnConfirmationIdstring

Return confirmation id from the jurisdiction portal; null until filed.

paymentConfirmationIdstring

Payment confirmation id from the jurisdiction portal; null until paid.

pausedUntilDatestring

Date a paused filing auto-resumes, as YYYY-MM-DD; null when not paused.

isPausableboolean

Whether this filing is structurally eligible to be paused: it is not a back-filing, it is in a pauseable status, and its organization is on the auto-filing experience. The time-of-month pause window is not included; derive that client-side from dueDate.

canApproveboolean

Whether this filing can be approved. false when approval is blocked (for example by unapproved products or addresses), which disables the per-row Approve and file actions.

skipReasonstring

Why the filing was skipped, if it was; null otherwise.

isPrepaymentbooleanRequired

Whether this period is a prepayment rather than a full return.

isFinalbooleanRequired

Whether this is the registration's final filing period.

isRdfboolean

Whether this is a state Retail Delivery Fee return, a separate filing from the state's sales tax return.

transactionCountintegerRequired

Number of transactions in the filing period.

filingWebsiteUrlstring

The jurisdiction's filing portal URL, if known.

approvedAtstring

When the filing was approved, as an RFC-3339 UTC timestamp; null if not.

createdAtstringRequired

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

currencystring

ISO-4217 currency every amount on this filing is in; null until the filing's amounts settle.

amountstringRequired

Net amount due for the filing.

amountCalculatedstringRequired

Calculated tax for the period.

amountAdjustedstringRequired

Manual adjustment applied to the amount due.

amountDiscountsstringRequired

Vendor/timely-filing discounts applied.

amountFeesstringRequired

Fees added to the amount due.

feeTypePublicFeeTypeEnum

Whether amountFees is a penalty, interest, or other fee. Null when the fee was recorded before the label existed.

Available options:PENALTYINTERESTOTHER
amountPenaltiesstringRequired

Penalties added to the amount due.

amountTaxCollectedstringRequired

Tax collected on transactions in the period.

amountUseTaxstringRequired

Use tax owed for the period.

amountSalesstringRequired

Gross sales in the period.

totalTaxLiabilitystringRequired

Total tax liability for the filing.

taxRemittedstringRequired

Tax remitted to the jurisdiction; 0 until filed.

amountInputVatRecoverablestringRequired

Input VAT this filing claimed, subtracted from liability; 0 outside EU/UK VAT filings.

amountInputVatTrueUpstringRequired

Prior-year input VAT pro-rata true-up on this filing; 0 until posted and outside EU/UK VAT filings.

filingFrequencyPublicFilingFrequencyEnum

Filing frequency from the associated registration.

Available options:UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENT
ossTypePublicOssTypeEnum

OSS scheme (UNION/NON_UNION/IOSS) from the registration, if any.

Available options:UNIONNON_UNIONIOSS
quarterlyPrepayBalanceQuarterlyPrepayBalance

Display-only balance-due breakdown for CA Quarterly Prepayment reconciliation filings. When present, show balanceDue instead of totalTaxLiability. Absent means show totalTaxLiability as usual.

caMayPrepaymentCaMayPrepayment

Display-only CDTFA Option 2 (135% of May liability) for CA Quarterly Prepayment May prepayment filings. Absent means show totalTaxLiability.

estimatedPenaltyIntereststring

Display-only estimated penalties and interest for BACK_FILING rows. Null means unknown; zero is a genuine not-yet-late or zero-tax outcome.

penaltyInterestRemittanceTagstring

Customer-facing P&I timing tag for BACK_FILING rows, e.g. 'Paid with return' or 'State bills you later'.

salesBreakdownFilingSalesBreakdown

Sales composition for the period (taxable, exempt, marketplace count, credits utilized, deferred count). Absent unless the request passes expand=salesBreakdown.

vatRecoveryFilingVatRecovery

EU/UK input-VAT recovery rate pair for the filing. Absent unless the request passes expand=vatRecovery.

filingArtifactsFilingArtifacts

The filing's return/payment/additional artifacts resolved by slot, each downloadable through the attachments API. Absent unless the request passes expand=artifacts.

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

The request failed validation.

cURL
GET /filings/{filing_id}?expand=salesBreakdown
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/filings/{filing_id}?expand=salesBreakdown
Response
{
"id": "file_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"organizationName": "Acme Corp",
"registrationId": "regs_2mNpQr7Ls8f3k",
"status": "UNFILED",
"filingCategory": "REGULAR",
"taxType": "SALES_TAX",
"countryCode": "US",
"stateCode": "CA",
"stateName": "Acme Corp",
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"dueDate": "2026-07-21",
"dateFiled": "2026-07-21",
"returnConfirmationId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"paymentConfirmationId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"pausedUntilDate": "2026-07-21",
"isPausable": false,
"canApprove": true,
"skipReason": "Customer request",
"isPrepayment": false,
"isFinal": false,
"isRdf": false,
"transactionCount": 1,
"filingWebsiteUrl": "https://www.example.com",
"approvedAt": "2026-07-28T12:00:00Z",
"createdAt": "2026-07-28T12:00:00Z",
"currency": "USD",
"amount": "10.00",
"amountCalculated": "10.00",
"amountAdjusted": "10.00",
"amountDiscounts": "10.00",
"amountFees": "10.00",
"feeType": "PENALTY",
"amountPenalties": "10.00",
"amountTaxCollected": "10.00",
"amountUseTax": "10.00",
"amountSales": "10.00",
"totalTaxLiability": "10.00",
"taxRemitted": "10.00",
"amountInputVatRecoverable": "10.00",
"amountInputVatTrueUp": "10.00",
"filingFrequency": "UNKNOWN",
"ossType": "UNION",
"quarterlyPrepayBalance": {
"grossTaxLiability": "10.00",
"balanceDue": "10.00",
"prepaymentDeductions": [
{
"label": "April prepayment",
"amount": "10.00",
"filingId": "file_2mNpQr7Ls8f3k"
}
]
},
"caMayPrepayment": {
"baseTaxLiability": "10.00",
"prepaymentAmount": "10.00",
"note": "Reviewed and approved."
},
"estimatedPenaltyInterest": "10.00",
"penaltyInterestRemittanceTag": "penalty interest remittance tag",
"salesBreakdown": {
"totalTaxableSales": "10.00",
"exemptSales": "10.00",
"marketplaceTransactionCount": 1,
"creditsUtilized": "10.00",
"deferredTransactionCount": 1
},
"vatRecovery": {
"inputVatRecoveryRate": "10.00",
"inputVatRecoveryRateIsDefinitive": false
},
"filingArtifacts": {
"returnArtifact": {
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
},
"paymentArtifact": {
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
},
"additionalArtifacts": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
}
]
}
}
Get a filing by id (2026-07-21) | Kintsugi API Reference