Различия

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

--- doc:dev:api:writeoff [01.09.2017 14:35]
mzubkov [Параметры запроса]
+++ doc:dev:api:writeoff [12.12.2025 11:45] (текущий)
rlysov [Структура ответа сервера]
@@ Строка 9: / Строка 9: @@
 Пример запроса на получение данных о документах "Списание":
- http://mycompany.virtpos.ru/api/writeoff?apikey=MySecret&format=xml
+ https://[company].myvirtualpos.ru/api/writeoff?apikey=MySecret&format=xml
 ==== Параметры запроса на получение данных ====
@@ Строка 107: / Строка 107: @@
 					<lot_number/>
 					<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
+					<reason>Без указания причины</reason>
 				</item>
 			</items>
@@ Строка 175: / Строка 176: @@
   * **guid** - GUID строки
+  * **reason** - Причина списания
@@ Строка 182: / Строка 185: @@
 Пример запроса на обновление данных о списании:
- http://mycompany.virtpos.ru/api/writeoff/update/?apikey=MySecret&format=xml&id=1&comment=NewComment
+ https://[company].myvirtualpos.ru/api/writeoff/update/?apikey=MySecret&format=xml&id=1&comment=NewComment
 ==== Параметры запроса ====
@@ Строка 226: / Строка 229: @@
 Пример запроса на удаление списания:
- http://mycompany.virtpos.ru/api/writeoff/delete/?apikey=MySecret&format=xml&id=1
+ https://[company].myvirtualpos.ru/api/writeoff/delete/?apikey=MySecret&format=xml&id=1
 ==== Параметры запроса ====
@@ Строка 262: / Строка 265: @@
 Пример запроса на обновление данных о товарной позиции в списании:
- http://mycompany.virtpos.ru/api/writeoff/updateItems/?apikey=MySecret&format=xml&id=1&quantity=2
+ https://[company].myvirtualpos.ru/api/writeoff/updateItems/?apikey=MySecret&format=xml&id=1&quantity=2
 ==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - идентификатор товарной строки в поступлении, данные которой нужно обновить
+  * **id** (get only) - идентификатор товарной строки в поступлении, данные которой нужно обновить
-  * **create_if_not_exist** - Если истина, то при неудачном поиске товарная строка будет добавлена в систему.
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске товарная строка будет добавлена в систему.
   * Также в качестве параметров могут быть переданы все поля для строки товарной позиции в списании
@@ Строка 301: / Строка 304: @@
 Пример запроса на удаление товарной строки из документа списания:
- http://mycompany.virtpos.ru/api/writeoff/deleteItems/?apikey=MySecret&format=xml&id=1
+ https://[company].myvirtualpos.ru/api/writeoff/deleteItems/?apikey=MySecret&format=xml&id=1
 ==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - идентификатор строки товарной позиции Списания, которая будет удалена
+  * **id** (get only) - идентификатор строки товарной позиции Списания, которая будет удалена