INinvoiceninja
tax_rates

Gets a list of tax_rates

Changed on

Lists tax rates

get/api/v1/tax_rates

Request

Query parameters

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=name|asc.

Multiple sorts — for example
sort[]=rate|asc&sort[]=name|asc.

Only tax_rates table columns apply. Unsupported keys are ignored.

[
  "name|asc"
]

Response

A list of tax_rates

Example response

{
  "data": [
    {
      "id": "Opnel5aKBz",
      "name": "GST",
      "rate": 10,
      "is_deleted": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes