Returns the list of Tax objects

get https://qa2.revelup.com/resources/Tax/

Responses

Response body

array of objects

object

active

boolean

Defaults to true

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

agency

uri

URI of the related Tax Agency.

created_by

uri

required

URI of the user that created this resource.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

dining_options

string

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

establishment

uri

URI of the Establishment this tax rule applies to.

fiscal_rate

integer

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

1 2 3 4 5 6

number

ID of this Tax object.

max_quantity_threshold

integer

0 to 32767

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

max_threshold

string

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

min_quantity_threshold

integer

0 to 32767

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

min_threshold

string

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

name

string

required

length ≤ 280

Tax rule name. Will appear in the reports.

resource_uri

uri

URI of this Tax object.

rounding_type

integer

Defaults to 0

Tax rounding options:

0 - Math
1 - Ceiling

1

tax_rate

array of objects

List of tax rates included in this tax rule.

tax_rate

object

created_by

uri

required

URI of the user that created this resource.

created_date

date-time

ISO8601 timestamp of the time the resource was created.

effective_from

date-time

required

ISO8601 timestamp of when the tax rate begins to apply.

effective_to

date-time

ISO8601 timestamp of when the tax rate expires. If set to null, tax rate will never expire.

number

ID of this TaxRate object.

resource_uri

uri

URI of this TaxRate object.

tax

uri

required

URI of the related Tax object.

tax_rate

float

required

≥ 0

Sales tax percentage to be applied.

tax_table

object

updated_by

uri

required

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

updated_date

date-time

ISO8601 timestamp of the last time the resource was updated.

use_tax_table

boolean

Defaults to false

Flag. If set to True, will use the associated TaxTable instead of the specified percentage rate.

tax_type

integer

Defaults to 0

Tax type:

0 - Percentage
1 - Flat

1

updated_by

uri

required

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

updated_date

date-time

ISO8601 timestamp of the last time the resource was updated.

301

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

401

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

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://qa2.revelup.com/resources/Tax/?limit=20&offset=0' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Resource successfully retrieved.

Fiscal Tax Rate options:

Tax rounding options:

Tax type: