API :: WarehouseSafeboxTransaction. Движение денежных средств на главной кассе магазина (ПКО\РКО)

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

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

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

Параметры, которые не отмечены как get only, могут быть переданы как get- или как post-параметры.

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• format (get only) - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• id (get only) - код транзакции, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях на главной кассе.

• warehouse_id (get only) - код точки продаж, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях.

• ext_warehouse_id (get only) - код точки продаж во внешней системе.

• date (get only) - получение транзакций кассовой книги на определенную дату. Формат: ГГГГММДД. Необязательный параметр.

• datefrom (get only) - получение транзакций начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр.

• dateto (get only) - получение транзакций начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр.

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

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

<root>
	<success>1</success>
	<type>warehouseSafeboxTransaction</type>
	<count>2</count>
	<warehouseSafeboxTransactions>
		<warehouseSafeboxTransaction>
			<id>30</id>
			<guid>8df13434-6e18-11e7-b208-74d435ee6043</guid>
			<warehouse_safebox_id>1</warehouse_safebox_id>
			<warehouse_id>1</warehouse_id>
			<ext_warehouse_id>111</ext_warehouse_id>
			<type>income</type>
			<typeName>Приход</typeName>
			<subtype>cash_changing_return</subtype>
			<subtype_name>Приход</subtype_name>
			<subtypeName>Возврат размена из кассы</subtypeName>
			<subtype_external_id/>
			<cash_before>1999.55</cash_before>
			<cash_after>2199.55</cash_after>
			<cash_change>200.00</cash_change>
			<doc_num>12</doc_num>
			<comment/>
			<rel_id>653</rel_id>
			<rel_type>CashFlow</rel_type>
			<rel_document>
				<id>653</id>
				<user_id>2</user_id>
				<type>outcome</type>
				<src_terminal_id>135</src_terminal_id>
				<dst_terminal_id/>
				<cash_before>2538.00</cash_before>
				<cash_after>2338.00</cash_after>
				<cash_change>-200.00</cash_change>
				<created_date>21.07.2017 16:28:59</created_date>
				<created_by>2</created_by>
				<last_update_date>21.07.2017 16:28:59</last_update_date>
				<last_update_by>2</last_update_by>
				<fiscal_journal_id>1041</fiscal_journal_id>
				<comment/>
				<subtype>to_strongbox</subtype>
				<cheque_datetime>2017-07-21 16:28:59</cheque_datetime>
				<receipt_id/>
				<guid>8df13432-6e18-11e7-b208-74d435ee6043</guid>
				<user_login>admin</user_login>
				<user_corp_code>CBX-0000</user_corp_code>
				<src_warehouse_id>1</src_warehouse_id>
				<dst_warehouse_id/>
				<src_warehouse_ext_id>111</src_warehouse_ext_id>
				<dst_warehouse_ext_id/>
				<src_machine_number>2419075107350</src_machine_number>
				<dst_machine_number/>
				<src_terminal_open_datetime>2017-07-21 16:21:28</src_terminal_open_datetime>
				<dst_terminal_open_datetime/>
				<src_terminal_session>2</src_terminal_session>
				<dst_terminal_session/>
			</rel_document>
			<responsible_user_id>2</responsible_user_id>
			<responsible_user_corp_code>CBX-0000</responsible_user_corp_code>
			<responsible_user_full_name>Ронкин Алексей .</responsible_user_full_name>
			<manager_user_id>3</manager_user_id>
			<manager_user_corp_code>CBX-2222</manager_user_corp_code>
			<manager_user_full_name>Семенова Юлия К</manager_user_full_name>
			<application/>
			<reason>Возврат размена из операционной кассы</reason>
			<credit_account>71.02</credit_account>
			<correspondent_account>50.02</correspondent_account>
			<created_date>2017-07-21 16:28:59</created_date>
			<created_by>2</created_by>
			<created_by_corp_code>CBX-0000</created_by_corp_code>
			<created_by_full_name>Ронкин Алексей .</created_by_full_name>
			<last_update_date>2017-07-21 16:28:59</last_update_date>
			<last_update_by>2</last_update_by>
			<terminal_user_corp_code>CBX-0000</terminal_user_corp_code>
			<terminal_machine_number>2419075107350</terminal_machine_number>
			<terminal_session>2</terminal_session>
			<terminal_open_datetime>2017-07-21 16:21:28</terminal_open_datetime>
		</warehouseSafeboxTransaction>
		<warehouseSafeboxTransaction>
			<id>31</id>
			<guid>901f110e-6e18-11e7-b208-74d435ee6043</guid>
			<warehouse_safebox_id>1</warehouse_safebox_id>
			<warehouse_id>1</warehouse_id>
			<ext_warehouse_id>111</ext_warehouse_id>
			<type>outcome</type>
			<typeName>Расход</typeName>
			<subtype>cash_changing</subtype>
			<subtype_name>Расход</subtype_name>
			<subtypeName>Выдача размена в кассу</subtypeName>
			<subtype_external_id/>
			<cash_before>2199.55</cash_before>
			<cash_after>2099.55</cash_after>
			<cash_change>-100.00</cash_change>
			<doc_num>10</doc_num>
			<comment/>
			<rel_id>654</rel_id>
			<rel_type>CashFlow</rel_type>
			<rel_document>
				<id>654</id>
				<user_id>2</user_id>
				<type>income</type>
				<src_terminal_id/>
				<dst_terminal_id>135</dst_terminal_id>
				<cash_before>2338.00</cash_before>
				<cash_after>2438.00</cash_after>
				<cash_change>100.00</cash_change>
				<created_date>21.07.2017 16:29:03</created_date>
				<created_by>2</created_by>
				<last_update_date>21.07.2017 16:29:03</last_update_date>
				<last_update_by>2</last_update_by>
				<fiscal_journal_id>1042</fiscal_journal_id>
				<comment/>
				<subtype>from_strongbox</subtype>
				<cheque_datetime>2017-07-21 16:29:02</cheque_datetime>
				<receipt_id/>
				<guid>901f110c-6e18-11e7-b208-74d435ee6043</guid>
				<user_login>admin</user_login>
				<user_corp_code>CBX-0000</user_corp_code>
				<src_warehouse_id/>
				<dst_warehouse_id>1</dst_warehouse_id>
				<src_warehouse_ext_id/>
				<dst_warehouse_ext_id>111</dst_warehouse_ext_id>
				<src_machine_number/>
				<dst_machine_number>2419075107350</dst_machine_number>
				<src_terminal_open_datetime/>
				<dst_terminal_open_datetime>2017-07-21 16:21:28</dst_terminal_open_datetime>
				<src_terminal_session/>
				<dst_terminal_session>2</dst_terminal_session>
			</rel_document>
			<responsible_user_id>2</responsible_user_id>
			<responsible_user_corp_code>CBX-0000</responsible_user_corp_code>
			<responsible_user_full_name>Ронкин Алексей .</responsible_user_full_name>
			<manager_user_id>3</manager_user_id>
			<manager_user_corp_code>CBX-2222</manager_user_corp_code>
			<manager_user_full_name>Семенова Юлия К</manager_user_full_name>
			<application/>
			<reason>Выдача размена в операционную кассу</reason>
			<credit_account>50.02</credit_account>
			<correspondent_account>71.02</correspondent_account>
			<created_date>2017-07-21 16:29:03</created_date>
			<created_by>2</created_by>
			<created_by_corp_code>CBX-0000</created_by_corp_code>
			<created_by_full_name>Ронкин Алексей .</created_by_full_name>
			<last_update_date>2017-07-21 16:29:03</last_update_date>
			<last_update_by>2</last_update_by>
			<terminal_user_corp_code>CBX-0000</terminal_user_corp_code>
			<terminal_machine_number>2419075107350</terminal_machine_number>
			<terminal_session>2</terminal_session>
			<terminal_open_datetime>2017-07-21 16:21:28</terminal_open_datetime>
		</warehouseSafeboxTransaction>
	</warehouseSafeboxTransactions>
</root>

• terminal_user_corp_code - Корпоративный код сотрудника открывшего смену
• manager_user_corp_code - Корпоративный код директора магазина
• responsible_user_corp_code - Корпоративный код ответственного сотрудника