extension/module/tax/get - Equotix One API

This returns the list of taxes available for the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

filter_name

string

optional

Filters the list by the name.

filter_title

string

optional

Filters the list by the title.

filter_status

integer

optional

Filters the list by the status.

filter_date_modified

string

optional

Filter the list of taxes modified after the spcified date.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "status", "rate", "sort_order", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "filter_name": "string",
    "filter_title": "string",
    "filter_status": 0,
    "filter_date_modified": "string",
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available if there is no error.

taxes

array [object {10}]

optional

The list of templates available if there is no error.

tax_id

integer

required

The tax ID.

name

string

required

The tax name.

title

string

required

The tax title.

status

boolean

required

The tax status.

rate

number

required

The tax rate.

type

string

required

The tax type.

sort_order

integer

required

The tax sort order.

configuration

object

required

The tax settings key-value.

date_modified

string

required

The date time the tax was last modified.

items

object

required

The items specific to the tax.

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "taxes": [
        {
            "tax_id": 0,
            "name": "string",
            "title": "string",
            "status": true,
            "rate": 0,
            "type": "string",
            "sort_order": 0,
            "configuration": {},
            "date_modified": "string",
            "items": {}
        }
    ]
}