TRtrykintsugi
Filings

Get filings

Changed on

The Get Filings API retrieves a paginated list of filings based on filters such as dates, jurisdiction, Country, status, etc. This helps track and manage tax filings efficiently across multiple jurisdictions.

get/v1/filings

Request

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

Query parameters

status__instring nullable

Filter filings by status

start_datestring date nullable

Filter filings with a start date greater than or equal to this date.

end_datestring date nullable

Filter filings with an end date less than or equal to this date.

date_filed__gtestring date nullable

Filter filings filed on or after this date.

date_filed__ltestring date nullable

Filter filings filed on or before this date.

order_bystring nullable

Comma-separated list of fields to sort the results.

state_codestring nullable

Filter filings by state code (e.g., CA for California).

filing_category__instring nullable

Filter filings by category (e.g., REGULAR, BACK_FILING, AMENDMENT).

tax_type__instring nullable

Filter filings by tax type. Multiple tax types can be passed, separated by commas (SALES_TAX, USE_TAX, SALES_AND_USE_TAX).

pageinteger

Page number

sizeinteger

Page size

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved filings

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

  • 2c90b14ca671Revision changes
    • warning

      added the new SMALL_PARCEL_VAT enum value to the // response property for the response status

  • 47ea0598da9fRevision changes
    • warning

      removed the optional property // from the response with the status