(Quick Reference)
Service: Show
Description: This web service return an existing customer taxList of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerTaxLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted customer tax list | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerTaxLists/reference/{customerId}/{taxListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| taxListId | reference of the tax list | String | Yes | TL-001 |
Success Output
Success case: response.status=200
{
"id": 163,
"customerReference": "C-001",
"taxListReference": "RT-22",
"customer": {
"id": 1334,
"reference": "C-001",
"name": "cus1",
"href": "/api/v1/customers/1334"
},
"taxList": {
"id": 13,
"reference": "RT-22",
"name": "Tx22",
"href": "/api/v1/taxLists/13"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T08:33:59Z",
"lastUpdated": "2016-08-24T08:33:59Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer tax list with the id 999 doesn't exist."
}
