# GetEcoNexusThresholds

Retrieve economic nexus threshold statuses for a company

`GET /api/v2/companies/{companyId}/econexusthresholds`

**API:** AvaTax API
**Tag:** EcoNexusThreshold
**API Version:** v2
**Base URL:** https://sandbox-rest.avatax.com/
**Accepts:** `application/json`
**Authentication:** API Key (`Authorization` in header) or OAuth 2.0 or Basic (username + license key)

Source: https://developer.avalara.com/products/crossborder/api/methods/EcoNexusThreshold/GetEcoNexusThresholds/

## Description

Retrieve the economic nexus threshold status for each US region in which activity has been
evaluated for this company.
            
Each entry in `states` describes the measurement window used, the sales and transaction
thresholds that apply to that region, the company's totals for the window, and whether
the threshold has been met.
            
Threshold statuses are evaluated on a recurring schedule rather than at request time.
Use `lastRefreshedAt` to determine how current the returned data is; when it is absent
from the response, the age of the data is not known.
            
When the optional `region` query parameter is provided, only the matching region is included
in `states`. If no threshold status exists for that company and region, `states` is returned
as an empty array with a 200 response.
            
Requires the `NexusFetch` permission for the target company.

### Security Policies

* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

## Parameters

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `companyId` | integer | path | Yes | The ID of the company to retrieve threshold statuses for. |
| `region` | string | query | No | Optional two-letter US region postal code used to filter the results (case-insensitive).
             When provided, `states` contains at most one entry, matched against the `region` field of each entry.
             Must be exactly two characters; otherwise this endpoint returns 400. |
| `X-Avalara-Client` | string | header | No | Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . |

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | Success | `EcoNexusThresholdsModel` |
| 400 | Bad Request | `ErrorResult` |
| 401 | Unauthorized |  |

### 200 Response: `EcoNexusThresholdsModel`

The economic nexus threshold statuses evaluated for a company.

| Property | Type | Required | Description |
|---|---|---|---|
| `companyId` | integer | No | The unique ID number of the company to which these threshold statuses belong. |
| `states` | ThresholdStateSummaryModel[] | No | The per-region threshold statuses for this company.
Empty when no threshold status has been evaluated for the company. |
| `lastRefreshedAt` | string | No | The UTC date and time when these threshold statuses were last updated.
Omitted when the age of the data is not known. |

## Example Request

```bash
curl -X GET "https://sandbox-rest.avatax.com/api/v2/companies/{companyId}/econexusthresholds" \
  -H "Authorization: Basic <credentials>" \
  -H "Accept: application/json"
```