Skip to main content
PUT
/
v1
/
filings
/
{filing_id}
{
  "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"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-organization-id
string | null
required

The unique identifier for the organization making the request

Path Parameters

​
filing_id
string
required

Unique identifier for the filing to retrieve.

Body

application/json

This is a temporary serializer for the update filing endpoint. It will be deprecated and with a filing approval endpoint.

​
filing_id
string | null
​
organization_id
string | null
​
is_test
boolean | null
​
status
enum<string>
default:UNFILED
Available options:
UNFILED,
FILED,
FILING,
PAUSED
​
start_date
string<date> | null
​
end_date
string<date> | null
​
due_date
string<date> | null
​
date_filed
string<date> | null
​
is_manual
boolean | null
​
state_code
string | null
​
state_name
string | null
​
country_code
enum<string> | null
Available options:
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
​
jira_issue_key
string | null
​
auto_approved
boolean | null
default:false
​
auto_file
boolean | null
default:false
​
paused_until_date
string<date> | null
​
pause_reason
string | null

Response

Successfully retrieved filing by id

​
start_date
string<date>
required

The start date of the filing period.

​
end_date
string<date>
required

The end date of the filing period.

​
country_code
enum<string>
required

Country code in ISO 3166-1 alpha-2 format (e.g., US).

Available options:
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
​
id
string
required

Unique identifier for the filing.

​
registration_id
string
required

Identifier for the registration associated with the filing.

​
filing_website_url
string | null
required

Get the filing website URL for this filing's jurisdiction

​
status
enum<string>
default:UNFILED

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

Available options:
UNFILED,
FILED,
FILING,
PAUSED
​
due_date
string<date> | null

The due date of the filing.

​
date_filed
string<date> | null

The date the filing was completed, if applicable.

​
is_manual
boolean | null

Indicates if the filing was done manually.

​
state_code
string | null

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

​
state_name
string | null

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

​
jira_issue_key
string | null

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

​
auto_approved
boolean | null
default:false

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

​
paused_until_date
string<date> | null

Indicates the date when filing will be unpaused.

​
filing_category
string
default:REGULAR

Category of filing. Common values: REGULAR (standard periodic filing), PREPAYMENT (prepayment or estimated tax), AMENDMENT (amended return). Different categories can have overlapping periods.

Maximum string length: 50
​
approved_by
string | null

User ID of who approved the filing.

​
approved_at
string<date-time> | null

Timestamp when the filing was approved.

​
amount_calculated
string
default:0.00

The calculated amount for the filing. Defaults to 0.00.

​
amount_adjusted
string
default:0.00

Adjusted amount, if any.

​
amount_discounts
string
default:0.00

Discounts applied to the filing.

​
amount_fees
string
default:0.00

Discounts applied to the amount.

​
amount_penalties
string
default:0.00

Penalties applied to the filing.

​
amount_tax_collected
string
default:0.00

Total tax collected during the filing period.

​
amount_sales
string
default:0.00

Total sales amount during the filing period.

​
total_taxable_sales
string | null
default:0.00

Total taxable amount during the filing period.

​
amount
string
default:0.00

Final amount due for the filing.

​
total_tax_liability
string
default:0.00

Total tax liability for the filing.

​
transaction_count
integer
default:0

Number of non-marketplace transactions. For total, add marketplace_transaction_count.

​
marketplace_transaction_count
integer
default:0

Number of marketplace transactions associated with the filing.

​
internal_notes
string | null

Notes or comments related to the filing.

​
recent_details_report_link
string | null
​
tax_remitted
string
default:0.00

The amount of tax remitted.

​
return_confirmation_id
string | null

Return confirmation ID, if applicable.

​
payment_confirmation_id
string | null

Payment confirmation ID, if applicable.

​
block_approval
boolean | null

Indicates if the filing can be approved.

​
currency
enum<string> | null

Currency code for the filing (e.g., USD, CAD).

Available options:
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
​
attachments
Attachments · object

List of attachments associated with the filing, if any.

​
credits_utilized
string
default:0.00