Skip to content
Bottle

Change how customer account numbers work

PATCH
/account-numbers
curl --request PATCH \
  --url https://example.com/account-numbers \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "mode": "off", "prefix": "example", "nextNumber": 1, "digits": 1, "printOn": { "invoices": true } }'

Send only what changes. Switching off hides account numbers everywhere and keeps every number already given. Changing the next number never renumbers a customer.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
mode
string
Allowed values: off numbered own
prefix
string
<= 12 characters /^[\p{L}\p{N} ./-]*$/u/
nextNumber
integer
>= 1 <= 99999999
digits
integer
>= 1 <= 8
printOn
object
invoices
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Saved

Media typeapplication/json
object
settings
required
object
mode
required
string
Allowed values: off numbered own
prefix
required
string
<= 12 characters
nextNumber
required
integer
>= 1 <= 99999999
digits
required
integer
>= 1 <= 8
printOn
required
object
invoices
required
boolean
next
required
string | null
withoutNumber
required
integer

Example 

{
  "settings": {
    "mode": "off"
  }
}

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 an owner or admin

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"
    }
  ]
}