TAG LINE
SMALL TITLE
Represents a container that holds a set of the Tax Rates such as "Texas Taxes"
identity READ-ONLY | "identity": 6 Type: Number This is the unique numeric identifier for the TaxCode |
countryId | "countryId": 18 Type: Number Unique identifier for the associated Country object. |
countryName | "countryName": "Sample Name" Type: String The name of the object associated with the countryId property. |
stateId | "stateId": 6 Type: Number Unique identifier for the associated State object. |
stateName | "stateName": "Sample Name" Type: String The name of the object associated with the stateId property. |
name | "name": "Texas Taxes" Type: String User defined name for the Tax Code. |
ownerId READ-ONLY | "ownerId": 24 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. |
accountTaxCategoryId | "accountTaxCategoryId": 24 Type: Number Unique identifier for the associated AccountTaxCategory object. |
accountTaxCategoryName | "accountTaxCategoryName": "Sample Name" Type: String The name of the object associated with the accountTaxCategoryId property. |
serviceTaxCategoryId | "serviceTaxCategoryId": 14 Type: Number Unique identifier for the associated ServiceTaxCategory object. |
serviceTaxCategoryName | "serviceTaxCategoryName": "Sample Name" Type: String The name of the object associated with the serviceTaxCategoryId property. |
taxVendorId | "taxVendorId": 23 Type: Number Unique identifier for the associated TaxVendor object. |
taxVendorName | "taxVendorName": "Sample Name" Type: String The name of the object associated with the taxVendorId property. |
isReverseVat | "isReverseVat": true Type: Boolean Whether or not to calculate the tax but not apply it to the transaction. You want to report the tax but not charge for it. |
displayName | "displayName": "State Taxes" Type: String User defined report/invoice friendly name the Tax Code. |
isUsageTaxOnly | "isUsageTaxOnly": true Type: Boolean Whether or not this Tax Code should only be applied to usage charges. |
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:
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the TaxCode object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v3/Tax/Code/{id} |
| Delete an instance of the TaxCode 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 TaxCode object. |
Delete an instance of the TaxCode object. DELETE api/v3/Tax/Code/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "taxCode"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/Tax/Code/ |
| Retrieve all of the TaxCode objects. | |
Retrieve all of the TaxCode objects. GET api/v3/Tax/Code/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"countryId": 25,
"countryName": "Sample Text Data",
"stateId": 17,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 13,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 24,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 8,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 25,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
]
} | |
| GET | api/v3/Tax/Code/Paged |
| Retrieve all of the TaxCode 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 TaxCode objects in a paged fashion. GET api/v3/Tax/Code/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,
"countryId": 16,
"countryName": "Sample Text Data",
"stateId": 4,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 8,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 11,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 4,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 15,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
]
}
} | |
| GET | api/v3/Tax/Code/Paged/Detail |
| Retrieve all of the TaxCode objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the TaxCode objects in a paged fashion with all object details. GET api/v3/Tax/Code/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"countryId": 11,
"countryName": "Sample Text Data",
"stateId": 10,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 26,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 10,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 22,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 21,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v3/Tax/Code/{id} |
| Retrieve an instance of the TaxCode object by its ID. | |
| {id} | Unique identifier for the TaxCode object. |
Retrieve an instance of the TaxCode object by its ID. GET api/v3/Tax/Code/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"countryId": 14,
"countryName": "Sample Text Data",
"stateId": 9,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 13,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 10,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 10,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 16,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
} | |
| GET | api/v3/Tax/Code/{id}/Detail |
| Retrieve deep detail of the TaxCode object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the TaxCode object. |
Retrieve deep detail of the TaxCode object by its ID. GET api/v3/Tax/Code/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"countryId": 15,
"countryName": "Sample Text Data",
"stateId": 19,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 16,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 3,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 18,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 11,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v3/Tax/Code/{id} |
| Update or Add the TaxCode object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the TaxCode object. |
Update or Add the TaxCode object and optionally make changes to any child objects. PATCH api/v3/Tax/Code/{id}
{
"details": {},
"taxCodes": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"countryId": 17,
"stateId": 13,
"name": "Texas Taxes",
"accountTaxCategoryId": 14,
"serviceTaxCategoryId": 22,
"taxVendorId": 6,
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "taxCode",
"instance": {
"identity": 1,
"countryId": 18,
"countryName": "Sample Text Data",
"stateId": 3,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 7,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 5,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 3,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 27,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
}
]
}
} | |
| POST | api/v3/Tax/Code/ |
| Create a new instance of the TaxCode object. | |
Create a new instance of the TaxCode object. POST api/v3/Tax/Code/
{
"countryId": 13,
"stateId": 16,
"name": "Texas Taxes",
"accountTaxCategoryId": 5,
"serviceTaxCategoryId": 8,
"taxVendorId": 4,
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"countryId": 3,
"countryName": "Sample Text Data",
"stateId": 25,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 27,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 14,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 15,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 23,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
]
}
} | |
| PUT | api/v3/Tax/Code/{id} |
| Update an existing instance of the TaxCode object. | |
Update an existing instance of the TaxCode object. PUT api/v3/Tax/Code/{id}
{
"identity": 1,
"countryId": 27,
"stateId": 0,
"name": "Texas Taxes",
"accountTaxCategoryId": 1,
"serviceTaxCategoryId": 9,
"taxVendorId": 22,
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"countryId": 21,
"countryName": "Sample Text Data",
"stateId": 21,
"stateName": "Sample Text Data",
"name": "Texas Taxes",
"ownerId": 22,
"ownerName": "Sample Text Data",
"accountTaxCategoryId": 5,
"accountTaxCategoryName": "Sample Text Data",
"serviceTaxCategoryId": 16,
"serviceTaxCategoryName": "Sample Text Data",
"taxVendorId": 12,
"taxVendorName": "Sample Text Data",
"isReverseVat": true,
"displayName": "State Taxes",
"isUsageTaxOnly": true
}
]
}
} | |