GET
/
v2
/
tax
curl --request GET \
  --url https://api.sonderplan.com/v2/tax \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 5693,
      "name": "GST",
      "rate": "10",
      "code": "CAP: Capital Purchase",
      "compound": false,
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

One or more (comma seperated) IDs of taxes to retrieve

​
name
string

Perform a full text search for the tax name

​
rate
string

Perform a direct match for the tax rate

​
code
string

Perform a full text search for the tax code

​
compound
boolean

Perform a direct match for the tax compound setting

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

200
application/json
Successful Operation
​
data
object[]

Standard tax model that returns all properties by default

​
meta
object