tax_rates

Updates a tax rate

Changed on

Handles the updating of a tax rate by id

put/api/v1/tax_rates/{id}

Request

Path parameters

idstring string required

The TaxRate Hashed ID

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the TaxRate object

idstring

Thie hashed id of the tax

namestring

The tax name

ratenumber

The tax rate

is_deletedboolean

Boolean flag determining if the tax has been deleted

Example response

{
  "id": "Opnel5aKBz",
  "name": "GST",
  "rate": 10,
  "is_deleted": true
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status