VAT Groups [API]
Customer VAT groups define whether a customer should pay VAT or not for an order
Notes: Customer VAT groups are used with Product VAT classes in order to determine product VAT rate. VAT groups are usually setup in the beginning and you can use the backend administration in order to set them up.
| Description |
List available VAT Groups |
| Action |
GET |
| URL |
<your URL here>/api/vat_groups |
| Sample request parameters |
(empty – no data required) |
| Sample Successful Response |
[
{
"id":1,
"name":"Normal VAT",
"created_at":"2016-06-23T09:13:17.000Z",
"updated_at":"2016-06-23T09:13:17.000Z",
"is_default":false
},
{
"id":2,
"name":"No VAT",
"created_at":"2016-06-23T09:13:17.000Z",
"updated_at":"2016-06-23T09:13:17.000Z",
"is_default":true
}
]
|
| Description |
Create VAT Group |
| Action |
POST |
| URL |
<your URL here>/api/vat_groups |
| Sample request parameters |
{"id":1,"name":"Sales Tax Group NY"}
|
| Sample Successful Response |
{
"id": 4,
"name": "Sales Tax Group NY",
"created_at": "2019-05-15T01:26:58.043-04:00",
"updated_at": "2019-05-15T01:26:58.043-04:00",
"is_default": false
}
|
| Description |
Update VAT Group |
| Action |
PATCH/PUT |
| URL |
<your URL here>/api/vat_groups/<id of VAT group> |
| Sample request parameters |
{"name":"Sales Tax Group NY - update"}
|
| Sample Successful Response |
{
"id": 4,
"name": "Sales Tax Group NY - update",
"created_at": "2019-05-15T15:26:58.000+10:00",
"updated_at": "2019-05-15T15:40:54.880+10:00",
"is_default": false
}
|
