API reference / Get nexus details for id

Get nexus details for id

GET/v1/nexus/{nexus_id}

Get details for a specific nexus by its ID.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Path parameters

nexus_idstringRequired

The unique identifier of the nexus.

Response

processing_statusNexusStatusEnum

Available options:NEEDS_RERUNUP_TO_DATENOT_READY

statusNexusStateEnum

Available options:EXPOSEDAPPROACHINGPENDING_REGISTRATIONOSS_PENDING_REGISTRATIONREGISTEREDOSS_REGISTEREDNOT_EXPOSED

country_codeCountryCodeEnumRequired

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU

state_codestringRequired

state_namestringRequired

treatment_of_exempt_transactionsTreatmentEnumRequired

Available options:INCLUDEDEXCLUDEDDEPENDSINCLUDE_IF_PRESENCEYES_SALES_NO_TRANSACTIONS

triggerstringRequired

sales_or_transactionsSalesOrTransactionsEnumRequired

Available options:EITHERSALESBOTHTRANSACTIONS

threshold_sales_bigintinteger

threshold_transactionsintegerRequired

start_datestringRequired

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

imported_tax_liabilitystring

tax_liabilitystring

nexus_metboolean

nexus_met_datestring

tax_typeTaxTypeEnum

Which tax obligation this nexus tracks.

Available options:SALES_TAXUSE_TAXSALES_AND_USE_TAX

economic_nexus_metboolean

economic_nexus_met_datestring

physical_nexus_metboolean

physical_nexus_met_datestring

collected_tax_nexus_metboolean

collected_tax_nexus_met_datestring

period_modelPeriodModelEnumRequired

Available options:CURRENT_OR_PREVIOUSCURRENT_OR_TWO_PREVIOUSPRECEDING_YEAR_FROM_OCTOBERCALENDAR_YEARPREVIOUS_12_MONTHSCURRENT_OR_PREVIOUS_12_MONTHSPREVIOUS_4_QUARTERSPREVIOUS_4_QUARTERS_OFFSETPRECEDING_YEARPRECEDING_YEAR_QUARTERLYPRECEDING_YEAR_QUARTERLY_OFFSET

period_start_datestringRequired

period_end_datestringRequired

previous_period_start_datestringRequired

previous_period_end_datestringRequired

earliest_transaction_datestring

most_recent_transaction_datestring

find_threshold_crossing_transaction_stateFindThresholdCrossingTransactionState

earliest_collected_datestring

predicted_month_from_todayinteger

vda_eligibleboolean

confidence_levelnumber

last_processed_atstring

last_tax_liability_processed_atstring

periodsobject[]

currencyCurrencyEnum

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

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD

idstringRequired

created_atstringRequired

updated_atstringRequired

organization_idstringRequired

registrationobject

registration_regimeRegistrationsRegimeEnum

Available options:STANDARDSIMPLIFIED

disregarded_atstring

disregarded_bystring

disregarded_typeDisregardedTypeEnum

Available options:DISREGARDEDIOR_OPT_OUTIOR_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_salesintegerRequired

is_vda_eligiblebooleanRequired

nexus_typeNexusTypeEnumRequired

Available options:CANADA_FEDERALEU_AGGREGATORSTATEEU_MEMBER_STATE

total_transactionsintegerRequired

total_transactions_includedintegerRequired

total_transactions_exemptedintegerRequired

total_transactions_marketplaceintegerRequired

marketplace_includedbooleanRequired

200

Successful Response

422

Validation Error

cURL

GET /v1/nexus/{nexus_id}

-H "x-api-key: ***"

Example request

https://api.trykintsugi.com/v1/nexus/{nexus_id}

Response

{

"processing_status": "NEEDS_RERUN",

"status": "EXPOSED",

"country_code": "AF",

"state_code": "string",

"state_name": "string",

"treatment_of_exempt_transactions": "INCLUDED",

"trigger": "string",

"sales_or_transactions": "EITHER",

"threshold_sales_bigint": 0,

"threshold_transactions": 0,

"start_date": "string",

"transaction_count": 0,

"transactions_amount": "0.00",

"previous_transaction_count": 0,

"previous_transactions_amount": "0.00",

"calculated_tax_liability": "string",

"imported_tax_liability": "string",

"tax_liability": "0.00",

"nexus_met": false,

"nexus_met_date": "string",

"tax_type": "SALES_TAX",

"economic_nexus_met": false,

"economic_nexus_met_date": "string",

"physical_nexus_met": false,

"physical_nexus_met_date": "string",

"collected_tax_nexus_met": true,

"collected_tax_nexus_met_date": "string",

"period_model": "CURRENT_OR_PREVIOUS",

"period_start_date": "string",

"period_end_date": "string",

"previous_period_start_date": "string",

"previous_period_end_date": "string",

"earliest_transaction_date": "string",

"most_recent_transaction_date": "string",

"find_threshold_crossing_transaction_state": {

"last_txn_id": "string",

"last_txn_datetime": "string",

"period_start_date": "string",

"period_end_date": "string",

"running_sales_total_decimal": "string",

"running_transaction_count": 0,

"has_all_marketplace_transactions": true

"earliest_collected_date": "2018-01-01T00:00:00",

"predicted_month_from_today": 0,

"vda_eligible": true,

"confidence_level": 0,

"last_processed_at": "string",

"last_tax_liability_processed_at": "string",

"periods": [

null

"currency": "AED",

"id": "string",

"created_at": "string",

"updated_at": "string",

"organization_id": "string",

"registration": null,

"registration_regime": "STANDARD",

"disregarded_at": "string",

"disregarded_by": "string",

"disregarded_type": "DISREGARDED",

"disregarded_nexus_types": [

"string"

"is_currently_disregarded": false,

"ior_opt_out_eligible": false,

"ior_eligible_at_registration": false,

"requires_ior_number_to_register": false,

"threshold_sales": 0,

"is_vda_eligible": true,

"nexus_type": "CANADA_FEDERAL",

"total_transactions": 0,

"total_transactions_included": 0,

"total_transactions_exempted": 0,

"total_transactions_marketplace": 0,

"marketplace_included": true

}