Get one filing

curl --request GET \
  --url https://base_url/api/v1/filings/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "corporation_id": "<string>",
    "country": "US",
    "country_specific_details": {
      "legal_name": "Example Inc.",
      "state": "CA",
      "state_specific_details": {
        "payment_interval": "<string>",
        "sales_tax_id": "<string>",
        "username": "<string>",
        "password": "<string>",
        "pin": "<string>",
        "web_file_number": "<string>",
        "tax_types": [
          "RSST"
        ]
      }
    },
    "frequency": "MONTHLY",
    "period_start_date": "2023-12-25",
    "due_date": "2023-12-25",
    "filing_status": "PENDING",
    "filed_on": "2023-12-25",
    "registration_id": "<string>",
    "total_tax_filed": 135.92,
    "sales_details": {
      "total_sales": 12345.91,
      "taxable_sales": 12345.91,
      "sales_tax_collected": 771.62
    },
    "payment_details": {
      "amount_due": 771.62,
      "payment_status": "PENDING",
      "failure_details": {
        "failed_at": "<string>",
        "reason": "<string>"
      }
    }
  },
  "message": "Successfully fetched filing."
}

GET

filings

{id}

Get one filing

curl --request GET \
  --url https://base_url/api/v1/filings/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "corporation_id": "<string>",
    "country": "US",
    "country_specific_details": {
      "legal_name": "Example Inc.",
      "state": "CA",
      "state_specific_details": {
        "payment_interval": "<string>",
        "sales_tax_id": "<string>",
        "username": "<string>",
        "password": "<string>",
        "pin": "<string>",
        "web_file_number": "<string>",
        "tax_types": [
          "RSST"
        ]
      }
    },
    "frequency": "MONTHLY",
    "period_start_date": "2023-12-25",
    "due_date": "2023-12-25",
    "filing_status": "PENDING",
    "filed_on": "2023-12-25",
    "registration_id": "<string>",
    "total_tax_filed": 135.92,
    "sales_details": {
      "total_sales": 12345.91,
      "taxable_sales": 12345.91,
      "sales_tax_collected": 771.62
    },
    "payment_details": {
      "amount_due": 771.62,
      "payment_status": "PENDING",
      "failure_details": {
        "failed_at": "<string>",
        "reason": "<string>"
      }
    }
  },
  "message": "Successfully fetched filing."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The unique identifier of the transaction to fetch.

Response

Transaction fetch response

data

object

Show child attributes

data.id

string

The unique identifier for the filing.

data.corporation_id

string

The unique identifier for a corporation associated with this filing.

data.country

string

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

data.country_specific_details

object

Show child attributes

data.country_specific_details.legal_name

string

required

The legal name of the entity being registered.

Example:

"Example Inc."

data.country_specific_details.state

string

required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

data.country_specific_details.state_specific_details

object

Show child attributes

data.country_specific_details.state_specific_details.payment_interval

string

Payment interval for sales tax.

data.country_specific_details.state_specific_details.sales_tax_id

string

Sales tax ID.

data.country_specific_details.state_specific_details.username

string

Username for tax filing.

data.country_specific_details.state_specific_details.password

string

Password for tax filing.

data.country_specific_details.state_specific_details.pin

string

PIN for tax filing.

data.country_specific_details.state_specific_details.web_file_number

string

Web file number for tax filing.

data.country_specific_details.state_specific_details.tax_types

enum<string>[]

Enum representing different types of taxes applicable in various jurisdictions.

Available options:

RSST,

RST,

RUT,

SSUT,

GRT,

VUT,

RTPT,

TPT,

DTT,

RDF,

SUT,

GET,

ROT,

CUT,

RSSUT,

BAO

data.frequency

enum<string>

Filing frequency refers to how often a business is required to submit its sales tax returns, which is typically determined by the state based on the business's sales volume and tax liability.

Available options:

MONTHLY,

QUARTERLY,

ANNUALLY,

SEMI_ANNUALLY

data.period_start_date

string<date>

ISO 8601 date string, identifying the start date of the period period for which the sales tax is being filed (e.g., '2024-09-01' for September 2024). For a quarter 1 filing where the fiscal year starts in March, the period_start_date will be 2024-03-01 and frequency will be QUARTERLY.

data.due_date

string<date>

ISO 8601 date string, identifying the date when by which the filing must be submitted.

data.filing_status

enum<string>

Current status of the filing.

Available options:

PENDING,

FILED

data.filed_on

string<date>

Date when the taxes were filed with the state, in ISO 8601 format.

data.registration_id

string

The unique identifier for the tax registration associated with this filing.

data.total_tax_filed

number

Total amount of sales tax filed with various jurisdictions for this period. May differ slightly from the total tax collected.

Example:

135.92

data.sales_details

object

Show child attributes

data.sales_details.total_sales

number

Total sales amount for the filing period.

Example:

12345.91

data.sales_details.taxable_sales

number

Total sales amount that was subject to sales tax for the filing period.

Example:

12345.91

data.sales_details.sales_tax_collected

number

Total sales tax collected during the period.

Example:

771.62

data.payment_details

object

Show child attributes

data.payment_details.amount_due

number

Total amount due for this filing.

Example:

771.62

data.payment_details.payment_status

enum<string>

Status of the payment.

Available options:

PENDING,

COMPLETED,

FAILED

data.payment_details.failure_details

object

This object will be populated if the payment fails for any reason.

Show child attributes

data.payment_details.failure_details.failed_at

string

ISO 8601 date string, identifying the date when the payment failed.

data.payment_details.failure_details.reason

string

Specific information why the payment failed.

message

string

Example:

"Successfully fetched filing."

List filings Products

⌘I

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

Get one filing

Authorizations

Path Parameters

Response