Sign in
Nexus

Get nexus details for id

Get details for a specific nexus by its ID.

get/v1/nexus/{nexus_id}

Path parameters

nexus_idstring required

The unique identifier of the nexus.

The unique identifier of the nexus.

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

The unique identifier for the organization making the request

Response

Successful Response

processing_status'NEEDS_RERUN' | 'UP_TO_DATE' | 'NOT_READY'
status'EXPOSED' | 'APPROACHING' | 'PENDING_REGISTRATION' | 'OSS_PENDING_REGISTRATION' | 'REGISTERED' | 'OSS_REGISTERED' | 'NOT_EXPOSED'
country_code'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' required
state_codestring required
state_namestring required
treatment_of_exempt_transactions'INCLUDED' | 'EXCLUDED' | 'DEPENDS' | 'INCLUDE_IF_PRESENCE' | 'YES_SALES_NO_TRANSACTIONS' required
triggerstring required
sales_or_transactions'EITHER' | 'SALES' | 'BOTH' | 'TRANSACTIONS' required
threshold_sales_bigintinteger
threshold_transactionsinteger nullable required
start_datestring date required
transaction_countinteger
transactions_amountstring
previous_transaction_countinteger

Deprecated: transaction_count now includes both current and previous period values when period_model is CURRENT_OR_PREVIOUS, CURRENT_OR_TWO_PREVIOUS, or CURRENT_OR_PREVIOUS_12_MONTHS

previous_transactions_amountstring

Deprecated: transactions_amount now includes both current and previous period values when period_model is CURRENT_OR_PREVIOUS, CURRENT_OR_TWO_PREVIOUS, or CURRENT_OR_PREVIOUS_12_MONTHS

calculated_tax_liabilitystring nullable
imported_tax_liabilitystring nullable
tax_liabilitystring
nexus_metboolean
nexus_met_datestring date nullable
tax_type'SALES_TAX' | 'USE_TAX' | 'SALES_AND_USE_TAX'

Tax obligation on a nexus, registration, or filing row.

Registrations and filings may be SALES_AND_USE_TAX: one state account and one return can cover both taxes, and each is stored as a single row. Nexus rows are only SALES_TAX or USE_TAX. Sales and use tax exposure are separate obligations with their own met dates, period models, and liability accrual.

economic_nexus_metboolean
economic_nexus_met_datestring date nullable
physical_nexus_metboolean
physical_nexus_met_datestring date nullable
collected_tax_nexus_metboolean nullable
collected_tax_nexus_met_datestring date nullable
period_model'CURRENT_OR_PREVIOUS' | 'CURRENT_OR_TWO_PREVIOUS' | 'PRECEDING_YEAR_FROM_OCTOBER' | 'CALENDAR_YEAR' | 'PREVIOUS_12_MONTHS' | 'CURRENT_OR_PREVIOUS_12_MONTHS' | 'PREVIOUS_4_QUARTERS' | 'PREVIOUS_4_QUARTERS_OFFSET' | 'PRECEDING_YEAR' | 'PRECEDING_YEAR_QUARTERLY' | 'PRECEDING_YEAR_QUARTERLY_OFFSET' required
period_start_datestring date required
period_end_datestring date required
previous_period_start_datestring date nullable required
previous_period_end_datestring date nullable required
earliest_transaction_datestring date-time nullable
most_recent_transaction_datestring date-time nullable
earliest_collected_datestring date-time
predicted_month_from_todayinteger nullable
vda_eligibleboolean nullable
confidence_levelnumber nullable
last_processed_atstring date-time nullable
last_tax_liability_processed_atstring date-time nullable
periodsobject[]
currency'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'
idstring required
created_atstring date-time required
updated_atstring date-time required
organization_idstring required
registrationobject nullable
registration_regime'STANDARD' | 'SIMPLIFIED'
disregarded_atstring date-time nullable
disregarded_bystring nullable
disregarded_type'DISREGARDED' | 'IOR_OPT_OUT' | 'IOR_OPT_OUT_NON_PHYSICAL_GOODS'
disregarded_nexus_typesstring[]
is_currently_disregardedboolean
ior_opt_out_eligibleboolean
ior_eligible_at_registrationboolean
requires_ior_number_to_registerboolean
threshold_salesinteger required
is_vda_eligibleboolean required
nexus_type'CANADA_FEDERAL' | 'EU_AGGREGATOR' | 'STATE' | 'EU_MEMBER_STATE' required
total_transactionsinteger required
total_transactions_includedinteger required
total_transactions_exemptedinteger required
total_transactions_marketplaceinteger required
marketplace_includedboolean nullable required

Changes

Changed in 1 of the 3 revisions of this API.1

  • 6ba4f4c774c31See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 362 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog