TAG LINE
SMALL TITLE

Tax / Vendor / Service / Class

(API Version v4)


System defined service classes for Taxation. This is typically defined by the tax integration vendor for tax mapping purposes.


What can you do with TaxVendorServiceClass?


Properties

Property Details
identity
READ-ONLY
"identity": 17
Type: Number
This is the unique numeric identifier for the TaxVendorServiceClass
name
READ-ONLY
"name": "Default"
Type: String
System defined name for the Service Class
sortOrder
READ-ONLY
"sortOrder": 3
Type: Number
Unused


End Points

GETapi/v4/Tax/Vendor/Service/Class/
Retrieve all of the TaxVendorServiceClass objects.
Retrieve all of the TaxVendorServiceClass objects.
GET api/v4/Tax/Vendor/Service/Class/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Default",
            "sortOrder": 12
        }
    ]
}
GETapi/v4/Tax/Vendor/Service/Class/Paged
Retrieve all of the TaxVendorServiceClass 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 TaxVendorServiceClass objects in a paged fashion.
GET api/v4/Tax/Vendor/Service/Class/Paged
View Sample Response
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": "Default",
                "sortOrder": 24
            }
        ]
    }
}
GETapi/v4/Tax/Vendor/Service/Class/{id}
Retrieve an instance of the TaxVendorServiceClass object by its ID.
{id}Unique identifier for the TaxVendorServiceClass object.
Retrieve an instance of the TaxVendorServiceClass object by its ID.
GET api/v4/Tax/Vendor/Service/Class/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Default",
        "sortOrder": 26
    }
}
POSTapi/v4/Tax/Vendor/Service/Class/Search
Retreive a list of TaxVendorServiceClass 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 TaxVendorServiceClass objects based on search criteria.
POST api/v4/Tax/Vendor/Service/Class/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Default",
            "sortOrder": 4
        }
    ]
}