Это старая версия документа.


API :: WarehouseSafeboxTransaction. Получение данных по кассовой книге главной кассы

В системе реализован программный интерфейс для получения данных о кассовой книге главной кассы. Данные выгружаются по http протоколу. Формат на выбор - xml или json.

Пример запроса на получение данных

Пример запроса на получение данных о кассовой книге главной кассы:

http://mycompany.virtpos.ru/api/warehousesafeboxtransaction?apikey=MySecret&format=xml

Параметры запроса

  • apikey - Секретный ключ для доступа к данным. Обязательный параметр.
  • format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.
  • id - код транзакции, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях кассовой книги главной кассы.
  • date - получение транзакций кассовой книги на определенную дату. Формат: ГГГГММДД. Необязательный параметр.
  • datefrom - получение транзакций кассовой книги начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр.
  • dateto - получение транзакций кассовой книги начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр.

Ответ сервера

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info

Пример ответа сервера

Ниже приведен пример ответа сервера в формате XML

<root>
  <success>1</success>
  <type>warehouseSafeboxTransaction</type>
  <count>1</count>
  <warehousesSafeboxTransactions>
    <warehousesSafeboxTransaction>
      <id>1</id>
      <warehouse_safebox_id>1</warehouse_safebox_id>
      <warehouse_id>2</warehouse_id>
      <type>income</type>
      <typeName>Приход</typeName>
      <subtype>terminal_cash_earning</subtype>
      <search_subtype_id/>
      <subtypeName>Выручка наличными с операционной кассы</subtypeName>
      <cash_before>0.00</cash_before>
      <cash_after>425.00</cash_after>
      <cash_change>425.00</cash_change>
      <doc_num>1</doc_num>
      <comment/>
      <responsible_user_id/>
      <application/>
      <reason/>
      <created_date>2017-06-23 14:46:59</created_date>
      <created_by>2</created_by>
      <last_update_date>2017-06-23 14:46:59</last_update_date>
      <last_update_by>2</last_update_by>
    </warehousesSafeboxTransaction>
  <warehousesSafeboxTransaction>
</warehousesSafeboxTransactions>
</root>