nexusresponse.md

NexusResponse

Fields

Field	Type	Required	Description
processing_status	Optional[models.NexusStatusEnum]	➖	N/A
status	Optional[models.NexusStateEnum]	➖	N/A
country_code	models.CountryCodeEnum	✔️	N/A
state_code	str	✔️	N/A
state_name	str	✔️	N/A
treatment_of_exempt_transactions	models.TreatmentEnum	✔️	N/A
trigger	str	✔️	N/A
sales_or_transactions	models.SalesOrTransactionsEnum	✔️	N/A
threshold_sales_bigint	Optional[int]	➖	N/A
threshold_transactions	Nullable[int]	✔️	N/A
start_date	datetime	✔️	N/A
transaction_count	Optional[int]	➖	N/A
transactions_amount	Optional[str]	➖	N/A
previous_transaction_count	Optional[int]	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. 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_amount	Optional[str]	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. 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_liability	OptionalNullable[str]	➖	N/A
imported_tax_liability	OptionalNullable[str]	➖	N/A
tax_liability	Optional[str]	➖	N/A
nexus_met	Optional[bool]	➖	N/A
nexus_met_date	datetime	➖	N/A
tax_type	Optional[models.TaxTypeEnum]	➖	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_met	Optional[bool]	➖	N/A
economic_nexus_met_date	datetime	➖	N/A
physical_nexus_met	Optional[bool]	➖	N/A
physical_nexus_met_date	datetime	➖	N/A
collected_tax_nexus_met	OptionalNullable[bool]	➖	N/A
collected_tax_nexus_met_date	datetime	➖	N/A
period_model	models.PeriodModelEnum	✔️	N/A
period_start_date	datetime	✔️	N/A
period_end_date	datetime	✔️	N/A
previous_period_start_date	datetime	✔️	N/A
previous_period_end_date	datetime	✔️	N/A
earliest_transaction_date	date	➖	N/A
most_recent_transaction_date	date	➖	N/A
find_threshold_crossing_transaction_state	OptionalNullable[models.FindThresholdCrossingTransactionState]	➖	N/A
earliest_collected_date	date	➖	N/A
predicted_month_from_today	OptionalNullable[int]	➖	N/A
vda_eligible	OptionalNullable[bool]	➖	N/A
confidence_level	OptionalNullable[float]	➖	N/A
last_processed_at	date	➖	N/A
last_tax_liability_processed_at	date	➖	N/A
periods	List[Dict[str, Any]]	➖	N/A
currency	OptionalNullable[models.CurrencyEnum]	➖	Currency code for the nexus (e.g., USD, CAD).
id	str	✔️	N/A
created_at	date	✔️	N/A
updated_at	date	✔️	N/A
organization_id	str	✔️	N/A
registration	Dict[str, Any]	➖	N/A
registration_regime	OptionalNullable[models.RegistrationsRegimeEnum]	➖	N/A
disregarded_at	date	➖	N/A
disregarded_by	OptionalNullable[str]	➖	N/A
disregarded_type	OptionalNullable[models.DisregardedTypeEnum]	➖	N/A
disregarded_nexus_types	List[str]	➖	N/A
is_currently_disregarded	Optional[bool]	➖	N/A
ior_opt_out_eligible	Optional[bool]	➖	N/A
ior_eligible_at_registration	Optional[bool]	➖	N/A
requires_ior_number_to_register	Optional[bool]	➖	N/A
threshold_sales	int	✔️	N/A
is_vda_eligible	bool	✔️	N/A
nexus_type	models.NexusTypeEnum	✔️	N/A
total_transactions	int	✔️	N/A
total_transactions_included	int	✔️	N/A
total_transactions_exempted	int	✔️	N/A
total_transactions_marketplace	int	✔️	N/A
marketplace_included	Nullable[bool]	✔️	N/A