Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Payment
SPI Product Recommendations
SPI Product Search
Journals v3
Purchase Prices v3
Shipments v3

Sales Taxes

Add Sales Tax

post /sites/{siteid}/salestaxes
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
salestax
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxes.json
{
  "name": "Washington State Tax",
  "decimalvaluedefault": "6.500"
}
RESPONSE JSON
4
HTTP Status Code Summary
200Returns salestaxid
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Sales Taxes

get /sites/{siteid}/salestaxes
PARAMETERS
siteid
integer
path
REQUIRED
start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. Default is all fields in salestax.

Example: /sites/{siteid}/salestaxes?fields=salestaxid,name,code
Returns

Returns an envelope with items of type salestax.

salestax
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxes.json?num=3
RESPONSE JSON
{
  "totalcount": 3,
  "items": [
    {
      "salestaxid": 1,
      "name": "FL State Tax",
      "code": null,
      "decimalvaluedefault": "6.000",
      "productgrouprules": []
    },
    {
      "salestaxid": 2,
      "name": "Miami Dade County Tax",
      "code": null,
      "decimalvaluedefault": "1.000",
      "productgrouprules": []
    },
    {
      "salestaxid": 3,
      "name": "MA State Tax",
      "code": null,
      "decimalvaluedefault": "6.250",
      "productgrouprules": [
        {
          "vatid": 2,
          "type": 20,
          "moneymin": "175.00",
          "moneymax": null,
          "decimalvalue": "6.250",
          "externalid": "20010"
        }
      ]
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type salestax.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Sales Tax

get /sites/{siteid}/salestaxes/{salestaxid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxid
integer
path
REQUIRED
Returns

Returns an item of type salestax.

salestax
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxes/4.json
RESPONSE JSON
{
  "salestaxid": 4,
  "name": "Washington State Tax",
  "code": null,
  "decimalvaluedefault": "6.500",
  "productgrouprules": []
}
HTTP Status Code Summary
200Returns an item of type salestax.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Update Sales Tax

put /sites/{siteid}/salestaxes/{salestaxid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxid
integer
path
REQUIRED
REQUEST BODY
object
salestax
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxes/4.json
{
  "name": "WA State Tax"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Delete Sales Tax

delete /sites/{siteid}/salestaxes/{salestaxid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxes/4.json
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Add Sales Tax Group

post /sites/{siteid}/salestaxgroups
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
salestaxgroup
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxgroups.json
{
  "name": "Miami State (General)",
  "region": "FL",
  "salestaxes": [
    {
      "salestaxid": 1
    }
  ]
}
RESPONSE JSON
3
HTTP Status Code Summary
200Returns salestaxgroupid
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Sales Tax Groups

get /sites/{siteid}/salestaxgroups
PARAMETERS
siteid
integer
path
REQUIRED
start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. Default is all fields in salestaxgroup.

Example: /sites/{siteid}/salestaxgroups?fields=salestaxgroupid,name,region
Returns

Returns an envelope with items of type salestaxgroup.

salestaxgroup
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxgroups.json?num=2
RESPONSE JSON
{
  "totalcount": 2,
  "items": [
    {
      "salestaxgroupid": 1,
      "name": "Miami Dade",
      "region": "FL",
      "salestaxes": [
        {
          "salestaxid": 1,
          "name": "FL State Tax",
          "code": null,
          "decimalvaluedefault": "6.000",
          "productgrouprules": []
        },
        {
          "salestaxid": 2,
          "name": "Miami Dade County Tax",
          "code": null,
          "decimalvaluedefault": "1.000",
          "productgrouprules": []
        }
      ]
    },
    {
      "salestaxgroupid": 2,
      "name": "Massachusetts",
      "region": "MA",
      "salestaxes": [
        {
          "salestaxid": 3,
          "name": "MA State Tax",
          "code": null,
          "decimalvaluedefault": "6.250",
          "productgrouprules": [
            {
              "vatid": 2,
              "type": 20,
              "moneymin": "175.00",
              "moneymax": null,
              "decimalvalue": "6.250",
              "externalid": "20010"
            }
          ]
        }
      ]
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type salestaxgroup.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Sales Tax Group

get /sites/{siteid}/salestaxgroups/{salestaxgroupid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxgroupid
integer
path
REQUIRED
Returns

Returns an item of type salestaxgroup.

salestaxgroup
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxgroups/3.json
RESPONSE JSON
{
  "salestaxgroupid": 3,
  "name": "Miami State (General)",
  "region": "FL",
  "salestaxes": [
    {
      "salestaxid": 1,
      "name": "FL State Tax",
      "code": null,
      "decimalvaluedefault": "6.000",
      "productgrouprules": []
    }
  ]
}
HTTP Status Code Summary
200Returns an item of type salestaxgroup.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Update Sales Tax Group

put /sites/{siteid}/salestaxgroups/{salestaxgroupid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxgroupid
integer
path
REQUIRED
REQUEST BODY
object
salestaxgroup
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxgroups/3.json
{
  "name": "Miami State (Default)"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Delete Sales Tax Group

delete /sites/{siteid}/salestaxgroups/{salestaxgroupid}
PARAMETERS
siteid
integer
path
REQUIRED
salestaxgroupid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/salestaxgroups/3.json
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$
Example: "123.00"

salestax
object

A definition of a sales tax.

PROPERTIES
salestaxid
integer
READ ONLY
REQUIRED

The ID of the sales tax.

name
string
REQUIRED

The name of the sales tax.

code
string

The code used for the sales tax.

decimalvaluedefault
string
REQUIRED

The default tax percentage for this sales tax.

productgrouprules
array
(salestaxproductgrouprule)

An array of salestaxproductgrouprule applicable to this sales tax.

salestaxgroup
object

A collection of salestax used for a point of sale.

PROPERTIES
salestaxgroupid
integer
READ ONLY
REQUIRED

The ID of the sales tax group.

name
string
REQUIRED

The name of the sales tax group.

region
string

The region for the sales tax group.

salestaxes
array
(salestax)
REQUIRED

An array of salestax applicable to this sales tax group.

salestaxproductgrouprule
object

A sales tax rule for a specific product group.

PROPERTIES
vatid
integer

The VAT ID of the productgroup that this rule applies to.

type
salestaxproductgroupruletype

The type for this rule.

moneymin
money

The minimum value for this rule (if applicable).

moneymax
money

The maximum value for this rule (if applicable).

decimalvalue
string
REQUIRED

The tax percentage for this rule.

externalid
string

An external ID used for this rule. (e.g Product Tax Code)

salestaxproductgroupruletype
integer

  • 10 Total
  • 20 OverMin
  • 30 Exempt
Copyright © 2024 Sitoo AB. All rights reserved.