(Quick Reference)
Service: Show a tax
Description: This web service return an existing tax of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/taxes/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired tax | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/taxes/reference/{itemListId}/{itemId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemId | reference of the item | String | No | eliteBook_820 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"id": 1367,
"itemReference": "bracelet-GRP09062",
"item": {
"id": 519,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/519"
},
"taxListReference": "20_tax_list",
"taxList": {
"id": 7,
"reference": "20_tax_list",
"name": "VAT 20%",
"href": "/api/v1.0/taxLists/7"
},
"taxValue": 24,
"organization": "entity1",
"dateCreated": "2016-02-10T13:36:18Z",
"lastUpdated": "2016-02-10T13:36:18Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The tax with the id 10 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
