TAG LINE
TAG LINE
SMALL TITLE
System defined exemption types which are typically populated by a 3rd party tax integration such as AvaTax.
identity READ-ONLY | "identity": 4 Type: Number This is the unique numeric identifier for the TaxExemptType |
name READ-ONLY | "name": "Harmonized Sales Tax" Type: String System defined name for the Exempt Type |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| GET | api/v3/Tax/ExemptType/ |
| Retrieve all of the TaxExemptType objects. | |
Retrieve all of the TaxExemptType objects. GET api/v3/Tax/ExemptType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Harmonized Sales Tax"
}
]
} | |
| GET | api/v3/Tax/ExemptType/Paged |
| Retrieve all of the TaxExemptType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the TaxExemptType objects in a paged fashion. GET api/v3/Tax/ExemptType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Harmonized Sales Tax"
}
]
}
} | |
| GET | api/v3/Tax/ExemptType/{id} |
| Retrieve an instance of the TaxExemptType object by its ID. | |
| {id} | Unique identifier for the TaxExemptType object. |
Retrieve an instance of the TaxExemptType object by its ID. GET api/v3/Tax/ExemptType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Harmonized Sales Tax"
}
} | |