Get Nexus For Org

GET

nexus

Get Nexus For Org

curl --request GET \
  --url https://api.trykintsugi.com/v1/nexus \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'

{
  "items": [
    {
      "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": "<string>",
      "previous_period_end_date": "<string>",
      "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": "<string>",
      "economic_nexus_met": false,
      "economic_nexus_met_date": "<string>",
      "physical_nexus_met": false,
      "physical_nexus_met_date": "<string>",
      "collected_tax_nexus_met": false,
      "collected_tax_nexus_met_date": "<string>",
      "earliest_transaction_date": "<string>",
      "most_recent_transaction_date": "<string>",
      "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": "<string>",
      "last_tax_liability_processed_at": "<string>",
      "periods": [
        {}
      ],
      "currency": "AED",
      "registration": {},
      "registration_regime": "STANDARD",
      "disregarded_at": "<string>",
      "disregarded_by": "<string>",
      "disregarded_nexus_types": [
        "<string>"
      ],
      "is_currently_disregarded": false
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

X-API-KEY

string

header

required

x-organization-id

string

header

required

Query Parameters

without_pagination

boolean

default:false

Return all results without pagination

disregard_view

string

Filter nexuses by disregard view: 'exposed' or 'disregarded'

status__in

string

default:APPROACHING,NOT_EXPOSED,PENDING_REGISTRATION,EXPOSED,APPROACHING,REGISTERED

state_code

string

country_code__in

string

order_by

string

default:state_code,country_code

collected_tax_nexus_met

boolean

page

integer

default:1

Required range: x >= 1

size

integer

default:50

Required range: 1 <= x <= 100

Response

Successful Response

items

NexusResponse · object[]

required

Show child attributes

items.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

items.state_code

string

required

items.state_name

string

required

items.treatment_of_exempt_transactions

enum<string>

required

Available options:

INCLUDED,

EXCLUDED,

DEPENDS,

INCLUDE_IF_PRESENCE,

YES_SALES_NO_TRANSACTIONS

items.trigger

string

required

items.sales_or_transactions

enum<string>

required

Available options:

EITHER,

SALES,

BOTH,

TRANSACTIONS

items.threshold_sales

integer

required

items.threshold_transactions

integer

required

items.start_date

string<date>

required

items.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

items.period_start_date

string<date>

required

items.period_end_date

string<date>

required

items.previous_period_start_date

string

required

items.previous_period_end_date

string

required

items.id

string

required

items.created_at

string<date-time>

required

items.updated_at

string<date-time>

required

items.organization_id

string

required

items.is_vda_eligible

boolean

required

items.nexus_type

enum<string>

required

Available options:

CANADA_FEDERAL,

EU_AGGREGATOR,

STATE,

EU_MEMBER_STATE

items.total_transactions

integer

required

items.total_transactions_included

integer

required

items.total_transactions_exempted

integer

required

items.total_transactions_marketplace

integer

required

items.marketplace_included

boolean

required

items.processing_status

enum<string>

default:UP_TO_DATE

Available options:

NEEDS_RERUN,

UP_TO_DATE,

NOT_READY

items.status

enum<string>

default:NOT_EXPOSED

Available options:

EXPOSED,

APPROACHING,

PENDING_REGISTRATION,

OSS_PENDING_REGISTRATION,

REGISTERED,

OSS_REGISTERED,

NOT_EXPOSED

items.transaction_count

integer

default:0

items.transactions_amount

string

default:0.00

items.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

items.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

items.calculated_tax_liability

string

default:0.00

items.imported_tax_liability

string

default:0.00

items.tax_liability

string

default:0.00

items.nexus_met

boolean

default:false

items.nexus_met_date

string

items.economic_nexus_met

boolean

default:false

items.economic_nexus_met_date

string

items.physical_nexus_met

boolean

default:false

items.physical_nexus_met_date

string

items.collected_tax_nexus_met

boolean

default:false

items.collected_tax_nexus_met_date

string

items.earliest_transaction_date

string

items.most_recent_transaction_date

string

items.find_threshold_crossing_transaction_state

FindThresholdCrossingTransactionState · object

Show child attributes

items.find_threshold_crossing_transaction_state.period_start_date

string

required

items.find_threshold_crossing_transaction_state.period_end_date

string

required

items.find_threshold_crossing_transaction_state.running_sales_total_decimal

string

required

items.find_threshold_crossing_transaction_state.running_transaction_count

integer

required

items.find_threshold_crossing_transaction_state.has_all_marketplace_transactions

boolean

required

items.find_threshold_crossing_transaction_state.last_txn_id

string

items.find_threshold_crossing_transaction_state.last_txn_datetime

string

items.earliest_collected_date

string<date-time>

default:2018-01-01T00:00:00

items.predicted_month_from_today

integer

items.vda_eligible

boolean

default:false

items.confidence_level

number

items.last_processed_at

string

items.last_tax_liability_processed_at

string

items.periods

object[]

items.currency

enum<string>

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

items.registration

object

items.registration_regime

enum<string>

Available options:

STANDARD,

SIMPLIFIED

items.disregarded_at

string

items.disregarded_by

string

items.disregarded_nexus_types

string[]

items.is_currently_disregarded

boolean

default:false

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

Get Physical NexusRetrieve a paginated list of physical nexuses for a specific organization.

⌘I

Get Nexus For Org

curl --request GET \
  --url https://api.trykintsugi.com/v1/nexus \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'

{
  "items": [
    {
      "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": "<string>",
      "previous_period_end_date": "<string>",
      "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": "<string>",
      "economic_nexus_met": false,
      "economic_nexus_met_date": "<string>",
      "physical_nexus_met": false,
      "physical_nexus_met_date": "<string>",
      "collected_tax_nexus_met": false,
      "collected_tax_nexus_met_date": "<string>",
      "earliest_transaction_date": "<string>",
      "most_recent_transaction_date": "<string>",
      "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": "<string>",
      "last_tax_liability_processed_at": "<string>",
      "periods": [
        {}
      ],
      "currency": "AED",
      "registration": {},
      "registration_regime": "STANDARD",
      "disregarded_at": "<string>",
      "disregarded_by": "<string>",
      "disregarded_nexus_types": [
        "<string>"
      ],
      "is_currently_disregarded": false
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Tax Estimation

Transactions

Address Validation

Customers

Registrations

Products

Nexus

Filings

Organizations

Organization Management

Connections

Exemptions

Get Nexus For Org

Authorizations

Query Parameters

Response