TAG LINE
SMALL TITLE
An Account Tax Category is assigned to a group of Accounts that are to be taxed in the same manner.
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": 3 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. |
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:
| DELETE | api/v2/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/v2/Account/TaxCategory/{id}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"
}
]
}
} | |
| GET | api/v2/Account/TaxCategory/ |
| Retrieve all of the AccountTaxCategory objects. | |
Retrieve all of the AccountTaxCategory objects. GET api/v2/Account/TaxCategory/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Default Tax Category",
"ownerId": 24,
"ownerName": "Sample Text Data"
}
]
} | |
| GET | api/v2/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/v2/Account/TaxCategory/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": "Default Tax Category",
"ownerId": 17,
"ownerName": "Sample Text Data"
}
]
}
} | |
| GET | api/v2/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/v2/Account/TaxCategory/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Default Tax Category",
"ownerId": 15,
"ownerName": "Sample Text Data"
}
} | |
| POST | api/v2/Account/TaxCategory/ |
| Create a new instance of the AccountTaxCategory object. | |
Create a new instance of the AccountTaxCategory object. POST api/v2/Account/TaxCategory/
{
"name": "Default Tax Category"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Default Tax Category",
"ownerId": 25,
"ownerName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v2/Account/TaxCategory/{id} |
| Update an existing instance of the AccountTaxCategory object. | |
Update an existing instance of the AccountTaxCategory object. PUT api/v2/Account/TaxCategory/{id}
{
"identity": 1,
"name": "Default Tax Category"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Default Tax Category",
"ownerId": 6,
"ownerName": "Sample Text Data"
}
]
}
} | |