TAG LINE
TAG LINE
SMALL TITLE
System defined exemption levels such as all, federal, local or state. These work in coordination with a 3rd party tax integration such as AvaTax.
identity READ-ONLY | "identity": 23 Type: Number This is the unique numeric identifier for the TaxExemptLevel |
name READ-ONLY | "name": "Federal" Type: String System defined name for the Exempt Level |
GET | api/v4/Tax/ExemptLevel/ |
Retrieve all of the TaxExemptLevel objects. | |
Retrieve all of the TaxExemptLevel objects. GET api/v4/Tax/ExemptLevel/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "Federal" } ] } |
GET | api/v4/Tax/ExemptLevel/Paged |
Retrieve all of the TaxExemptLevel 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 TaxExemptLevel objects in a paged fashion. GET api/v4/Tax/ExemptLevel/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": "Federal" } ] } } |
GET | api/v4/Tax/ExemptLevel/{id} |
Retrieve an instance of the TaxExemptLevel object by its ID. | |
{id} | Unique identifier for the TaxExemptLevel object. |
Retrieve an instance of the TaxExemptLevel object by its ID. GET api/v4/Tax/ExemptLevel/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Federal" } } |
POST | api/v4/Tax/ExemptLevel/Search |
Retreive a list of TaxExemptLevel objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST. | |
Retreive a list of TaxExemptLevel objects based on search criteria. POST api/v4/Tax/ExemptLevel/Search { "query": { "top": 20, "search": [ { "name": "MyFieldName", "operator": "startsWith", "value": "a" } ] } } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "itemCount": 1, "items": [ { "identity": 1, "name": "Federal" } ] } |