This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/taxes |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve the list of tax types setup for a user. |
Parameters
| Name | Type | Description |
|---|---|---|
| Id | Numeric | Unique id given to the tax entry |
| Code | String | Unique code assigned to the tax entry |
| Description | String | Description of the tax entry |
| Rate | Numeric | Vat rate for the tax entry |
GET Operation
GET of taxes returns list of all taxes setup for user account.URL : /taxes?type={type}
{type} in the URL is an optional parameter which should be replaced with ‘supply’ or ‘purchase’ to indicate whether the taxes to be fetched are associated with supply or purchase respectively. The default value for this parameter is ‘supply’.
Example response for GET of list of taxes
{
"Tax": [
{
"Code": "TX7",
"Description": "Purchases with GST incurred at 7% and",
"Id": 1,
"Rate": 7.0000
},
{
"Code": "IM",
"Description": "GST incurred for import of goods",
"Id": 2,
"Rate": 7.0000
}
]
}