TRtrykintsugi
Filings

Get filing by id

Changed on

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

get/v1/filings/{filing_id}

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/filings/{filing_id}
  • Auth
    API key in header X-API-KEY

Path parameters

filing_idstring required

Unique identifier for the filing to retrieve.

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved filing by id

input_vat_recovery_ratestring nullable

Input VAT recovery rate applied to this filing, as a percentage 0-100. Null when no rate exists for the filing's country and year, which means fully recoverable. Uses the definitive rate when set, otherwise the year's frozen provisional.

input_vat_recovery_rate_is_definitiveboolean nullable

True when input_vat_recovery_rate is this year's definitive rate. False when it is the provisional. Null when no rate exists.

status'UNFILED' | 'FILED' | 'FILING' | 'SUBMITTED' | 'PAUSED' | 'SKIPPED' | 'CANCELLED' | 'ISSUE'
start_datestring date required

The start date of the filing period.

end_datestring date required

The end date of the filing period.

due_datestring date nullable

The due date of the filing.

date_filedstring date nullable

The date the filing was completed, if applicable.

is_manualboolean nullable

Indicates if the filing was done manually.

state_codestring nullable

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

state_namestring nullable

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

country_code'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'CI' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'XK' | 'ZZ_EU' required
auto_approvedboolean nullable

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

paused_until_datestring date nullable

Indicates the date when filing will be unpaused.

assistance_ticket_idstring nullable

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 nullable

User ID of who approved the filing.

approved_atstring date-time nullable

Timestamp when the filing was approved.

issue_reasonstring nullable

Reason why the filing has an issue, if applicable.

skip_reasonstring nullable

Reason why the filing was skipped, if applicable.

cancelled_reasonstring nullable

Reason why the filing was cancelled, if applicable.

tax_type'SALES_TAX' | 'USE_TAX' | 'SALES_AND_USE_TAX' | 'RETAIL_DELIVERY_FEE' | 'SMALL_PARCEL_VAT'

Tax obligation on a nexus, registration, or filing row.

Registrations and filings may be SALES_AND_USE_TAX: one state account and one return can cover both taxes, and each is stored as a single row. Nexus rows are SALES_TAX, USE_TAX, RETAIL_DELIVERY_FEE, or SMALL_PARCEL_VAT. Sales tax, use tax, the retail delivery fee, and the Swiss small-parcel threshold are separate obligations with their own met dates and period models. SMALL_PARCEL_VAT is a threshold only. A sales tax registration covers it, and it has no account and no return of its own.

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.

fee_type'PENALTY' | 'INTEREST' | 'OTHER'

Label for Filing.amount_fees — penalty vs interest vs other.

Nullable on the row: existing fees predate the label and stay blank until Tax Ops classifies them. Does not change arithmetic.

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 recoverable VAT. Defaults to 0.00.

amount_input_vat_recoverablestring

Input VAT this filing actually claimed. Subtracted from liability; always 0.00 outside EU/UK VAT filings.

amount_input_vat_true_upstring

Prior-year input VAT pro-rata true-up on this filing. Negative claims more, positive repays. Always 0.00 until posted.

amount_input_vat_recoverable_basestring

Input VAT this filing would have claimed at a 100% rate. Always 0.00 outside EU/UK VAT filings.

input_vat_recovery_rate_appliedstring nullable

Rate actually used on this filing's reclaim. Null when this filing is not EU/UK VAT.

amount_salesstring

Total sales amount during the filing period.

total_taxable_salesstring nullable

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 nullable

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

internal_notesstring nullable

Notes or comments related to the filing.

recent_details_report_linkstring nullable
tax_remittedstring

The amount of tax remitted.

original_tax_remittedstring nullable

Tax remitted when filing was first confirmed.

return_confirmation_idstring nullable

Return confirmation ID, if applicable.

payment_confirmation_idstring nullable

Payment confirmation ID, if applicable.

submitted_return_confirmation_idstring nullable

Return confirmation ID captured when the filing was moved to Submitted

submitted_payment_confirmation_idstring nullable

Payment confirmation ID captured when the filing was moved to Submitted

block_approvalboolean nullable

Indicates if the filing can be approved.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD'

ISO-4217 currency code. Pair with a monetary amount on the same object.

idstring required

Unique identifier for the filing.

registration_idstring required

Identifier for the registration associated with the filing.

filing_frequencystring nullable

Filing frequency from the associated registration.

oss_typestring nullable

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

estimated_penalty_intereststring nullable

Display-only estimated penalties and interest for BACK_FILING rows. Null means unknown (placeholder). Zero means the estimate found nothing owed. Some states charge a flat late penalty even when the tax is zero. For a filed return, the estimate stops at the filing date. Never persisted on the filing or used for billing.

penalty_interest_remittance_tagstring nullable

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

organization_idstring required

Identifier for the organization associated with the filing.

attachmentsobject nullable

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_urlstring nullable required

Get the filing website URL for this filing's jurisdiction

Changes