KintsugiKintsugi
API reference / Approve filing

Approve filing

PUT/v1/filings/{filing_id}/approve

Approve a specific filing by its ID.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Path parameters

filing_idstringRequired

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.

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.

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

Use tax liability for the filing period. Defaults to 0.00.

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.

filing_website_urlstringRequired

Get the filing website URL for this filing's jurisdiction

200

Successful Response

422

Validation Error

cURL
PUT /v1/filings/{filing_id}/approve
-H "x-api-key: ***"
Example request
https://api.trykintsugi.com/v1/filings/{filing_id}/approve
Response
{
"status": "UNFILED",
"start_date": "string",
"end_date": "string",
"due_date": "string",
"date_filed": "string",
"is_manual": true,
"state_code": "string",
"state_name": "string",
"country_code": "AF",
"auto_approved": true,
"paused_until_date": "string",
"filing_category": "REGULAR",
"is_prepayment": false,
"approved_by": "string",
"approved_at": "string",
"issue_reason": "string",
"skip_reason": "string",
"cancelled_reason": "string",
"tax_type": "SALES_TAX",
"is_rdf": false,
"amount_calculated": "0.00",
"amount_adjusted": "0.00",
"amount_discounts": "0.00",
"amount_fees": "0.00",
"amount_penalties": "0.00",
"amount_tax_collected": "0.00",
"amount_use_tax": "0.00",
"amount_sales": "0.00",
"total_taxable_sales": "string",
"amount": "0.00",
"total_tax_liability": "0.00",
"transaction_count": 0,
"marketplace_transaction_count": 0,
"estimated_line_count": 0,
"internal_notes": "string",
"recent_details_report_link": "string",
"tax_remitted": "0.00",
"original_tax_remitted": "string",
"return_confirmation_id": "string",
"payment_confirmation_id": "string",
"block_approval": true,
"currency": "AED",
"id": "string",
"registration_id": "string",
"filing_frequency": "string",
"oss_type": "string",
"quarterly_prepay_balance": {
"gross_tax_liability": "string",
"balance_due": "string",
"prepayment_deductions": [
{
"label": "string",
"amount": "string",
"filing_id": "string"
}
]
},
"ca_may_prepayment": {
"base_tax_liability": "string",
"prepayment_amount": "string",
"note": "string"
},
"filing_website_url": "string"
}