Это старая версия документа.
API :: WarehouseSafeboxTransaction. Движение денежных средств на главной кассе магазина (ПКО\РКО)
В системе реализован программный интерфейс для получения данных о движении денежных средств в главной кассе магазина (сейф). Данные выгружаются по http протоколу. Формат на выбор - xml или json.
Пример запроса на получение данных
Пример запроса на получение данных о движении денежных средств на главной кассе:
http://mycompany.virtpos.ru/api/warehousesafeboxtransaction?apikey=MySecret&format=xml
Параметры запроса
- apikey - Секретный ключ для доступа к данным. Обязательный параметр.
- format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.
- id - код транзакции, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях на главной кассе.
- warehouseid - код точки продаж, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях.
- date - получение транзакций кассовой книги на определенную дату. Формат: ГГГГММДД. Необязательный параметр.
- datefrom - получение транзакций начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр.
- dateto - получение транзакций начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр.
Ответ сервера
В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info
Пример ответа сервера
Ниже приведен пример ответа сервера в формате XML
<root> <success>1</success> <type>warehouseSafeboxTransaction</type> <count>2</count> <warehousesSafeboxTransactions> <warehousesSafeboxTransaction> <id>141</id> <warehouse_safebox_id>1</warehouse_safebox_id> <warehouse_id>1</warehouse_id> <type>income</type> <typeName>Приход</typeName> <subtype>terminal_cash_earning</subtype> <subtype_name>Приход</subtype_name> <subtypeName>Выручка наличными с операционной кассы</subtypeName> <cash_before>17138.18</cash_before> <cash_after>17594.18</cash_after> <cash_change>456.00</cash_change> <doc_num>78</doc_num> <comment /> <rel_id>95</rel_id> <rel_class>Zreport</rel_class> <responsible_user_id>3</responsible_user_id> <responsible_user_corp_code /> <application>Справка кассира-операциониста</application> <reason>Выручка от продаж операционной кассы</reason> <credit_account>90.1.2.1</credit_account> <correspondent_account>50.02</correspondent_account> <created_date>2017-07-09 18:58:43</created_date> <created_by>3</created_by> <last_update_date>2017-07-09 18:58:43</last_update_date> <last_update_by>3</last_update_by> </warehousesSafeboxTransaction> <warehousesSafeboxTransaction> <id>142</id> <warehouse_safebox_id>1</warehouse_safebox_id> <warehouse_id>1</warehouse_id> <type>income</type> <typeName>Приход</typeName> <subtype>terminal_cash_earning</subtype> <subtype_name>Приход</subtype_name> <subtypeName>Выручка наличными с операционной кассы</subtypeName> <cash_before>17594.18</cash_before> <cash_after>17920.18</cash_after> <cash_change>326.00</cash_change> <doc_num>79</doc_num> <comment /> <rel_id>96</rel_id> <rel_class>Zreport</rel_class> <responsible_user_id>4</responsible_user_id> <responsible_user_corp_code /> <application>Справка кассира-операциониста</application> <reason>Выручка от продаж операционной кассы</reason> <credit_account>90.1.2.1</credit_account> <correspondent_account>50.02</correspondent_account> <created_date>2017-07-10 10:18:35</created_date> <created_by>4</created_by> <last_update_date>2017-07-10 10:18:35</last_update_date> <last_update_by>4</last_update_by> </warehousesSafeboxTransaction> </warehousesSafeboxTransactions> </root>