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.

x-organization-idstringRequired

Identifies the organization this request acts on.

Path parameters

filing_idstringRequired

Unique identifier for the filing to retrieve.

Response

statusFilingStatusEnum

Filing status. Possible values: UNFILED, FILING, FILED.

Available options:UNFILEDFILEDFILINGPAUSED

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

jira_issue_keystring

The associated JIRA issue key for tracking the filing, if available. Can be null.

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), PREPAYMENT (prepayment or estimated tax), AMENDMENT (amended return). Different categories can have overlapping periods.

approved_bystring

User ID of who approved the filing.

approved_atstring

Timestamp when the filing was approved.

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

Discounts applied to the amount.

amount_penaltiesstring

Penalties applied to the filing.

amount_tax_collectedstring

Total tax collected during the filing period.

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.

internal_notesstring

Notes or comments related to the filing.

recent_details_report_linkstring

tax_remittedstring

The amount of tax remitted.

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.

attachmentsobject

List of attachments associated with the filing, if any.

credits_utilizedstring

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: ***"

-H "x-organization-id: ***"

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"

}