Get

[POST] .../v1/useroperatingcash/get

Returns user operating cash register assignments. Use this method to retrieve links between users and operating cash registers for access setup, POS availability checks and administration screens. The response returns paged UserOperatingCash records with next_offset and total and supports filters, sort_orders, search, limit and offset for users, cash registers, stocks, price types and virtual cash registers. The caller must have user operating cash get 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 string for the fields: user_first_name, middle_name, last_name, main_phone, phones.
sort_orders Array of UserOperatingCash_SortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
id int Assignment record IDs.
is_virtual bool Indicates whether the cash register is virtual.
operating_cash_id int Cash register ID.
price_type_id int Price type IDs available through the linked operating cash registers.
stock_id int Stock IDs available through the linked operating cash registers.
user_id int User ID linked to operating cash registers.

Sortable Fields

Field
id
operating_cash.id
user.main_phone
user.name

Request Example

{
  "filters": [
    {
      "Field": "user_id",
      "Operator": "Equal",
      "Value": "17"
    },
    {
      "Field": "is_virtual",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "sort_orders": [
    {
      "column": "operating_cash.id",
      "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 UserOperatingCash Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 23,
      "user": {
        "id": 17,
        "full_name": "Ali Karimov",
        "first_name": "Ali",
        "middle_name": "",
        "last_name": "Karimov",
        "main_phone": "\u002B998901234567",
        "active": true
      },
      "operating_cash": {
        "id": 12,
        "key": "POS-MAIN-01",
        "stock": {
          "id": 8,
          "name": "Main store"
        },
        "price_type": {
          "id": 4,
          "name": "Retail"
        },
        "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
}