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>
<transactions>
    <id>4</id>
    <warehouse_safebox_id>1</warehouse_safebox_id>
    <date>2017-07-10</date>
    <cash_in>4346.00</cash_in>
    <cash_out>6392.00</cash_out>
    <trx_in_count>2</trx_in_count>
    <trx_out_count>0</trx_out_count>
    <trx_in_amount>2046.00</trx_in_amount>
    <trx_out_amount>0.00</trx_out_amount>
    <cashier/>
    <accountant/>
    <page_start>4</page_start>
    <page_finish>4</page_finish>
    <created_date>2017-07-10 17:10:02</created_date>
    <created_by>2</created_by>
    <last_update_date>2017-07-10 17:10:02</last_update_date>
    <last_update_by>2</last_update_by>
    <doc_date>10.07.2017</doc_date>
    <doc_date_data>
        <day>10</day>
        <month_string>июля</month_string>
        <year>2017</year>
    </doc_date_data>
    <organisation>
        <id>1</id>
        <name>ООО "Красная площадь, д.1"</name>
        <inn>7813404796</inn>
        <kpp>780201001</kpp>
        <address>
            190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н
        </address>
        <realaddress>
            190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н
        </realaddress>
        <created_date>2015-07-23 17:40:26</created_date>
        <created_by>2</created_by>
        <last_update_date>2015-07-23 17:40:26</last_update_date>
        <last_update_by>2</last_update_by>
        <print_name/>
        <legal_name>ООО "Красная площадь, д.1"</legal_name>
        <active>1</active>
        <ogrn/>
        <okpo/>
        <bank_name/>
        <account/>
        <corr_account/>
        <bik/>
        <attribute1/>
        <attribute2/>
        <attribute3/>
        <attribute4/>
        <attribute5/>
        <attribute6/>
        <attribute7/>
        <attribute8/>
        <attribute9/>
        <attribute10/>
        <attribute11/>
        <attribute12/>
        <attribute13/>
        <attribute14/>
        <attribute15/>
        <textInfo>
            ООО "Красная площадь, д.1", 190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н, ИНН 7813404796, р/с , , к/с , БИК , КПП 7813404796
        </textInfo>
    </organisation>
    <pages>
        <page_number>4</page_number>
        <items>
            <title>Остаток на начало дня:</title>
            <title_align>right</title_align>
            <in_amount>4346.00</in_amount>
            <id>9</id>
            <warehouse_safebox_id>1</warehouse_safebox_id>
            <warehouse_id>2</warehouse_id>
            <type>income</type>
            <subtype>terminal_cash_earning</subtype>
            <cash_before>4346.00</cash_before>
            <cash_after>6174.00</cash_after>
            <cash_change>1828.00</cash_change>
            <doc_num>7</doc_num>
            <comment/>
            <rel_id>14497</rel_id>
            <created_date>2017-07-10 17:10:02</created_date>
            <created_by>2</created_by>
            <last_update_date>2017-07-10 17:10:02</last_update_date>
            <last_update_by>2</last_update_by>
            <responsible_user_id>2</responsible_user_id>
            <reason>Выручка от продаж операционной кассы</reason>
            <application/>
            <index>1</index>
            <title>
                ПКО №7 от кого: ВиртуалПос В. -. осн: Выручка от продаж операционной кассы
            </title>
            <in_amount>1828.00</in_amount>
            <account>90.1.2.1</account>
            <title_align>left</title_align>
            <id>10</id>
            <warehouse_safebox_id>1</warehouse_safebox_id>
            <warehouse_id>2</warehouse_id>
            <type>income</type>
            <subtype>zreport_changing_return</subtype>
            <cash_before>6174.00</cash_before>
            <cash_after>6392.00</cash_after>
            <cash_change>218.00</cash_change>
            <doc_num>8</doc_num>
            <comment/>
            <rel_id>14497</rel_id>
            <created_date>2017-07-10 17:10:02</created_date>
            <created_by>2</created_by>
            <last_update_date>2017-07-10 17:10:02</last_update_date>
            <last_update_by>2</last_update_by>
            <responsible_user_id>2</responsible_user_id>
            <reason>Возврат размена из операционной кассы</reason>
            <application/>
            <index>2</index>
            <title>
                ПКО №8 от кого: ВиртуалПос В. -. осн: Возврат размена из операционной кассы
            </title>
            <in_amount>218.00</in_amount>
            <account>71.02</account>
            <title_align>left</title_align>
            <title>Итого за день:</title>
            <title_align>right</title_align>
            <in_amount>2046.00</in_amount>
            <out_amount>0.00</out_amount>
            <title>Остаток на конец дня:</title>
            <title_align>right</title_align>
            <in_amount>6392.00</in_amount>
        </items>
    </pages>
</transactions>
</root>