Get Registrations

Authorizations

X-API-KEY

string

header

required

x-organization-id

string

header

required

Query Parameters

status__in

string

default:REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,VALIDATING,AWAITING_CLARIFICATION

Filter registrations by status. Multiple statuses can be passed, separated by commas.

state_code

string

Filter registrations by state code.

filing_frequency__in

string

Filter registrations by filing frequency. Multiple filing frequencies can be passed, separated by commas.

country_code__in

enum<string>[]

Filter registrations by country code in ISO 3166-1 alpha-2 format (e.g., US, CA).

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

order_by

string

Order results by specified fields (comma-separated)

page

integer

default:1

Page number

Required range: x >= 1

size

integer

default:50

Page size

Required range: 1 <= x <= 100

Response

Successfully retrieved registrations

items

RegistrationReadWithPassword · object[]

required

Show child attributes

items.status

enum<string>

required

The current status of the registration. Possible values: REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, VALIDATING, AWAITING_CLARIFICATION.

Available options:

REGISTERED,

PROCESSING,

UNREGISTERED,

DEREGISTERING,

DEREGISTERED,

VALIDATING,

AWAITING_CLARIFICATION

items.country_code

enum<string>

required

The country code (ISO 3166-1 alpha-2 format) where the registration applies.

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

items.state_code

string

required

The state/province code where the registration applies.

items.state_name

string

required

The name of the state/province.

items.filing_frequency

enum<string>

required

Specifies how often tax filings should be made. Possible values: MONTHLY, QUARTERLY, ANNUALLY, UNKNOWN.

Available options:

UNKNOWN,

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

ANNUALLY,

ANNUAL_FISCAL_YEAR,

SEMI_MONTHLY,

BI_MONTHLY,

FOUR_MONTHLY,

QUARTERLY_PREPAYMENT

items.id

string

required

The unique identifier for the registration.

items.filing_days

integer

required

items.registration_type

enum<string>

required

Available options:

EU_OSS,

OTHER

items.registration_date

string

The date when the registration was created. Format: YYYY-MM-DD.

items.registration_email

string

Email address associated with the registration.

items.registration_key

string

A unique key assigned to the registration.

items.deregistration_key

string

A unique key assigned for deregistration.

items.registration_requested

string

Timestamp when the registration was requested.

items.registration_completed

string

Timestamp when the registration was completed.

items.deregistration_requested

string

Timestamp when deregistration was requested.

items.deregistration_completed

string

Timestamp when the deregistration was completed.

items.auto_registered

boolean

default:false

Indicates whether the registration was completed automatically.

items.registrations_regime

enum<string>

The tax registration regime (e.g., STANDARD, SIMPLIFIED).

Available options:

STANDARD,

SIMPLIFIED

items.change_regime_status

enum<string>

Available options:

REQUESTED,

APPROVED,

DONE,

ACKNOWLEDGED

items.third_party_enabled

boolean

default:false

Indicates whether third-party access is enabled for this registration.

items.do_not_file

boolean

default:false

If true, do not file for this registration (treated as False by default).

items.two_factor_enabled

boolean

Indicates whether two-factor authentication (2FA) is enabled for this registration.

items.marked_collecting

boolean

Indicates whether the registration is marked as collecting in shopify

items.username

string

Username for accessing tax registration details.

items.comment

string

Additional comments related to the registration.

items.create_filings_from

string

The date from which filings should be created. should start (YYYY-MM-DD).

items.initial_sync

boolean

default:false

Indicates whether an initial synchronization should be performed.

items.amount_fees

string

default:0.00

The amount of fees associated with the registration.

items.vda

boolean

default:false

Indicates whether a Voluntary Disclosure Agreement (VDA) applies.

items.imported

boolean

Whether the registration was imported from another system.

items.sales_tax_id

string

The sales tax ID associated with the registration.

items.sst_import

boolean

default:false

Indicates whether the registration is an SST Import.

items.oss_type

enum<string>

The type of OSS registration. Should be filled for ZZ_EU OSS registrations.

Available options:

UNION,

NON_UNION

items.oss_member_state_of_identification_code

enum<string>

The Member State of Identification code for OSS registrations.

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

items.marked_collecting_date

string

The date when the registration was marked as collecting.

items.needs_mark_as_collecting

boolean

default:false

Indicates whether the registration needs to be marked as collecting.

items.credits_total_available

string

default:0.00

items.registration_category

enum<string>

default:REGULAR

The category of the registration. Possible values: REGULAR, IMPORTED, DEREGISTRATION.

Available options:

REGULAR,

IMPORTED,

DEREGISTRATION

items.password_encrypted

string

Encrypted password for accessing the registration, if applicable.

items.has_all_credentials

boolean

default:false

Indicates if all required credentials are present.

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

pages

integer

required

Required range: x >= 0

Tax Estimation

Transactions

Address Validation

Customers

Registrations

Products

Nexus

Filings

Exemptions

Get Registrations

Authorizations

Query Parameters

Response