WarehouseEncashment. Инкассации
Метод возвращает документы «Инкассация» — передачу наличных из главной кассы (сейфа) магазина в банк — вместе с реквизитами для бланка: сумма, организация, точка продаж, банки, номер сумки. Документы можно только читать.
Как получить ключ, как формируются запросы и какие бывают ответы и ошибки — в статье Общие сведения. Здесь описаны только особенности метода warehouseEncashment.
Запрос
Параметр id читается только из адресной строки (GET). Остальные параметры принимаются и в адресной строке, и в теле POST.
GET https://[компания].myvirtualpos.ru/api/warehouseEncashment?apikey=MySecret&warehouse_id=6&date_from=20260101&date_to=20260930
Параметры запроса
| id | Число. Ид инкассации. Если указан, вернётся только она. Только GET |
| warehouse_id | Число. Ид точки продаж |
| ext_warehouse_id | Строка. Код точки продаж во внешней системе. Действует, если не указан warehouse_id. Если точки с таким кодом нет, возвращается пустой список |
| date | Дата ГГГГММДД. Инкассации, созданные в этот день |
| date_from, date_to | Дата ГГГГММДД. Инкассации, созданные с указанной даты и по указанную включительно |
| format | json (по умолчанию) или xml |
Условия объединяются по «и». Без параметров возвращаются все инкассации за всё время. Ограничения по дате по умолчанию нет. Даты передаются строго в формате ГГГГММДД, иначе метод вернёт ошибку Incorrect date format.
Структура ответа
| success | 1 — данные получены |
| type | Тип данных, всегда warehouseEncashment |
| count | Количество инкассаций в ответе |
| warehouseEncashments | Список инкассаций. Каждая обёрнута в объект warehouseEncashment |
Поля инкассации
Пустые значения в JSON приходят как null, в XML — как пустой элемент.
Основное
| id | Число. Ид инкассации |
| warehouse_id | Число. Ид точки продаж |
| amount | Строка. Сумма инкассации |
| bag_number | Строка. Номер инкассаторской сумки |
| source_text | Строка. Источник средств, например «Поступления от продажи товаров» |
| warehouse_safebox_transaction_id | Число. Ид операции на главной кассе, которой оформлена инкассация. См. WarehouseSafeboxTransaction |
| created_at | Строка. Дата инкассации, формат гггг-мм-дд чч:мм:сс |
| created_date, last_update_date | Строка. Дата и время создания и последнего изменения записи |
| created_by, last_update_by | Число. Ид пользователя, создавшего и изменившего запись |
| creator_name, updater_name | Строка. Фамилия и инициалы этих пользователей |
Организация и точка продаж (данные на момент инкассации)
| org_name | Строка. Название организации |
| warehouse_name | Строка. Название точки продаж |
| warehouse_address | Строка. Адрес точки продаж |
| warehouse_inn | Строка. ИНН |
| org_account_num | Строка. Расчётный счёт организации |
| bank_account_num | Строка. Номер счёта банка |
Банки
| agent_bank_name, agent_bank_bik | Строка. Название и БИК банка-агента |
| agent_bank_id, agent_bank_external_id | Ид банка-агента в справочнике поставщиков и его код во внешней системе |
| recipient_bank_name, recipient_bank_bik | Строка. Название и БИК банка-получателя |
| recipient_bank_id, recipient_bank_external_id | Ид банка-получателя в справочнике поставщиков и его код во внешней системе |
Дополнительные поля
| note1 … note20 | Строка. Произвольные примечания для бланка инкассации |
| attribute1 … attribute15 | Строка. Значения гибких полей |
Пример ответа
{
"success": 1,
"type": "warehouseEncashment",
"count": 1,
"warehouseEncashments": [
{
"warehouseEncashment": {
"id": 1,
"warehouse_id": 6,
"amount": "50000.00",
"bag_number": "",
"org_name": "ИП Иванов И. И.",
"warehouse_name": "Точка на Тверской",
"warehouse_address": "г. Москва, ул. Тверская, д. 3",
"warehouse_inn": "781911631228",
"bank_account_num": "30101810000000000201",
"org_account_num": "40802810102890010436",
"agent_bank_name": null,
"agent_bank_bik": null,
"recipient_bank_name": null,
"recipient_bank_bik": null,
"source_text": "Поступления от продажи товаров",
"warehouse_safebox_transaction_id": 16498,
"note1": null,
"created_date": "2026-03-27 20:52:46",
"created_by": 63,
"last_update_date": "2026-03-27 20:52:46",
"last_update_by": 63,
"agent_bank_id": null,
"agent_bank_external_id": null,
"recipient_bank_id": null,
"recipient_bank_external_id": null,
"created_at": "2026-03-27 00:00:00",
"creator_name": "Петров П. П.",
"updater_name": "Петров П. П."
}
}
]
}
В примере опущены примечания note2…note20 и гибкие поля attribute1…attribute15. Тот же ответ при format=xml (сокращённо):
<?xml version="1.0" encoding="UTF-8"?> <root> <success>1</success> <type>warehouseEncashment</type> <count>1</count> <warehouseEncashments> <warehouseEncashment> <id>1</id> <warehouse_id>6</warehouse_id> <amount>50000.00</amount> <!-- остальные поля инкассации --> </warehouseEncashment> </warehouseEncashments> </root>
Примеры запросов
| Задача | Запрос |
|---|---|
| Все инкассации | /api/warehouseEncashment?apikey=MySecret |
| Одна инкассация | /api/warehouseEncashment?apikey=MySecret&id=1 |
| Инкассации точки за период | /api/warehouseEncashment?apikey=MySecret&warehouse_id=6&date_from=20260101&date_to=20260331 |
| Инкассации за день | /api/warehouseEncashment?apikey=MySecret&date=20260327 |
| Инкассации точки по её коду в 1С | /api/warehouseEncashment?apikey=MySecret&ext_warehouse_id=WH-6 |
Ошибки
Ошибка авторизации и общие ошибки описаны в статье Общие сведения.
| Сообщение | Причина | Что делать |
|---|---|---|
| Incorrect date format '…'. Valid format is: YYYYMMDD | Дата в параметре не в формате ГГГГММДД | Передайте дату как 20260327 |
Если по условиям ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком.