VAT Rules
| Description | List available VAT Rules |
| Action | GET |
| URL | <your URL here>/api/vat_rules |
| Sample request parameters | (empty – no data required) |
| Sample Successful Response | [
{
"id": 1,
"vat_class": {
"id": 1,
"name": "Sales Tax applicable",
"is_default": true
},
"vat_rate": {
"id": 1,
"name": "Tax Rate",
"rate": "20.0"
},
"vat_group": {
"id": 1,
"name": "Sales Tax GB"
},
"integration_ref": "GB_STANDARD"
},
{
"id": 2,
"vat_class": {
"id": 1,
"name": "Sales Tax applicable",
"is_default": true
},
"vat_rate": {
"id": 2,
"name": "Zero Tax",
"rate": "0.0"
},
"vat_group": {
"id": 2,
"name": "No Sales Tax"
},
"integration_ref": "GB_ZERO"
}
]
|
| Description | Create VAT Rule |
| Action | POST |
| URL | <your URL here>/api/vat_rules |
| Sample request parameters | {"vat_class_id":"1","vat_group_id":"2","vat_rate_id":"2"}
|
| Sample Successful Response | {
"id": 3,
"vat_class": {
"id": 1,
"name": "Sales Tax applicable",
"is_default": true
},
"vat_rate": {
"id": 2,
"name": "Zero Tax",
"rate": "0.0"
},
"vat_group": {
"id": 2,
"name": "No Sales Tax"
},
"integration_ref": null
}
|
| Description | Update VAT rule |
| Action | PATCH/PUT |
| URL | <your URL here>/api/vat_rates/<id of VAT rule> |
| Sample request parameters | {"vat_class_id":"1","vat_group_id":"3","vat_rate_id":"2"}
|
| Sample Successful Response | {
"id": 3,
"vat_class": {
"id": 1,
"name": "Sales Tax applicable",
"is_default": true
},
"vat_rate": {
"id": 2,
"name": "Zero Tax",
"rate": "0.0"
},
"vat_group": {
"id": 3,
"name": "Group 3"
},
"integration_ref": null
}
|