Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:writeoff [27.06.2017 12:31] 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** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| * **date** - получение списаний на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | * **date** - получение списаний на определенную дату. Формат: ГГГГММДД. Необязательный параметр. | ||
| Строка 53: | Строка 53: | ||
| <root> | <root> | ||
| <success>1</success> | <success>1</success> | ||
| - | <type>returns</type> | + | <type>writeoff</type> |
| <days_limit>30</days_limit> | <days_limit>30</days_limit> | ||
| <count>2</count> | <count>2</count> | ||
| Строка 68: | Строка 68: | ||
| <comment/> | <comment/> | ||
| <warehouse_external_id/> | <warehouse_external_id/> | ||
| + | <type>G</type> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| <created_date>2017-06-15 04:45:58</created_date> | <created_date>2017-06-15 04:45:58</created_date> | ||
| <created_by/> | <created_by/> | ||
| Строка 82: | Строка 84: | ||
| <amount/> | <amount/> | ||
| <status>draft</status> | <status>draft</status> | ||
| + | <type>G</type> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| <status_name>Черновик</status_name> | <status_name>Черновик</status_name> | ||
| <comment/> | <comment/> | ||
| Строка 102: | Строка 106: | ||
| <expir_date/> | <expir_date/> | ||
| <lot_number/> | <lot_number/> | ||
| + | <guid>803ad8b6-688c-11e7-849d-74d435ee6043</guid> | ||
| </item> | </item> | ||
| </items> | </items> | ||
| Строка 114: | Строка 119: | ||
| **Шапка документа** | **Шапка документа** | ||
| - | * **id** - ID документа поступления | + | * **id** - ID документа списания |
| * **warehouse_id** - ID магазина, на который оформлено списание | * **warehouse_id** - ID магазина, на который оформлено списание | ||
| Строка 124: | Строка 129: | ||
| * **warehouse_external_id** - код Магазина во внешней системе учета (например, в 1С) | * **warehouse_external_id** - код Магазина во внешней системе учета (например, в 1С) | ||
| - | * **amount** - сумма поставки | + | * **type** - тип списания (G - списание товаров, M - списание материальных ценностей) |
| - | * **status** - статус документа поставки (accept – принят, drаft – черновик) | + | * **guid** - GUID списания |
| - | * **created_date** - дата создания документа поступления (может не совпадать с датой документа Поступления) | + | * **amount** - сумма списания |
| - | * **created_by** - ID пользователя, создавшего поступление | + | * **status** - статус документа списания (accept – принят, drаft – черновик) |
| - | * **last_update_date** - дата и время последнего изменения в поступлении | + | * **created_date** - дата создания документа списания (может не совпадать с датой документа Списания) |
| + | |||
| + | * **created_by** - ID пользователя, создавшего списание | ||
| + | |||
| + | * **last_update_date** - дата и время последнего изменения в списании | ||
| * **last_update_by** - ID пользователя, сделавшего последние изменения | * **last_update_by** - ID пользователя, сделавшего последние изменения | ||
| - | * **external_id** - код Поступления во внешней системе (например, в 1С) | + | * **external_id** - код Списания во внешней системе (например, в 1С). Значение параметра уникально. |
| Содержание документа (зависит от настройки загружаемых полей и гибких полей на товарный остаток) | Содержание документа (зависит от настройки загружаемых полей и гибких полей на товарный остаток) | ||
| - | * **line_id** - сквозной ID строки в транзакциях поступлений | + | * **line_id** - сквозной ID строки в транзакциях списаний |
| * **item_id** - ID товарной позиции по номенклатурному справочнику | * **item_id** - ID товарной позиции по номенклатурному справочнику | ||
| Строка 164: | Строка 173: | ||
| * **lot_number** - характеристика (серия, партия и пр) позиции в накладной поступления | * **lot_number** - характеристика (серия, партия и пр) позиции в накладной поступления | ||
| + | |||
| + | * **guid** - GUID строки | ||
| Строка 171: | Строка 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** - Секретный ключ для доступа к данным. Обязательный параметр. | * **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) - код Магазина во внешней системе. Необязательный параметр; если указан, то будет осуществлен поиск Магазина по указанному коду и добавление ссылки на него в документ Списания. |
| Строка 215: | Строка 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** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - идентификатор списания, которое будет удалено | + | * **id** (get only) - идентификатор списания, которое будет удалено |
| - | * **external_id** - код списания во внешней системе учета (например, в 1С) | + | * **external_id** (get only) - код списания во внешней системе учета (например, в 1С) |
| Строка 251: | Строка 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** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - идентификатор товарной строки в поступлении, данные которой нужно обновить | + | * **id** (get only) - идентификатор товарной строки в поступлении, данные которой нужно обновить |
| - | * **create_if_not_exist** - Если истина, то при неудачном поиске товарная строка будет добавлена в систему. | + | * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске товарная строка будет добавлена в систему. |
| * Также в качестве параметров могут быть переданы все поля для строки товарной позиции в списании | * Также в качестве параметров могут быть переданы все поля для строки товарной позиции в списании | ||
| Строка 290: | Строка 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** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - идентификатор строки товарной позиции Списания, которая будет удалена | + | * **id** (get only) - идентификатор строки товарной позиции Списания, которая будет удалена |