TAG LINE
TAG LINE
SMALL TITLE

Service / Tax Category

(API Version v8)


User defined Tax Category to be assigned to a Tax Codes.


What can you do with ServiceTaxCategory?


Properties

Property Details
identity
READ-ONLY
"identity": 16
Type: Number
This is the unique numeric identifier for the ServiceTaxCategory
ownerId
READ-ONLY
"ownerId": 15
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Land Line Taxable"
Type: String
User defined name for the Tax Category.


End Points

DELETEService/TaxCategory/{id}
Delete an instance of the ServiceTaxCategory object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the ServiceTaxCategory object.
Delete an instance of the ServiceTaxCategory object.
DELETE Service/TaxCategory/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "serviceTaxCategory"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETService/TaxCategory/
Retrieve all of the ServiceTaxCategory objects.
Retrieve all of the ServiceTaxCategory objects.
GET Service/TaxCategory/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 9,
            "ownerName": "Sample Text Data",
            "name": "Land Line Taxable"
        }
    ]
}
GETService/TaxCategory/AvaTax
Retrieve all of the ServiceTaxCategory objects.
Retrieve all of the ServiceTaxCategory objects.
GET Service/TaxCategory/AvaTax
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 1,
            "ownerName": "Sample Text Data",
            "name": "Land Line Taxable"
        }
    ]
}
GETService/TaxCategory/Paged
Retrieve all of the ServiceTaxCategory 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 ServiceTaxCategory objects in a paged fashion.
GET Service/TaxCategory/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,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}
GETService/TaxCategory/{id}
Retrieve an instance of the ServiceTaxCategory object by its ID.
{id}Unique identifier for the ServiceTaxCategory object.
Retrieve an instance of the ServiceTaxCategory object by its ID.
GET Service/TaxCategory/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 19,
        "ownerName": "Sample Text Data",
        "name": "Land Line Taxable"
    }
}
POSTService/TaxCategory/
Create a new instance of the ServiceTaxCategory object.
Create a new instance of the ServiceTaxCategory object.
POST Service/TaxCategory/

{
    "name": "Land Line Taxable"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}
PUTService/TaxCategory/{id}
Update an existing instance of the ServiceTaxCategory object.
Update an existing instance of the ServiceTaxCategory object.
PUT Service/TaxCategory/{id}

{
    "identity": 1,
    "name": "Land Line Taxable"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 8,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}