Skip to main content
GET
/
nexus
Get nexus information
curl --request GET \
  --url https://base_url/api/v1/nexus \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
    "states": [
      {
        "state": "CA",
        "nexus_rule": {
          "sales_threshold": 100000,
          "transactions_threshold": 200,
          "threshold_type": "SALES_OR_TRANSACTIONS",
          "evaluation_period_type": "PREV_CALENDAR_YEAR",
          "includable_sales_type": "ALL_SALES"
        },
        "calculation": {
          "sales_exposure_percentage": 0.06,
          "transaction_exposure_percentage": 0.1235,
          "total_sales": 12345.9,
          "total_transactions": 12,
          "taxable_sales": 10000,
          "taxable_transactions": 10,
          "retail_sales": 8000,
          "retail_transactions": 8,
          "includable_sales_type": "TAXABLE_SALES"
        },
        "is_nexus_breached": true,
        "date_of_breach": "2023-12-25"
      }
    ]
  },
  "message": "Successfully fetched nexus."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
corporation_id
string
required

The unique identifier for a corporation. All transactions associated with the specified corporation will be returned.

Response

Nexus data for all states

​
data
object
​
message
string
Example:

"Successfully fetched nexus."

⌘I