Skip to main content
GET
/
v1
/
nexus
/
{nexus_id}
{
  "country_code": "AF",
  "state_code": "<string>",
  "state_name": "<string>",
  "treatment_of_exempt_transactions": "INCLUDED",
  "trigger": "<string>",
  "sales_or_transactions": "EITHER",
  "threshold_sales": 123,
  "threshold_transactions": 123,
  "start_date": "2023-12-25",
  "period_model": "CURRENT_OR_PREVIOUS",
  "period_start_date": "2023-12-25",
  "period_end_date": "2023-12-25",
  "previous_period_start_date": "2023-12-25",
  "previous_period_end_date": "2023-12-25",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "is_vda_eligible": true,
  "nexus_type": "CANADA_FEDERAL",
  "total_transactions": 123,
  "total_transactions_included": 123,
  "total_transactions_exempted": 123,
  "total_transactions_marketplace": 123,
  "marketplace_included": true,
  "processing_status": "UP_TO_DATE",
  "status": "NOT_EXPOSED",
  "transaction_count": 0,
  "transactions_amount": "0.00",
  "previous_transaction_count": 0,
  "previous_transactions_amount": "0.00",
  "calculated_tax_liability": "0.00",
  "imported_tax_liability": "0.00",
  "tax_liability": "0.00",
  "nexus_met": false,
  "nexus_met_date": "2023-12-25",
  "economic_nexus_met": false,
  "economic_nexus_met_date": "2023-12-25",
  "physical_nexus_met": false,
  "physical_nexus_met_date": "2023-12-25",
  "collected_tax_nexus_met": false,
  "collected_tax_nexus_met_date": "2023-12-25",
  "earliest_transaction_date": "2023-11-07T05:31:56Z",
  "most_recent_transaction_date": "2023-11-07T05:31:56Z",
  "find_threshold_crossing_transaction_state": {
    "period_start_date": "<string>",
    "period_end_date": "<string>",
    "running_sales_total_decimal": "<string>",
    "running_transaction_count": 123,
    "has_all_marketplace_transactions": true,
    "last_txn_id": "<string>",
    "last_txn_datetime": "<string>"
  },
  "earliest_collected_date": "2018-01-01T00:00:00",
  "predicted_month_from_today": 123,
  "vda_eligible": false,
  "confidence_level": 123,
  "last_processed_at": "2023-11-07T05:31:56Z",
  "last_tax_liability_processed_at": "2023-11-07T05:31:56Z",
  "periods": [
    {}
  ],
  "currency": "AED",
  "registration": {},
  "registration_regime": "STANDARD",
  "disregarded_at": "2023-11-07T05:31:56Z",
  "disregarded_by": "<string>",
  "disregarded_nexus_types": [
    "<string>"
  ],
  "is_currently_disregarded": false
}

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

​
nexus_id
string
required

The unique identifier of the nexus.

Response

Successful Response

​
country_code
enum<string>
required
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
​
state_code
string
required
​
state_name
string
required
​
treatment_of_exempt_transactions
enum<string>
required
Available options:
INCLUDED,
EXCLUDED,
DEPENDS,
INCLUDE_IF_PRESENCE,
YES_SALES_NO_TRANSACTIONS
​
trigger
string
required
​
sales_or_transactions
enum<string>
required
Available options:
EITHER,
SALES,
BOTH,
TRANSACTIONS
​
threshold_sales
integer
required
​
threshold_transactions
integer | null
required
​
start_date
string<date>
required
​
period_model
enum<string>
required
Available options:
CURRENT_OR_PREVIOUS,
PRECEDING_YEAR_FROM_OCTOBER,
CALENDAR_YEAR,
PREVIOUS_12_MONTHS,
PREVIOUS_4_QUARTERS,
PREVIOUS_4_QUARTERS_OFFSET,
PRECEDING_YEAR,
PRECEDING_YEAR_QUARTERLY,
PRECEDING_YEAR_QUARTERLY_OFFSET
​
period_start_date
string<date>
required
​
period_end_date
string<date>
required
​
previous_period_start_date
string<date> | null
required
​
previous_period_end_date
string<date> | null
required
​
id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
organization_id
string
required
​
is_vda_eligible
boolean
required
​
nexus_type
enum<string>
required
Available options:
CANADA_FEDERAL,
EU_AGGREGATOR,
STATE,
EU_MEMBER_STATE
​
total_transactions
integer
required
​
total_transactions_included
integer
required
​
total_transactions_exempted
integer
required
​
total_transactions_marketplace
integer
required
​
marketplace_included
boolean | null
required
​
processing_status
enum<string>
default:UP_TO_DATE
Available options:
NEEDS_RERUN,
UP_TO_DATE,
NOT_READY
​
status
enum<string>
default:NOT_EXPOSED
Available options:
EXPOSED,
APPROACHING,
PENDING_REGISTRATION,
OSS_PENDING_REGISTRATION,
REGISTERED,
OSS_REGISTERED,
NOT_EXPOSED
​
transaction_count
integer
default:0
​
transactions_amount
string
default:0.00
​
previous_transaction_count
integer
default:0
deprecated

Deprecated: transaction_count now includes both current and previous period values when period_model is CURRENT_OR_PREVIOUS

​
previous_transactions_amount
string
default:0.00
deprecated

Deprecated: transactions_amount now includes both current and previous period values when period_model is CURRENT_OR_PREVIOUS

​
calculated_tax_liability
string | null
default:0.00
​
imported_tax_liability
string | null
default:0.00
​
tax_liability
string
default:0.00
​
nexus_met
boolean
default:false
​
nexus_met_date
string<date> | null
​
economic_nexus_met
boolean
default:false
​
economic_nexus_met_date
string<date> | null
​
physical_nexus_met
boolean
default:false
​
physical_nexus_met_date
string<date> | null
​
collected_tax_nexus_met
boolean | null
default:false
​
collected_tax_nexus_met_date
string<date> | null
​
earliest_transaction_date
string<date-time> | null
​
most_recent_transaction_date
string<date-time> | null
​
find_threshold_crossing_transaction_state
FindThresholdCrossingTransactionState · object
​
earliest_collected_date
string<date-time>
default:2018-01-01T00:00:00
​
predicted_month_from_today
integer | null
​
vda_eligible
boolean | null
default:false
​
confidence_level
number | null
​
last_processed_at
string<date-time> | null
​
last_tax_liability_processed_at
string<date-time> | null
​
periods
Periods · object[] | null
​
currency
enum<string> | null

Currency code for the nexus (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
​
registration
Registration · object
​
registration_regime
enum<string> | null
Available options:
STANDARD,
SIMPLIFIED
​
disregarded_at
string<date-time> | null
​
disregarded_by
string | null
​
disregarded_nexus_types
string[]
​
is_currently_disregarded
boolean
default:false