Cash registers

GET

/v1/cash-box

curl --request GET \
  --url 'https://api-admin.billz.ai/v1/cash-box?page=1&limit=100&sort_field=name&sort_direction=asc' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

• Production

The cash register id is passed in the cashbox_id field when creating a sale (POST /v2/order) and when paying (POST /v2/order-payment/{order_id}).

Error codes: 400 — input validation error; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

• BearerAuth

Parameters

Query Parameters

page

integer format: int32

default: 1

Not a number — 400

limit

integer format: int32

default: 10

Not a number — 400

Example

100

shop_id

string format: uuid

Cash registers of a single shop

shop_ids

Array<string>

Cash registers of several shops, IDs comma-separated

name

string

Filter by cash register name

with_hq

boolean

When true, the head office cash register is added to the list

sort_field

string

Allowed values: name created_at

name or created_at; applied only together with sort_direction

sort_direction

string

Allowed values: asc desc

asc or desc; applied only together with sort_field

Header Parameters

accept-language

string

Ru|uz|en, default ru — language of payment type names

platform-id

string

default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

200

Successful response

Media typeapplication/json

object

count

Total count regardless of pagination

integer format: int32

cash_boxes

List of cash registers

Array<object>

object

id

string

company_id

string

shop_id

string

shop

Shop the cash register belongs to

object

id

string

name

string

phone_numbers

Array<string>

nullable

facebook

string

instagram

string

telegram

string

website

string

working_hours

{id, shop_id, week_day, start_time, end_time, is_active}

Array<object>

nullable

object

name

string

cheque_id

string

payment_types

Payment types enabled for the cash register

Array<object>

object

id

string

company_payment_type_id

Payment type id from GET /v1/company-payment-type

string

company_payment_type

Company payment type

object

is_active

boolean

e_pos

integer format: int32

tariff_limits

object

local_payment_types

boolean

Example^generated

{
  "count": 1,
  "cash_boxes": [
    {
      "id": "example",
      "company_id": "example",
      "shop_id": "example",
      "shop": {
        "id": "example",
        "name": "example",
        "phone_numbers": [
          "example"
        ],
        "facebook": "example",
        "instagram": "example",
        "telegram": "example",
        "website": "example",
        "working_hours": [
          {}
        ]
      },
      "name": "example",
      "cheque_id": "example",
      "payment_types": [
        {
          "id": "example",
          "company_payment_type_id": "example",
          "company_payment_type": {},
          "is_active": true
        }
      ],
      "e_pos": 1,
      "tariff_limits": {},
      "local_payment_types": true
    }
  ]
}