(Quick Reference) Service: Show

Description: This web service return an existing taxList of the specified id in JSON format

URL:

https://BASE_URL/api/VERSION/taxLists/{id}

URL with external_id:

https://BASE_URL/api/VERSION/taxLists/reference/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idid of the wanted tax listLong/StringYes777

Success Output

Success case: response.status=200
{
    "id": 11,
    "name": "Tx1",
    "reference": "RT-1",
    "organization": "Lyon",
    "taxType": {
        "id": 17,
        "name": "Percentage %",
        "href": "/api/v1.0/taxTypes/17"
    },
    "dateCreated": "2016-08-18T13:44:01Z",
    "lastUpdated": "2016-08-18T13:44:01Z"
}

Failure Output

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The tax list with the id 444 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."
}