TAG LINE
SMALL TITLE

Account / Tax Category

(API Version v4)


An Account Tax Category is assigned to a group of Accounts that are to be taxed in the same manner.


What can you do with AccountTaxCategory?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the AccountTaxCategory
name
"name": "Default Tax Category"
Type: String
User defined name given to the Tax Category.
ownerId
READ-ONLY
"ownerId": 10
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.


End Points

DELETEapi/v4/Account/TaxCategory/{id}
Delete an instance of the AccountTaxCategory object. Upon successful delete, this API will return a record of all of the reelated 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 AccountTaxCategory object.
Delete an instance of the AccountTaxCategory object.
DELETE api/v4/Account/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": "accountTaxCategory"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Account/TaxCategory/
Retrieve all of the AccountTaxCategory objects.
Retrieve all of the AccountTaxCategory objects.
GET api/v4/Account/TaxCategory/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Default Tax Category",
            "ownerId": 17,
            "ownerName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Account/TaxCategory/Paged
Retrieve all of the AccountTaxCategory 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 AccountTaxCategory objects in a paged fashion.
GET api/v4/Account/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,
                "name": "Default Tax Category",
                "ownerId": 20,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Account/TaxCategory/{id}
Retrieve an instance of the AccountTaxCategory object by its ID.
{id}Unique identifier for the AccountTaxCategory object.
Retrieve an instance of the AccountTaxCategory object by its ID.
GET api/v4/Account/TaxCategory/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Default Tax Category",
        "ownerId": 25,
        "ownerName": "Sample Text Data"
    }
}
POSTapi/v4/Account/TaxCategory/
Create a new instance of the AccountTaxCategory object.
Create a new instance of the AccountTaxCategory object.
POST api/v4/Account/TaxCategory/

{
    "name": "Default Tax Category"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Default Tax Category",
                "ownerId": 5,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Account/TaxCategory/Search
Retreive a list of AccountTaxCategory 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 AccountTaxCategory objects based on search criteria.
POST api/v4/Account/TaxCategory/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 Tax Category",
            "ownerId": 18,
            "ownerName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Account/TaxCategory/{id}
Update an existing instance of the AccountTaxCategory object.
Update an existing instance of the AccountTaxCategory object.
PUT api/v4/Account/TaxCategory/{id}

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