[POST] …/v1/operatingcash/get
Возвращает информацию о кассах розничной торговли.
Входные параметры
| Название | Тип данных | Обязательность | Описание |
|---|---|---|---|
| ids | Array of int64 | Необязательный | Массив id касс |
| firm_ids | Array of int64 | Необязательный | Массив id предприятий |
| stock_ids | Array of int64 | Необязательный | Массив id складов |
| price_type_ids | Array of int64 | Необязательный | массив id видов цен |
| is_virtual | Boolean | Необязательный | Метка о том, что касса виртуальная: true - виртуальная, false - не виртуальная |
| accepted_user_id | Int64 | Необязательный | Id пользователя, который принял кассу в работу |
| sort_orders | Array of SortOrders | Необязательный | Сортировака выходных параметров |
| search | String | Необязательный | Поиск по значениям параметров: id - ID кассы, key - Ключ безопасности, stock_name - Наимнование склада, user_accept_name - Имя пользователя на кассе |
| filters | Array of Filter | Необязательный | Фильтры по основным и дополнительным полям |
| limit | Int32 | Необязательный | Количество элементов выборки, возвращаемых при запросе |
| offset | Int32 | Необязательный | Смещение от начала выборки |
Доступные основные поля для filters: id, stock.id, firm.id, key, price_type.id, description, virtual, auto_close, max_cheque_quantity_in_session, accepted_user.id, last_update. Также доступны дополнительные поля, созданные для entity_type = OperatingCash.
Модель сортировки выходных параметров
| Название | Тип данных | Обязательность | Описание |
|---|---|---|---|
| column | enum | Необязательный | Значение для сортировки: <Default | 0> (по умолчанию), <Id | 1> (id кассы), <StockName | 2> (наименование склада), <Key | 3> (ключ безопасности), <PriceTypeName | 4> (наименование цены), <Virtual | 5> (виртуальная или нет), <AutoClose | 6> (автоматическое закрытие смены), <UserAcceptName | 7> (имя пользователя на кассе), <LastUpdate | 8> (последнее изменение) |
| direction | enum | Необязательный | Порядок сортировки: <ASC | 1> (по возростанию), <DESC | 2> (по убыванию) |
Пример запроса
{
"ids": [
1
],
"firm_ids": [
1
],
"stock_ids": [
1
],
"price_type_ids": [
1
],
"is_virtual": true,
"accepted_user_id": 1,
"filters": [
{
"field": "field_terminal_code",
"operator": "Equal",
"value": "T-01"
}
],
"sort_orders": [
{
"column": "example",
"direction": "asc"
}
],
"search": "example",
"limit": 1,
"offset": 0
}Выходные параметры
| Название | Тип данных | Описание |
|---|---|---|
| result | Array of OperatingCash | Массив касс розничной торговли |
| next_offset | Int32 | Смещение для следующей выборки данных |
| total | Int32 | Количество элементов выборки |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"stock": {
"id": 1,
"name": "Новомосковская",
"address": "example",
"firm": {
"id": 1,
"group": {
"id": 1,
"parent_id": 0,
"name": "Предприятия",
"child_count": 0,
"last_update": 1715233269
},
"deleted_mark": false,
"last_update": 1715863600,
"name": "REGOS",
"fullname": "ООО \"REGOS Software\"",
"boss_name": "Андрей",
"address": "Мукими, 8А",
"phones": "+998987654321",
"description": "EasyTrade successor",
"inn": "305930137",
"bank_name": "Ипак Йули",
"mfo": "01101",
"rs": "22125489632541254782",
"oked": "62090",
"vat_index": "1325489654785"
},
"description": "example",
"area": 1.1,
"deleted_mark": false,
"last_update": 1705583155
},
"key": null,
"price_type": {
"id": 1,
"name": "example",
"round_to": 0.00,
"markup": 0.25,
"max_discount": 0.2,
"currency": {
"id": 1,
"code_num": 123,
"code_chr": "UZS",
"name": "Узбекский сум",
"exchange_rate": 1,
"is_base": true,
"deleted": false,
"last_update": 1533619909
},
"currency_additional": {
"id": 1,
"code_num": 123,
"code_chr": "USD",
"name": "Dolar",
"exchange_rate": 1.1,
"is_base": false,
"deleted": false,
"last_update": 1533619909
},
"last_update": 1700000000
},
"description": "Web касса для REGOS SUPPORT 3 не удалять",
"virtual": true,
"auto_close": true,
"max_cheque_quantity_in_session": 1000,
"last_update": 1693395827,
"fields": [
{
"key": "field_terminal_code",
"name": "Terminal code",
"data_type": "string",
"metadata": null,
"is_custom": true,
"required": false,
"value": "T-01"
}
],
"UserAccept": {
"id": 1,
"full_name": "John Fitzgerald Kennedy",
"main_phone": "998123456789",
"user_group": {
"id": 1,
"parent_id": 1,
"name": "Administrators",
"child_count": 1,
"last_update": 1529755889
},
"enable_hints": true,
"system": true,
"seller_barcode": "1010000001000000",
"last_update": 1532276019,
"first_name": "John",
"last_name": "Kennedy",
"middle_name": "Fitzgerald",
"sex": "Male",
"date_of_birth": "1993-12-21",
"address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
"phones": "998123456789",
"email": "example@example.com",
"description": "example",
"login": "Admin",
"can_authorize": true,
"active": true,
"language_code": "RUS"
}
}
],
"next_offset": 0,
"total": 1
}