This API retrieves detailed information about a specific filing using its unique identifier (filing_id).
Your secret API key. Include it with every request.
Unique identifier for the filing to retrieve.
Filing status. Possible values: UNFILED, FILING, FILED, PAUSED, SKIPPED, CANCELLED, ISSUE.
UNFILEDFILEDFILINGPAUSEDSKIPPEDCANCELLEDISSUEThe start date of the filing period.
The end date of the filing period.
The due date of the filing.
The date the filing was completed, if applicable.
Indicates if the filing was done manually.
The code of the state associated with the filing (e.g., IA, NY).
The name of the state associated with the filing (e.g., Iowa, New York).
Country code in ISO 3166-1 alpha-2 format (e.g., US).
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUIndicates if the filing was auto-approved. Defaults to false.
Indicates the date when filing will be unpaused.
DevRev ticket DON for the active assistance-pause episode. Cleared when the filing is approved from PAUSED.
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.
True when this filing is a prepayment obligation. Independent of filing_category so a past-due prepayment can still be BACK_FILING.
True when this filing is a final return for deregistration. Independent of filing_category — finals stay REGULAR.
User ID of who approved the filing.
Timestamp when the filing was approved.
Reason why the filing has an issue, if applicable.
Reason why the filing was skipped, if applicable.
Reason why the filing was cancelled, if applicable.
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.
SALES_TAXUSE_TAXSALES_AND_USE_TAXTrue when this filing is a state Retail Delivery Fee return, a separate filing from the state's sales tax return.
The calculated amount for the filing. Defaults to 0.00.
Adjusted amount, if any.
Discounts applied to the filing.
Fees applied to the filing.
Penalties applied to the filing.
Total tax collected during the filing period.
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.
Input VAT reclaimed on this filing's purchases. Subtracted from liability; always 0.00 outside EU/UK VAT AP filings.
Total sales amount during the filing period.
Total taxable amount during the filing period.
Final amount due for the filing.
Total tax liability for the filing.
Number of non-marketplace transactions. For total, add marketplace_transaction_count.
Number of marketplace transactions associated with the filing.
Estimated schedule line count (distinct jurisdictions). For Tax Ops workload ranking, not portal accuracy.
Notes or comments related to the filing.
The amount of tax remitted.
Tax remitted when filing was first confirmed.
Return confirmation ID, if applicable.
Payment confirmation ID, if applicable.
Indicates if the filing can be approved.
Currency code for the filing (e.g., USD, CAD).
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWDUnique identifier for the filing.
Identifier for the registration associated with the filing.
Filing frequency from the associated registration.
OSS scheme (UNION/NON_UNION/IOSS) from the associated registration, if any.
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.
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.
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.
Customer-facing P&I timing tag for BACK_FILING rows, e.g. 'Paid with return' or 'State bills you later'.
Identifier for the organization associated with the filing.
Map of attachment names to download URLs for the filing, if any.
Credits utilized for this filing.
Number of transactions deferred from this filing period.
Get the filing website URL for this filing's jurisdiction
Successfully retrieved filing by id
Unauthenticated request.
Resource not found
Validation error
Internal server error