VAT Classes [API]

Product VAT classes define whether a product has VAT or not or belongs to a specific VAT category.

Notes: Customer VAT groups are used with Product VAT classes in order to determine product VAT rate.

Description List available VAT Classes
Action GET
URL <your URL here>/api/vat_classes
Sample request parameters (empty – no data required)
Sample Successful Response
[ 
   { 
      "id":1, 
      "name":"Normal Product VAT", 
      "is_default":true, 
      "created_at":"2016-06-23T09:13:17.000Z", 
      "updated_at":"2016-06-23T09:13:17.000Z" 
   } 
]
		

Description Create VAT Class
Action POST
URL <your URL here>/api/vat_classes
Sample request parameters
{"name":"Sales Tax NOT applicable"}
		
Sample Successful Response
{
  "id": 2,
  "name": "Sales Tax NOT applicable",
  "is_default": null,
  "created_at": "2019-05-15T17:58:50.339+12:00",
  "updated_at": "2019-05-15T17:58:50.339+12:00"
}
		

Description Update VAT Class
Action PATCH/PUT
URL <your URL here>/api/vat_classes/<id of VAT class>
Sample request parameters
{"name":"Sales Tax NOT applicable - update"}
		
Sample Successful Response
{
  "id": 2,
  "name": "Sales Tax NOT applicable - update",
  "is_default": null,
  "created_at": "2019-05-15T17:58:50.000+12:00",
  "updated_at": "2019-05-15T18:00:41.823+12:00"
}
		

Still need help? Contact Us Contact Us