Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:dev:api:cashflow [09.09.2016 17:07]
rlysov
+++ doc:dev:api:cashflow [02.06.2018 10:42] (текущий)
@@ Строка 3: / Строка 3: @@
 В системе реализован программный интерфейс для получения данных движении денежных средств на кассовом рабочем месте. Данные выгружаются по http протоколу. Формат на выбор - xml или json.
+Пользовательский интерфейс для просмотра движения денег на кассе доступен в административной панели, меню **Кассовые места** -> **Рабочее кассовое место** -> **Движение денежных средств**
+===== Типы денежных операций =====
 Доступны данные о следующих типах операций:
   * **sale** - поступление наличных денег от продажа товара
@@ Строка 9: / Строка 12: @@
   * **outcome** - выплата наличных денег из кассы
   * **income** - внесение наличных денег в кассу
+  * **to_strongbox** - перемещение в главную кассу
+  * **from_strongbox** - перемещение из главной кассы
-===== Получение данных =====
+===== Параметры запроса на получение данных =====
+Параметры запроса данных (все параметры передаются как get-параметры):
-Пример запроса на получение данных о движении денежных средств на всех кассах за последние два дня:
- http://mycompany.virtpos.ru/api/cashflow?apikey=MySecret&days=2
-Параметры запроса данных:
   * int **terminalid** - ID кассы. Если не указан, то будут отданы данные по всем кассам
   * int  **warehouseid** - ID точки продаж (магазина), данные о которой надо получить. Будут отданы данные обо всех кассах этого магазина. Параметр игнорируется, если указан terminalid
@@ Строка 26: / Строка 26: @@
   * int **days** - возвращает данные за последние количество дней.
+===== Пример запроса на получение данных =====
+Пример запроса на получение данных о движении денежных средств на всех кассах за последние два дня:
+ http://mycompany.virtpos.ru/api/cashFlow?apikey=MySecret&days=2&type=income,outcome
+===== Пример ответа =====
+<file xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+	<success>1</success>
+	<type>cashflow</type>
+	<count>3</count>
+	<transactions>
+		<transaction>
+		<id>375</id>
+		<user_id>3</user_id>
+		<user_login>ivanov</user_login>
+		<user_corp_code>CBX-0000</user_corp_code>
+		<created_date>2016-09-07 19:42:42</created_date>
+		<last_update_date>2016-09-07 19:42:42</last_update_date>
+		<src_terminal_id>13</src_terminal_id>
+		<dst_terminal_id/>
+		<src_machine_number>0515309</src_machine_number>
+		<dst_machine_number/>
+		<src_warehouse_id>6</src_warehouse_id>
+		<dst_warehouse_id/>
+		<src_warehouse_ext_id/>
+		<dst_warehouse_ext_id/>
+		<type>sale</type>
+		<subtype/>
+		<cash_before>437.00</cash_before>
+		<cash_after>759.50</cash_after>
+		<cash_change>322.50</cash_change>
+		<comment/>
+		<receipt_id>363</receipt_id>
+		<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
+		<src_terminal_open_datetime/>
+		<dst_terminal_open_datetime>2017-07-19 13:56:52</dst_terminal_open_datetime>
+		<src_terminal_session/>
+		<dst_terminal_session>0</dst_terminal_session>
+	</transaction>
+</root>
+</file>
+===== Формат ответа =====
+  * **id** - уникальный номер операции
+  * **user_id** - ID пользователя, совершившего операцию
+  * **user_login** - Логин пользователя, совершившего операцию
+  * **user_corp_code** - Корпоративный код пользователя, совершившего операцию
+  * **created_date** - Дата создания операции
+  * **last_update_date** - Дата обновления этой записи. Должна совпадать с created_date
+  * **src_terminal_id** - Уникальный идентификатор кассового рабочего места, откуда осуществлялось изъятие денег
+  * **dst_terminal_id** - Уникальный идентификатор кассового рабочего места, в которую осуществлено поступление денег
+  * **src_machine_number** - Регистрационный номер кассы, откуда осуществлялось изъятие денег
+  * **dst_machine_number** - Регистрационный номер кассы, в которую осуществлено поступление денег
+  * **src_warehouse_id** - Уникальный идентификатор точки продаж, откуда осуществлялось изъятие денег
+  * **dst_warehouse_id** - Уникальный идентификатор точки продаж, в которую осуществлено поступление денег
+  * **src_warehouse_ext_id** - аналог src_warehouse_id, но хранит код точки продаж во внешней системе
+  * **dst_warehouse_ext_id** - аналог dst_warehouse_id, но хранит код точки продаж во внешней системе
+  * **type** - тип операции
+  * **subtype** - подтип операции. Возможные значения зависят от настроек системы
+  * **cash_before** - сумма наличных денег в кассе до операции
+  * **cash_after** - сумма наличных денег в кассе после операции
+  * **cash_change** - сальдо операции
+  * **comment** - комментарий, который оставил продавец при осуществлении операции
+  * **receipt_id** - ID чека. Заполняется для типов операций "продажа" и "возврат"
+  * **guid** - GUID операции
+  * **src_terminal_open_datetime** - дата открытия смены на кассе, откуда осуществлялось изъятие денег
+  * **dst_terminal_open_datetime** - дата открытия смены на кассе, в которую осуществлено поступление денег
+  * **src_terminal_session** - номер смены на кассе, откуда осуществлялось изъятие денег
+  * **dst_terminal_session** - номер смены на кассе, в которую осуществлено поступление денег