Различия

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

--- doc:dev:api:writeoff [28.06.2017 15:10]
dchuprunov
+++ doc:dev:api:writeoff [22.10.2025 12:13] (текущий)
rlysov
@@ Строка 9: / Строка 9: @@
 Пример запроса на получение данных о документах "Списание":
- http://mycompany.virtpos.ru/api/writeoff?apikey=MySecret&format=xml
+ https://[company].myvirtualpos.ru/api/writeoff?apikey=MySecret&format=xml
 ==== Параметры запроса на получение данных ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
   * **date** - получение списаний на определенную дату. Формат: ГГГГММДД. Необязательный параметр.
@@ Строка 69: / Строка 69: @@
 			<warehouse_external_id/>
 			<type>G</type>
+			<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
 			<created_date>2017-06-15 04:45:58</created_date>
 			<created_by/>
@@ Строка 84: / Строка 85: @@
 			<status>draft</status>
 			<type>G</type>
+			<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
 			<status_name>Черновик</status_name>
 			<comment/>
@@ Строка 104: / Строка 106: @@
 					<expir_date/>
 					<lot_number/>
+					<guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid>
 				</item>
 			</items>
@@ Строка 127: / Строка 130: @@
   * **type** - тип списания (G - списание товаров, M - списание материальных ценностей)
+  * **guid** - GUID списания
   * **amount** - сумма списания
@@ Строка 140: / Строка 145: @@
   * **last_update_by** - ID пользователя, сделавшего последние изменения
-  * **external_id** - код Списания во внешней системе (например, в 1С)
+  * **external_id** - код Списания во внешней системе (например, в 1С). Значение параметра уникально.
@@ Строка 168: / Строка 173: @@
   * **lot_number** - характеристика (серия, партия и пр) позиции в накладной поступления
+  * **guid** - GUID строки
@@ Строка 175: / Строка 182: @@
 Пример запроса на обновление данных о списании:
- 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
 ==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - идентификатор списания, данные которого нужно обновить
+  * **id** (get only) - идентификатор списания, данные которого нужно обновить
-  * **external_id** - код списания во внешней системе учета (например, в 1С)
+  * **external_id** (get only) - код списания во внешней системе учета (например, в 1С)
-  * **create_if_not_exist** - Если истина, то при неудачном поиске cписание будет добавлено в систему.
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске cписание будет добавлено в систему.
-  * **warehouse_external_id** - код Магазина во внешней системе. Необязательный параметр; если указан, то будет осуществлен поиск Магазина по указанному коду и добавление ссылки на него в документ Списания.
+  * **warehouse_external_id** (get only) - код Магазина во внешней системе. Необязательный параметр; если указан, то будет осуществлен поиск Магазина по указанному коду и добавление ссылки на него в документ Списания.
@@ Строка 219: / Строка 226: @@
 Пример запроса на удаление списания:
- 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
 ==== Параметры запроса ====
+Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - идентификатор списания, которое будет удалено
+  * **id** (get only) - идентификатор списания, которое будет удалено
-  * **external_id** - код списания во внешней системе учета (например, в 1С)
+  * **external_id** (get only) - код списания во внешней системе учета (например, в 1С)
@@ Строка 255: / Строка 262: @@
 Пример запроса на обновление данных о товарной позиции в списании:
- 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) - Если истина, то при неудачном поиске товарная строка будет добавлена в систему.
   * Также в качестве параметров могут быть переданы все поля для строки товарной позиции в списании
@@ Строка 294: / Строка 301: @@
 Пример запроса на удаление товарной строки из документа списания:
- 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) - идентификатор строки товарной позиции Списания, которая будет удалена