Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:warehousesafeboxtransaction [11.07.2017 15:22] mkuklin [Пример ответа сервера] |
doc:dev:api:warehousesafeboxtransaction [02.06.2018 10:42] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== API :: WarehouseSafeboxTransaction. Получение данных по кассовой книге главной кассы ====== | + | ====== API :: WarehouseSafeboxTransaction. Движение денежных средств на главной кассе магазина (ПКО\РКО) ====== |
| - | В системе реализован программный интерфейс для получения данных о кассовой книге главной кассы. Данные выгружаются по http протоколу. Формат на выбор - xml или json. | + | В системе реализован программный интерфейс для получения данных о движении денежных средств в главной кассе магазина (сейф). Данные выгружаются по http протоколу. Формат на выбор - xml или json. |
| ===== Пример запроса на получение данных ===== | ===== Пример запроса на получение данных ===== | ||
| - | Пример запроса на получение данных о кассовой книге главной кассы: | + | Пример запроса на получение данных о движении денежных средств на главной кассе: |
| - | http://mycompany.virtpos.ru/api/warehousesafeboxtransaction?apikey=MySecret&format=xml | + | http://mycompany.virtpos.ru/api/warehouseSafeboxTransaction?apikey=MySecret&format=xml |
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код транзакции, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях кассовой книги главной кассы. | + | * **id** (get only) - код транзакции, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях на главной кассе. |
| - | * **date** - получение транзакций кассовой книги на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | + | * **warehouse_id** (get only) - код точки продаж, для которой надо вернуть данные. Если не указан, то возвращаются данные обо всех транзакциях. |
| - | * **datefrom** - получение транзакций кассовой книги начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. | + | * **ext_warehouse_id** (get only) - код точки продаж во внешней системе. |
| - | * **dateto** - получение транзакций кассовой книги начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр. | + | * **date** (get only) - получение транзакций кассовой книги на определенную дату. Формат: ГГГГММДД. Необязательный параметр. |
| + | |||
| + | * **datefrom** (get only) - получение транзакций начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
| + | |||
| + | * **dateto** (get only) - получение транзакций начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр. | ||
| ==== Ответ сервера ==== | ==== Ответ сервера ==== | ||
| Строка 34: | Строка 38: | ||
| <file xml> | <file xml> | ||
| <root> | <root> | ||
| - | <success>1</success> | + | <success>1</success> |
| - | <type>warehouseSafeboxTransaction</type> | + | <type>warehouseSafeboxTransaction</type> |
| - | <count>1</count> | + | <count>2</count> |
| - | <warehousesSafeboxTransactions> | + | <warehouseSafeboxTransactions> |
| - | <warehousesSafeboxTransaction> | + | <warehouseSafeboxTransaction> |
| - | <id>1</id> | + | <id>30</id> |
| - | <warehouse_safebox_id>1</warehouse_safebox_id> | + | <guid>8df13434-6e18-11e7-b208-74d435ee6043</guid> |
| - | <warehouse_id>2</warehouse_id> | + | <warehouse_safebox_id>1</warehouse_safebox_id> |
| - | <type>income</type> | + | <warehouse_id>1</warehouse_id> |
| - | <typeName>Приход</typeName> | + | <ext_warehouse_id>111</ext_warehouse_id> |
| - | <subtype>terminal_cash_earning</subtype> | + | <type>income</type> |
| - | <search_subtype_id/> | + | <typeName>Приход</typeName> |
| - | <subtypeName>Выручка наличными с операционной кассы</subtypeName> | + | <subtype>cash_changing_return</subtype> |
| - | <cash_before>0.00</cash_before> | + | <subtype_name>Приход</subtype_name> |
| - | <cash_after>425.00</cash_after> | + | <subtypeName>Возврат размена из кассы</subtypeName> |
| - | <cash_change>425.00</cash_change> | + | <subtype_external_id/> |
| - | <doc_num>1</doc_num> | + | <cash_before>1999.55</cash_before> |
| - | <comment/> | + | <cash_after>2199.55</cash_after> |
| - | <responsible_user_id/> | + | <cash_change>200.00</cash_change> |
| - | <application/> | + | <doc_num>12</doc_num> |
| - | <reason/> | + | <comment/> |
| - | <created_date>2017-06-23 14:46:59</created_date> | + | <rel_id>653</rel_id> |
| - | <created_by>2</created_by> | + | <rel_type>CashFlow</rel_type> |
| - | <last_update_date>2017-06-23 14:46:59</last_update_date> | + | <rel_document> |
| - | <last_update_by>2</last_update_by> | + | <id>653</id> |
| - | </warehousesSafeboxTransaction> | + | <user_id>2</user_id> |
| - | <warehousesSafeboxTransaction> | + | <type>outcome</type> |
| - | </warehousesSafeboxTransactions> | + | <src_terminal_id>135</src_terminal_id> |
| - | <transactions> | + | <dst_terminal_id/> |
| - | <id>4</id> | + | <cash_before>2538.00</cash_before> |
| - | <warehouse_safebox_id>1</warehouse_safebox_id> | + | <cash_after>2338.00</cash_after> |
| - | <date>2017-07-10</date> | + | <cash_change>-200.00</cash_change> |
| - | <cash_in>4346.00</cash_in> | + | <created_date>21.07.2017 16:28:59</created_date> |
| - | <cash_out>6392.00</cash_out> | + | <created_by>2</created_by> |
| - | <trx_in_count>2</trx_in_count> | + | <last_update_date>21.07.2017 16:28:59</last_update_date> |
| - | <trx_out_count>0</trx_out_count> | + | <last_update_by>2</last_update_by> |
| - | <trx_in_amount>2046.00</trx_in_amount> | + | <fiscal_journal_id>1041</fiscal_journal_id> |
| - | <trx_out_amount>0.00</trx_out_amount> | + | <comment/> |
| - | <cashier/> | + | <subtype>to_strongbox</subtype> |
| - | <accountant/> | + | <cheque_datetime>2017-07-21 16:28:59</cheque_datetime> |
| - | <page_start>4</page_start> | + | <receipt_id/> |
| - | <page_finish>4</page_finish> | + | <guid>8df13432-6e18-11e7-b208-74d435ee6043</guid> |
| - | <created_date>2017-07-10 17:10:02</created_date> | + | <user_login>admin</user_login> |
| - | <created_by>2</created_by> | + | <user_corp_code>CBX-0000</user_corp_code> |
| - | <last_update_date>2017-07-10 17:10:02</last_update_date> | + | <src_warehouse_id>1</src_warehouse_id> |
| - | <last_update_by>2</last_update_by> | + | <dst_warehouse_id/> |
| - | <doc_date>10.07.2017</doc_date> | + | <src_warehouse_ext_id>111</src_warehouse_ext_id> |
| - | <doc_date_data> | + | <dst_warehouse_ext_id/> |
| - | <day>10</day> | + | <src_machine_number>2419075107350</src_machine_number> |
| - | <month_string>июля</month_string> | + | <dst_machine_number/> |
| - | <year>2017</year> | + | <src_terminal_open_datetime>2017-07-21 16:21:28</src_terminal_open_datetime> |
| - | </doc_date_data> | + | <dst_terminal_open_datetime/> |
| - | <organisation> | + | <src_terminal_session>2</src_terminal_session> |
| - | <id>1</id> | + | <dst_terminal_session/> |
| - | <name>ООО "Красная площадь, д.1"</name> | + | </rel_document> |
| - | <inn>7813404796</inn> | + | <responsible_user_id>2</responsible_user_id> |
| - | <kpp>780201001</kpp> | + | <responsible_user_corp_code>CBX-0000</responsible_user_corp_code> |
| - | <address> | + | <responsible_user_full_name>Ронкин Алексей .</responsible_user_full_name> |
| - | 190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н | + | <manager_user_id>3</manager_user_id> |
| - | </address> | + | <manager_user_corp_code>CBX-2222</manager_user_corp_code> |
| - | <realaddress> | + | <manager_user_full_name>Семенова Юлия К</manager_user_full_name> |
| - | 190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н | + | <application/> |
| - | </realaddress> | + | <reason>Возврат размена из операционной кассы</reason> |
| - | <created_date>2015-07-23 17:40:26</created_date> | + | <credit_account>71.02</credit_account> |
| - | <created_by>2</created_by> | + | <correspondent_account>50.02</correspondent_account> |
| - | <last_update_date>2015-07-23 17:40:26</last_update_date> | + | <created_date>2017-07-21 16:28:59</created_date> |
| - | <last_update_by>2</last_update_by> | + | <created_by>2</created_by> |
| - | <print_name/> | + | <created_by_corp_code>CBX-0000</created_by_corp_code> |
| - | <legal_name>ООО "Красная площадь, д.1"</legal_name> | + | <created_by_full_name>Ронкин Алексей .</created_by_full_name> |
| - | <active>1</active> | + | <last_update_date>2017-07-21 16:28:59</last_update_date> |
| - | <ogrn/> | + | <last_update_by>2</last_update_by> |
| - | <okpo/> | + | <terminal_user_corp_code>CBX-0000</terminal_user_corp_code> |
| - | <bank_name/> | + | <terminal_machine_number>2419075107350</terminal_machine_number> |
| - | <account/> | + | <terminal_session>2</terminal_session> |
| - | <corr_account/> | + | <terminal_open_datetime>2017-07-21 16:21:28</terminal_open_datetime> |
| - | <bik/> | + | </warehouseSafeboxTransaction> |
| - | <attribute1/> | + | <warehouseSafeboxTransaction> |
| - | <attribute2/> | + | <id>31</id> |
| - | <attribute3/> | + | <guid>901f110e-6e18-11e7-b208-74d435ee6043</guid> |
| - | <attribute4/> | + | <warehouse_safebox_id>1</warehouse_safebox_id> |
| - | <attribute5/> | + | <warehouse_id>1</warehouse_id> |
| - | <attribute6/> | + | <ext_warehouse_id>111</ext_warehouse_id> |
| - | <attribute7/> | + | <type>outcome</type> |
| - | <attribute8/> | + | <typeName>Расход</typeName> |
| - | <attribute9/> | + | <subtype>cash_changing</subtype> |
| - | <attribute10/> | + | <subtype_name>Расход</subtype_name> |
| - | <attribute11/> | + | <subtypeName>Выдача размена в кассу</subtypeName> |
| - | <attribute12/> | + | <subtype_external_id/> |
| - | <attribute13/> | + | <cash_before>2199.55</cash_before> |
| - | <attribute14/> | + | <cash_after>2099.55</cash_after> |
| - | <attribute15/> | + | <cash_change>-100.00</cash_change> |
| - | <textInfo> | + | <doc_num>10</doc_num> |
| - | ООО "Красная площадь, д.1", 190000, Санкт-Петербург г, Просвещения пр-кт, дом № 28, корпус лит А, квартира пом.21-Н, ИНН 7813404796, р/с , , к/с , БИК , КПП 7813404796 | + | <comment/> |
| - | </textInfo> | + | <rel_id>654</rel_id> |
| - | </organisation> | + | <rel_type>CashFlow</rel_type> |
| - | <pages> | + | <rel_document> |
| - | <page_number>4</page_number> | + | <id>654</id> |
| - | <items> | + | <user_id>2</user_id> |
| - | <title>Остаток на начало дня:</title> | + | <type>income</type> |
| - | <title_align>right</title_align> | + | <src_terminal_id/> |
| - | <in_amount>4346.00</in_amount> | + | <dst_terminal_id>135</dst_terminal_id> |
| - | <id>9</id> | + | <cash_before>2338.00</cash_before> |
| - | <warehouse_safebox_id>1</warehouse_safebox_id> | + | <cash_after>2438.00</cash_after> |
| - | <warehouse_id>2</warehouse_id> | + | <cash_change>100.00</cash_change> |
| - | <type>income</type> | + | <created_date>21.07.2017 16:29:03</created_date> |
| - | <subtype>terminal_cash_earning</subtype> | + | <created_by>2</created_by> |
| - | <cash_before>4346.00</cash_before> | + | <last_update_date>21.07.2017 16:29:03</last_update_date> |
| - | <cash_after>6174.00</cash_after> | + | <last_update_by>2</last_update_by> |
| - | <cash_change>1828.00</cash_change> | + | <fiscal_journal_id>1042</fiscal_journal_id> |
| - | <doc_num>7</doc_num> | + | <comment/> |
| - | <comment/> | + | <subtype>from_strongbox</subtype> |
| - | <rel_id>14497</rel_id> | + | <cheque_datetime>2017-07-21 16:29:02</cheque_datetime> |
| - | <created_date>2017-07-10 17:10:02</created_date> | + | <receipt_id/> |
| - | <created_by>2</created_by> | + | <guid>901f110c-6e18-11e7-b208-74d435ee6043</guid> |
| - | <last_update_date>2017-07-10 17:10:02</last_update_date> | + | <user_login>admin</user_login> |
| - | <last_update_by>2</last_update_by> | + | <user_corp_code>CBX-0000</user_corp_code> |
| - | <responsible_user_id>2</responsible_user_id> | + | <src_warehouse_id/> |
| - | <reason>Выручка от продаж операционной кассы</reason> | + | <dst_warehouse_id>1</dst_warehouse_id> |
| - | <application/> | + | <src_warehouse_ext_id/> |
| - | <index>1</index> | + | <dst_warehouse_ext_id>111</dst_warehouse_ext_id> |
| - | <title> | + | <src_machine_number/> |
| - | ПКО №7 от кого: ВиртуалПос В. -. осн: Выручка от продаж операционной кассы | + | <dst_machine_number>2419075107350</dst_machine_number> |
| - | </title> | + | <src_terminal_open_datetime/> |
| - | <in_amount>1828.00</in_amount> | + | <dst_terminal_open_datetime>2017-07-21 16:21:28</dst_terminal_open_datetime> |
| - | <account>90.1.2.1</account> | + | <src_terminal_session/> |
| - | <title_align>left</title_align> | + | <dst_terminal_session>2</dst_terminal_session> |
| - | <id>10</id> | + | </rel_document> |
| - | <warehouse_safebox_id>1</warehouse_safebox_id> | + | <responsible_user_id>2</responsible_user_id> |
| - | <warehouse_id>2</warehouse_id> | + | <responsible_user_corp_code>CBX-0000</responsible_user_corp_code> |
| - | <type>income</type> | + | <responsible_user_full_name>Ронкин Алексей .</responsible_user_full_name> |
| - | <subtype>zreport_changing_return</subtype> | + | <manager_user_id>3</manager_user_id> |
| - | <cash_before>6174.00</cash_before> | + | <manager_user_corp_code>CBX-2222</manager_user_corp_code> |
| - | <cash_after>6392.00</cash_after> | + | <manager_user_full_name>Семенова Юлия К</manager_user_full_name> |
| - | <cash_change>218.00</cash_change> | + | <application/> |
| - | <doc_num>8</doc_num> | + | <reason>Выдача размена в операционную кассу</reason> |
| - | <comment/> | + | <credit_account>50.02</credit_account> |
| - | <rel_id>14497</rel_id> | + | <correspondent_account>71.02</correspondent_account> |
| - | <created_date>2017-07-10 17:10:02</created_date> | + | <created_date>2017-07-21 16:29:03</created_date> |
| - | <created_by>2</created_by> | + | <created_by>2</created_by> |
| - | <last_update_date>2017-07-10 17:10:02</last_update_date> | + | <created_by_corp_code>CBX-0000</created_by_corp_code> |
| - | <last_update_by>2</last_update_by> | + | <created_by_full_name>Ронкин Алексей .</created_by_full_name> |
| - | <responsible_user_id>2</responsible_user_id> | + | <last_update_date>2017-07-21 16:29:03</last_update_date> |
| - | <reason>Возврат размена из операционной кассы</reason> | + | <last_update_by>2</last_update_by> |
| - | <application/> | + | <terminal_user_corp_code>CBX-0000</terminal_user_corp_code> |
| - | <index>2</index> | + | <terminal_machine_number>2419075107350</terminal_machine_number> |
| - | <title> | + | <terminal_session>2</terminal_session> |
| - | ПКО №8 от кого: ВиртуалПос В. -. осн: Возврат размена из операционной кассы | + | <terminal_open_datetime>2017-07-21 16:21:28</terminal_open_datetime> |
| - | </title> | + | </warehouseSafeboxTransaction> |
| - | <in_amount>218.00</in_amount> | + | </warehouseSafeboxTransactions> |
| - | <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> | </root> | ||
| </file> | </file> | ||
| + | |||
| + | ==== Структура ответа сервера ==== | ||
| + | |||
| + | * **terminal_user_corp_code** - Корпоративный код сотрудника открывшего смену | ||
| + | * **manager_user_corp_code** - Корпоративный код директора магазина | ||
| + | * **responsible_user_corp_code** - Корпоративный код ответственного сотрудника | ||