lockWarehouseSafeboxTransaction. Движение денежных средств на главной кассе (ПКО/РКО)

Метод возвращает операции по главной кассе (сейфу) магазина: приходные (ПКО) и расходные (РКО) кассовые ордера — выручку из операционных касс, инкассации, выдачу разменной монеты, выплаты и другие. Операции можно только читать.

Параметр id читается только из адресной строки (GET). Остальные параметры принимаются и в адресной строке, и в теле POST.

GET https://[компания].myvirtualpos.ru/api/warehouseSafeboxTransaction?apikey=MySecret&warehouse_id=6&datefrom=20260901&dateto=20260930&type=income

Условия объединяются по «и». Названия параметров datefrom и dateto пишутся слитно (в отличие от date_from и date_to в методе инкассаций); неизвестные параметры игнорируются. Даты передаются строго в формате ГГГГММДД, иначе метод вернёт ошибку Incorrect date format.

Тип операции — income (приход) или outcome (расход). Подтип (subtype) уточняет назначение. Системные подтипы:

Помимо системных, в данных встречаются подтипы, созданные пользователями (например, «Зарплата», «Хоз. нужды»). Их название приходит в subtype.

Пустые значения в JSON приходят как null, в XML — как пустой элемент.

Основное

Суммы

Бухгалтерские счета

Люди

Связанный документ

Реквизиты инкассации (только у подтипа encashment)

{
  "success": 1,
  "type": "warehouseSafeboxTransaction",
  "count": 1,
  "warehouseSafeboxTransactions": [
    {
      "warehouseSafeboxTransaction": {
        "id": 31308,
        "guid": "5A07A106-A1A8-ECBC-2BA7-113B8662F9AF",
        "warehouse_safebox_id": 6,
        "warehouse_id": 6,
        "ext_warehouse_id": "WH-6",
        "type": "outcome",
        "typeName": "Расход",
        "subtype": "encashment",
        "subtype_name": "Инкассация",
        "subtypeName": "Инкассация",
        "subtype_external_id": "",
        "cash_before": "70870.49",
        "cash_after": "20870.49",
        "cash_change": "-50000.00",
        "doc_num": 1,
        "comment": "Инкассация за сентябрь",
        "rel_id": 1,
        "rel_type": "WarehouseEncashment",
        "rel_document": { "id": 1, "amount": "50000.00" },
        "responsible_user_id": 113,
        "responsible_user_corp_code": "",
        "responsible_user_full_name": "Иванова Анна Сергеевна",
        "manager_user_id": 3,
        "manager_user_corp_code": "",
        "manager_user_full_name": "Петров Пётр Петрович",
        "application": "",
        "reason": "",
        "credit_account": "",
        "correspondent_account": "",
        "created_date": "2026-09-30 20:35:21",
        "created_by": 113,
        "created_by_corp_code": "",
        "created_by_full_name": "Иванова Анна Сергеевна",
        "last_update_date": "2026-09-30 20:35:21",
        "last_update_by": 113,
        "agent_bank_name": null,
        "recipient_bank_name": null,
        "bank_account_num": "30101810000000000201",
        "org_account_num": "40802810102890010436",
        "terminal_user_corp_code": null,
        "terminal_machine_number": null,
        "terminal_session": null,
        "terminal_open_datetime": null
      }
    }
  ]
}

В примере для краткости сокращены поля связанного документа и опущены идентификаторы банков. Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>warehouseSafeboxTransaction</type>
  <count>1</count>
  <warehouseSafeboxTransactions>
    <warehouseSafeboxTransaction>
      <id>31308</id>
      <type>outcome</type>
      <subtype>encashment</subtype>
      <cash_change>-50000.00</cash_change>
      <!-- остальные поля операции -->
    </warehouseSafeboxTransaction>
  </warehouseSafeboxTransactions>
</root>

Ошибка авторизации и общие ошибки описаны в статье Общие сведения.

Если по условиям ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком.