Fetches the details of a Vat Item by uuid - the unique identifier for this Vat Item.
For calling the API, you will need the uuid. If mapped, the results also include mapped AppZen Vat Code and AppZen Vat Rate information.
Request URI
GET https://api.appzen.com/dictionary-data-services/
vat/{{uuid}}
Header Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| x-api-key | String | The x-api-key provided to authorize the request. | Yes |
| customer-id | String | The Customer ID provided to authorize the request. | Yes |
| customer-key | String | The Customer Key provided to authorize the request. | Yes |
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
|
uuid |
String |
Globally unique identifier for an uploaded document |
Yes |
Sample Request
curl --location 'https://api.enft.dev.appzen.com/dictionary-data-services/vat/c941d490-3e63-48f8-a68f-ec2ab318afdf' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: <>' \
--header 'customer-id: 100094' \
--header 'customer-key: <>'
Sample Response
Success
{
"vat_code": "VAT12",
"vat_rate": 12,
"vat_id": "1xsd2sd",
"appzen_vat_code": "VAT",
"appzen_vat_rate": 12,
"is_active": true
}
Failure
The request fails if you enter an invalid URL.
{
"timestamp": "2019-01-17T16:12:45.977+0000",
"status": 404,
"error": "Not Found",
"message": "Error code : 17e3338d - The resource you specified cannot be not found"
}
Response Code
| Response Code | Description |
| 200 | The request is successful. |
|
400 |
The request failed due to a malformed request syntax. Check the requested URL, including the parameters. |
| 401 |
The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid. |
| 403 |
The request failed due to a permission issue. The x-api key may not have permission to perform the request. |
| 404 |
The request failed as the resource is not found. Check the requested URL. |
| 500 |
The request failed due to an AppZen server issue. |
See Also
Comments
Article is closed for comments.