Read how customer account numbers work

GET

/account-numbers

const url = 'https://example.com/account-numbers';
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/account-numbers \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Off, numbered by Bottle with a prefix and next number, or typed by the business. Also the number the next new customer gets, and how many customers have none.

Authorizations

sessionCookie
tenant:read

Responses

200

The settings

application/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

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

Not an owner or admin

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