Перейти к содержаниюСправка

Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:warehouseencashment [17.12.2019 15:03] – [Пример ответа сервера] doc:dev:api:warehouseencashment [26.09.2026 14:03] (текущий) – внешнее изменение
Строка 1: Строка 1:
-====== API :: WarehouseEncashment. Инкассации ======+====== WarehouseEncashment. Инкассации ======
  
-В системе реализован программный интерфейс для получения данных об инкассации из главной кассы магазина. Данные выгружаются по http протоколу. Формат на выбор - xml или json.+Статья перенесена: [[hc:api:warehouseencashment]]
  
-===== Пример запроса на получение данных ===== 
- 
-Пример запроса на получение данных об инкассации: 
- 
-http://mycompany.virtpos.ru/api/warehouseEncashment?apikey=MySecret&format=xml 
- 
-==== Параметры запроса ==== 
-Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. 
-  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. 
- 
-  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. 
- 
-  * **id** (get only) - ID инкассации, для которой надо вернуть данные. Необязательный параметр. 
- 
-  * **warehouse_id** (get only) - ID точки продаж, для которой надо вернуть данные. Необязательный параметр. 
- 
-  * **ext_warehouse_id** (get only) - код точки продаж во внешней системе. Необязательный параметр. 
- 
-  * **date** (get only) - получение данных на определенную дату. Формат: ГГГГММДД. Необязательный параметр. 
- 
-  * **date_from** (get only) - получение данных начиная с определенной даты. Формат: ГГГГММДД. Необязательный параметр. 
- 
-  * **date_to** (get only) - получение данных начиная до определенной даты. Формат: ГГГГММДД. Необязательный параметр. 
- 
-==== Ответ сервера ==== 
- 
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info 
- 
-==== Пример ответа сервера ==== 
- 
-Ниже приведен пример ответа сервера в формате XML 
- 
-<file xml> 
-<root> 
-  <success>1</success> 
-  <type>warehouseEncashment</type> 
-  <count>1</count> 
-  <warehouseEncashments> 
-  <warehouseEncashment> 
-    <id>1</id> 
-    <warehouse_id>12</warehouse_id> 
-    <amount>12000.00</amount> 
-    <bag_number/> 
-    <org_name>ИП Иванов И.И.</org_name> 
-    <warehouse_name>Владимирская</warehouse_name> 
-    <warehouse_address>Санкт Петербург</warehouse_address> 
-    <warehouse_inn>123123123123</warehouse_inn> 
-    <bank_account_num/> 
-    <org_account_num/> 
-    <agent_bank_name/> 
-    <agent_bank_bik/> 
-    <recipient_bank_name/> 
-    <recipient_bank_bik/> 
-    <source_text>Поступления от продажи товаров</source_text> 
-    <warehouse_safebox_transaction_id>1234</warehouse_safebox_transaction_id> 
-    <note1/> 
-    <note2/> 
-    <note3/> 
-    <note4/> 
-    <note5/> 
-    <note6/> 
-    <note7/> 
-    <note8/> 
-    <note9/> 
-    <note10/> 
-    <note11/> 
-    <note12/> 
-    <note13/> 
-    <note14/> 
-    <note15/> 
-    <note16/> 
-    <note17/> 
-    <note18/> 
-    <note19/> 
-    <note20/> 
-    <attribute1/> 
-    <attribute2/> 
-    <attribute3/> 
-    <attribute4/> 
-    <attribute5/> 
-    <attribute6/> 
-    <attribute7/> 
-    <attribute8/> 
-    <attribute9/> 
-    <attribute10/> 
-    <attribute11/> 
-    <attribute12/> 
-    <attribute13/> 
-    <attribute14/> 
-    <attribute15/> 
-    <created_date>2019-10-25 14:02:37</created_date> 
-    <created_by>123</created_by> 
-    <last_update_date>2019-10-25 14:02:37</last_update_date> 
-    <last_update_by>123</last_update_by> 
-    <agent_bank_id/> 
-    <agent_bank_external_id/> 
-    <recipient_bank_id/> 
-    <recipient_bank_external_id/> 
-    <created_at>2019-10-25 00:00:00</created_at> 
-    <creator_name>Петров П. П.</creator_name> 
-    <updater_name>Петров П. П.</updater_name> 
-  </warehouseEncashment> 
-  </warehouseEncashments> 
-</root> 
-</file>