Skip to content

Latest commit

 

History

History
164 lines (146 loc) · 3.41 KB

taxes.md

File metadata and controls

164 lines (146 loc) · 3.41 KB
Raw

Taxes

DEPRECATION NOTICE: The amount attribute is deprecated. We recommend using rate instead in your application.

Get Taxes

Resources

  • GET /taxes get all taxes

Example Request

curl https://api.au1.cliniko.com/v1/taxes \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "links": {
    "self": "https://api.au1.cliniko.com/v1/taxes?page=1"
  },
  "taxes": [
    {
      "amount": "10.0",
      "created_at": "2014-01-29T09:54:54Z",
      "id": "1",
      "links": {
        "self": "https://api.au1.cliniko.com/v1/taxes/1"
      },
      "name": "GST",
      "rate": "10.0",
      "updated_at": "2014-01-29T09:54:54Z"
    }
  ],
  "total_entries": 1
}

Get Tax

Resources

  • GET /taxes/:id get a specified tax

Example Request

curl https://api.au1.cliniko.com/v1/taxes/1 \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "amount": "10.0",
  "created_at": "2014-01-29T09:54:54Z",
  "id": "1",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/taxes/1"
  },
  "name": "GST",
  "rate": "10.0",
  "updated_at": "2014-01-29T09:54:54Z"
}

Create Tax

Resources

  • POST /taxes create a tax

Example Request

curl https://api.au1.cliniko.com/v1/taxes \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -d '{ "name": "VAT", "rate": 23 }' \
  -X POST

Example Response

Headers { Location: https://api.au1.cliniko.com/taxes/2 }

{
  "amount": "23.0",
  "created_at": "2014-03-03T09:54:54Z",
  "id": "2",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/taxes/2"
  },
  "name": "VAT",
  "rate": "23.0",
  "updated_at": "2014-03-03T09:54:54Z"
}

Update Tax

Resources

  • PUT /taxes/:id update a tax

Example Request

curl https://api.au1.cliniko.com/v1/taxes/2 \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -d '{ "amount": 22 }' \
  -X PUT

Example Response

{
  "amount": "22.0",
  "created_at": "2014-03-03T09:54:54Z",
  "id": "2",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/taxes/2"
  },
  "name": "VAT",
  "rate": "22.0",
  "updated_at": "2014-03-03T09:55:24Z"
}

Delete Tax

Resources

  • DELETE /taxes/:id delete a tax

Example Request

curl https://api.au1.cliniko.com/v1/taxes/2 \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -X DELETE

Example Response A status code of 204 no content will be returned if successful

Filtering Taxes

You can filter taxes by:

  • created_at DateTime
  • id BigInt
  • updated_at DateTime

See Filtering Results for details on how to apply filters.