Get

[POST] .../v1/operatingcash/get

Returns information about retail cash registers. Use this method to retrieve retail cash registers for POS sessions, stock and firm configuration, user assignments and administration screens. The response returns paged OperatingCash records with next_offset and total and supports filters, sort_orders, search, limit and offset for stock, firm, key, price type, virtual state, accepted user, custom fields and update dates. The caller must have operating cash select permission; missing body, denied access, invalid filters or sorting and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Number of result items returned by the request. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search by parameter values: id - cash register ID, key - security key, stock_name - stock name, user_accept_name - name of the user at the cash register.
sort_orders Array of OperatingCash_SortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
accepted_user.id int
accepted_user_id int ID of the user who accepted the cash register for work.
auto_close bool
description string
firm.id int
firm_id int Company IDs.
id int Cash register IDs.
is_virtual bool Indicates whether the cash register is virtual: true - virtual, false - not virtual.
key string
last_update int
max_cheque_quantity_in_session int
price_type.id int
price_type_id int Price type IDs.
stock.id int
stock_id int Stock IDs.
virtual bool

Sortable Fields

Field
auto_close
id
key
last_update
price_type.name
stock.name
user_accept.name
virtual

Request Example

{
  "filters": [
    {
      "Field": "stock.id",
      "Operator": "Equal",
      "Value": "8"
    },
    {
      "Field": "virtual",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "sort_orders": [
    {
      "column": "key",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of OperatingCash Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 12,
      "stock": {
        "id": 8,
        "name": "Main store",
        "address": "Tashkent, Buyuk Ipak Yuli 10",
        "firm": {
          "id": 2,
          "name": "REGOS Retail"
        },
        "area": 120.5,
        "description": "Primary retail stock",
        "deleted_mark": false,
        "last_update": 1712345600
      },
      "key": "POS-MAIN-01",
      "price_type": {
        "id": 4,
        "name": "Retail",
        "round_to": 0.01,
        "markup": 25.00,
        "max_discount": 10.00,
        "last_update": 1712345600
      },
      "description": "Main checkout",
      "virtual": true,
      "auto_close": true,
      "max_cheque_quantity_in_session": 1000,
      "last_update": 1712345600,
      "fields": [],
      "UserAccept": null
    }
  ],
  "next_offset": 0,
  "total": 1
}