Skip to content
Bottle

Update VAT settings

PATCH
/tax
curl --request PATCH \
  --url https://example.com/tax \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "registered": true, "vatNumber": "example", "pricesIncludeVat": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
registered
boolean
vatNumber
string | null
<= 20 characters
pricesIncludeVat
boolean

Example generated

{
  "registered": true,
  "vatNumber": "example",
  "pricesIncludeVat": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The settings as they now stand

Media typeapplication/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

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Validation failed

Media typeapplication/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"
    }
  ]
}