View on GitHub

api-documentation

RESTful API for MyTourist

Back to overview


TaxRates API

This API endpoint let you manage your tax rates.

Index:

List all rates

Get a list of all your tax rates returned in JSON format.

GET https://app.mytourist.cloud/api/v1/tax-rates

Example results

[
    {
        "id":"23192011033",
        "label":"Low",
        "rate":10,
        "created_at":"2020-11-03T09:52:42.000000Z",
        "updated_at":"2020-11-03T09:52:42.000000Z"
    },
    {
        "id":"23192011034",
        "label":"High",
        "rate":20,
        "created_at":"2020-11-03T09:52:46.000000Z",
        "updated_at":"2020-11-03T09:52:46.000000Z"
    }
]

Create / Update a rate

However tax rates are normally unchanged for a long time, you can manage your tax rates by this endpoint. When call is done (HTTP 200) it will return the full rate in JSON format like above.

POST (add) https://app.mytourist.cloud/api/v1/tax-rates POST (update) https://app.mytourist.cloud/api/v1/tax-rates/{RATE_ID}

Parameters

labelrequired on addstring
raterequiredfloat

Delete a single rate

Be aware that products on invoices has potential their relations to this rate. After deleting this rate the invoice keep their calculated data, but when you change an product on the any invoice row no longer this rate exists and won’t calculate tax any longer.

DELETE https://app.mytourist.cloud/api/v1/tax-rates/{RATE_ID}