TAG LINE
TAG LINE
SMALL TITLE
Represents an individual tax rate within the system.
identity READ-ONLY | "identity": 5 Type: Number This is the unique numeric identifier for the TaxRate |
rate | "rate": 1.13 Type: Number The multiplier to be used to generate the taxable amount. |
name | "name": "VAT" Type: String User defined name for the Tax Rate. |
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. |
generalLedgerId | "generalLedgerId": 7 Type: Number Unique identifier for the associated GeneralLedger object. |
generalLedgerName | "generalLedgerName": "Sample Name" Type: String The name of the object associated with the generalLedgerId property. |
displayName | "displayName": "VAT" Type: String User defined friendly name for the Tax Rate. |
taxOnTax | "taxOnTax": true Type: Boolean Unused |
systemGenerated | "systemGenerated": true Type: Boolean Whether or not this tax was imported by the system typically in an integration with a 3rd party tax vendor. |
taxCategoryId | "taxCategoryId": 22 Type: Number Unique identifier for the associated TaxCategory object. |
taxCategoryName | "taxCategoryName": "Sample Name" Type: String The name of the object associated with the taxCategoryId property. |
| DELETE | Tax/Rate/{id} |
| Delete an instance of the TaxRate 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 TaxRate object. |
Delete an instance of the TaxRate object. DELETE Tax/Rate/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "taxRate"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Tax/Rate/ |
| Retrieve all of the TaxRate objects. | |
Retrieve all of the TaxRate objects. GET Tax/Rate/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"rate": 1.13,
"name": "VAT",
"ownerId": 15,
"ownerName": "Sample Text Data",
"generalLedgerId": 4,
"generalLedgerName": "Sample Text Data",
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 5,
"taxCategoryName": "Sample Text Data"
}
]
} | |
| GET | Tax/Rate/Paged |
| Retrieve all of the TaxRate 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 TaxRate objects in a paged fashion. GET Tax/Rate/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,
"rate": 1.13,
"name": "VAT",
"ownerId": 4,
"ownerName": "Sample Text Data",
"generalLedgerId": 20,
"generalLedgerName": "Sample Text Data",
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 5,
"taxCategoryName": "Sample Text Data"
}
]
}
} | |
| GET | Tax/Rate/{id} |
| Retrieve an instance of the TaxRate object by its ID. | |
| {id} | Unique identifier for the TaxRate object. |
Retrieve an instance of the TaxRate object by its ID. GET Tax/Rate/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"rate": 1.13,
"name": "VAT",
"ownerId": 7,
"ownerName": "Sample Text Data",
"generalLedgerId": 8,
"generalLedgerName": "Sample Text Data",
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 20,
"taxCategoryName": "Sample Text Data"
}
} | |
| POST | Tax/Rate/ |
| Create a new instance of the TaxRate object. | |
Create a new instance of the TaxRate object. POST Tax/Rate/
{
"rate": 1.13,
"name": "VAT",
"generalLedgerId": 17,
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 26
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"rate": 1.13,
"name": "VAT",
"ownerId": 20,
"ownerName": "Sample Text Data",
"generalLedgerId": 7,
"generalLedgerName": "Sample Text Data",
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 20,
"taxCategoryName": "Sample Text Data"
}
]
}
} | |
| PUT | Tax/Rate/{id} |
| Update an existing instance of the TaxRate object. | |
Update an existing instance of the TaxRate object. PUT Tax/Rate/{id}
{
"identity": 1,
"rate": 1.13,
"name": "VAT",
"generalLedgerId": 12,
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 23
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"rate": 1.13,
"name": "VAT",
"ownerId": 1,
"ownerName": "Sample Text Data",
"generalLedgerId": 25,
"generalLedgerName": "Sample Text Data",
"displayName": "VAT",
"taxOnTax": true,
"systemGenerated": true,
"taxCategoryId": 19,
"taxCategoryName": "Sample Text Data"
}
]
}
} | |