KintsugiKintsugi
API reference / Get filing by id

Get filing by id

GET/v1/filings/{filing_id}

This API retrieves detailed information about a specific filing using its unique identifier (filing_id).

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Path parameters

filing_idstringRequired

Unique identifier for the filing to retrieve.

Response

statusFilingStatusEnum

Filing status. Possible values: UNFILED, FILING, FILED, PAUSED, SKIPPED, CANCELLED, ISSUE.

Available options:UNFILEDFILEDFILINGPAUSEDSKIPPEDCANCELLEDISSUE
start_datestringRequired

The start date of the filing period.

end_datestringRequired

The end date of the filing period.

due_datestring

The due date of the filing.

date_filedstring

The date the filing was completed, if applicable.

is_manualboolean

Indicates if the filing was done manually.

state_codestring

The code of the state associated with the filing (e.g., IA, NY).

state_namestring

The name of the state associated with the filing (e.g., Iowa, New York).

country_codeCountryCodeEnumRequired

Country code in ISO 3166-1 alpha-2 format (e.g., US).

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU
auto_approvedboolean

Indicates if the filing was auto-approved. Defaults to false.

paused_until_datestring

Indicates the date when filing will be unpaused.

assistance_ticket_idstring

DevRev ticket DON for the active assistance-pause episode. Cleared when the filing is approved from PAUSED.

filing_categorystring

Category of filing. Common values: REGULAR (standard periodic filing), BACK_FILING (past-due period), AMENDMENT (amended return). Prepayment is is_prepayment, not a category. Different categories can have overlapping periods.

is_prepaymentboolean

True when this filing is a prepayment obligation. Independent of filing_category so a past-due prepayment can still be BACK_FILING.

is_finalboolean

True when this filing is a final return for deregistration. Independent of filing_category — finals stay REGULAR.

approved_bystring

User ID of who approved the filing.

approved_atstring

Timestamp when the filing was approved.

issue_reasonstring

Reason why the filing has an issue, if applicable.

skip_reasonstring

Reason why the filing was skipped, if applicable.

cancelled_reasonstring

Reason why the filing was cancelled, if applicable.

tax_typeTaxTypeEnum

Which taxes this filing return covers. SALES_AND_USE_TAX is one real return covering both; USE_TAX is a standalone consumer use tax return.

Available options:SALES_TAXUSE_TAXSALES_AND_USE_TAX
is_rdfboolean

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

amount_calculatedstring

The calculated amount for the filing. Defaults to 0.00.

amount_adjustedstring

Adjusted amount, if any.

amount_discountsstring

Discounts applied to the filing.

amount_feesstring

Fees applied to the filing.

amount_penaltiesstring

Penalties applied to the filing.

amount_tax_collectedstring

Total tax collected during the filing period.

amount_use_taxstring

Gross tax the buyer owes on purchases. US use tax, or EU/UK reverse-charge self-assessed VAT. Not net of reclaim. Defaults to 0.00.

amount_input_vat_recoverablestring

Input VAT reclaimed on this filing's purchases. Subtracted from liability; always 0.00 outside EU/UK VAT AP filings.

amount_salesstring

Total sales amount during the filing period.

total_taxable_salesstring

Total taxable amount during the filing period.

amountstring

Final amount due for the filing.

total_tax_liabilitystring

Total tax liability for the filing.

transaction_countinteger

Number of non-marketplace transactions. For total, add marketplace_transaction_count.

marketplace_transaction_countinteger

Number of marketplace transactions associated with the filing.

estimated_line_countinteger

Estimated schedule line count (distinct jurisdictions). For Tax Ops workload ranking, not portal accuracy.

internal_notesstring

Notes or comments related to the filing.

recent_details_report_linkstring
tax_remittedstring

The amount of tax remitted.

original_tax_remittedstring

Tax remitted when filing was first confirmed.

return_confirmation_idstring

Return confirmation ID, if applicable.

payment_confirmation_idstring

Payment confirmation ID, if applicable.

block_approvalboolean

Indicates if the filing can be approved.

currencyCurrencyEnum

Currency code for the filing (e.g., USD, CAD).

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
idstringRequired

Unique identifier for the filing.

registration_idstringRequired

Identifier for the registration associated with the filing.

filing_frequencystring

Filing frequency from the associated registration.

oss_typestring

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

quarterly_prepay_balanceQuarterlyPrepayBalanceDisplay

Display-only balance-due breakdown for CA Quarterly Prepayment reconciliation filings, populated only when the org toggle is on and the filing qualifies. When present, clients should show balance_due instead of total_tax_liability. Absent means show total_tax_liability as usual.

ca_may_prepaymentCaMayPrepaymentDisplay

Display-only CDTFA Option 2 (135% of May liability) for CA Quarterly Prepayment May prepayment filings. When present, list/CSV/approve copy should prefer prepayment_amount; Tax Overview keeps Total Liability at 100% and adds a separate CDTFA Option 2 row. Absent means show total_tax_liability as usual.

estimated_penalty_intereststring

Display-only estimated penalties and interest for BACK_FILING rows. Null means unknown (placeholder). Zero is a genuine not-yet-late or zero-tax outcome. Never persisted on the filing or used for billing.

penalty_interest_remittance_tagstring

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

organization_idstringRequired

Identifier for the organization associated with the filing.

attachmentsobject

Map of attachment names to download URLs for the filing, if any.

credits_utilizedstring

Credits utilized for this filing.

deferred_transaction_countinteger

Number of transactions deferred from this filing period.

filing_website_urlstringRequired

Get the filing website URL for this filing's jurisdiction

200

Successfully retrieved filing by id

401

Unauthenticated request.

404

Resource not found

422

Validation error

500

Internal server error

cURL
GET /v1/filings/{filing_id}
-H "x-api-key: ***"
Example request
https://api.trykintsugi.com/v1/filings/{filing_id}
Response
{
"status": "UNFILED",
"start_date": "2023-01-01",
"end_date": "2023-12-31",
"due_date": "2024-01-20",
"is_manual": true,
"state_code": "XX",
"state_name": "Dummy State",
"country_code": "XY",
"auto_approved": false,
"amount_calculated": "1000.00",
"amount_adjusted": "50.00",
"amount_discounts": "25.00",
"amount_fees": "10.00",
"amount_penalties": "5.00",
"amount_tax_collected": "200.00",
"amount_sales": "5000.00",
"amount": "980.00",
"total_tax_liability": "1200.00",
"transaction_count": 15,
"internal_notes": "Sample internal notes.",
"tax_remitted": "100.00",
"return_confirmation_id": "dummy_return_id_123",
"payment_confirmation_id": "dummy_payment_id_456",
"id": "file_dummy_id_789",
"registration_id": "regs_dummy_id_101",
"can_file": true,
"credits_utilized": "10.00"
}