Get VAT settings

GET

/tax

const url = 'https://example.com/tax';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/tax \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

A business that is not registered charges no VAT on anything, whatever rate a product carries. pricesIncludeVat is how the business types its prices: what a new price is read as when nobody says, and how prices are best shown. It changes nothing already saved; every saved price carries its own flag.

Authorizations

sessionCookie
tax:read
apiKey
tax:read

Responses

200

The settings

application/json

object

registered

required

boolean

vatNumber

required

string | null

pricesIncludeVat

required

How this business types its prices: true means a price typed without saying is read as including VAT, false as excluding it. A preference for new prices and for how they are shown; it does not change anything already saved, since every saved price carries its own flag.

boolean

updatedAt

required

string format: date-time

Example

{
  "vatNumber": "GB123456789"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}