Replaces a Tax object

Replaces a Tax object specified by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of Tax to replace

Body Params

Tax object that needs to be updated

boolean
Defaults to true

Flag. If set to False, the tax rule is not applied.

uri

URI of the related Tax Agency.

uri
required

URI of the user that created this resource.

date-time

ISO8601 timestamp of the time the resource was created.

string

JSON array of the dining options that this tax rule applies to. Only checked if "Tax by Order/Dining Option" is enabled.

uri

URI of the Establishment this tax rule applies to.

integer
enum
Defaults to 2

Fiscal Tax Rate options:

  • 0 - GST (Quebec specific)
  • 1 - QST (Quebec specific)
  • 2 - Skip fiscal print
  • 3 - Swedish VAT-1
  • 4 - Swedish VAT-2
  • 5 - Swedish VAT-3
  • 6 - Swedish VAT-4
Allowed:
integer
0 to 32767

Maximum amount of products in a single order this tax rule can apply to.

string

Maximum order total this tax rule will apply to. Excess amounts are not affected by this tax.

integer
0 to 32767

Minimum amount of products needed in an order before this tax rule can apply

string

Minimum order total this tax rule will apply to. Smaller amounts are not affected by this tax.

string
required
length ≤ 280

Tax rule name. Will appear in the reports.

integer
enum
Defaults to 0

Tax rounding options:

  • 0 - Math
  • 1 - Ceiling
Allowed:
tax_rate
array of objects

List of tax rates included in this tax rule.

tax_rate
integer
enum
Defaults to 0

Tax type:

  • 0 - Percentage
  • 1 - Flat
Allowed:
uri
required

URI of the user that last made changes to this resource.

date-time

ISO8601 timestamp of the last time the resource was updated.

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Bad request. Usually caused by invalid request body.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Tax with the provided ID not found.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json