Skip to main content
GET
/
v1
/
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
​
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