Navbar
Search

Документы

Общие сведения

Шаблоны документов

Шаблон - предзаполненный стандартными полями JSON-объект, который затем можно использовать для успешного создания документа. Средствами JSON API можно получать предзаполненные шаблоны документов. Они могут быть предзаполнены как на основе других документов, так и стандартными значениями без связей с другими документами. Для этого, во всех документах, по которым можно получить шаблон, существует специальный ресурс Шаблон документа, адрес которого формируется следующим образом:
https://api.moysklad.ru/api/remap/1.2/entity/<ключевое слово для документа>/new
В тело PUT запроса по данному ресурсу нужно передать метаданные документа, на основе которого будет создан шаблон нового документа, либо просто передать пустое тело запроса. Метаданные должны быть "обернуты" в объект, имя которого есть ключевое слово для документа-основания в JSON API. Для каждого из данных ресурсов есть примеры запросов и ответов.
Шаблон по токену решения. Существуют отличия в полученных шаблонах при авторизации от пользователя или авторизации от токена решения. В шаблоне полученном при авторизации от решения будет отсутствовать поле owner, group, store, organization. Так же будут отличия между шаблонами на основании документов, полученных при авторизации от пользователя или решения.
На данный момент можно получить шаблоны следующих документы на основании других:

Документ Основание, на котором он может быть создан
Cчет покупателю (invoiceout) Заказ покупателя (customerorder),
Отгрузка (demand)
Возврат покупателя (salesreturn) Отгрузка (demand),
Розничная продажа (retaildemand)
Возврат поставщику (purchasereturn) Приемка (supply)
Входящий платеж (paymentin) Заказ покупателя (customerorder),
Возврат поставщику (purchasereturn),
Отгрузка (demand),
Счет покупателю (invoiceout),
Полученный отчет комиссионера (commissionreportin)
Заказ на производство (processingorder) Техкарта (processingplan)
Заказ поставщику (purchaseorder) Внутренний заказ (internalorder),
Заказ покупателя (customerorder)
Исходящий платеж (paymentout) Возврат покупателя (salesreturn),
Приемка (supply),
Счет поставщика (invoicein),
Заказ поставщику (purchaseorder),
Выданный отчет комиссионера (commissionreportout)
Оприходование (enter) Инвентаризация(inventory)
Отгрузка (demand) Заказ покупателя (customerorder),
Счет покупателю (invoiceout)
Перемещение (move) Внутренний заказ (internalorder),
Заказ покупателя (customerorder)
Приходный ордер (cashin) Заказ покупателя (customerorder),
Возврат поставщику (purchasereturn),
Отгрузка (demand),
Счет покупателю (invoiceout),
Полученный отчет комиссионера (commissionreportin)
Расходный ордер (cashout) Возврат покупателя (salesreturn),
Приемка (supply),
Счет поставщика (invoicein),
Заказ поставщику (purchaseorder),
Выданный отчет комиссионера (commissionreportout)
Розничная продажа (retaildemand) Розничная смена (retailshift),
Заказ покупателя (customerorder)
Розничный возврат (retailsalesreturn) Розничная смена (retailshift),
Розничная продажа (retaildemand)
Выплата денег (retaildrawercashout) Розничная смена (retailshift)
Внесение денег (retaildrawercashin) Розничная смена (retailshift)
Списание (loss) Возврат покупателя (salesreturn),
инвентаризация(inventory)
Счет поставщика (invoicein) Заказ поставщику (purchaseorder),
Приемка (supply)
Счет-фактура полученный (facturein) Приемка (supply),
Исходящий платеж (paymentout)
Счет-фактура выданный (factureout) Отгрузка (demand),
Возврат поставщику (purchasereturn),
Входящий платеж (paymentin)
Техоперация (processing) Заказ на производство (processingorder),
Техкарта (processingplan)

В результате PUT запроса по /entity/entityName/new НЕ будет создано нового документа.
Возвращаемый предзаполненный объект является лишь "болванкой" с некоторыми заполненными полями (поля заполняются по той же логике, что и в аналогичной ситуации в основном интерфейсе), облегчающей создание документа. Он не сохраняется в системе. Этот объект затем можно передать в теле запроса на создание соответствующего документа и тогда уже документ будет создан, и связан с документом-основанием.
Если послать на данный ресурс пустое тело запроса, то в итоговом шаблоне будут предзаполнены лишь стандартные поля в т.ч. указанные в настройках пользователя в учетной записи сервиса МойСклад.

В случае если инвентаризация содержит более 500 подходящих позиций, то шаблон списания (loss) и оприходования (entry) будет создан по первым 500 позициям.

С подробностями и примерами по каждому из документов можно ознакомиться в соответствующих разделах документации. Например, для шаблона отгрузки - смотреть в Шаблонах отгрузки

Контекстный поиск для документов

В JSON API можно осуществлять контекстный поиск среди списка сущностей определенного типа по их строковым полям. Для этого используется URI параметр фильтрации search.

Поиск среди документов на соответствие поисковой строке будет осуществлен по следующим полям: + по наименованию (name) + по описанию (description) + по входящему номеру (incomingNumber)

Удаление в корзину

Корзина позволяет избежать риска случайного удаления важных документов. Удаление в корзину доступно только при наличии у сотрудника соответствующих прав, а также настроек компании на использовании корзины.

Пример удаления Приемки в корзину

Response 200 (application/json) Успешное удаление Приемки.

Связи документов

Привязка документов к документам

Для того чтобы привязать к уже существующему документу другой документ нужно передать meta привязываемого документа в коллекцию связанных документов или в единственный документ этого типа. Такие поля присутствуют среди атрибутов документов. В описании сущностей они описаны в секции Связи с другими документами. Для коллекций каждое поле называется как ключевое слово для типов привязываемых документов во множественном числе. Например поле invoicesOut у отгрузок отвечает за связи с счетами покупателю. Если вы хотите привязать к отгрузке счет, в это поле, в составе коллекции, нужно положить meta счета покупателя который вы хотите привязать, Можно привязывать более 1 документа.

Пример привязки 1

Привязка внутреннего заказа к перемещению.

Пример привязки 2

Привязка счета покупателю к отгрузке.

Пример привязки 3

Привязка перемещений к заказу покупателя.

Привязка платежей к документам

К некоторым документам в JSON API могут быть привязаны платежи. Платежи бывают 4-х типов: Входящий платеж, Приходный ордер, Исходящий платеж, Расходный ордер. Документы, к которым могут быть привязаны платежи содержат вложенную коллекцию payments среди атрибутов документа. Платежи в свою очередь содержат коллекцию operations - операции, к которым привязан данный платеж. Для того, чтобы привязать платеж к документу, нужно в запросах на создание/обновление платежа в составе коллекции operations указать meta документа. Документы в этой коллекции могут иметь разный тип, однако это не значит, что к любому документу можно привязать все 4 типа платежей. Валидные типы платежей определяются самим документом, к которому происходит привязка. К примеру к полученному отчету комиссионера можно привязать только входящий платеж или приходный ордер.
В результате привзяки платежа, в составе коллекции operations платежа появится новый объект, указывающий на документ, а в составе коллекции payments у документа, к которому привязывается платеж, появится новый элемент ссылающийся на данный платеж.

Пример привязки платежа 1

Привязка входящего платежа к полученному отчету комиссионера.

Пример привязки платежа 2

Привязка приходного ордера к заказу покупателя.

Валюта в документах

Поле rate содержит объект, представляющий валюту в документах.

Атрибуты объекта валюты

Название Тип Описание
currency Meta Метаданные валюты
Обязательное при ответе Expand
value Float Курс валюты в этом документе (содержится в ответе, если значение курса отлично от 1)

Вместо ссылки на валюту можно получить объект валюты целиком с помощью параметра запроса ?expand=rate.currency.

Пересчет расчетного остатка в инвентаризации

С помощью json api можно пересчитать расчетный остатки в позициях документа "Инвентаризация". В результате, значение поля calculatedQuantity у позиций инвентаризации изменится и документ будет пересохранен.

Пересчет расчетного остатка в инвентаризации

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id инвентаризации.

Пересчитать

Отправить запрос на пересчет расчетных остатков у позиций инвентаризации.

Response 201 (application/json) Успешный запрос. Результат - Пустое тело ответа.

Печать документов

Средствами JSON API можно запрашивать печать документов с помощью шаблонов печатных форм. При запросе на формирование печатной формы сервер (при готовности документа, корректной печатной форме и правильном формате запроса) отвечает пустым телом ответа с http кодом 303. В заголовке Location ответа содержится адрес временного расположения готовой к загрузке печатной формы. Файл во временном расположении доступен для загрузки в течение 5 минут.

Сервер может вернуть ответ 202 и заголовок Location с адресом для опроса готовности печатной формы к загрузке. Данный вариант будет реализован позже.

Печать документа

Запрос на печать

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности, для которой запрашивается печать.
type string (required) Example: demand тип сущности, для которой запрашивается печать.

Запрос на печать отдельного документа по шаблону печатной формы.

Атрибуты запроса

Название Тип Описание
template Meta Метаданные Шаблона печати
Обязательное при ответе
extension String(4) Расширение, в котором нужно напечатать форму. Можно указать xls, pdf, html, ods
Обязательное при ответе

Также можно напечатать комплект документов. Для этого вместо поля template нужно указать поле templates, которое является массивом объектов со следующими полями:

Название Тип Описание
template Meta Метаданные Шаблона печати
Обязательное при ответе
count Int Количество копий печатной формы. От 1 до 10.
Обязательное при ответе

Если в запросе будет как поле templates так и поле template (вне элемента массива templates), произойдет ошибка. В запросе допустимо только 1 из этих полей. При печати комплектов не нужно указывать поле extension - все комплекты печатаются в pdf.

При печати комплекта, для определенных сущностей можно использовать шаблоны для печати связанных документов. Так, например, для отгрузки (demand) можно использовать шаблоны:

для заказа покупателя:

для счета покупателю:

Публикация документов

JSON API позволяет опубликовать для общего пользования печатную форму документа, созданную на основе шаблона печатной формы. Кодом сущности для публикации в составе JSON API является ключевое слово publication.

Работа пользователя с публикациями документов возможна, если есть право на чтение и право печати сущности данного типа.

Публикации доступны только для следующих типов: Заказ покупателя, Счет покупателю, Отгрузка, Заказ поставщику, Счет поставщика, Приемка, Входящий платеж, Приходный ордер, Исходящий платеж, Расходный ордер, Внутренний заказ, Перемещение, Оприходование, Списание, Счет-фактура выданный, Счет-фактура полученный, Возврат поставщику, Возврат покупателя, Выплата денег, Внесение денег, Розничный возврат, Розничная продажа, Договор, Розничная смена, Заказ на производство, Полученный отчет комиссионера, Выданный отчет комиссионера, Инвентаризация, Техоперация.

Публикации

Атрибуты сущности

Название Тип Описание
meta Meta Метаданные Публикации
Обязательное при ответе
template Meta Метаданные Шаблона печати
Обязательное при ответе Expand
href URL Ссылка на страницу Публикации
Обязательное при ответе

Получить публикации

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности, по которой получить Публикации.
type string (required) Example: demand тип сущности, по которой получить Публикации.

Публикация

Создать публикацию

Запрос на публикацию документа. Публикация документа происходит на основании переданного объекта JSON, который должен содержать ссылку на шаблона для печати документа template в формате Метаданных. Если публикация была ранее создана, то ответ будет со статусом 200.

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности, по которой получить Публикации.
type string (required) Example: demand тип сущности, по которой получить Публикации.

Удалить публикацию

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности.
publicationId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Публикации.
type string (required) Example: demand тип сущности.

Response 204 (application/json) Успешное удаление Публикации.

Получить публикацию

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности.
publicationId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Публикации.
type string (required) Example: demand тип сущности.

Автозаполнение

Средствами JSON API можно рассчитать значение скидок, цен и ндс для позиций следующих документов:

Заполнение скидок не поддерживает следующие типы:

Заполнение цен не поддерживает Инвентаризация

Заполнение себестоимости поддерживается только для возвратов без основания следующих типов: - Возврат покупателя - Розничный возврат

Шаблон автозаполнения

Атрибуты сущности

Атрибуты сущности нужно передавать в зависимости от типа документа, для которого будет выполнено автозаполнение. В соответствие с типом, будут обрабатываться соответствующие поля.

Ниже приводятся поля, которые влияют на заполнение скидок, цен, ндс и себестоимости.

При этом, если помимо вышеперечисленных полей были добавлены другие, не влияющие на заполнение, то они будут присутствовать в ответе в том же порядке и с теми же значениями.

Примечания

Значения параметра action можно передавать через запятую.

Если в документе не используется поле agent, то для расчета цен evaluate_price и скидок evaluate_discount используется значение поля organization.

Позиции документа

Позиции в шаблоне - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции содержит следующие поля:

Запрос автозаполения

Запрос заполения полей шаблона. Результат: Объект JSON, с заполненным шаблоном.

Параметры

Параметр Описание
action enum (optional) Example: evaluate_discount, evaluate_price, evaluate_discount Определяет какую информацию нужно заполнить: цены (evaluate_price), ндс (evaluate_vat), скидки (evaluate_discount) или себестоимость (evaluate_cost). Допустимые значения: evaluate_price, evaluate_discount, evaluate_vat, evaluate_cost.

Запрос автозаполения цен

Запрос автозаполения с параметром action со значением evaluate_price. Требуется заполнение поля agent (или organization, если поле agent отсутствует). Заполняет поле цены товара price (если явно не передано) ценой переданного в поле agent контрагента, а также поле discountedPrice, с учетом рассчитанной или переданной скидки discount (принимается за 0, если значение отсутствует) и НДС vat (не учитывается, если пустое, поле vatEnabled имеет значение false или vatIncluded имеет значение true). Если передано поле quantity, то будет рассчитано поле sum. При вычислениях используется переданный rate.

Запрос автозаполения скидок

Запрос автозаполения с параметром action со значением evaluate_discount. Требуется заполнение поля agent (или organization, если поле agent отсутствует). Заполняет поле скидки discount (если явно не передано) суммой применимых к данному товару активных скидок переданного в поле agent контрагента.

Запрос автозаполения НДС

Запрос автозаполения с параметром action со значением evaluate_vat. Требуется заполнение поля organization. Заполняет поле vatEnabled на основе того, является ли переданная в поле organization организация плательщиком НДС и поля vat у позиций значением из карточки товара, если организация - плательщик НДС.

Запрос автозаполения себестоимости

Запрос автозаполения с параметром action со значением evaluate_cost. Выполняется только для Возвратов Покупателя и Розничных Возвратов без основания. Требуется заполнение поля store. Заполняет поля cost у позиций значением себестоимости, рассчитанным по FIFO на момент moment. Если поле moment не указано, то себестоимость рассчитывается на текущую дату.

Внесение денег

Средствами JSON API можно создавать и обновлять сведения о Внесениях денег, запрашивать списки Внесений денег и сведения по отдельным Внесениям денег. Кодом сущности для Внесения денег в составе JSON API является ключевое слово retaildrawercashin. Больше о Внесениях денег и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Внесения денег

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Внесения денег
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Внесения денег
externalCode String(255) = != ~ ~= =~ Внешний код Внесения денег
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Внесения денег
Обязательное при ответе Только для чтения
meta Meta Метаданные Внесения денег
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Внесения денег
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Внесения денег
Expand
sum Int = != < > <= >= Сумма Внесения денег в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Внесения денег
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
retailShift Ссылка на розничную смену, в рамках которой было выполнено Внесение денег в формате Метаданных. По данному полю можно фильтровать используя операторы = и !=. Необходимое

Получить Внесения денег

Запрос на получение всех Внесений денег на данной учетной записи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Внесение денег

Запрос на создание Внесения денег. Обязательные для создания поля:

Массовое создание и обновление Внесений денег

Массовое создание и обновление Внесений денег. В теле запроса нужно передать массив, содержащий JSON представления Внесений денег, которые вы хотите создать или обновить. Обновляемые Внесения денег должны содержать идентификатор в виде метаданных.

Удалить Внесение денег

Запрос на удаление Внесения денег с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внесения денег.

Response 200 (application/json) Успешный запрос.

Массовое удаление Внесений денег

В теле запроса нужно передать массив, содержащий JSON метаданных Внесений денег, которые вы хотите удалить.

Метаданные Внесений денег

Метаданные Внесений денег

Запрос на получение метаданных Внесений денег. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Внесений денег
attributes Массив объектов доп. полей Внесений денег в формате Метаданных
states Массив статусов Внесений денег
createShared создавать новые Внесения денег с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Шаблон Внесения денег

Шаблон Внесения денег

Шаблон Внесения денег на основе

Запрос на получение предзаполненного Внесения денег на основе розничной смены. В результате запроса, будет создан предзаполненный шаблон Внесения денег на основе переданной розничной смены.
Внимание! Не забывайте, что поле retailShift должно быть написано с большой S.

Внесение денег

Получить Внесение денег

Изменить Внесение денег

Запрос на обновление Внесения денег.

Внутренний заказ

Средствами JSON API можно создавать и обновлять сведения о Внутренних заказах, запрашивать списки Внутренних заказов и сведения по отдельным Внутренним заказам. Позициями Внутренних заказов можно управлять как в составе отдельного заказа, так и с помощью специальных ресурсов для управления позициями. Кодом сущности для Внутреннего заказа в составе JSON API является ключевое слово internalorder.

Внутренние заказы

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Только для чтения
code String(255) = != ~ ~= =~ Код Внутреннего заказа
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Внутреннего заказа
Только для чтения
deliveryPlannedMoment DateTime Планируемая дата приемки
description String(4096) = != ~ ~= =~ Комментарий Внутреннего заказа
externalCode String(255) = != ~ ~= =~ Внешний код Внутреннего заказа
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Внутреннего заказа
Обязательное при ответе Только для чтения
meta Meta Метаданные Внутреннего заказа
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
moves Array(Object) Коллекция метаданных на связанные заказы перемещения
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Внутреннего заказа
Обязательное при ответе Необходимо при создании
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Внутреннего заказа
Обязательное при ответе Только для чтения Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
purchaseOrders Array(Object) Коллекция метаданных на связанные заказы поставщику
Обязательное при ответе
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе Только для чтения
state Meta = != Метаданные статуса Внутреннего заказа
Expand
store Meta Метаданные склада
Expand
sum Int = != < > <= >= Сумма Внутреннего заказа в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Внутреннего заказа
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения

Позиции Внутреннего заказа

Позиции Внутреннего заказа - это список товаров/услуг/модификаций/серий. Объект позиции Внутреннего заказа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Внутреннего заказа, а также в составе отдельного Внутреннего заказа. При работе в составе отдельного Внутреннего заказа, вы можете отправлять запросы на создание отдельного Внутреннего заказа с включенным в тело запроса массивом позиций Внутреннего заказа. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Внутреннего заказа". Также, при работе в составе отдельного Внутреннего заказа, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Внутреннего заказа. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Внутреннего заказа" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Внутренних заказов можно прочитать здесь

Получить Внутренние заказы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Внутренний заказ

Запрос на создание нового Внутреннего заказа. Обязательные для создания поля:

Шаблон Внутреннего заказа

Шаблон Внутреннего заказа

Запрос на получение шаблона Внутреннего заказа.

Массовое создание и обновление Внутренних заказов

Массовое создание и обновление Внутренних заказов. В теле запроса нужно передать массив, содержащий JSON представления Внутренних заказов, которые вы хотите создать или обновить. Обновляемые Внутренние заказы должны содержать идентификатор в виде метаданных.

Удалить Внутренний заказ

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.

Response 200 (application/json) Успешное удаление Внутреннего заказа.

Массовое удаление Внутренних заказов

В теле запроса нужно передать массив, содержащий JSON метаданных Внутренних заказов, которые вы хотите удалить.

Метаданные Внутренних заказов

Метаданные Внутренних заказов

Запрос на получение метаданных Внутренних заказов. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Внутренних заказов
attributes Массив объектов доп. полей Внутренних заказов в формате Метаданных
states Массив статусов Внутренних заказов
createShared создавать новые Внутренние заказы с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Внутренний заказ

Получить Внутренний заказ

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.

Изменить Внутренний заказ

Запрос на обновление Внутреннего заказа с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.

Позиции Внутреннего заказа

Отдельный ресурс для управления позициями Внутреннего заказа. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Внутреннего заказа

Запрос на получение списка всех позиций данного Внутреннего заказа.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Внутреннего заказа.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать позиции Внутреннего заказа

Запрос на создание новой позиции во Внутреннем заказе. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.

Позиция Внутреннего заказа

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции Внутреннего заказа.

Изменить позицию

Запрос на обновление отдельной позиции Внутреннего заказа.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции Внутреннего заказа.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Внутреннего заказа.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Внутреннего заказа.

Response 200 (application/json) Успешное удаление позиции Внутреннего заказа.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 7623cd58-684d-11ee-ac12-000c0000009e id Внутреннего заказа.

Response 200 (application/json) Успешное удаление позиций Внутреннего заказа.

Возврат покупателя

Средствами JSON API можно создавать и обновлять сведения о Возвратах покупателей, запрашивать списки Возвратов покупателей и сведения по отдельным Возвратам покупателей. Позициями Возвратов покупателей можно управлять как в составе отдельного Возврата, так и отдельно - с помощью специальных ресурсов для управления позициями Возврата покупателя. Кодом сущности для Возврата покупателя в составе JSON API является ключевое слово salesreturn.

Возвраты покупателей

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Change-handler
agentAccount Meta Метаданные счета контрагента
Expand Change-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта Change-handler
code String(255) = != ~ ~= =~ Код Возврата Покупателя
contract Meta = != Метаданные договора
Expand Change-handler
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Возврата Покупателя
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Возврата Покупателя
Change-handler
externalCode String(255) = != ~ ~= =~ Внешний код Возврата Покупателя
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Возврата Покупателя
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Возврата Покупателя
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler
name String(255) = != ~ ~= =~ Наименование Возврата Покупателя
Обязательное при ответе Change-handler
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler
organizationAccount Meta Метаданные счета юрлица
Expand Change-handler
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Возврата Покупателя
Обязательное при ответе Expand Change-handler
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Возврата Покупателя
Expand Change-handler
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании Change-handler
sum Int = != < > <= >= Сумма Возврата Покупателя в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Возврата Покупателя
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler
vatIncluded Boolean Включен ли НДС в цену Change-handler
vatSum Float Сумма НДС
Обязательное при ответе Change-handler

Связи с другими документами

Название Описание
demand Ссылка на отгрузку, по которой произошел возврат в формате Метаданных Поле является необходимым для возврата с основанием.
losses Массив ссылок на связанные списания в формате Метаданных
payments Массив ссылок на связанные платежи в формате Метаданных
payedSum Сумма исходящих платежей по возврату покупателя
factureOut Ссылка на Счет-фактуру выданный, с которым связан этот возврат, в формате Метаданных

Позиции Возврата покупателя

Позиции Возврата покупателей - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Возврата покупателей содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации/комплекта, которую представляет собой позиция
Обязательное при ответе Expand Change-handler
cost Int Себестоимость (выводится, если документ был создан без основания)
country Meta Метаданные Страны
Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler
gtd Object ГТД. Подробнее тут
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler
slot Meta Ячейка на складе. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Возврата покупателей, а также в составе отдельного Возврата покупателей. При работе в составе отдельного Возврата покупателей, вы можете отправлять запросы на создание отдельного Возврата покупателей с включенным в тело запроса массивом позиций Возврата покупателей. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Возврата покупателей". Также, при работе в составе отдельного Возврата покупателей, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Возврата покупателей. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Возврата покупателей" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Возвратов покупателейых возвратов можно прочитать здесь

Получить Возвраты покупателей

Запрос всех Возвратов покупателей на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Возвраты покупателей.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Возврат покупателя

Обязательные поля при создании нового Возврата покупателей:

При создании возврата:

Массовое создание и обновление Возвратов покупателя

Массовое создание и обновление Возвратов покупателя. В теле запроса нужно передать массив, содержащий JSON представления Возвратов покупателя, которые вы хотите создать или обновить. Обновляемые Возвраты покупателя должны содержать идентификатор в виде метаданных.

Удалить Возврат покупателя

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.

Response 200 (application/json) Успешное удаление Возврата покупателей.

Массовое удаление Возвратов покупателей

В теле запроса нужно передать массив, содержащий JSON метаданных Возвратов покупателей, которые вы хотите удалить.

Метаданные Возвратов покупателей

Метаданные Возвратов покупателей

Запрос на получение метаданных Возвратов покупателей. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Возвратов покупателей
attributes Массив объектов доп. полей Возвратов покупателей в формате Метаданных
states Массив статусов Возвратов покупателей
createShared создавать новые Возвраты покупателей с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Возврата покупателя

Шаблон Возврата покупателя

Запрос на получение предзаполненого стандартными значениями шаблона возврата покупателя без связи с каким-либо документом.

Шаблон Возврата покупателя на основе

Запрос на получение предзаполненного шаблона возврата покупателя на основе переданной отгрузки. В ответ на запрос вернется предзаполненный шаблон возврата покупателя, который затем можно будет использовать для создания нового возврата с помощью POST запроса.

Возврат покупателя

Получить Возврат покупателя

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.

Изменить Возврат покупателя

Запрос на обновление Возврата покупателей с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Возврата покупателей, кроме тех, что помечены Только для чтения в описании атрибутов Возврата покупателей. При обновлении поля organization нужно также обновить поле organizationAccount иначе произойдет ошибка. Контрагент должен совпадать с контрагентом, указанным в документе, по которому создается возврат.

При обновлении возврата:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.

Позиции возврата покупателя

Отдельный ресурс для управления позициями Возврата покупателей. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить Позиции

Запрос на получение списка всех позиций данной Возврата покупателей.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Возврата покупателей.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Позицию

Запрос на создание новой позиции в Возврате покупателя. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.

Позиция Возврата покупателя

Получить Позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата покупателей.

Изменить Позицию

Запрос на обновление отдельной позиции Возврата покупателей. При обновлении отдельной позиции в возврате можно только изменить количество данной позиции. Причем это количество должно быть в пределах , где n - кол-во данной позиции в документе, по которому создан возврат.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата покупателей.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата покупателей.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата покупателей.

Response 200 (application/json) Успешное удаление позиции Возврата покупателей.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Возврата покупателей

Response 200 (application/json) Успешное удаление позиций Возврата покупателей.

Возврат поставщику

Средствами JSON API можно создавать и обновлять сведения о Возвратах поставщикам, запрашивать списки Возвратов поставщикам и сведения по отдельным Возвратам поставщикам. Позициями Возвратов поставщикам можно управлять как в составе отдельного Возврата, так и отдельно - с помощью специальных ресурсов для управления позициями Возврата поставщику. Кодом сущности для Возврата поставщику в составе JSON API является ключевое слово purchasereturn.

Возвраты поставщикам

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Возврата поставщику
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Возврата поставщику
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Возврата поставщику
externalCode String(255) = != ~ ~= =~ Внешний код Возврата поставщику
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Возврата поставщику
Обязательное при ответе Только для чтения
meta Meta Метаданные Возврата поставщику
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Возврата поставщику
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Возврата поставщику
Expand
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании
sum Int = != < > <= >= Сумма Возврата поставщику в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Возврата поставщику
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе

Связи с другими документами

Название Описание
positions Ссылка на позиции Возврата поставщику в формате Метаданных
supply Ссылка на приемку, по которой произошел возврат в формате Метаданных Поле является необходимым для возврата с основанием.
factureOut Ссылка на Счет-фактуру выданный в формате Метаданных
factureIn Ссылка на Счет-фактуру полученный в формате Метаданных
payedSum Сумма входящих платежей по возврату поставщику
payments Массив ссылок на связанные платежи в формате Метаданных

Позиции Возврата поставщику

Позиции Возврата поставщику - это список товаров/услуг/модификаций/серий. Объект позиции Возврата поставщику содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
slot Meta Ячейка на складе. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.

С позициями можно работать с помощью специальных ресурсов для управления позициями Возврата поставщику, а также в составе отдельного Возврата поставщику. При работе в составе отдельного Возврата поставщику, вы можете отправлять запросы на создание отдельного Возврата поставщику с включенным в тело запроса массивом позиций Возврата поставщику. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Возврата поставщику". Также, при работе в составе отдельного Возврата поставщику, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Возврата поставщику. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Возврата поставщику" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Возвратов поставщикамых возвратов можно прочитать здесь

Получить Возвраты поставщикам

Запрос всех Возвратов поставщикам на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Возвраты поставщикам.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Возврат поставщику

Обязательные поля при создании нового Возврата поставщику: + organization - Ссылка на ваше юрлицо в формате Метаданных + store - Ссылка на склад в формате Метаданных + supply - Ссылка на приемку, по которой произошел возврат в формате Метаданных, обязательное поле только для возврата по основанию + agent - Ссылка на контрагента в формате Метаданных Контрагент, указанный в запросе на создание возврата, должен совпадать с контрагентом, указанном в документе, по которому создается возврат.

При создании возврата: + При создании возврата без основания поле supply указывать не нужно + Контрагент в возврате и в документе, по которому он создается, должны совпадать + Валюта и юрлицо в возврате и в документе так же должны совпадать + При передаче коллекции positions в теле запроса на создание возврата, передаваемые позиции должны соответствовать позициям в документе. Различие может быть только в количестве товара в позиции (меньшее либо равное количеству в документе). Нельзя передать позиции, которых нет в документе.

Массовое создание и обновление Возвратов поставщику

Массовое создание и обновление Возвратов поставщику. В теле запроса нужно передать массив, содержащий JSON представления Возвратов поставщику, которые вы хотите создать или обновить. Обновляемые Возвраты поставщику должны содержать идентификатор в виде метаданных.

Удалить Возврат поставщику

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.

Response 200 (application/json) Успешное удаление Возврата поставщику.

Массовое удаление Возвратов поставщикам

В теле запроса нужно передать массив, содержащий JSON метаданных Возвратов поставщикам, которые вы хотите удалить.

Метаданные Возвратов поставщикам

Метаданные Возвратов поставщикам

Запрос на получение метаданных Возвратов поставщикам. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Возвратов поставщикам
attributes Массив объектов доп. полей Возвратов поставщикам в формате Метаданных
states Массив статусов Возвратов поставщикам
createShared создавать новые Возвраты поставщикам с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Возврата поставщику

Шаблон Возврата поставщику

Запрос на получение предзаполненого стандартными значениями шаблона возврата поставщику без связи с каким-либо документом.

Шаблон Возврата поставщику на основе

Запрос на получение предзаполненного шаблона возврата поставщику на основе переданной приемки. В ответ на запрос вернется предзаполненный шаблон возврата поставщику, который затем можно будет использовать для создания нового возврата с помощью POST запроса.

Возврат поставщику

Получить Возврат поставщику

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.

Изменить Возврат поставщику

Запрос на обновление Возврата поставщику с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Возврата поставщику, кроме тех, что помечены Только для чтения в описании атрибутов Возврата поставщику. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка. Контрагент должен совпадать с контрагентом, указанным в документе, по которому создается возврат.

При обновлении возврата:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.

Позиции Возврата поставщику

Отдельный ресурс для управления позициями Возврата поставщику. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить Позиции

Запрос на получение списка всех позиций данной Возврата поставщику.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Возврата поставщику.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Позицию

Запрос на создание новой позиции в Возврате поставщику. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.

Позиция Возврата поставщику

Получить Позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.
positionIDv string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата поставщику.

Изменить Позицию

Запрос на обновление отдельной позиции Возврата поставщику. При обновлении отдельной позиции в возврате можно только изменить количество данной позиции. Причем это количество должно быть в пределах , где n - кол-во данной позиции в документе, по которому создан возврат.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата поставщику.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата поставщику.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата поставщику.

Response 200 (application/json) Успешное удаление позиции Возврата поставщику.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Возврата поставщика

Response 200 (application/json) Успешное удаление позиций Возврата поставщика.

Возврат предоплаты

Возврата предоплаты

Средствами JSON API можно запрашивать списки Возвратов предоплат и сведения по отдельным Возвратам предоплат. Кодом сущности для Возврата предоплаты в составе JSON API является ключевое слово prepaymentreturn.

По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов предоплат на соответствие поисковой строке будет осуществлён по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
cashSum Float Оплачено наличными
Обязательное при ответе
code String(255) = != ~ ~= =~ Код Возврата предоплаты
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Возврата предоплаты
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Возврата предоплаты
externalCode String(255) = != ~ ~= =~ Внешний код Возврата предоплаты
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Возврата предоплаты
Обязательное при ответе Только для чтения
meta Meta Метаданные Возврата предоплаты
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Возврата предоплаты
Обязательное при ответе
noCashSum Float Оплачено картой
Обязательное при ответе
organization Meta = != Метаданные юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Возврата предоплаты
Обязательное при ответе Expand
prepayment Meta Метаданные Предоплаты
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
qrSum Float Оплачено по QR-коду
Обязательное при ответе
rate Object Валюта. Подробнее тут
Обязательное при ответе
retailShift Meta = != Метаданные Розничной смены
Обязательное при ответе Expand Необходимо при создании
retailStore Meta = != Метаданные Точки продаж
Обязательное при ответе Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Возврата предоплаты
Expand
sum Int = != < > <= >= Сумма Возврата предоплаты в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
taxSystem Enum Код системы налогообложения. Подробнее тут
updated DateTime = != < > <= >= Момент последнего обновления Возврата предоплаты
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент

Позиции Возврата предоплаты

Позиции Возврата предоплаты - это список товаров/услуг/модификаций/серий. Объект позиции Возврата предоплаты содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Int Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

Атрибуты доступные для фильтрации

Значение Описание
agent Ссылка на контрагента
applicable Отметка о проведении
created Дата создания
deleted Момент последнего удаления сущности
description Комментарий Предоплаты
externalCode Внешний код Предоплаты
group Отдел сотрудника
id ID в формате UUID
isDeleted Удалена ли Предоплата
moment Дата Предоплаты
name номер Предоплаты
organization Ссылка на ваше юрлицо
owner Ссылка на Владельца (Сотрудника)
shared Общий доступ
state Статус Предоплаты
sum Сумма Предоплаты в установленной валюте
syncId ID синхронизации
updated Момент последнего обновления сущности
updatedBy Автор последнего обновления сущности в формате uid (admin@admin)

Атрибуты доступные для сортировки

Значение Описание
applicable Отметка о проведении
created Дата создания
description Комментарий Предоплаты
externalCode Внешний код Предоплаты
id ID в формате UUID
moment Дата Предоплаты
name номер Предоплаты
sum Сумма Предоплаты в установленной валюте
syncId ID синхронизации
updated Момент последнего обновления сущности

Получить список Возвратов предоплаты [GET]

Запрос всех Возвратов предоплат на данной учётной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Возвраты предоплат.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Метаданные Возвратов предоплат

Метаданные Возвратов предоплат

Запрос на получение метаданных Возвратов предоплат. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Возвратов предоплат
attributes Массив объектов доп. полей Возвратов предоплат в формате Метаданных
states Массив статусов Возвратов предоплат
createShared создавать новые Возвраты предоплат с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Отдельное доп. поле

Возврат предоплаты

Получить Возврат предоплаты [GET]

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата предоплаты.

Удалить Возврат предоплаты

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата предоплаты.

Response 200 (application/json) Успешное удаление Возврата предоплаты.

Позиции Возврата предоплаты

Отдельный ресурс для управления позициями Возврата предоплаты. С его помощью вы можете запросить позиции большого документа, количество строк в котором превышает лимит на количество строк в выдаче документа. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Возврата предоплаты

Запрос на получение списка всех позиций данного Возврата предоплаты.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Возврата предоплаты.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата предоплаты.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Возврата предоплаты

Отдельная позиция Возврата предоплаты с указанным id позиции.

Получить позицию Возврата предоплаты

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Возврата предоплаты.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Возврата предоплаты.

Входящий платеж

Входящие платежи

Средствами JSON API можно создавать и обновлять сведения о платеже , запрашивать списки Входящих платежей и сведения по отдельным Входящим платежам. Кодом сущности для Входящего платежа в составе JSON API является ключевое слово paymentin. Больше о платежах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Входящего платежа
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Входящего платежаа
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Входящего платежа
externalCode String(255) = != ~ ~= =~ Внешний код Входящего платежа
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Входящего платежа
Обязательное при ответе Только для чтения
incomingDate DateTime = != < > <= >= Входящая дата
incomingNumber Int = != ~ ~= =~ Входящий номер
meta Meta Метаданные Входящего платежа
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Входящего платежа
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
paymentPurpose String(255) = != ~ ~= =~ Назначение платежа
Обязательное при ответе
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
salesChannel Meta = != Метаданные канала продаж
Expand
state Meta = != Метаданные статуса Входящего платежа
Expand
sum Int = != < > <= >= Сумма Входящего платежа в установленной валюте
Обязательное при ответе
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Входящего платежа
Обязательное при ответе Только для чтения
vatSum Float Сумма НДС
Обязательное при ответе

Связи с другими документами

Название Описание
factureOut Ссылка на Счет-фактуру выданный, с которым связан этот платеж в формате Метаданных
operations Массив ссылок на связанные операции в формате Метаданных

Разрешенные типы связанных операций:

О работе с доп. полями Входящих платежей можно прочитать здесь

Получить Входящие платежи

Запрос всех Входящих платежей на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Входящие платежи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Входящий платеж

Запрос на создание нового Входящего платежа. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента в формате Метаданных

Массовое создание и обновление Входящих платежей

Массовое создание и обновление Входящих платежей. В теле запроса нужно передать массив, содержащий JSON представления Входящих платежей, которые вы хотите создать или обновить. Обновляемые Входящие платежи должны содержать идентификатор в виде метаданных.

Удалить Входящий платеж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Входящего платежа.

Response 200 (application/json) Успешное удаление Входящего платежа.

Массовое удаление Входящих платежей

В теле запроса нужно передать массив, содержащий JSON метаданных Входящих платежей, которые вы хотите удалить.

Метаданные Входящих платежей

Метаданные Входящих платежей

Запрос на получение метаданных Входящих платежей. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Входящих платежей
attributes Массив объектов доп. полей Входящих платежей в формате Метаданных
states Массив статусов Входящих платежей
createShared создавать новые Входящие платежи с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Входящего платежа

Шаблон Входящего платежа

Шаблон Входящего платежа на основе

Запрос на получение предзаполненного входящего платежа на основе другого документа. В результате запроса, будет создан предзаполненный шаблон входящего платежа на основе переданного документа.

Входящий платеж

Получить Входящий платеж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Входящего платежа.

Изменить Входящий платеж

Запрос на обновление Входящего платежа с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Входящего платежа, кроме тех, что помечены Только для чтения в описании атрибутов Входящего платежа. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.
Для привязки входящего платежа к другим документам нужно положить в поле под именем operations все meta тех документов, к которым вы хотите привязать финансовую операцию. Также для каждого документа можно указать cумму, оплаченную по данному документу из этого платежа linkedSum.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Входящего платежа.

Вывод кодов маркировки из оборота

Вывод из оборота

Средствами JSON API можно создавать и обновлять сведения о Выводе кодов маркировки из оборота, а также запрашивать списки документов и информацию о конкретных Выводах. Позициями можно управлять как в составе документа Вывода, так и отдельно - с помощью специальных ресурсов для управления позициями. Кодом сущности для Вывода из оборота в составе JSON API является ключевое слово retireorder. Больше о Выводах кодов из оборота можно прочитать здесь.

Тарифные ограничения

Для создания/изменения Вывода из оборота необходима тарифная опция Маркировка для аккаунтов из RU региона и расширение Честный знак для остальных регионов.

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
agent Meta Метаданные контрагента
Expand
code String(255) Код Вывода из оборота
created DateTime Дата создания
Обязательное при ответе Только для чтения
deleted DateTime Момент последнего удаления Вывода из оборота
Только для чтения
description String(4096) Комментарий Вывода из оборота
destinationCountry Meta Страна назначения
documentState Enum Статус процесса вывода кодов маркировки из оборота. Подробнее тут
Обязательное при ответе Только для чтения
externalCode String(255) Внешний код Вывода из оборота
Обязательное при ответе
group Meta Отдел сотрудника
Обязательное при ответе Expand
id UUID ID Вывода из оборота
Обязательное при ответе Только для чтения
meta Meta Метаданные Вывода из оборота
Обязательное при ответе
moment DateTime Дата документа
Обязательное при ответе
name String(255) Наименование Вывода из оборота
Обязательное при ответе
organization Meta Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Вывода из оборота
Обязательное при ответе Expand
primaryDocumentName String(255) Наименование первичного документа
printed Boolean Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
retireOrderType Enum Способ вывода из оборота. Подробнее тут
Обязательное при ответе Необходимо при создании
shared Boolean Общий доступ
Обязательное при ответе
state Meta Метаданные статуса Вывода из оборота
Expand
stateContractId String(255) Идентификатор государственного контракта, договора (соглашения)
supportingTransaction Enum Тип документа-основания. Подробнее тут
supportingTransactionDate DateTime Дата документа-основания
supportingTransactionNumber String(255) Номер документа-основания
syncId UUID ID синхронизации. После заполнения недоступен для изменения
trackingType Enum Тип маркируемой продукции. Подробнее тут
Обязательное при ответе Необходимо при создании
updated DateTime Момент последнего обновления Вывода из оборота.
Обязательное при ответе Только для чтения
sum Int Сумма вывода из оборота в установленной валюте
Обязательное при ответе
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Только для чтения

Статусы процесса вывода кодов маркировки из оборота

Значения поля documentState. Статус IN_PROGRESS, WAIT_FOR_CONTINUATION, CHECKED_OK, CHECKED_NOT_OK, PROCESSING_ERROR берутся из Честного знака.

Значение Описание
CREATED Вывод из оборота создан, но не отправлен в Честный знак
SEND Запрос на вывод из оборота отправлен в Честный знак
IN_PROGRESS Проверяется
WAIT_FOR_CONTINUATION Проверяется
CHECKED_OK Обработан Честным знаком
CHECKED_NOT_OK Обработан Честным знаком с ошибками
PROCESSING_ERROR Техническая ошибка на стороне Честного знака
UNDEFINED Состояние не определяется

Тип маркируемой продукции

Значения поля trackingType.

Значение Описание
BEER_ALCOHOL Пиво и слабоалкогольная продукция
BICYCLE Велосипеды
ELECTRONICS Фотокамеры и лампы-вспышки
FOOD_SUPPLEMENT Биологически активные добавки к пище
LP_CLOTHES Тип маркировки "Одежда"
LP_LINENS Тип маркировки "Постельное белье"
MEDICAL_DEVICES Медизделия и кресла-коляски
MILK Молочная продукция
PERFUMERY Духи и туалетная вода
SANITIZER Антисептики
SEAFOOD Икра и морепродукты
SHOES Тип маркировки "Обувь"
SOFT_DRINKS Безалкогольные напитки
TIRES Шины и покрышки
VETPHARMA Ветеринарные препараты
WATER Упакованная вода

Способ вывода из оборота

Значения поля retireOrderType.

Значение Описание
BY_SAMPLES Продажа по образцам
CONFISCATE_SALE Конфискация
DAMAGE_AND_LOSS Утрата
DESTRUCTION Уничтожение
DISTANCE Дистанционная продажа
DONATION Безвозмездная передача
EXPIRATION Истечение срока годности
EXPORT_INSIDE_EEU Трансграничная продажа в страны ЕАЭС
EXPORT_OUTSIDE_EEU Экспорт за пределы стран ЕАЭС
MEDICAL_USE Использование для медицинского применения
MISMATCH Пересортица по кодам
OWN_USE Использование для собственных нужд
PACKING Фасовка
PRODUCTION_USE Использование для производственных целей
RETAIL_SALE Розничная продажа
RETURN_TO_INDIVIDUAL Возврат физическому лицу
STATE_CONTRACT Продажа по государственному (муниципальному) контракту
UTILIZATION Утилизация
VENDING Продажа через вендинговый аппарат

Тип документа-основания

Значения поля supportingTransaction

Значение Описание
CERTIFICATE_OF_DESTRUCTION Акт уничтожения (утраты/утилизации)
CONSIGNMENT_NOTE Товарная накладная
CUSTOMS_DECLARATION Таможенная декларация на товары
OTHER Прочее
RECEIPT Кассовый чек
SALES_RECEIPT Товарный чек
UTD Универсальный передаточный документ

Позиции Вывода из оборота

Позиции Вывода из оборота - это список товаров/модификаций/серий. Объект позиции Вывода из оборота содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/серии/модификации, которую представляет собой позиция
Обязательное при ответе Необходимо при создании Expand Change-handler
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
price Float Цена товара в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров данного вида в позиции
Обязательное при ответе Change-handler
trackingCodes Array(Object) Коды маркировки товаров. Подробнее тут
Обязательное при ответе Необходимо при создании
vat Boolean НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler Update-provider
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler Update-provider

С позициями можно работать с помощью специальных ресурсов для управления позициями Вывода из оборота, а также в составе отдельного Вывода из оборота. При работе в составе отдельного Вывода из оборота, вы можете отправлять запросы на создание отдельного Вывода из оборота с включенным в тело запроса массивом позиций Вывода из оборота. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Вывода из оборота". Также, при работе в составе отдельного Вывода из оборота, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Вывода из оборота. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Вывода из оборота" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

Получить Выводы из оборота

Запрос всех Выводов из оборота на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Выводы из оборота.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Вывод из оборота

Получить Вывод из оборота

Параметры

Параметр Описание
id string (required) Example: b14bcb5e-3b17-4765-87cf-bc4569fc5f32 id Вывода из оборота.

Создать Вывод из оборота

Запрос на создание нового Вывода из оборота.

Обязательные для создания поля:

Особенности поведения при создании Вывода из оборота

Связь допустимых значений поля retireOrderType в зависимости от trackingType

trackingType retireOrderType
SHOES, LP_CLOTHES, LP_LINENS, PERFUMERY, ELECTRONICS, TIRES RETAIL_SALE, BY_SAMPLES, DISTANCE, CONFISCATE_SALE, DESTRUCTION, EXPORT_OUTSIDE_EEU, EXPORT_INSIDE_EEU, OWN_USE, DAMAGE_AND_LOSS, UTILIZATION, MEDICAL_USE, STATE_CONTRACT, RETURN_TO_INDIVIDUAL
MILK RETAIL_SALE, BY_SAMPLES, DISTANCE, CONFISCATE_SALE, DESTRUCTION, EXPORT_OUTSIDE_EEU, EXPORT_INSIDE_EEU, OWN_USE, DAMAGE_AND_LOSS, UTILIZATION, MEDICAL_USE, STATE_CONTRACT, PRODUCTION_USE, EXPIRATION, VENDING, PACKING
FOOD_SUPPLEMENT, SANITIZER, MEDICAL_DEVICES RETAIL_SALE, BY_SAMPLES, DISTANCE, CONFISCATE_SALE, DESTRUCTION, EXPORT_OUTSIDE_EEU, EXPORT_INSIDE_EEU, OWN_USE, DAMAGE_AND_LOSS, UTILIZATION, MEDICAL_USE, STATE_CONTRACT
BICYCLE RETAIL_SALE, EXPORT_INSIDE_EEU, EXPORT_OUTSIDE_EEU, DAMAGE_AND_LOSS, RETURN_TO_INDIVIDUAL, CONFISCATE_SALE, DESTRUCTION, STATE_CONTRACT, DISTANCE, BY_SAMPLES, UTILIZATION, OWN_USE, PRODUCTION_USE
VETPHARMA RETAIL_SALE, EXPORT_INSIDE_EEU, EXPORT_OUTSIDE_EEU, DAMAGE_AND_LOSS, CONFISCATE_SALE, DESTRUCTION, STATE_CONTRACT, DISTANCE, BY_SAMPLES, UTILIZATION, OWN_USE, PRODUCTION_USE, EXPIRATION
SOFT_DRINKS RETAIL_SALE, EXPORT_OUTSIDE_EEU, DISTANCE, EXPORT_INSIDE_EEU, EXPIRATION, OWN_USE, PACKING, PRODUCTION_USE, STATE_CONTRACT, VENDING, DONATION
WATER RETAIL_SALE, EXPORT_OUTSIDE_EEU, CONFISCATE_SALE, DESTRUCTION, DISTANCE, EXPORT_INSIDE_EEU, EXPIRATION, DAMAGE_AND_LOSS, OWN_USE, PRODUCTION_USE, STATE_CONTRACT, VENDING, BY_SAMPLES, UTILIZATION, DONATION
SEAFOOD RETAIL_SALE, EXPORT_INSIDE_EEU, EXPORT_OUTSIDE_EEU, DAMAGE_AND_LOSS, CONFISCATE_SALE, DESTRUCTION, STATE_CONTRACT, DISTANCE, BY_SAMPLES, UTILIZATION, OWN_USE, PRODUCTION_USE, EXPIRATION, VENDING
BEER_ALCOHOL RETAIL_SALE, EXPORT_OUTSIDE_EEU, EXPORT_INSIDE_EEU, OWN_USE, PRODUCTION_USE, DONATION, STATE_CONTRACT, DAMAGE_AND_LOSS, DESTRUCTION, CONFISCATE_SALE, UTILIZATION, EXPIRATION, MISMATCH

Связь допустимых значений поля supportingTransaction в зависимости от retireOrderType

retireOrderType supportingTransaction
BY_SAMPLES RECEIPT, SALES_RECEIPT, OTHER, CONSIGNMENT_NOTE, UTD
CONFISCATE_SALE OTHER, CONSIGNMENT_NOTE, UTD
DAMAGE_AND_LOSS OTHER
DESTRUCTION CERTIFICATE_OF_DESTRUCTION, OTHER
DISTANCE RECEIPT, SALES_RECEIPT, OTHER, CONSIGNMENT_NOTE, UTD
DONATION OTHER, CONSIGNMENT_NOTE
EXPIRATION OTHER
EXPORT_OUTSIDE_EEU CUSTOMS_DECLARATION, OTHER
MEDICAL_USE OTHER
MISMATCH OTHER
OWN_USE OTHER
PACKING OTHER
PRODUCTION_USE OTHER
RETAIL_SALE RECEIPT, SALES_RECEIPT, OTHER
RETURN_TO_INDIVIDUAL OTHER
UTILIZATION OTHER
VENDING OTHER

Способ вывода из оборота retireOrderType:

Тип документа-основания supportingTransaction:

Документ вывода из оборота с позициями:

+Поле trackingType каждой позиции должно совпадать со значением поля trackingType документа.

Массовое создание и обновление Выводов из оборота

Массовое создание и обновление Выводов из оборота. В теле запроса нужно передать массив, содержащий JSON представления Выводов из оборота, которые вы хотите создать или обновить. Обновляемые Выводы из оборота должны содержать идентификатор в виде метаданных.

Изменение Вывода из оборота

Запрос на обновление Вывода из оборота с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Вывода из оборота, кроме тех, что помечены Только для чтения в описании атрибутов Вывода из оборота.

Особенности поведения при изменении Вывода из оборота

Изменение Вывода из оборота доступно только для документов со статусом documentState = CREATED, CHECKED_NOT_OK, PROCESSING_ERROR

Параметры

Параметр Описание
id string (required) Example: b14bcb5e-3b17-4765-87cf-bc4569fc5f32 id Вывода из оборота.

Позиции Вывода из оборота

Отдельный ресурс для управления позициями Вывода из оборота. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Вывода из оборота

Запрос на получение списка всех позиций данного Вывода из оборота.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Вывода из оборота.

Параметры

Параметр Описание
id string (required) Example: b14bcb5e-3b17-4765-87cf-bc4569fc5f32 id Вывода из оборота.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Вывода из оборота

Получить позицию

Параметры

Параметр Описание
id string (required) Example: b14bcb5e-3b17-4765-87cf-bc4569fc5f32 id Вывода из оборота.
positionID string (required) Example: 05c97192-d4d3-4781-b2e8-85edc190347b id позиции.

Создать позицию

Запрос на создание новой позиции в Выводе из оборота. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Вывода из оборота.

Изменить позицию

Запрос на обновление отдельной позиции Вывода из оборота. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Вывода из оборота.
positionID string (required) Example: d3040339-a8bd-11ef-ac15-000400000059 id позиции.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Вывода из оборота.
positionID string (required) Example: d3040339-a8bd-11ef-ac15-000400000059 id позиции.

Response 200 (application/json) Успешное удаление позиции Вывода из оборота.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Вывода из оборота.

Response 200 (application/json) Успешное удаление позиций Вывода из оборота.

Выданный отчет комиссионера

Средствами JSON API можно создавать и обновлять сведения о Выданных отчетах комиссионера, запрашивать списки Выданных отчетов комиссионера и сведения по отдельным Выданным отчетам комиссионера. Позициями отчетов комиссионера можно управлять как в составе отдельного отчета, так и с помощью специальных ресурсов для управления позициями. Кодом сущности для Выданного отчета комиссионера в составе JSON API является ключевое слово commissionreportout. Больше об отчетах комиссионера и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Выданные отчеты комиссионера

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Только для чтения
code String(255) = != ~ ~= =~ Код Выданного отчета комиссионера
commissionPeriodEnd DateTime Конец периода
Обязательное при ответе Необходимо при создании
commissionPeriodStart DateTime Начало периода
Обязательное при ответе Необходимо при создании
commitentSum Float Сумма коммитента в установленной валюте
Только для чтения
contract Meta = != Метаданные договора
Обязательное при ответе Expand Необходимо при создании
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Выданного отчета комиссионера
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Выданного отчета комиссионера
externalCode String(255) = != ~ ~= =~ Внешний код Выданного отчета комиссионера
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Выданного отчета комиссионераы
Обязательное при ответе Только для чтения
meta Meta Метаданные Выданного отчета комиссионера
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Выданного отчета комиссионера
Обязательное при ответе Необходимо при создании
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Оплаченная сумма
Обязательное при ответе Только для чтения
positions MetaArray Метаданные позиций Выданного отчета
Обязательное при ответе Только для чтения Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
rewardPercent Int Процент вознаграждения (всегда 0 если вознаграждение не рассчитывается)
rewardType String(255) Тип вознаграждения
shared Boolean = != Общий доступ
Обязательное при ответе Только для чтения
salesChannel Meta = != Метаданные канала продаж
Expand
state Meta = != Метаданные статуса Выданного отчета комиссионера
Expand
sum Int = != < > <= >= Сумма Выданного отчета комиссионера в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Выданного отчета комиссионера
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
payments Массив ссылок на связанные платежи в формате Метаданных

Позиции Выданного отчета комиссионера

Позиции Выданного отчета комиссионера - это список товаров/модификаций/серий. Объект позиции Выданного отчета комиссионера содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
reward Float Вознаграждение
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Выданного отчета комиссионера, а также в составе отдельного Выданного отчета комиссионера. При работе в составе отдельного Выданного отчета комиссионера, вы можете отправлять запросы на создание Выданного отчета комиссионера с включенным в тело запроса массивом позиций Выданного отчета комиссионера. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции отчета комиссионера". Также, при работе в составе отдельного Выданного отчета комиссионера, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Выданного отчета комиссионера. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Выданного отчета комиссионера" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

Получить Выданные отчеты комиссионера

Запрос всех Выданных отчетов комиссионера на учетной записи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Выданный отчет комиссионера

Запрос на создание нового Выданного отчета комиссионера. Обязательные для создания поля:

При указании поля contract важно:

Удалить Выданный отчет комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.

Response 200 (application/json) Успешное удаление Выданного отчета комиссионера.

Массовое создание и обновление Выданных отчетов комиссионера

Массовое создание и обновление Выданных отчетов комиссионера. В теле запроса нужно передать массив, содержащий JSON представления Выданных отчетов комиссионера, которые вы хотите создать или обновить. Обновляемые Выданные отчеты комиссионера должны содержать идентификатор в виде метаданных.

Массовое удаление Выданных отчетов комиссионера

В теле запроса нужно передать массив, содержащий JSON метаданных Выданных отчетов комиссионера, которые вы хотите удалить.

Метаданные Выданного отчета

Метаданные Выданного отчета

Запрос на получение метаданных отчетов комиссионера. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные отчетов комиссионера
attributes Массив объектов доп. полей отчетов комиссионера формате Метаданных
states Массив статусов отчетов комиссионера
createShared создавать новые отчеты комиссионера с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Выданный отчет комиссионера

Получить Выданный отчет комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.

Изменить Выданный отчет комиссионера

Запрос на обновление Выданного отчета комиссионера с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Выданного отчета комиссионера, кроме тех, что помечены Только для чтения в описании атрибутов Выданного отчета комиссионера. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.


При указании поля contract важно:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.

Позиции Выданного отчета комиссионера

Отдельный ресурс для управления позициями Выданного отчета комиссионера. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции

Запрос на получение списка всех позиций данного Выданного отчета комиссионера.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Выданного отчета комиссионера.

Создать позицию

Запрос на создание новой позиции в отчете комиссионера. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.

Изменить позицию

Запрос на обновление отдельной позиции Выданного отчета комиссионера. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Выданного отчета комиссионера.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выданного отчета комиссионера.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции Выданного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиции Выданного отчета комиссионера.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Выданного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиций Выданного отчета комиссионера.

Выплата денег

Средствами JSON API можно создавать и обновлять сведения о Выплатах денег, запрашивать списки Выплат денег и сведения по отдельным Выплатам денег. Кодом сущности для внесения денег в составе JSON API является ключевое слово retaildrawercashout. Больше о Выплатах денег и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке

Выплаты денег

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Выплаты денег
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Выплаты денег
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Выплаты денег
externalCode String(255) = != ~ ~= =~ Внешний код Выплаты денег
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Выплаты денег
Обязательное при ответе Только для чтения
meta Meta Метаданные Выплаты денег
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Выплаты денег
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Выплаты денег
Expand
sum Int = != < > <= >= Сумма Выплаты денег установленной валюте
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Выплаты денег
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
retailShift Ссылка на розничную смену, в рамках которой было выполнено Внесение денег в формате Метаданных. По данному полю можно фильтровать используя операторы = и !=. Необходимое

Получить Выплаты денег

Запрос на получение всех Выплат денег на данной учетной записи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Выплату денег

Запрос на создание Выплаты денег. Обязательные для создания поля:

Массовое создание и обновление Выплат денег

Массовое создание и обновление Выплат денег. В теле запроса нужно передать массив, содержащий JSON представления Выплат денег, которые вы хотите создать или обновить. Обновляемые Выплаты денег должны содержать идентификатор в виде метаданных.

Удалить Выплату денег

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выплаты денег.

Response 200 (application/json) Успешный запрос.

Массовое удаление Выплат денег

В теле запроса нужно передать массив, содержащий JSON метаданных Выплат денег, которые вы хотите удалить.

Метаданные Выплат денег

Метаданные Выплат денег

Запрос на получение метаданных Выплат денег. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Выплат денег
attributes Массив объектов доп. полей Выплат денег в формате Метаданных
states Массив статусов Выплат денег
createShared создавать новые Выплаты денег с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Шаблон Выплаты денег

Шаблон Выплаты денег

Шаблон Выплаты денег на основе

Запрос на получение предзаполненной Выплаты денег на основе розничной смены. В результате запроса, будет создан предзаполненный шаблон Выплаты денег на основе переданной розничной смены.

Выплата денег

Получить Выплату денег

Изменить Выплату денег

Запрос на обновление Выплаты денег.

Выполнение этапа производства

Средствами JSON API можно создавать, обновлять и удалять сведения о Выполнениях этапов производства, запрашивать списки Выполнений этапов производства и сведения по отдельным Выполнениям этапов производства. Если производство не начато по Производственному заданию, то попытки создать Выполненный этап на это Производственное задание будут завершаться ошибкой.

Выполнения этапов производства

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Дата создания
Обязательное при ответе Только для чтения
defect Boolean Признак брака
Обязательное при ответе После создания изменить нельзя
description String(4096) = != ~ ~= =~ Комментарий Выполнения этапа
enableHourAccounting Boolean Признак активности учета по нормо-часам
Обязательное при ответе
externalCode String(255) Внешний код Выполнения этапа производства
Обязательное при ответе
group Meta Отдел сотрудника
Обязательное при ответе Expand
id UUID ID Выполнения этапа производства
Обязательное при ответе Только для чтения
labourUnitCost Double Оплата труда за единицу объема производства
Обязательное при ответе
standardHourUnit Double Нормо-часы единицы объема производства
Обязательное при ответе
materials MetaArray Метаданные Материалов выполнения этапа производства. Подробнее тут
Expand
meta Meta Метаданные Выполнения этапа производства
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) Наименование Выполнения этапа производства
Обязательное при ответе
owner Meta Владелец (Сотрудник)
Expand
performer Meta Исполнитель (Сотрудник)
Expand
processingUnitCost Double Затраты на единицу объема производства
Обязательное при ответе
productionStage Meta Производственный этап
Expand После создания изменить нельзя
productionVolume Double Объем производства
Обязательное при ответе
products MetaArray Метаданные Продуктов выполнения этапа производства. Есть только у последнего этапа. Подробнее тут
Expand
service Meta Услуга, выполняемая контрагентом
shared Boolean Общий доступ
Обязательное при ответе
standardHourCost Double Стоимость нормо-часа
Обязательное при ответе
updated DateTime Момент последнего обновления Выполнения этапа производства
Обязательное при ответе Только для чтения

Особенности: Для сущности действуют ограничения на expand: для поля productionStage.productionRow недоступен expand вложенных полей.

Для создания Выполнения этапа с контрагентом в качестве исполнителя может быть передана услуга. Иначе будет сохранена та услуга, которая выбрана для данного контрагента в Этапе производства. Контрагент может отсутствовать в списке возможных исполнителей Этапа производства, тогда услугу требуется передать обязательно. В случае отсутствия исполнителя или если исполнитель - это сотрудник, то задавать услугу нельзя.

Изменение типа расчета оплаты труда доступно только в том случае, если в Производственном этапе был ранее установлен признак расчета по нормо-часам (флаг enableHourAccounting=true). Выполнение этапа будет по умолчанию создано с этим типом расчета и оплата труда будет вычисляться автоматически (по формуле labourUnitCost = standardHourCost * standardHourUnit). Изменение значения оплаты труда при включенном флаге недопустимо - для передачи фиксированного значения требуется деактивировать флаг.

Получить список Выполнений этапов производства

Запрос Выполнений этапов производства на аккаунте.

При получении списка Выполнений этапов можно передать фильтр на конкретное производственное задание:
filter=productionTask=https://api.moysklad.ru/api/remap/1.2/entity/productionTask/<id>.

Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Выполнения этапов.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Выполнение этапа производства

Запрос на создание нового Выполнения этапа производства. Условие создания Выполненного этапа - наличие начала производства у Производственного задания для которого создается Выполненный этап. Подробнее можно прочитать тут. При создании происходит автоматическое изменение даты старта производства, если дата старта производства позже даты выполнения этапа. Обязательные для создания поля:

Создание Выполнение этапа с серийными номерами на текущий момент не поддерживается.

Массовое создание и обновление Выполнений этапов производства

Массовое создание и обновление Выполнений этапов производства. В теле запроса нужно передать массив, содержащий JSON представления Выполнений этапов производства, которые вы хотите создать или обновить. Обновляемые Выполненных этапов производства должны содержать идентификатор в виде метаданных.

Удалить Выполнение этапа производства

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства

Response 200 (application/json) Успешное удаление Выполнения этапа производства.

Массовое удаление Выполнений этапов производства

В теле запроса нужно передать массив, содержащий JSON метаданных Выполнений этапов производства, которые вы хотите удалить.

Удаление происходит в указанном порядке. Поэтому выполнения последнего этапа должно располагаться до выполнений этапов, от которых оно зависит.

Получить Выполнение этапа производства

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства.

Изменить Выполнение этапа производства

Запрос на обновление Выполнения этапа производства с указанным id. При обновлении происходит автоматическое изменение даты старта производства, если дата старта производства позже даты выполнения этапа. В теле запроса необходимо указать те поля, которые необходимо изменить у Выполнения этапа производства, кроме тех, что помечены Только для чтения в описании атрибутов Выполнения этапа производства.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства.

Материалы Выполнения этапа производства

Материалы Выполнения этапа производства - это товары, модификации и серии, затраченные при выполнении этапа производства.

Объект материала Выполнения этапа производства содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/модификации/серии, которую представляет собой позиция
Обязательное при ответе Expand
consumedQuantity Float Количество товаров/модификаций данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута

Продукты Выполнения этапа производства

Продукты Выполнения этапа производства - это товары, модификации и серии, созданные при выполнении этапа производства.

Объект продукта Выполнения этапа производства содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/модификации/серии, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
producedQuantity Float Количество товаров/модификаций данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе
Обязательное при ответе
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута

Материалы выполнения этапа производства

Отдельный ресурс для управления Материалами выполнения этапа производства.

Получить Материалы выполнения этапа производства

Запрос на получение списка всех Материалов выполнения этапа производства.

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Материалы выполнения этапа производства

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей

Добавить Материал выполнения этапа производства

Запрос на добавление Материала к выполненному этапу производства. Для товаров с серийным учётом, поле consumedQuantity автоматически изменяется на количество переданных в поле things серийных номеров.

Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства

Изменить Материал выполнения этапа производства

Запрос на обновление отдельного Материала выполнения этапа производства. Для товаров с серийным учётом, поле consumedQuantity автоматически изменяется на количество переданных в поле things серийных номеров.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства
materialID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id Материала выполнения этапа производства

Продукты выполнения этапа производства

Отдельный ресурс для управления Продуктами выполнения этапа производства.

Получить Продукты выполнения этапа производства

Запрос на получение списка всех Продуктов выполнения этапа производства.

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Продукты выполнения этапа производства

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей

Изменить Продукт выполнения этапа производства

Запрос на обновление отдельного Продукта выполнения этапа производства. Изменять товар / модификацию нельзя, но можно изменить серию товара. Для товаров с серийным учётом, поле producedQuantity автоматически изменяется на количество переданных в поле things серийных номеров.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Выполнения этапа производства
productID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id Продукта выполнения этапа производства

Заказ кодов маркировки

Заказ кодов маркировки

Средствами JSON API можно создавать, обновлять и управлять сведениями о Заказах кодов маркировки, запрашивать списки Заказов и получать данные по отдельным Заказам. Позициями Заказов можно управлять как в составе отдельного Заказа кодов маркировки, так и отдельно – с помощью специальных ресурсов для управления позициями. Кодом сущности для Заказа кодов маркировки в составе JSON API является ключевое слово emissionorder. Больше информации о работе с Заказами кодов маркировки и их особенностях вы можете найти в документации службы поддержки этой ссылке.

Тарифные ограничения

Для создания/изменения Заказов кодов маркировки необходима тарифная опция Маркировка для аккаунтов из RU региона и расширение Честный знак для остальных регионов.

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
created DateTime Момент создания Заказа кодов маркировки
Обязательное при ответе Только для чтения
description String(255) Комментарий
documentState Enum Способ ввода в оборот. Подробнее тут
Только для чтения
emissionType Enum Состояние документов маркировки. Подробнее тут
Обязательное при ответе
externalCode String(255) Внешний код Заказа кодов маркировки
Обязательное при ответе
group Meta Отдел сотрудника
Обязательное при ответе Expand
id UUID ID Заказа кодов маркировки
Обязательное при ответе Только для чтения
meta Meta Метаданные Заказа кодов маркировки
Обязательное при ответе Только для чтения
moment DateTime Дата документа
Обязательное при ответе
name String(255) Наименование Заказа кодов маркировки
Обязательное при ответе
organization Meta Метаданные юрлица
Обязательное при ответе Expand
owner Meta Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Заказа кодов маркировки
Обязательное при ответе Expand
printed Boolean Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean Опубликован ли документ
Обязательное при ответе Только для чтения
shared Boolean Общий доступ
Обязательное при ответе
state Meta Метаданные статуса Заказа кодов маркировки
Expand
trackingType Enum Тип маркируемой продукции. Подробнее тут
Обязательное при ответе
updated DateTime Момент последнего обновления
Обязательное при ответе Только для чтения

Позиции Заказа кодов маркировки

Позиции Заказа кодов маркировки - это список товаров/модификаций/серий. В Заказе кодов маркировки не может присутствовать больше 10 позиций. Поле quantity имеет максимальное ограничение в 1000 шт.

Объект позиции Заказа кодов маркировки содержит следующие поля:
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/модификации/серии, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
meta Meta Метаданные позиции заказа кодов маркировки
Обязательное при ответе Только для чтения
quantity Float Количество товаров данного вида в позиции.
Обязательное при ответе
status Enum Статус кодов.
Обязательное при ответе Только для чтения Подробнее тут

Статус кодов

Значения поля status.

Значение Описание
EMISSION_NOT_SEND Не отправлен
EMISSION_SEND В обработке
EMISSION_ACTIVE Коды доступны
EMISSION_ERROR Ошибка
EMISSION_RECEIVED Коды получены
EMISSION_PRINTED_PARTLY Частично напечатаны
EMISSION_PRINTED_FULLY Коды напечатаны
EMISSION_COMPLETED Коды получены

Способ ввода в оборот

Значения поля emissionType.

Значение Описание
LOCAL Произведен в РФ
FOREIGN Ввезен в РФ
REMAINS Маркировка остатков
CROSSBORDER Ввезен из стран ЕАЭС
COMMISSION Принят на комиссию от физического лица

Состояние документов маркировки

Значения поля documentState.

Значение Описание
CREATED Не отправлен
SUZ_CREATED Создан
SUZ_SEND Отправлен
SUZ_COMPLETED Закрыт

Получить заказы кодов маркировки

Запрос всех заказов кодов маркировки на учетной записи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Заказ кодов маркировки

Запрос на создание нового Заказа кодов маркировки. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
trackingType Тип маркируемой продукции. Подробнее тут
emissionType Состояние документов маркировки. Подробнее тут

Массовое создание и обновление Заказов кодов маркировки

Массовое создание и обновление Заказов кодов маркировки. В теле запроса необходимо передать массив, содержащий JSON представления Заказов кодов маркировки, которые вы хотите создать или обновить. Обновляемые Заказы кодов маркировки должны содержать идентификатор в виде метаданных.

Метаданные Заказа кодов маркировки

Метаданные Заказа кодов маркировки

Запрос на получение метаданных Заказа кодов маркировки. Результат - объект JSON, включающий в себя:

Параметр Описание
createShared создавать новые заказы кодов маркировки с меткой "Общий"
meta Ссылка на метаданные заказа кодов маркировки
states Массив статусов заказов кодов маркировки

Получить заказ кодов маркировки

Параметры

Параметр Описание
id string (required) Example: 33c8ac0b-a670-11ef-ac12-000d00000111 id заказа кодов маркировки.

Изменить Заказ кодов маркировки

Запрос на обновление Заказа кодов маркировки с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Заказа кодов маркировки, кроме тех, что помечены Только для чтения в описании атрибутов Заказа кодов маркировки.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа кодов маркировки.

Получить Позиции Заказа кодов маркировки

Запрос на получение списка всех позиций данного Заказа кодов маркировки.

Параметры

Параметр Описание
id string (required) Example: 33c8ac0b-a670-11ef-ac12-000d00000111 id Заказа кодов маркировки
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить позицию Заказа кодов маркировки

Параметры

Параметр Описание
id string (required) Example: 33c8ac0b-a670-11ef-ac12-000d00000111 id Заказа кодов маркировки.
positionID string (required) Example: 33c8bd7c-a670-11ef-ac12-000d00000112 id позиции Заказа кодов маркировки.

Создать позицию

Запрос на создание новой позиции в Заказе кодов маркировки. Для успешного создания необходимо в теле запроса указать следующие поля:

Тип маркируемой продукции у позиций и у заказа Кодов маркировки должен быть идентичным.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа кодов маркировки.

Изменить позицию

Запрос на обновление отдельной позиции Заказа. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа кодов маркировки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа кодов маркировки.

Заказ на производство

Заказы на производство

Средствами JSON API можно создавать и обновлять сведения о Заказах на производство, запрашивать списки Заказов и сведения по отдельным Заказам на производство. Позициями Заказов можно управлять как в составе отдельного Заказа на производство, так и отдельно - с помощью специальных ресурсов для управления позициями Заказа. Кодом сущности для Заказа на производство в составе JSON API является ключевое слово processingorder. Больше о Заказах на производство и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Только для чтения
code String(255) = != ~ ~= =~ Код Заказа на производство
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Заказа на производство
Только для чтения
deliveryPlannedMoment DateTime = != < > <= >= Планируемая дата производства
description String(4096) = != ~ ~= =~ Комментарий Заказа на производство
externalCode String(255) = != ~ ~= =~ Внешний код Заказа на производство
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Заказа на производство
Обязательное при ответе Только для чтения
meta Meta Метаданные Заказа на производство
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Заказа на производство
Обязательное при ответе Необходимо при создании
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Заказа на производство
Обязательное при ответе Expand Необходимо при создании
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
processingPlan Meta Метаданные Техкарты
Обязательное при ответе Expand Необходимо при создании
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
quantity Float = != < > <= >= Объем производства
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе Только для чтения
state Meta = != Метаданные статуса Заказа на производство
Expand
store Meta Метаданные склада
Обязательное при ответе Expand Необходимо при создании
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновленияЗаказа на производство
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
processings Массив ссылок на связанные техоперации в формате Метаданных

Позиции Заказа на производство

Позиции Заказа - это список товаров/модификаций, соответствующих материалам техкарты. Объект позиции Заказа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
reserve Float Резерв данной позиции
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Заказа, а также в составе отдельного Заказа на производство. При работе в составе отдельного Заказа на производство, вы можете отправлять запросы на создание отдельного Заказа на производство с включенным в тело запроса массивом позиций Заказа. Также, при работе в составе отдельного Заказа на производство, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Заказа. Позиции с новыми товарами не могут быть добавлены в Заказ.

О работе с доп. полями Заказов на производство можно прочитать здесь

Получить список Заказов на производство

Запрос всех Заказов на производство на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Заказы на производство.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Заказ на производство

Запрос на создание нового Заказа на производство. Обязательные для создания поля:

Массовое создание и обновление Заказов на производство

Массовое создание и обновление Заказов на производство. В теле запроса нужно передать массив, содержащий JSON представления Заказов на производство, которые вы хотите создать или обновить. Обновляемые Заказы на производство должны содержать идентификатор в виде метаданных.

Удалить Заказ на производство

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.

Response 200 (application/json) Успешное удаление Заказа на производство.

Массовое удаление Заказов на производство

В теле запроса нужно передать массив, содержащий JSON метаданных Заказов на производство, которые вы хотите удалить.

Метаданные Заказов на производство

Метаданные Заказов на производство

Запрос на получение метаданных Заказов на производство. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Заказов на производство
attributes Массив объектов доп. полей Заказов на производство в формате Метаданных
states Массив статусов Заказов на производство
createShared создавать новые Заказы на производство с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Заказа на производство

Шаблон Заказа на производство на основе

Запрос на получение предзаполненного заказа на основе другого документа. В результате запроса будет создан предзаполненный шаблон заказа на основе переданного документа.

Заказ на производство

Получить Заказ на производство

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.

Изменить Заказ на производство

Запрос на обновление Заказа на производство с указанным id. В теле запроса необходимо указать поле meta processingPlan (даже если оно не меняется), а также указать те поля, которые необходимо изменить у Заказа на производство, кроме тех, что помечены Только для чтения в описании атрибутов Заказа на производство.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.

Позиции Заказа на производство

Отдельный ресурс для управления позициями Заказа на производство. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Заказа на производство

Запрос на получение списка всех позиций данного Заказа на производство.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Заказа на производство.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Заказа на производство

Отдельная позиция Заказа с указанным id позиции.

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа на производство.

Изменить позицию

Запрос на обновление отдельной позиции Заказа. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа на производство.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа на производство.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа на производство.

Response 200 (application/json) Успешное удаление позиции Заказа на производство.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Заказа на производство.

Response 200 (application/json) Успешное удаление позиций Заказа на производство.

Заказ покупателя

Заказы покупателей

Средствами JSON API можно создавать и обновлять сведения о Заказах покупателя, запрашивать списки Заказов и сведения по отдельным Заказам покупателей. Позициями Заказов можно управлять как в составе отдельного Заказа покупателя, так и отдельно - с помощью специальных ресурсов для управления позициями Заказа. Кодом сущности для Заказа покупателя в составе JSON API является ключевое слово customerorder. Больше о Заказах покупателей и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. Также в Заказе покупателя поддерживается протокол оповещения об изменениях виджетов вендоров - change-handler. Подробнее см. в документации для вендоров о виджетах.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтенияChange-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при созданииChange-handler Update-provider
agentAccount Meta Метаданные счета контрагента
ExpandChange-handler Update-provider
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler Update-provider
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler Update-provider
code String(255) = != ~ ~= =~ Код Заказа покупателя
contract Meta = != Метаданные договора
ExpandChange-handler Update-provider
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтенияChange-handler
deleted DateTime = != < > <= >= Момент последнего удаления Заказа покупателя
Только для чтения
deliveryPlannedMoment DateTime = != < > <= >= Планируемая дата отгрузки
Change-handler Update-provider
description String(4096) = != ~ ~= =~ Комментарий Заказа покупателя
Change-handler Update-provider
externalCode String(255) = != ~ ~= =~ Внешний код Заказа покупателя
Обязательное при ответеChange-handler Update-provider
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Заказа покупателя
Обязательное при ответе Только для чтенияChange-handler
invoicedSum Float Сумма счетов покупателю
Обязательное при ответе Только для чтенияChange-handler
meta Meta Метаданные Заказа покупателя
Обязательное при ответеChange-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответеChange-handler Update-provider
name String(255) = != ~ ~= =~ Наименование Заказа покупателя
Обязательное при ответеChange-handler Update-provider
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при созданииChange-handler Update-provider
organizationAccount Meta Метаданные счета юрлица
ExpandChange-handler Update-provider
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Заказу
Обязательное при ответе Только для чтенияChange-handler
positions MetaArray Метаданные позиций Заказа покупателя
Обязательное при ответе ExpandChange-handler Update-provider
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
ExpandChange-handler Update-provider
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответеChange-handler Update-provider
reservedSum Float Сумма товаров в резерве
Обязательное при ответе Только для чтенияChange-handler
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
shipmentAddress String(255) = != ~ ~= =~ Адрес доставки Заказа покупателя
Change-handler
shipmentAddressFull Object Адрес доставки Заказа покупателя с детализацией по отдельным полям. Подробнее тут
Change-handler
shippedSum Float Сумма отгруженного
Обязательное при ответе Только для чтенияChange-handler
state Meta = != Метаданные статуса заказа
ExpandChange-handler Update-provider
store Meta = != Метаданные склада
ExpandChange-handler Update-provider
sum Int = != < > <= >= Сумма Заказа в установленной валюте
Обязательное при ответе Только для чтенияChange-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
taxSystem Enum Код системы налогообложения. Подробнее тут
Change-handler
updated DateTime = != < > <= >= Момент последнего обновления Заказа покупателя
Обязательное при ответе Только для чтенияChange-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответеChange-handler Update-provider
vatIncluded Boolean Включен ли НДС в цену
Change-handler Update-provider
vatSum Float Сумма НДС
Обязательное при ответе Только для чтенияChange-handler
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент

Связи с другими документами

Название Описание
purchaseOrders Массив ссылок на связанные заказы поставщикам в формате Метаданных
demands Массив ссылок на связанные отгрузки в формате Метаданных
payments Массив ссылок на связанные платежи в формате Метаданных
invoicesOut Массив ссылок на связанные счета покупателям в формате Метаданных
moves Массив ссылок на связанные перемещения в формате Метаданных
prepayments Массив ссылок на связанные предоплаты в формате Метаданных

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Заказа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтенияChange-handler
assortment Meta Метаданные товара/услуги/серии/модификации/комплекта, которую представляет собой позиция
Обязательное при ответе ExpandChange-handler Update-provider
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответеChange-handler Update-provider
id UUID ID позиции
Обязательное при ответе Только для чтенияChange-handler Update-provider
pack Object Упаковка Товара. Подробнее тут
Change-handler Update-provider
price Float Цена товара/услуги в копейках
Обязательное при ответеChange-handler Update-provider
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответеChange-handler Update-provider
reserve Float Резерв данной позиции
Change-handler Update-provider
shipped Float Доставлено
Обязательное при ответе Только для чтения Change-handler
taxSystem Enum Код системы налогообложения. Подробнее тут
vat Int НДС, которым облагается текущая позиция
Обязательное при ответеChange-handler Update-provider
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответеChange-handler Update-provider

С позициями можно работать с помощью специальных ресурсов для управления позициями Заказа, а также в составе отдельного Заказа покупателя. При работе в составе отдельного Заказа покупателя, вы можете отправлять запросы на создание отдельного Заказа покупателя с включенным в тело запроса массивом позиций Заказа. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Заказа покупателя". Также, при работе в составе отдельного Заказа покупателя, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Заказа. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Заказа" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

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

Атрибуты сущности Адрес доставки

Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому атрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле shipmentAddress передать пустую строку "".

Получить список Заказов покупателей

Запрос всех Заказов покупателей на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Заказы покупателей.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Заказ покупателя

Запрос на создание нового Заказа покупателя. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента (покупателя) в формате Метаданных

Массовое создание и обновление Заказов покупателей

Массовое создание и обновление Заказов покупателей. В теле запроса нужно передать массив, содержащий JSON представления Заказов покупателей, которые вы хотите создать или обновить. Обновляемые Заказы покупателей должны содержать идентификатор в виде метаданных.

Удалить Заказ покупателя

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.

Response 200 (application/json) Успешное удаление Заказа покупателя.

Метаданные Заказов покупателей

Метаданные Заказов покупателей

Запрос на получение метаданных Заказов покупателей. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Заказов покупателей
attributes Массив объектов доп. полей Заказов покупателей в формате Метаданных
states Массив статусов Заказов покупателей
createShared создавать новые Заказы покупателей с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Массовое удаление Заказов покупателей

В теле запроса нужно передать массив, содержащий JSON метаданных Заказов покупателей, которые вы хотите удалить.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Отдельное доп. поле

Заказ покупателя

Получить Заказ покупателя

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.

Изменить Заказ покупателя

Запрос на обновление Заказа покупателя с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Заказа покупателя, кроме тех, что помечены Только для чтения в описании атрибутов Заказа покупателя. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.

Позиции Заказа покупателя

Отдельный ресурс для управления позициями Заказа покупателя. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Заказа покупателя

Запрос на получение списка всех позиций данного Заказа покупателя.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Заказа покупателя.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Заказа покупателя

Отдельная позиция Заказа с указанным id позиции.

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа покупателя.

Создать позицию

Запрос на создание новой позиции в Заказе покупателя. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.

Изменить позицию

Запрос на обновление отдельной позиции Заказа. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа покупателя.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа покупателя.

Response 200 (application/json) Успешное удаление позиции Заказа.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Заказа покупателя.

Response 200 (application/json) Успешное удаление позиций Заказа покупателя.

Заказ поставщику

Заказы Поставщикам

Средствами JSON API можно создавать и обновлять сведения о Заказах поставщику, запрашивать списки Заказов и сведения по отдельным Заказам Поставщикам. Позициями Заказов можно управлять как в составе отдельного Заказа поставщику, так и отдельно - с помощью специальных ресурсов для управления позициями Заказа. Кодом сущности для Заказа поставщику в составе JSON API является ключевое слово purchaseorder. Больше о Заказах Поставщикам и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Заказа поставщику
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Заказа поставщику
Только для чтения
deliveryPlannedMoment DateTime = != < > <= >= Планируемая дата отгрузки
description String(4096) = != ~ ~= =~ Комментарий Заказа поставщику
externalCode String(255) = != ~ ~= =~ Внешний код Заказа поставщику
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Заказа поставщику
Обязательное при ответе Только для чтения
invoicedSum Float Сумма счетов поставщику
Только для чтения
meta Meta Метаданные Заказа поставщику
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Заказа поставщику
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Заказу
Только для чтения
positions MetaArray Метаданные позиций Заказа поставщику
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
shippedSum Float Сумма принятого
Только для чтения
state Meta = != Метаданные статуса заказа
Expand
store Meta = != Метаданные склада
Expand
sum Int = != < > <= >= Сумма Заказа поставщику в установленной валюте
Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Заказа поставщику
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Только для чтения
waitSum Float Сумма товаров в пути

Связи с другими документами

Название Описание
customerOrders Массив ссылок на связанные заказы покупателей в формате Метаданных
invoicesIn Массив ссылок на связанные счета поставщиков в формате Метаданных
payments Массив ссылок на связанные платежи в формате Метаданных
supplies Массив ссылок на связанные приемки в формате Метаданных
internalOrder Внутренний заказ, связанный с заказом поставщику, в формате Метаданных

Позиции Заказа поставщику

Позиции Заказа - это список товаров/услуг/модификаций/серий. Объект позиции Заказа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
shipped Float Принято
Обязательное при ответе
inTransit Float Ожидание
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Заказа, а также в составе отдельного Заказа поставщику. При работе в составе отдельного Заказа поставщику, вы можете отправлять запросы на создание отдельного Заказа поставщику с включенным в тело запроса массивом позиций Заказа. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Заказа поставщику". Также, при работе в составе отдельного Заказа поставщику, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Заказа. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Заказа" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Заказов поставщикам можно прочитать здесь

Получить список Заказов Поставщикам

Запрос всех Заказов Поставщикам на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Заказы Поставщикам.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Заказ поставщику

Запрос на создание нового Заказа поставщику. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента (поставщику) в формате Метаданных

Массовое создание и обновление Заказов поставщику

Массовое создание и обновление Заказов поставщику. В теле запроса нужно передать массив, содержащий JSON представления Заказов поставщику, которые вы хотите создать или обновить. Обновляемые Заказы поставщику должны содержать идентификатор в виде метаданных.

Удалить Заказ поставщику

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.

Response 200 (application/json) Успешное удаление Заказа поставщику.

Массовое удаление Заказов Поставщикам

В теле запроса нужно передать массив, содержащий JSON метаданных Заказов Поставщикам, которые вы хотите удалить.

Метаданные Заказов Поставщикам

Метаданные Заказов Поставщикам

Запрос на получение метаданных Заказов поставщикам. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Заказов поставщикам
attributes Массив объектов доп. полей Заказов поставщикам в формате Метаданных
states Массив статусов Заказов поставщикам
createShared создавать новые Заказы поставщикам с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Заказа поставщику

Шаблон Заказа поставщику

Запрос на получение предзаполненого стандартными значениями шаблона заказа поставщику без связи с каким-либо документом.

Шаблон Заказа поставщику на основе

Запрос на получение предзаполненного шаблона заказа поставщику на основе внутреннего заказа или заказа покупателя. В ответ на запрос вернется предзаполненный шаблон заказа поставщику. В шаблоне будет отсутствовать поле agent, т.к. Поставщик товара (agent в шаблоне заказа поставщику) не совпадает с Покупателем (agent в заказе покупателя), его необходимо заполнить самому. Затем шаблон можно будет использовать для создания нового заказа с помощью POST запроса.

При создании документа на основании заказа покупателя, содержащего комплекты в позициях, комплекты будут автоматически разбиты на составляющие компоненты в отдельные позиции.

Если у указанного в качестве основания документа уже есть связанный с ним заказ поставщику, то позиции, указанные в нем, в созданном шаблоне указаны не будут.

Заказ поставщику

Получить Заказ поставщику

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.

Изменить Заказ поставщику

Запрос на обновление Заказа поставщику с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Заказа поставщику, кроме тех, что помечены Только для чтения в описании атрибутов Заказа поставщику. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.

Позиции Заказа поставщику

Отдельный ресурс для управления позициями Заказа поставщику. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Заказа поставщику

Запрос на получение списка всех позиций данного Заказа поставщику.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Заказа поставщику.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Заказа

Отдельная позиция Заказа с указанным id позиции.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа поставщику.

Получить позицию

Создать позицию

Запрос на создание новой позиции в Заказе поставщику. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.

Изменить позицию

Запрос на обновление отдельной позиции Заказа. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа поставщику.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Заказа поставщику.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Заказа поставщику.

Response 200 (application/json) Успешное удаление позиции Заказа.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Заказа поставщику.

Response 200 (application/json) Успешное удаление позиций Заказа поставщику.

Инвентаризация

Средствами JSON API можно создавать и обновлять сведения о Инвентаризации, запрашивать списки Инвентаризаций и сведения по отдельным Инвентаризациям. Позициями Инвентаризации можно управлять как в составе отдельной Инвентаризации, так и отдельно - с помощью специальных ресурсов для управления позициями Инвентаризации. Кодом сущности для Инвентаризации в составе JSON API является ключевое слово inventory. Больше о Инвентаризациях можно прочитать этой ссылке.

Инвентаризация

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Инвентаризации
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Инвентаризации
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Инвентаризации
externalCode String(255) = != ~ ~= =~ Внешний код Инвентаризации
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Инвентаризации
Обязательное при ответе Только для чтения
meta Meta Метаданные Инвентаризации
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Инвентаризации
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Инвентаризации
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Инвентаризации
Expand
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании
sum Int = != < > <= >= Сумма Инвентаризации в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Инвентаризации
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
enters Ссылка на связанное с инвентаризацией оприходование в формате Метаданных
losses Ссылка на связанное с инвентаризацией списание в формате Метаданных

Позиции Инвентаризации

Позиции Инвентаризации - это список товаров/модификаций/серий. Объект позиции Инвентаризации содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
calculatedQuantity Float расчетный остаток
Обязательное при ответе
correctionAmount Float разница между расчетным остатком и фактическимх
Обязательное при ответе Только для чтения
correctionSum Float избыток/недостача
Обязательное при ответе Только для чтения
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Инвентаризации, а также в составе отдельной Инвентаризации. При работе в составе отдельной Инвентаризации, вы можете отправлять запросы на создание отдельной Инвентаризации с включенным в тело запроса массивом позиций Инвентаризации. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Инвентаризации". Также, при работе в составе отдельной Инвентаризации, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Инвентаризации. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Инвентаризации" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Инвентаризации можно прочитать здесь

Получить Инвентаризации

Запрос всех Инвентаризаций на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Инвентаризации.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Инвентаризацию

Запрос на создание новой Инвентаризации

Обязательные для создания поля:

Массовое создание и обновление Инвентаризаций

Массовое создание и обновление Инвентаризаций. В теле запроса нужно передать массив, содержащий JSON представления Инвентаризаций, которые вы хотите создать или обновить. Обновляемые Инвентаризации должны содержать идентификатор в виде метаданных.

Удалить Инвентаризацию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.

Response 200 (application/json) Успешное удаление Инвентаризации.

Массовое удаление Инвентаризаций

В теле запроса нужно передать массив, содержащий JSON метаданных Инвентаризаций, которые вы хотите удалить.

Метаданные Инвентаризаций

Метаданные Инвентаризаций

Запрос на получение метаданных Инвентаризаций. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Инвентаризаций
attributes Массив объектов доп. полей Инвентаризацийв формате Метаданных
states Массив статусов Инвентаризаций
createShared создавать новые Инвентаризаций с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Инвентаризации

Шаблон Инвентаризации

Инвентаризация

Получить Инвентаризацию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.

Изменить Инвентаризацию

Запрос на обновление инвентаризации с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.

Позиции Инвентаризации

Отдельный ресурс для управления позициями Инвентаризации. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции

Запрос на получение списка всех позиций данной Инвентаризации.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Инвентаризации.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Инвентаризации

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Создать позицию

Запрос на создание новой позиции в Инвентаризации. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.

Изменить позицию

Запрос на обновление отдельной позиции Инвентаризации. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Инвентаризации.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Response 200 (application/json) Успешное удаление позиции Инвентаризации.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Инвентаризации.

Response 200 (application/json) Успешное удаление позиций Инвентаризации.

Исходящий платеж

Исходящие платежи

Средствами JSON API можно создавать и обновлять сведения о Исходящем платеже, запрашивать списки Исходящих платежей и сведения по отдельным Исходящим платежам. Кодом сущности для Исходящего платежа в составе JSON API является ключевое слово paymentout. Больше о платежа х и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента, сотрудника или юр.лица
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента или юр.лица
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Исходящего платежа
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Исходящего платежа
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Исходящего платежа
expenseItem Meta Метаданные Статьи расходов
Обязательное при ответе Expand Необходимо при создании
externalCode String(255) = != ~ ~= =~ Внешний код Исходящего платежа
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
noClosingDocs Boolean Признак возможности привязки закрывающих документов и отключения взаиморасчетов с контрагентом по этой выплате
Обязательное при ответе Только для чтения
id UUID = != ID Исходящегоо платежа
Обязательное при ответе Только для чтения
meta Meta Метаданные Исходящего платежа
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Исходящего платежа
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
paymentPurpose String(255) = != ~ ~= =~ Назначение платежа
Обязательное при ответе
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Исходящего платежа
Expand
sum Int = != < > <= >= Сумма Исходящего платежа в установленной валюте
Обязательное при ответе
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Исходящего платежа
Обязательное при ответе Только для чтения
vatSum Float Сумма НДС
Обязательное при ответе

Связи с другими документами

Название Описание
factureIn Ссылка на Счет-фактуру полученный, с которым связан этот платеж в формате Метаданных
operations Массив ссылок на связанные операции в формате Метаданных

Разрешенные типы связанных операций:

О работе с доп. полями Исходящих платежей можно прочитать здесь

Получить Исходящие платежи

Запрос всех Исходящих платежей на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Исходящие платежи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Исходящий платеж

Запрос на создание нового Исходящего платежа . Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента, сотрудника или юр.лицо в формате Метаданных
expenseItem Статья расходов в формате Метаданных

Массовое создание и обновление Исходящих платежей

Массовое создание и обновление Исходящих платежей. В теле запроса нужно передать массив, содержащий JSON представления Исходящих платежей, которые вы хотите создать или обновить. Обновляемые Исходящие платежи должны содержать идентификатор в виде метаданных.

Удалить Исходящий платеж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Исходящего платежа.

Response 200 (application/json) Успешное удаление Исходящего платежа .

Массовое удаление Исходящих платежей

В теле запроса нужно передать массив, содержащий JSON метаданных Исходящих платежей, которые вы хотите удалить.

Метаданные Исходящих платежей

Метаданные Исходящих платежей

Запрос на получение метаданных Исходящих платежей . Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Исходящих платежей
attributes Массив объектов доп. полей Исходящих платежей в формате Метаданных
states Массив статусов Исходящих платежей
createShared создавать новые Исходящие платежи с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Исходящего платежа

Шаблон Исходящего платежа

Шаблон Исходящего платежа на основе

Запрос на создание получение прелзаполненного исходящего платежа на основе другого документа. В результате запроса, будет создан предзаполненный шаблон исходящего платеж на основе переданного документа.

Исходящий платеж

Получить Исходящий платеж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Исходящего платежа.

Изменить Исходящий платеж

Запрос на обновление Исходящего платежа с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Исходящего платежа , кроме тех, что помечены Только для чтения в описании атрибутов Исходящего платежа . При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Для привязки исходящего платежа к другим документам нужно положить в поле под именем operations все meta тех документов, к которым вы хотите привязать финансовую операцию. Также для каждого документа можно указать cумму, оплаченную по данному документу из этого платежа linkedSum.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Исходящего платежа.

Корректировка взаиморасчетов

Средствами JSON API можно создавать и обновлять сведения о Корректировках взаиморасчетов, запрашивать списки Корректировок взаиморасчетов и сведения по отдельным Корректировкам взаиморасчетов. Кодом сущности для Корректировки взаиморасчетов в составе JSON API является ключевое слово counterpartyadjustment. Больше о Корректировках взаиморасчетов и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Корректировки взаиморасчетов

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента или сотрудника
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Корректировки взаиморасчетов
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Корректировки взаиморасчетов
externalCode String(255) = != ~ ~= =~ Внешний код Корректировки взаиморасчетов
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Корректировки взаиморасчетов
Обязательное при ответе Только для чтения
meta Meta Метаданные Корректировки взаиморасчетов
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Корректировки взаиморасчетов
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean Опубликован ли документ
Обязательное при ответе Только для чтения
shared Boolean = != Общий доступ
Обязательное при ответе
sum Int = != < > <= >= Сумма Корректировки взаиморасчетов в копейках
Обязательное при ответе Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Корректировки взаиморасчетов
Обязательное при ответе Только для чтения

Получить список Корректировок взаиморасчетов

Запрос всех Корректировок взаиморасчетов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Корректировки взаиморасчетов.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Корректировку взаиморасчетов

Запрос на создание новой Корректировки взаиморасчетов. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента или сотрудника в формате Метаданных

Массовое создание и обновление Корректировок взаиморасчетов

Массовое создание и обновление Корректировок взаиморасчетов. В теле запроса нужно передать массив, содержащий JSON представления Корректировок взаиморасчетов, которые вы хотите создать или обновить. Обновляемые Корректировки взаиморасчетов должны содержать идентификатор в виде метаданных.

Удалить Корректировку взаиморасчетов

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Корректировки взаиморасчетов.

Response 200 (application/json) Успешное удаление Корректировки взаиморасчетов.

Массовое удаление Корректировок взаиморасчетов

В теле запроса нужно передать массив, содержащий JSON метаданных Корректировок взаиморасчетов, которые вы хотите удалить.

Метаданные Корректировок взаиморасчетов

Метаданные Корректировок взаиморасчетов

Запрос на получение метаданных Корректировок взаиморасчетов. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Корректировок взаиморасчетов
attributes Массив объектов доп. полей Корректировок взаиморасчетов в формате Метаданных
createShared создавать новые Корректировки взаиморасчетов с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Корректировка взаиморасчетов

Получить Корректировку взаиморасчетов

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Корректировки взаиморасчетов.

Изменить Корректировку взаиморасчетов

Запрос на обновление Корректировки взаиморасчетов с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Корректировки взаиморасчетов, кроме тех, что помечены Только для чтения в описании атрибутов Корректировки взаиморасчетов.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Корректировки взаиморасчетов.

Оприходование

Средствами JSON API можно создавать и обновлять сведения об Оприходованиях, запрашивать списки Оприходований и сведения по отдельным Оприходованиям. Позициями Оприходований можно управлять как в составе отдельного Оприходования, так и отдельно - с помощью специальных ресурсов для управления позициями Оприходования. Кодом сущности для Оприходования в составе JSON API является ключевое слово enter. Больше об Оприходованиях можно прочитать этой ссылке.

Оприходования

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler Update-provider
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler Update-provider
code String(255) = != ~ ~= =~ Код Оприходования
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Оприходования
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Оприходования
Change-handler Update-provider
externalCode String(255) = != ~ ~= =~ Внешний код Оприходования
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Оприходования
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Оприходования
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler Update-provider
name String(255) = != ~ ~= =~ Номер Оприходования
Обязательное при ответе Change-handler Update-provider
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
overhead Object Накладные расходы. Подробнее тут. Если Позиции Оприходования не заданы, то накладные расходы нельзя задать
Update-provider
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Оприходования
Обязательное при ответе Expand Change-handler Update-provider
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler Update-provider
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler Update-provider
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса оприходования
Expand Change-handler Update-provider
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
sum Int = != < > <= >= Сумма Оприходования в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Оприходования
Обязательное при ответе Только для чтения Change-handler

Накладные расходы

Описание полей overhead

Название Тип Описание
sum Int Сумма Оприходования в копейках
Обязательное при ответе Update-provider
distribution Enum Распределение накладных расходов [weight, volume, price] -> [по весу, по объему, по цене]
Обязательное при ответе Update-provider

Связи с другими документами

Название Описание
inventory Ссылка на связанную с оприходованием инвентаризацию в формате Метаданных

Позиции Оприходования

Позиции Оприходования - это список товаров/модификаций/серий. Объект позиции Оприходования содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler Update-provider
country Meta Метаданные страны
Expand
gtd Object ГТД. Подробнее тут
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
overhead Int Накладные расходы. Подробнее тут. Если Позиции Оприходования не заданы, то накладные расходы нельзя задать
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
Change-handler Update-provider
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler Update-provider
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler Update-provider
reason String(255) Причина оприходования данной позиции
slot Meta Ячейка на складе. Подробнее тут
Expand
things Object(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута. Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Оприходования, а также в составе отдельного Оприходования. При работе в составе отдельного Оприходования, вы можете отправлять запросы на создание отдельного Оприходования с включенным в тело запроса массивом позиций Оприходования. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Оприходования". Также, при работе в составе отдельного Оприходования, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Оприходования. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Оприходования" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Оприходований можно прочитать здесь

Получать Оприходования

Запрос всех Оприходований на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Оприходования.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Оприходования

Запрос на создание нового Оприходования. Обязательные для создания поля:

Название Тип Описание
organization Meta Метаданные юрлица
store Meta Метаданные склада

Массовое создание и обновление Оприходований

Массовое создание и обновление Оприходований. В теле запроса нужно передать массив, содержащий JSON представления Оприходований, которые вы хотите создать или обновить. Обновляемые Оприходования должны содержать идентификатор в виде метаданных.

Удалить Оприходование

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.

Response 200 (application/json) Успешное удаление Оприходования.

Массовое удаление Оприходований

В теле запроса нужно передать массив, содержащий JSON метаданных Оприходований, которые вы хотите удалить.

Метаданные Оприходований

Метаданные Оприходований

Запрос на получение метаданных Оприходований. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Оприходований
attributes Массив объектов доп. полей Оприходований в формате Метаданных
states Массив статусов Оприходований
createShared создавать новых Оприходованияс меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Отдельное доп. поле

Оприходование

Получить Оприходование

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.

Изменить Оприходование

Запрос на обновление оприходования с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.

Позиции Оприходований

Отдельный ресурс для управления позициями Оприходования. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Оприходования

Запрос на получение списка всех позиций данного Оприходования.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Оприходования.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Оприходования

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Создать позицию

Запрос на создание новой позиции в Оприходовании. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.

Изменить позицию

Запрос на обновление отдельной позиции Оприходования. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Оприходования.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Response 200 (application/json) Успешное удаление позиции Оприходования.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Оприходования.

Response 200 (application/json) Успешное удаление позиций Оприходования.

Отгрузка

Средствами JSON API можно создавать и обновлять сведения об Отгрузках, запрашивать списки Отгрузок и сведения по отдельным Отгрузкам. Позициями Отгрузок можно управлять как в составе отдельной Отгрузки, так и отдельно - с помощью специальных ресурсов для управления позициями Отгрузки. Кодом сущности для Отгрузки в составе JSON API является ключевое слово demand. Больше об Отгрузках и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

В Отгрузке поддерживается протокол оповещения об изменениях виджетов вендоров - change-handler. Подробнее см. в документации для вендоров о виджетах.

Отгрузки

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
agentAccount Meta Метаданные счета контрагента
Expand Change-handler Update-provider
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler Update-provider
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler Update-provider
code String(255) = != ~ ~= =~ Код Отгрузки
contract Meta = != Метаданные договора
Expand Change-handler Update-provider
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Отгрузки
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Отгрузки
Change-handler Update-provider
externalCode String(255) = != ~ ~= =~ Внешний код Отгрузки
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Отгрузки
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Отгрузки
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler Update-provider
name String(255) = != ~ ~= =~ Наименование Отгрузки
Обязательное при ответе Change-handler Update-provider
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
organizationAccount Meta Метаданные счета юрлица
Expand Change-handler Update-provider
overhead Object Накладные расходы. Подробнее тут. Если Позиции Отгрузки не заданы, то накладные расходы нельзя задать
Update-provider
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Отгрузке
Обязательное при ответе Только для чтения
positions MetaArray Метаданные позиций Отгрузки
Обязательное при ответе Expand Change-handler Update-provider
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler Update-provider
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler Update-provider
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
shipmentAddress String(255) = != ~ ~= =~ Адрес доставки Отгрузки
Change-handler
shipmentAddressFull Object Адрес доставки Отгрузки с детализацией по отдельным полям. Подробнее тут
Change-handler
state Meta = != Метаданные статуса Отгрузки
Expand Change-handler Update-provider
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
sum Int = != < > <= >= Сумма Отгрузки в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Отгрузки
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler Update-provider
vatIncluded Boolean Включен ли НДС в цену
Change-handler Update-provider
vatSum Float Сумма НДС
Change-handler Только для чтения

Накладные расходы

Описание полей overhead

Название Тип Описание
sum Int Сумма в копейках
Обязательное при ответе Update-provider
distribution Enum Распределение накладных расходов [weight, volume, price] -> [по весу, по объему, по цене]
Обязательное при ответе Update-provider

Связи с другими документами

Название Описание
customerOrder Ссылка на Заказ Покупателя, с которым связана эта Отгрузка в формате Метаданных
factureOut Ссылка на Счет-фактуру выданный, с которым связана эта Отгрузка в формате Метаданных
returns Массив ссылок на связанные возвраты в формате Метаданных
payments Массив ссылок на связанные платежи в формате Метаданных
invoicesOut Массив ссылок на связанные счета покупателям в формате Метаданных

Другие поля

Название Тип Описание
cargoName String(255) Наименование груза
Change-handler
carrier Meta Метаданные перевозчика (контрагент или юрлицо)
Expand Change-handler
consignee Meta Метаданные грузополучателя (контрагент или юрлицо)
Change-handler
goodPackQuantity Int Всего мест
Change-handler
shippingInstructions String(255) Указания грузоотправителя
Change-handler
stateContractId String(255) Идентификатор государственного контракта, договора (соглашения)
Change-handler
transportFacility String(255) Транспортное средство
Change-handler
transportFacilityNumber String(255) Номер автомобиля
Change-handler

Позиции Отгрузки

Позиции Отгрузки - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Отгрузки содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации/комплекта, которую представляет собой позиция
Обязательное при ответе Expand Change-handler Update-provider
cost Int Себестоимость (только для услуг)
declaration Array(Object) Информация о прослеживаемости импортных товаров. Подробнее тут
Выводится по запросу Только для чтения
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler Update-provider
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут Change-handler Update-provider
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler Update-provider
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler Update-provider
slot Meta Ячейка на складе. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута. Change-handler
trackingCodes Array(Object) Коды маркировки товаров и транспортных упаковок. Подробнее тут
trackingCodes_1162 Array(Object) Коды маркировки товаров в формате тега 1162. Подробнее тут
overhead Int Накладные расходы. Подробнее тут. Если Позиции Отгрузки не заданы, то накладные расходы нельзя задать.
Обязательное при ответе Только для чтения
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler Update-provider
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler Update-provider

С позициями можно работать с помощью специальных ресурсов для управления позициями Отгрузки, а также в составе отдельной Отгрузки. При работе в составе отдельной Отгрузки, вы можете отправлять запросы на создание отдельной Отгрузки с включенным в тело запроса массивом позиций Отгрузки. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Отгрузки". Также, при работе в составе отдельной Отгрузки, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Отгрузки. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Отгрузки" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Отгрузок можно прочитать здесь

Информация о прослеживаемости импортных товаров

Поле declaration выводится по запросу. Для вывода в позициях документа информации о прослеживаемости импортных товаров необходимо передать в URL запроса дополнительный параметр fields=declaration, например ../demand/{id}/positions?fields=declaration. Подробнее о параметре fields.

Аттрибуты объекта:

Название Тип Описание
gtd String Регистрационный номер партии товара
Только для чтения
rnpt String Грузовая таможенная декларация
Только для чтения
country Meta Страна происхождения товара
Только для чтения
quantity Float Количество товара с указанными ГТД или РНПТ в позиции документа
Только для чтения

Коды маркировки товаров и транспортных упаковок

Поддержаны в виде иерархической структуры JSON.

Название Тип Описание
cis String Значение кода маркировки
Обязательное при ответе Необходимо при создании
type Enum Тип кода маркировки. Возможные значения: trackingcode, consumerpack, transportpack
Обязательное при ответе Необходимо при создании
trackingCodes Array(Object) Массив вложенных кодов маркировки. Может присутствовать, только если type имеет значения consumerpack или transportpack

Значение кода указывается в атрибуте cis. Для каждого кода указывается тип type: trackingcode (код маркировки товара), consumerpack (код маркировки потребительской упаковки) или transportpack (код транспортной упаковки). Допустима вложенность кодов маркировки товаров в транспортные упаковки. Транспортные упаковки не могут иметь вложенных упаковок. Коды упаковок могут отсутствовать - в этом случае структура не будет вложенной. Если продукция не является маркированной, то коды маркировки для позиции не будут сохранены. Количество кодов маркировки может отличаться от фактического количества единиц продукции.

Коды маркировки товаров и транспортных упаковок в формате тега 1162

Поддержаны в виде иерархической структуры JSON.

Название Тип Описание
cis_1162 String Значение кода маркировки в формате тега 1162
Обязательное при ответе Только для чтения
type Enum Тип кода маркировки. Возможные значения: trackingcode, consumerpack, transportpack
Обязательное при ответе Только для чтения
trackingCodes_1162 Array(Object) Массив вложенных кодов маркировки в формате тега 1162. Может присутствовать, только если type имеет значения consumerpack или transportpack

Значение кода указывается в атрибуте cis_1162. Для каждого кода указывается тип type: trackingcode (код маркировки товара), consumerpack (код маркировки потребительской упаковки) или transportpack (код транспортной упаковки). Допустима вложенность кодов маркировки товаров в транспортные упаковки. Транспортные упаковки не могут иметь вложенных упаковок. Коды упаковок могут отсутствовать - в этом случае структура не будет вложенной. Если продукция не является маркированной, то коды маркировки в формате тега 1162 для позиции не будут сохранены. Количество кодов маркировки может отличаться от фактического количества единиц продукции.

Особенности работы с кодами маркировки и серийными номерами для позиции документа

При работе с позицией Отгрузки следует учитывать следующие особенности.

Недопустимо сохранение дублирующихся кодов маркировки и серийных номеров внутри документа Отгрузки.

Атрибуты сущности Адрес доставки

Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому атрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле shipmentAddress передать пустую строку "".

Получить список Отгрузок

Запрос всех Отгрузок на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Отгрузки.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Отгрузку

Запрос на создание новой Отгрузки. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента в формате Метаданных
store Ссылка на склад в формате Метаданных

Массовое создание и обновление Отгрузок

Массовое создание и обновление Отгрузок. В теле запроса нужно передать массив, содержащий JSON представления Отгрузок, которые вы хотите создать или обновить. Обновляемые Отгрузки должны содержать идентификатор в виде метаданных.

Удалить Отгрузку

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.

Response 200 (application/json) Успешное удаление Отгрузки.

Массовое удаление Отгрузок

В теле запроса нужно передать массив, содержащий JSON метаданных Отгрузок, которые вы хотите удалить.

Метаданные Отгрузок

Метаданные Отгрузок

Запрос на получение метаданных Отгрузок. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Отгрузок
attributes Массив объектов доп. полей Отгрузок в формате Метаданных
states Массив статусов Отгрузок
createShared создавать новые Отгрузки с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Отгрузки

Шаблон Отгрузки

Шаблон Отгрузки на основе

Запрос на получение шаблона отгрузки на основе заказа покупателя или счета покупателю. В результате запроса, будет создан предзаполненный шаблон отгрузки на основе переданного документа.

Отгрузка

Получить Отгрузку

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.

Изменить Отгрузку

Запрос на обновление Отгрузки с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Отгрузки, кроме тех, что помечены Только для чтения в описании атрибутов Отгрузки. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.

Позиции Отгрузки

Отдельный ресурс для управления позициями Отгрузки. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Отгрузки

Запрос на получение списка всех позиций данной Отгрузки.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Отгрузки.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Отгрузки

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Отгрузки.

Создать позицию

Запрос на создание новой позиции в Отгрузке. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.

Изменить позицию

Запрос на обновление отдельной позиции Отгрузки. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

При обновлении списка кодов маркировки учитывать, что их количество может отличаться от фактического количества единиц продукции. Для изменения количества единиц продукции необходимо использовать параметр quantity.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Отгрузки.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отгрузки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Отгрузки.

Response 200 (application/json) Успешное удаление позиции Отгрузки.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Отгрузки.

Response 200 (application/json) Успешное удаление позиций Отгрузки.

Перемещение

Средствами JSON API можно создавать и обновлять сведения о Перемещениях, запрашивать списки Перемещений и сведения по отдельным Перемещениям. Позициями Перемещений можно управлять как в составе отдельного Перемещения, так и отдельно - с помощью специальных ресурсов для управления позициями Перемещения. Кодом сущности для Перемещения в составе JSON API является ключевое слово move.

Перемещения

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответеТолько для чтенияChange-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответеChange-handler Update-provider
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler Update-provider
code String(255) = != ~ ~= =~ Код Перемещения
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтенияChange-handler
deleted DateTime = != < > <= >= Момент последнего удаления Перемещения
Только для чтения
demand Meta Метаданные Отгрузки, связанной с Перемещением
Только для чтения Expand
description String(4096) = != ~ ~= =~ Комментарий Перемещения
Change-handler Update-provider
externalCode String(255) = != ~ ~= =~ Внешний код Перемещения
Обязательное при ответеChange-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Перемещения
Обязательное при ответе Только для чтенияChange-handler
internalOrder Meta Метаданные Внутреннего заказа, связанного с Перемещением
Expand
customerOrder Meta Метаданные Заказа покупателя, связанного с Перемещением
Expand
meta Meta Метаданные Перемещения
Обязательное при ответеChange-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответеChange-handler Update-provider
name String(255) = != ~ ~= =~ Наименование Перемещения
Обязательное при ответеChange-handler Update-provider
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при созданииChange-handler Update-provider
overhead Object Накладные расходы. Подробнее тут. Если Позиции Перемещения не заданы, то накладные расходы нельзя задать
Update-provider
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Перемещения
Обязательное при ответе ExpandChange-handler Update-provider
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
ExpandChange-handler Update-provider
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответеChange-handler Update-provider
shared Boolean = != Общий доступ
Обязательное при ответе
sourceStore Meta Метаданные склада, с которого совершается перемещение
Обязательное при ответе Expand Необходимо при созданииChange-handler Update-provider
state Meta = != Метаданные статуса Перемещения
Expand Change-handler Update-provider
sum Int = != < > <= >= Сумма Перемещения в копейках
Обязательное при ответе Только для чтенияChange-handler
supply Meta Метаданные Приемки, связанной с Перемещением
Только для чтения Expand
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
targetStore Meta Метаданные склада, на который совершается перемещение
Обязательное при ответе Expand Необходимо при созданииChange-handler Update-provider
updated DateTime = != < > <= >= Момент последнего обновления Перемещения
Обязательное при ответе Только для чтенияChange-handler

Накладные расходы

Описание полей overhead

Название Тип Описание
sum Int Сумма в копейках
Обязательное при ответе Update-provider
distribution Enum Распределение накладных расходов [weight, volume, price] -> [по весу, по объему, по цене]
Обязательное при ответе Update-provider

Позиции Перемещения

Позиции Перемещения - это список товаров/модификаций/серий. Объект позиции Перемещения содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтенияChange-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе ExpandChange-handler Update-provider
id UUID ID позиции
Обязательное при ответе Только для чтенияChange-handler
overhead Int Накладные расходы. Подробнее тут. Если Позиции Перемещения не заданы, то накладные расходы нельзя задать
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
Change-handler Update-provider
price Float Цена товара/услуги в копейках
Обязательное при ответеChange-handler Update-provider
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответеChange-handler Update-provider
sourceSlot Meta Ячейка на складе, с которого совершается перемещение. Подробнее тут
Expand
targetSlot Meta Ячейка на складе, на который совершается перемещение. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.Change-handler

Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.

С позициями можно работать с помощью специальных ресурсов для управления позициями Перемещения, а также в составе отдельного Перемещения. При работе в составе отдельного Перемещения, вы можете отправлять запросы на создание отдельного Перемещения с включенным в тело запроса массивом позиций Перемещения. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Перемещения". Также, при работе в составе отдельного Перемещения, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Перемещения. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Перемещения" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Перемещений можно прочитать здесь

Получить Перемещения

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Перемещение

Запрос на создание нового Перемещения. Обязательные для создания поля:

Массовое создание и обновление Перемещений

Массовое создание и обновление Перемещений. В теле запроса нужно передать массив, содержащий JSON представления Перемещений, которые вы хотите создать или обновить. Обновляемые Перемещения должны содержать идентификатор в виде метаданных.

Удалить Перемещение

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.

Response 200 (application/json) Успешное удаление Перемещения.

Массовое удаление Перемещений

В теле запроса нужно передать массив, содержащий JSON метаданных Перемещений, которые вы хотите удалить.

Шаблон Перемещения

Шаблон Перемещения

Шаблон Перемещения на основе

Запрос на получение предзаполненного шаблона перемещения на основе внутреннего заказа или заказа покупателя. В ответ на запрос вернется предзаполненный шаблон перемещения, который затем можно будет использовать для создания нового перемещения с помощью POST запроса.

Метаданные Перемещений

Метаданные Перемещений

Запрос на получение метаданных Перемещений. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Перемещений
attributes Массив объектов доп. полей Перемещений в формате Метаданных
states Массив статусов Перемещений
createShared создавать новые Перемещения с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Перемещение

Получить Перемещение

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.

Изменить Перемещение

Запрос на обновление Перемещения с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.

Позиции Перемещения

Отдельный ресурс для управления позициями Перемещения. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции

Запрос на получение списка всех позиций данного Перемещения.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Перемещения.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Позиция Перемещения

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id Перемещения.

Создать позицию

Запрос на создание новой позиции в Перемещении. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.

Изменить позицию

Запрос на обновление отдельной позиции Перемещения. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id Перемещения.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Перемещения.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id Перемещения.

Response 200 (application/json) Успешное удаление позиции Перемещения.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Перемещения.

Response 200 (application/json) Успешное удаление позиций Перемещения.

Полученный отчет комиссионера

Средствами JSON API можно создавать и обновлять сведения о Полученных отчетах комиссионера, запрашивать списки Полученных отчетов комиссионера и сведения по отдельным Полученным отчетам комиссионера. Позициями отчетов комиссионера можно управлять как в составе отдельного отчета, так и с помощью специальных ресурсов для управления позициями. Кодом сущности для Полученного отчета комиссионера в составе JSON API является ключевое слово commissionreportin. Больше об отчетах комиссионера и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Полученные отчеты комиссионера

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Полученного отчета комиссионера
commissionOverhead Object Прочие расходы. Подробнее тут. Если Позиции Отчета комиссионера не заданы, то расходы нельзя задать
Update-provider
commissionPeriodEnd DateTime Конец периода
Обязательное при ответе Необходимо при создании
commissionPeriodStart DateTime Начало периода
Обязательное при ответе Необходимо при создании
commitentSum Float Сумма коммитента в установленной валюте
Только для чтения
contract Meta = != Метаданные договора
Обязательное при ответе Expand Необходимо при создании
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Полученного отчета комиссионера
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Полученного отчета комиссионера
externalCode String(255) = != ~ ~= =~ Внешний код Полученного отчета комиссионера
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Полученного отчета комиссионера
Обязательное при ответе Только для чтения
meta Meta Метаданные Полученного отчета комиссионера
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Полученного отчета комиссионера
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Оплаченная сумма
Обязательное при ответе Только для чтения
positions MetaArray Метаданные позиций реализовано комиссионером Полученного отчета комиссионера
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
returnToCommissionerPositions MetaArray Метаданные позиций возврата на склад комиссионера Полученного отчета комиссионера
Обязательное при ответе Expand
rewardPercent Int Процент вознаграждения (всегда 0 если вознаграждение не рассчитывается)
rewardType String(255) Тип вознаграждения
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Полученного отчета комиссионера
Expand
sum Int = != < > <= >= Сумма Полученного отчета комиссионера в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Полученного отчета комиссионера
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения

Прочие расходы

Описание полей commissionOverhead:
Поле sum может быть отрицательным.

Название Тип Описание
sum Int Сумма в копейках
Обязательное при ответе Update-provider

Связи с другими документами

Название Описание
payments Массив ссылок на связанные платежи в формате Метаданных

Позиции Полученного отчета комиссионера

Позиции Полученного отчета комиссионера - это список товаров/модификаций/серий/комплектов. С позициями можно работать с помощью специальных ресурсов для управления позициями реализовано комиссионером и позициями возврата на склад комиссионера, а также в составе отдельного Полученного отчета комиссионера. При работе в составе отдельного Полученного отчета комиссионера, вы можете отправлять запросы на создание Полученного отчета комиссионера с включенным в тело запроса массивом реализованных позиций и позиций на возврат Полученного отчета комиссионера. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Реализованные позиции отчета комиссионера" и "Позиции на возврат отчета комиссионера". Также, при работе в составе отдельного Полученного отчета комиссионера, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Полученного отчета комиссионера. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Полученного отчета комиссионера" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

Объект позиции реализовано комиссионером содержит следующие поля:

Поле reward может быть отрицательным.

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/серии/модификации/комплекта, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара в копейках
Обязательное при ответе
quantity Float Количество товаров данного вида в позиции.
Обязательное при ответе
reward Float Вознаграждение
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе
Объект позиции возврата на склад комиссионера содержит следующие поля:
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/серии/модификации/комплекта, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
price Float Цена товара в копейках
Обязательное при ответе
quantity Float Количество товаров данного вида в позиции.
Обязательное при ответе
reward Float Вознаграждение
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

Получить отчеты комиссионера

Запрос всех Полученных отчетов комиссионера на учетной записи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.
incomingDate string (optional) Example: 2016-04-15 15:48:46 Параметр для фильтрации выборки по входящей дате. Подробнее про данный параметр можно посмотреть в разделе Фильтрация выборки с помощью параметра filter. Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)

Создать Полученный отчет комиссионера

Запрос на создание нового Полученного отчета комиссионера. Обязательные для создания поля:

При указании поля contract важно:

Массовое создание и обновление Полученных отчетов комиссионера

Массовое создание и обновление Полученных отчетов комиссионера. В теле запроса нужно передать массив, содержащий JSON представления Полученных отчетов комиссионера, которые вы хотите создать или обновить. Обновляемые Полученные отчеты комиссионера должны содержать идентификатор в виде метаданных.

Удалить Полученный отчет комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.

Response 200 (application/json) Успешное удаление Полученного отчета комиссионера.

Массовое удаление Полученных отчетов комиссионера

В теле запроса нужно передать массив, содержащий JSON метаданных Полученных отчетов комиссионера, которые вы хотите удалить.

Метаданные Полученного отчета

Метаданные Полученного отчета

Запрос на получение метаданных отчетов комиссионера. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные отчетов комиссионера
attributes Массив объектов доп. полей отчетов комиссионера формате Метаданных
states Массив статусов отчетов комиссионера
createShared создавать новые отчеты комиссионера с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Полученный отчет комиссионера

Получить отчет комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.

Изменить Полученный отчет комиссионера

Запрос на обновление Полученного отчета комиссионера с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Полученного отчета комиссионера, кроме тех, что помечены Только для чтения в описании атрибутов Полученного отчета комиссионера. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.


При указании поля contract важно:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.

Позиции реализовано комиссионером

Отдельный ресурс для управления позициями реализовано комиссионером Полученного отчета комиссионера. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции реализовано комиссионером

Запрос на получение списка всех позиций данного Полученного отчета комиссионера.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить позицию реализовано комиссионером

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции реализовано комиссионером Полученного отчета комиссионера.

Создать позицию реализовано комиссионером

Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.

Изменить позицию реализовано комиссионером

Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции реализовано комиссионером Полученного отчета комиссионера.

Удалить позицию реализовано комиссионером

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id позиции реализовано комиссионером Полученного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиции реализовано комиссионером.

Массовое удаление позиций реализовано комиссионером

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Полученного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиций реализовано комиссионером.

Позиции возврата на склад комиссионера

Отдельный ресурс для управления позициями возврата на склад комиссионера в Полученном отчете комиссионера. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции возврата на склад комиссионера

Запрос на получение списка всех позиций возврата на склад комиссионера данного Полученного отчета комиссионера.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить позицию возврата на склад комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции возврата на склад комиссионера Полученного отчета комиссионера.

Создать позицию возврата на склад комиссионера

Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.

Изменить позицию возврата на склад комиссионера

Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции возврата на склад комиссионера Полученного отчета комиссионера.

Удалить позицию возврата на склад комиссионера

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Полученного отчета комиссионера.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id позиции возврата на склад комиссионера Полученного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиции возврата на склад комиссионера.

Массовое удаление позиций возврата на склад комиссионера

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Полученного отчета комиссионера.

Response 200 (application/json) Успешное удаление позиций возврата на склад комиссионера

Прайс-лист

Средствами JSON API можно создавать и обновлять сведения о Прайс-листах, запрашивать списки Прайс-листов и сведения по отдельным Прайс-листам. Позициями Прайс-листов можно управлять как в составе отдельного Прайс-листа, так и отдельно - с помощью специальных ресурсов для управления позициями Прайс-листа. Кодом сущности для Прайс-листа в составе JSON API является ключевое слово pricelist. Больше о Прайс-листах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Прайс-листы

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Прайс-листа
columns Array(Object) Массив столбцов описания таблицы
Обязательное при ответе Необходимо при создании После создания изменить нельзя
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Прайс-листа
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Прайс-листа
externalCode String(255) = != ~ ~= =~ Внешний код Прайс-листа
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Прайс-листа
Обязательное при ответе Только для чтения
meta Meta Метаданные Прайс-листа
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Прайс-листа
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Прайс-листа
Обязательное при ответе Expand
priceType Object Объект типа цены
Обязательное при ответе Только для чтения
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Прайс-листа
Expand
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Прайс-листа
Обязательное при ответе Только для чтения

Тип цены

Название Тип Описание
externalCode String(255) Внешний код Типа цены
Обязательное при ответе
id UUID ID типа цены
Обязательное при ответе Только для чтения
meta Meta Метаданные Типа цены
Обязательное при ответе Только для чтения
name String(255) Наименование Типа цены
Обязательное при ответе Необходимо при создании

Позиции Прайс-листа

Позиции Прайс-листа - это список товаров/услуг/модификаций/комплектов. Объект позиции Прайс-листа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Expand
cells Array(Object) Массив значений столбцов в позиции Прайс-листа
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковки Товара. Подробнее тут

С позициями можно работать с помощью специальных ресурсов для управления позициями Прайс-листа, а также в составе отдельного Прайс-листа. При работе в составе отдельного Прайс-листа, вы можете отправлять запросы на создание отдельного Прайс-листа с включенным в тело запроса массивом позиций Прайс-листа. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Прайс-листа". Также, при работе в составе отдельной Прайс-листа, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Прайс-листа. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Прайс-листа" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

Столбцы

Поле columns - массив, содержащий в себе объекты со следующими атрибутами:

Название Тип Описание
name String(255) Наименование Прайс-листа
Обязательное при ответе Необходимо при создании
percentageDiscount Int Процентная наценка или скидка по умолчанию для столбца

На столбцы налагаются следующие ограничения:

Ячейки

Поле cells - массив, содержащий в себе объекты со следующими атрибутами:

Название Тип Описание
column String(255) Название столбца, к которому относится данная ячейка
Обязательное при ответе Необходимо при создании
sum Int Числовое значение ячейки
Обязательное при ответе Необходимо при создании

При создании если значения ячеек позиций Прайс-листа были не указаны, то заполнятся значениями по умолчанию те ячейки, столбцы которых имеют значение скидки(наценки) по умолчанию. Элементы массива cells соотносятся с колонками по названию по значению поля column.

О работе с доп. полями Прайс-листов можно прочитать здесь

Получить список Прайс-листов

Запрос всех Прайс-листов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Прайс-листы.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Прайс-лист

Запрос на создание нового Прайс-листа. Обязательные для создания поля:

Примечание: если при создании Прайс-листа указать несуществующий тип цен, то Прайс-лист создастся с типом цен продаж по умолчанию.

Массовое создание и обновление Прайс-листов

Массовое создание и обновление Прайс-листов. В теле запроса нужно передать массив, содержащий JSON представления Прайс-листов, которые вы хотите создать или обновить. Обновляемые Прайс-листы должны содержать идентификатор в виде метаданных.

Удалить Прайс-лист

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Прайс-листа.

Response 200 (application/json) Успешное удаление Прайс-листа.

Массовое удаление Прайс-листов

В теле запроса нужно передать массив, содержащий JSON метаданных Прайс-листов, которые вы хотите удалить.

Метаданные Прайс-листов

Метаданные Прайс-листов

Запрос на получение метаданных Прайс-листов. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Прайс-листов
attributes Массив объектов доп. полей Прайс-листов формате Метаданных
states Массив статусов Прайс-листов
createShared создавать новые Прайс-листы с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id 666f86f9-afec-11e6-8af5-581e00000087 (required, string) - id Доп. поля

Отдельное доп. поле

Прайс-лист

Получить Прайс-лист

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Прайс-листа.

Изменить Прайс-лист

Запрос на обновление Прайс-листа с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Прайс-листа, кроме тех, что помечены Только для чтения в описании атрибутов Прайс-листа.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Прайс-листа.

Позиции Прайс-листа

Отдельный ресурс для управления позициями Прайс-листа. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Прайс-листа

Запрос на получение списка всех позиций данного Прайс-листа.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Прайс-листа.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Прайс-листа.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Прайс-листа

Получить позицию

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Прайс-листа.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Прайс-листа.

Создать позицию

Запрос на создание новой позиции в Прайс-листе. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Прайс-листа.

Изменить позицию

Запрос на обновление отдельной позиции Прайс-листа. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Прайс-листа.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Прайс-листа.

Удалить Позицию

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Прайс-листа.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Прайс-листа.

Response 200 (application/json) Успешное удаление позиции Прайс-листа.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Прайс-листа.

Response 200 (application/json) Успешное удаление позиций Прайс-листа.

Предоплата

Предоплаты

Средствами JSON API можно запрашивать списки Предоплат и сведения по отдельным Предоплатам. Кодом сущности для Предоплаты в составе JSON API является ключевое слово prepayment. Больше о Предоплатах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов предоплат на соответствие поисковой строке будет осуществлён по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
cashSum Float Оплачено наличными
Обязательное при ответе
code String(255) = != ~ ~= =~ Код Предоплаты
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
customerOrder Meta Метаданные Заказа Покупателя
Обязательное при ответе Expand
deleted DateTime = != < > <= >= Момент последнего удаления Предоплаты
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Предоплаты
externalCode String(255) = != ~ ~= =~ Внешний код Предоплаты
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Предоплаты
Обязательное при ответе Только для чтения
meta Meta Метаданные Предоплаты
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Предоплаты
Обязательное при ответе
noCashSum Float Оплачено картой
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Предоплаты
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
qrSum Float Оплачено по QR-коду
Обязательное при ответе
rate Object Валюта. Подробнее тут
Обязательное при ответе
retailShift Meta = != Метаданные Розничной смены
Обязательное при ответе Expand Необходимо при создании
retailStore Meta = != Метаданные Точки продаж
Обязательное при ответе Expand
returns Array(Object) Коллекция метаданных на связанные возвраты
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Предоплаты
Expand
sum Int = != < > <= >= Сумма Предоплаты в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
taxSystem Enum Код системы налогообложения. Подробнее тут
updated DateTime = != < > <= >= Момент последнего обновления Предоплаты
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент

Позиции Предоплаты

Позиции Предоплаты - это список товаров/услуг/модификаций/серий. Объект позиции Предоплаты содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

Атрибуты доступные для фильтрации

Значение Описание
agent Ссылка на контрагента
applicable Отметка о проведении
created Дата создания
deleted Момент последнего удаления сущности
description Комментарий Предоплаты
externalCode Внешний код Предоплаты
group Отдел сотрудника
id ID в формате UUID
isDeleted Удалена ли Предоплата
moment Дата Предоплаты
name номер Предоплаты
organization Ссылка на ваше юрлицо
owner Ссылка на Владельца (Сотрудника)
shared Общий доступ
state Статус Предоплаты
sum Сумма Предоплаты в установленной валюте
syncId ID синхронизации
updated Момент последнего обновления сущности
updatedBy Автор последнего обновления сущности в формате uid (admin@admin)

Атрибуты доступные для сортировки

Значение Описание
applicable Отметка о проведении
created Дата создания
description Комментарий Предоплаты
externalCode Внешний код Предоплаты
id ID в формате UUID
moment Дата Предоплаты
name номер Предоплаты
sum Сумма Предоплаты в установленной валюте
syncId ID синхронизации
updated Момент последнего обновления сущности

Получить список Предоплат

Запрос всех Предоплат на данной учётной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Предоплаты.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Метаданные Предоплат

Метаданные Предоплат

Запрос на получение метаданных Заказов покупателей. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Предоплат
attributes Массив объектов доп. полей Предоплат в формате Метаданных
states Массив статусов Предоплат
createShared создавать новые Предоплаты с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Отдельное доп. поле

Предоплата

Получить Предоплату

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Предоплаты.

Удалить Предоплату

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Предоплаты.

Response 200 (application/json) Успешное удаление Предоплаты.

Позиции Предоплаты

Отдельный ресурс для управления позициями Предоплаты. С его помощью вы можете запросить позиции большого документа, количество строк в котором превышает лимит на количество строк в выдаче документа. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Предоплаты

Запрос на получение списка всех позиций данной Предоплаты.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Предоплаты.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Предоплаты.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Предоплаты

Отдельная позиция Предоплаты с указанным id позиции.

Получить позицию Предоплаты

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Предоплаты.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Предоплаты.

Приемка

Средствами JSON API можно создавать и обновлять сведения об Приемках, запрашивать списки Приемок и сведения по отдельным Приемкам. Позициями Приемок можно управлять как в составе отдельной Приемки, так и отдельно - с помощью специальных ресурсов для управления позициями Приемки. Кодом сущности для Приемки в составе JSON API является ключевое слово supply. Больше об Приемках и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Приемки

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
agentAccount Meta Метаданные счета контрагента
Expand Change-handler Update-provider
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler Update-provider
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler Update-provider
code String(255) = != ~ ~= =~ Код Приемки
contract Meta = != Метаданные договора
Expand Change-handler Update-provider
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Приемки
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Приемки
Change-handler Update-provider
externalCode String(255) = != ~ ~= =~ Внешний код Приемки
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Приемки
Обязательное при ответе Только для чтения Change-handler
incomingDate DateTime Входящая дата
Change-handler Update-provider
incomingNumber String(255) Входящий номер
Change-handler Update-provider
meta Meta Метаданные Приемки
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler Update-provider
name String(255) = != ~ ~= =~ Наименование Приемки
Обязательное при ответе Change-handler Update-provider
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
organizationAccount Meta Метаданные счета юрлица
Expand Change-handler Update-provider
overhead Object Накладные расходы. Подробнее тут. Если Позиции Приемки не заданы, то накладные расходы нельзя задать
Update-provider
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Приемке
Обязательное при ответе Только для чтения
positions MetaArray Метаданные позиций Приемки
Обязательное при ответе Expand Change-handler Update-provider
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler Update-provider
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler Update-provider
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Приемки
Expand Change-handler Update-provider
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании Change-handler Update-provider
sum Int = != < > <= >= Сумма Приемки в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Приемки
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler Update-provider
vatIncluded Boolean Включен ли НДС в цену
Change-handler Update-provider
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения Change-handler

Накладные расходы

Описание полей overhead

Название Тип Описание
sum Int Сумма в копейках
Обязательное при ответе Update-provider
distribution Enum Распределение накладных расходов [weight, volume, price] -> [по весу, по объему, по цене]
Обязательное при ответе Update-provider

Связи с другими документами

Название Описание
purchaseOrder Ссылка на связанный заказ поставщику в формате Метаданных
factureIn Ссылка на Счет-фактуру полученный, с которым связана эта Приемка в формате Метаданных
invoicesIn Массив ссылок на связанные счета поставщиков в формате Метаданных
payments Массив ссылок на связанные платежи в формате Метаданных
returns Массив ссылок на связанные возвраты в формате Метаданных

Позиции Приемки

Позиции Приемки - это список товаров/услуг/модификаций/серий. Объект позиции Приемки содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler Update-provider
country Meta Метаданные страны
Expand
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler Update-provider
gtd Object ГТД. Подробнее тут
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler Update-provider
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler Update-provider
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler Update-provider
slot Meta Ячейка на складе. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
trackingCodes Array(Object) Коды маркировки товаров и транспортных упаковок. Подробнее тут
overhead Int Накладные расходы. Подробнее тут. Если Позиции Приемки не заданы, то накладные расходы нельзя задать.
Обязательное при ответе Только для чтения
vat Boolean НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler Update-provider
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler Update-provider

С позициями можно работать с помощью специальных ресурсов для управления позициями Приемки, а также в составе отдельной Приемки. При работе в составе отдельной Приемки, вы можете отправлять запросы на создание отдельной Приемки с включенным в тело запроса массивом позиций Приемки. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Приемки". Также, при работе в составе отдельной Приемки, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Приемки. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Приемки" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Приемок можно прочитать здесь

Коды маркировки товаров и транспортных упаковок

Поддержаны в виде иерархической структуры JSON.

Название Тип Описание
cis String Значение кода маркировки
Обязательное при ответе Необходимо при создании
type Enum Тип кода маркировки. Возможные значения: trackingcode, consumerpack, transportpack
Обязательное при ответе Необходимо при создании
trackingCodes Array(Object) Массив вложенных кодов маркировки. Может присутствовать, только если type имеет значения consumerpack или transportpack

Значение кода указывается в атрибуте cis. Для каждого кода указывается тип type: trackingcode (код маркировки товара), consumerpack (код маркировки потребительской упаковки) или transportpack (код транспортной упаковки). Допустима вложенность кодов маркировки товаров в транспортные упаковки. Транспортные упаковки не могут иметь вложенных упаковок. Коды упаковок могут отсутствовать - в этом случае структура не будет вложенной. Если продукция не является маркированной, то коды маркировки для позиции не будут сохранены. Количество кодов маркировки может отличаться от фактического количества единиц продукции.

Особенности работы с кодами маркировки и серийными номерами для позиции документа

При работе с позицией Приемки следует учитывать следующие особенности.

Недопустимо сохранение дублирующихся кодов маркировки и серийных номеров внутри документа Приемки.

Получить список Приемок

Запрос всех Приемок на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Приемки.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Приемку

Запрос на создание новой Приемки. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента в формате Метаданных
store Ссылка на склад в формате Метаданных

Массовое создание и обновление Приемок

Массовое создание и обновление Приемок. В теле запроса нужно передать массив, содержащий JSON представления Приемок, которые вы хотите создать или обновить. Обновляемые Приемки должны содержать идентификатор в виде метаданных.

Удалить Приемку

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.

Response 200 (application/json) Успешное удаление Приемки.

Массовое удаление Приемок

В теле запроса нужно передать массив, содержащий JSON метаданных Приемок, которые вы хотите удалить.

Метаданные Приемок

Метаданные Приемок

Запрос на получение метаданных Приемок. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Приемок
attributes Массив объектов доп. полей Приемок в формате Метаданных
states Массив статусов Приемок
createShared создавать новые Приемки с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Шаблон Приемки

Шаблон Приемки

Шаблон Приемки на основе

Запрос на получение предзаполненной приемки на основе заказа поставщику. В результате запроса, будет создан предзаполненный шаблон приемки на основе переданного заказа поставщику.

Отдельное доп. поле

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Приемка

Получить Приемку

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.

Изменить Приемку

Запрос на обновление Приемки с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Приемки, кроме тех, что помечены Только для чтения в описании атрибутов Приемки. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.

Позиции Приемки

Отдельный ресурс для управления позициями Приемки. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Приемки

Запрос на получение списка всех позиций данной Приемки.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих позиции Приемки.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Приемки

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Приемки.

Создать позицию

Запрос на создание новой позиции в Приемке. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.

Изменить позицию

Запрос на обновление отдельной позиции Приемки. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

При обновлении списка кодов маркировки учитывать, что их количество может отличаться от фактического количества единиц продукции. Для изменения количества единиц продукции необходимо использовать параметр quantity.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Приемки.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приемки.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Приемки.

Response 200 (application/json) Успешное удаление позиции Приемки.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Приемки.

Response 200 (application/json) Успешное удаление позиций Приемки.

Приходный ордер

Приходные ордера

Средствами JSON API можно создавать и обновлять сведения о Приходном ордере, запрашивать списки Приходных ордеров и сведения по отдельным Приходным ордерам.Кодом сущности для Приходного ордера в составе JSON API является ключевое слово cashin.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Приходного ордера
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Приходного ордера
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Приходного ордера
externalCode String(255) = != ~ ~= =~ Внешний код Приходного ордера
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Приходного ордера
Обязательное при ответе Только для чтения
meta Meta Метаданные Приходного ордера
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Приходного ордера
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
paymentPurpose String(255) = != ~ ~= =~ Основание
Обязательное при ответе
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Приходного ордера
Expand
sum Int = != < > <= >= Сумма Приходного ордера в установленной валюте
Обязательное при ответе
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Приходного ордера
Обязательное при ответе Только для чтения
vatSum Float Сумма НДС
Обязательное при ответе

Связи с другими документами

Название Описание
factureIn Ссылка на Счет-фактуру полученный, с которым связан этот платеж в формате Метаданных
operations Массив ссылок на связанные операции в формате Метаданных

Разрешенные типы связанных операций:

О работе с доп. полями Приходных ордеров можно прочитать здесь

Получить Приходные ордера

Запрос всех Приходных ордеров на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Приходные ордера.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Приходный ордер

Запрос на создание нового Приходного ордера. Обязательные для создания поля:

Название Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента в формате Метаданных

Массовое создание и обновление Приходных ордеров

Массовое создание и обновление Приходных ордеров. В теле запроса нужно передать массив, содержащий JSON представления Приходных ордеров, которые вы хотите создать или обновить. Обновляемые Приходные ордера должны содержать идентификатор в виде метаданных.

Удалить Приходный ордер

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приходного ордера.

Response 200 (application/json) Успешное удаление Приходного ордера.

Массовое удаление Приходных ордеров

В теле запроса нужно передать массив, содержащий JSON метаданных Приходных ордеров, которые вы хотите удалить.

Метаданные Приходных ордеров

Метаданные Приходных ордеров

Запрос на получение метаданных Приходных ордеров. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Приходных ордеров
attributes Массив объектов доп. полей Приходных ордеров в формате Метаданных
states Массив статусов Приходных ордеров
createShared создавать новые Приходные ордер с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Приходного ордера

Шаблон Приходного ордера

Шаблон Приходного ордера на основе

Запрос на получение шаблона приходного ордера на основе другого документа. В результате запроса, будет предзаполненный приходный ордер на основе переданного документа.

Приходный ордер

Получить Приходный ордер

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приходного ордера.

Изменить Приходный ордер

Запрос на обновление Приходного ордера с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Приходного ордера, кроме тех, что помечены Только для чтения в описании атрибутов Приходного ордера. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.
Для привязки приходного ордера к другим документам нужно положить в поле под именем operations все meta тех документов, к которым вы хотите привязать финансовую операцию. Также для каждого документа можно указать cумму, оплаченную по данному документу из этого платежа linkedSum.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Приходного ордера.

Производственное задание

Средствами JSON API можно обновлять сведения о Производственных заданиях, запрашивать списки Производственных заданий и сведения по отдельным Производственным заданиям. Позициями Производственных заданий можно управлять как в составе отдельного Производственного задания, так и отдельно - с помощью специальных ресурсов для управления позициями Производственных заданий. Кодом сущности для Производственных заданий в составе JSON API является ключевое слово productiontask. Больше о Производстве и Производственном задании и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Работа с производственными этапами описана в отдельном разделе. Чтобы начать производство, нужно передать поле productionStart с указанием даты и времени начала производства.

Производственные задания

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
applicable Boolean Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей Поля объекта
awaiting Boolean Флаг ожидания продукта Производственного задания
code String(255) = != ~ ~= =~ Код Производственного задания
created DateTime Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Производственного задания
Только для чтения
deliveryPlannedMoment DateTime = != < > <= >= Планируемая дата выполнения
description String(4096) = != ~ ~= =~ Комментарий Производственного задания
externalCode String(255) = != ~ ~= =~ Внешний код Производственного задания
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Производственного задания
Обязательное при ответе Только для чтения
materialsStore Meta Метаданные склада материалов
Expand
meta Meta Метаданные Производственного задания
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Производственного задания
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean Напечатан ли документ
Обязательное при ответе Только для чтения
productionRows MetaArray Метаданные Позиций производственного задания. Подробнее тут
Expand
productionEnd DateTime Дата окончания производства
Только для чтения
productionStart DateTime Дата начала производства
products MetaArray Метаданные производимой продукции. Подробнее тут
Обязательное при ответе
productsStore Meta Метаданные склада продукции
Expand
published Boolean Опубликован ли документ
Обязательное при ответе Только для чтения
reserve Boolean Флаг резервирования материала Производственного задания
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta Метаданные статуса Производственного задания
Expand
updated DateTime = != < > <= >= Момент последнего обновления Производственного задания
Обязательное при ответе Только для чтения

Материалы производственного задания находятся в разделе Материалы производственного задания

Для сущности действует ограничение на expand: для поля productionRows недоступен expand вложенных полей.

Позиции Производственного задания

Позиции производственного задания - это список Техкарт, добавленных в Производственное задание. Объект позиции Производственного задания содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
externalCode String(255) Внешний код
id UUID ID позиции
Обязательное при ответе Только для чтения
name String(255) Наименование
processingPlan Meta Метаданные Техкарты
Обязательное при ответе
productionVolume Float Объем производства.
Обязательное при ответе
updated DateTime Момент последнего обновления Производственного задания
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Производственных заданий, а также в составе отдельного Производственного задания. При работе в составе отдельного Производственного задания, вы можете отправлять запросы на создание отдельного Производственного задания с включенным в тело запроса массивом позиций. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Производственного задания". Максимально допустимое число позиций у производственного задания - 200. Также, при работе в составе отдельного Производственного задания, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Производственного задания" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

Продукты производственного задания

Объект Продукта производственного задания содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Ссылка на товар/серию/модификацию, которую представляет собой позиция.
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
planQuantity Float Запланированное для производства количество продукта
Обязательное при ответе
productionRow Meta Метаданные Позиции производственного задания
Обязательное при ответе Expand Только для чтения

С продуктами можно работать с помощью специальных ресурсов для управления продуктами Производственных заданий, а также в составе отдельного Производственного задания. При работе в составе отдельного Производственного задания, вы можете отправлять запросы на создание отдельного Производственного задания с включенным в тело запроса массивом продуктов. Если количество продуктов превышает максимально допустимое, то для дальнейшего пополнения продуктов нужно будет работать со специальным ресурсом "Продукты производственного задания". Также, при работе в составе отдельного Производственного задания, можно отправлять запросы на обновление списка продуктов с включенным в тело запроса массивом продуктов. При этом важно помнить, что коллекция позиций будет восприниматься как "все Продукты производственного задания" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние продукты будут удалены, новые добавлены, существующие - изменены.

Получить список Производственных заданий

Запрос всех Производственных заданий на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Производственные задания.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Производственное задание

Запрос на создание нового Производственного задания. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
materialsStore Метаданные склада материалов
productsStore Метаданные склада продукции

По умолчанию Производственное задание создается не начатым. Чтобы сразу создать и начать производство необходимо передать заполненное поле productionStart

Массовое создание и обновление Производственных заданий

В теле запроса нужно передать массив, содержащий JSON представления Производственных заданий, которые вы хотите создать или обновить. Обновляемые Производственные задания должны содержать идентификатор в виде метаданных.

Массовое удаление Производственных заданий

В теле запроса нужно передать массив, содержащий JSON метаданных Производственных заданий, которые вы хотите удалить.

Метаданные Производственных заданий

Метаданные Производственных заданий

Запрос на получение метаданных Производственных заданий. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Метаданные Производственных заданий
attributes Коллекция доп. полей
createShared Создавать новые Производственныe задания с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 4ca308f4-98f3-11ee-0a81-05c700000a7d id Доп. поля.

Отдельное доп. поле

Получить Производственное задание

Параметры

Параметр Описание
id string (required) Example: 7f9a63c64-98ee-11ee-0a83-0045000025e7 id Производственного задания.

Изменить Производственное задание

Запрос на обновление Производственного задания с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Производственного задания, кроме тех, что помечены Только для чтения в описании атрибутов Производственного задания.

Чтобы начать производство или изменить его дату, необходимо передать заполненное поле productionStart. Стоит учитывать, что если Производственное задание имеет Выполненные этапы, то обновление даты старта производства (поле productionStart) на дату позже, чем дата Выполнения Этапа, приведет к ошибке.

Параметры

Параметр Описание
id string (required) Example: f9a63c64-98ee-11ee-0a83-0045000025e7 id Производственного задания

Удалить Производственное задание

При удалении Производственного задания удаляются все связанные Выполненные этапы производства.

Параметры

Параметр Описание
id string (required) Example: f400f8a3-98e7-11ee-0a83-0045000025d9 id Производственного задания.

Response 200 (application/json) Успешное удаление Производственного задания.

Продукты производственного задания

Отдельный ресурс для управления продуктами Производственного задания. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить Продукты производственного задания

Запрос на получение списка всех продуктов данного Производственного задания.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Продукты производственного задания.

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Продукт производственного задания

Отдельный продукт Производственного задания с указанным id позиции.

Получить продукт производственного задания

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.
productID string (required) Example: ef45d0b2-214e-11ee-c0a8-d00400000069 id продукта Производственного задания.

Создать продукт

Запрос на создание продукта Производственного задания. Для успешного создания необходимо в теле запроса указать следующие поля:

Одновременно можно создать как один, так и несколько продуктов. Все созданные данным запросом продукты будут добавлены к уже существующим.

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.

Изменить продукт

Запрос на обновление продукта Производственного задания. Для обновления продукта нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.
productID string (required) Example: ef45d0b2-214e-11ee-c0a8-d00400000069 id продукта Производственного задания.

Удалить продукт

Ограничения на удаление: нельзя удалить последний продукт из позиции Производственного задания и нельзя удалять продукты после начала выполнения финальной позиции Производственного задания.

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.
productID string (required) Example: ef45d0b2-214e-11ee-c0a8-d00400000069 id продукта Производственного задания.

Response 200 (application/json) Успешное удаление продукта Производственного задания.

Массовое удаление продуктов Производственного задания

Параметры

Параметр Описание
id string (required) Example: ef458539-214e-11ee-c0a8-d00400000066 id Производственного задания.

Response 200 (application/json) Успешное удаление продуктов Производственного задания.

Позиции производственного задания

Получить список позиций производственного задания

Получить отдельную позицию производственного задания

Изменить позиции производственного задания

Запрос на обновление отдельной позиции Производственного задания. Изменить можно только объём производства.

Параметры

Параметр Описание
id string (required) Example: e66dd4ab-9a5c-11ee-0a83-0a2e0000090d id Производственное задание.
positionID string (required) Example: e66de5ff-9a5c-11ee-0a83-0a2e00000910 id позиции Производственного задания.

Удалить отдельную позицию производственного задания

Учитывайте, что удалить позицию производственного задания, у которой есть начатые этапы - нельзя

Response 200 (application/json) Успешное удаление позиции Производственного задания.

Производственные этапы

Производственный этап не является самостоятельной сущностью, ее нельзя создать и удалить. Сущность создается автоматически при наполнении Производственного задания позициями техкарт. Средствами JSON API можно обновлять сведения о Производственных этапах, запрашивать списки Производственных этапов и сведения по отдельным Производственным этапам. Материалами Производственных этапов можно управлять как в составе отдельного Производственного этапа, так и отдельно - с помощью специальных ресурсов для управления материалами Производственных этапов. Кодом сущности для Производственных этапов в составе JSON API является ключевое слово productionstage. Больше о Производстве и Производственном задании и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
enableHourAccounting Boolean Признак активности учета по нормо-часам
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Expand Обязательное при ответе Только для чтения
id UUID ID Производственного этапа
Обязательное при ответе Только для чтения
instruction String(4096) Текст инструкции
Только для чтения
meta Meta Метаданные Производственного этапа
Обязательное при ответе Только для чтения
labourUnitCost Double Затраты на оплату труда за единицу объема производства
materials MetaArray Метаданные Материалов производственного этапа. Подробнее тут
Обязательное при ответе
materialStore Meta Метаданные склада материалов
Только для чтения
orderingPosition Int Индекс Производственного этапа в Позиции производственного задания
Обязательное при ответе Только для чтения
stage Meta Метаданные Этапа производства. Подробнее тут
Expand Обязательное при ответе Только для чтения
productionRow Meta Метаданные Позиции производственного задания
Expand Обязательное при ответе Только для чтения
totalQuantity Double Объем Производственного этапа. Соответствует объему Позиции производственного задания
Только для чтения
completedQuantity Double Выполненное количество
Только для чтения
availableQuantity Double Количество, доступное к выполнению
Только для чтения
blockedQuantity Double Количество, которое на данный момент выполнять нельзя. Например, ещё не выполнен предыдущий этап
Только для чтения
skippedQuantity Double Количество, которое не будет выполнено. Например, из-за остановки производства
Только для чтения
processingUnitCost Double Затраты на единицу объема производства
standardHourCost Double Стоимость нормо-часа
Обязательное при ответе
standardHourUnit Double Нормо-часы единицы объема производства
plannedEndDate DateTime Плановая дата завершения этапа

Особенности: Для сущности действуют ограничения на expand: для поля productionRow недоступен expand вложенных полей.

Для перехода на автоматический расчет оплаты труда по нормо-часам (по формуле labourUnitCost = standardHourCost * standardHourUnit) необходимо передать признак активации (флаг enableHourAccounting=true). Изменение значения оплаты труда при включенном флаге недопустимо - для передачи фиксированного значения требуется деактивировать флаг.

Материалы Производственного этапа

Материалы Производственного этапа - это товары, модификации и серии, которые планируется затратить при выполнении Производственного этапа.

Объект материала Производственного этапа содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID позиции
Обязательное при ответе Только для чтения
planQuantity Float Количество товаров/модификаций данного вида в позиции
Обязательное при ответе

Получить список Производственных этапов Производственного задания

При получении производственных этапов нужно обязательно передавать фильтр на конкретное производственное задание ?filter=productionTask=https://api.moysklad.ru/api/remap/1.2/entity/productiontask/<id>. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Производственные этапы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Изменить Производственный этап

Запрос на обновление Производственного этапа с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Производственного этапа, кроме тех, что помечены Только для чтения в описании атрибутов Производственного этапа.

Параметры

Параметр Описание
id string (required) Example: 19070bfd-99d6-11ee-0a83-0a2e0000076b id Производственного этапа

Материалы производственного этапа

Отдельный ресурс для управления Материалами производственного этапа.

Получить Материалы производственного этапа

Запрос на получение Материалов производственного этапа. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой материалы Производственного этапа

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Производственного этапа
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей

Добавить Материал к производственному этапу

Запрос на добавление Материала к производственному этапу.

Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Производственного этапа

Изменить Материал производственного этапа

Запрос на обновление отдельного Материала производственного этапа.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Производственного этапа
materialID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id материала Производственного этапа

Удалить Материал производственного этапа

Запрос на удаление отдельного Материала производственного этапа.

При включенном резерве, нельзя удалить последний материал в Производственном задании.

Нельзя удалить материал из этапа в котором присутствует выполненный этап.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Производственного этапа
materialID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id материала Производственного этапа

Response 200 (application/json) Успешное удаление материала Производственного этапа.

Расходный ордер

Расходные ордера

Средствами JSON API можно создавать и обновлять сведения о Расходном ордере, запрашивать списки Расходных ордеров и сведения по отдельным Расходных ордеров. Кодом сущности для Расходного ордера в составе JSON API является ключевое слово cashout.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Расходного ордера
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Расходного ордера
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Расходного ордера
expenseItem Meta Метаданные Статьи расходов
Обязательное при ответе Expand Необходимо при создании
externalCode String(255) = != ~ ~= =~ Внешний код Расходного ордера
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
noClosingDocs Boolean Признак возможности привязки закрывающих документов и отключения взаиморасчетов с контрагентом по этой выплате
Обязательное при ответе Только для чтения
id UUID = != ID Расходного ордера
Обязательное при ответе Только для чтения
meta Meta Метаданные Расходного ордера
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Расходного ордера
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
paymentPurpose String(255) = != ~ ~= =~ Основание
Обязательное при ответе
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Расходного ордера
Expand
sum Int = != < > <= >= Сумма расходного ордера в установленной валюте
Обязательное при ответе
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Расходного ордера
Обязательное при ответе Только для чтения
vatSum Float Сумма НДС
Обязательное при ответе

Связи с другими документами

Название Описание
factureIn Ссылка на Счет-фактуру полученный, с которым связан этот платеж в формате Метаданных
operations Массив ссылок на связанные операции в формате Метаданных

Разрешенные типы связанных операций:

О работе с доп. полями Расходных ордеров можно прочитать здесь

Получить Расходные ордера

Запрос всех Расходных ордеров на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Расходные ордера.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Расходный ордер

Запрос на создание нового Расходного ордера. Обязательные для создания поля:

Параметр Описание
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента в формате Метаданных
expenseItem Статья расходов в формате Метаданных

Массовое создание и обновление Расходных ордеров

Массовое создание и обновление Расходных ордеров. В теле запроса нужно передать массив, содержащий JSON представления Расходных ордеров, которые вы хотите создать или обновить. Обновляемые Расходные ордера должны содержать идентификатор в виде метаданных.

Удалить Расходный ордер

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Расходного ордера.

Response 200 (application/json) Успешное удаление Расходного ордера.

Массовое удаление Расходных ордеров

В теле запроса нужно передать массив, содержащий JSON метаданных Расходных ордеров, которые вы хотите удалить.

Метаданные Расходных ордеров

Метаданные Расходных ордеров

Запрос на получение метаданных Расходных ордеров. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Расходных ордеров
attributes Массив объектов доп. полей Расходных ордеров в формате Метаданных
states Массив статусов Расходных ордеров
createShared создавать новые Расходные ордера с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Расходного ордера

Шаблон Расходного ордера

Шаблон Расходного ордера на основе

Запрос на получение предзаполненного представления расходного ордера на основе другого документа.

Расходный ордер

Получить Расходный ордер

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Расходного ордера.

Изменить Расходный ордер

Запрос на обновление Расходного ордера с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Расходного ордера , кроме тех, что помечены Только для чтения в описании атрибутов Расходного ордера . При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.
Для привязки расходного ордера к другим документам нужно положить в поле под именем operations все meta тех документов, к которым вы хотите привязать финансовую операцию. Также для каждого документа можно указать cумму, оплаченную по данному документу из этого платежа linkedSum.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Расходного ордера.

Розничная продажа

Средствами JSON API можно создавать и обновлять сведения о Розничных продажах, запрашивать списки Розничных продаж и сведения по отдельным Розничным продажам. Позициями Розничных продаж можно управлять как в составе отдельной Розничной продажи, так и отдельно - с помощью специальных ресурсов для управления позициями Розничными продажами. Кодом сущности для Розничной продажи в составе JSON API является ключевое слово retaildemand. Больше о Розничных продажах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке в разделе Оформление продажи.

Розничные продажи

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
advancePaymentSum Float Оплачено из аванса
Обязательное при ответе
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании Change-handler
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта Change-handler
cashSum Float Оплачено наличными
Обязательное при ответе
checkNumber String(255) Номер чека
checkSum Float Сумма Чека
code String(255) = != ~ ~= =~ Код Розничной продажи
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
customerOrder Meta Метаданные Заказа Покупателя
Expand
deleted DateTime = != < > <= >= Момент последнего удаления Розничной продажи
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Розничной продажи
Change-handler
documentNumber String(255) Номер документа
externalCode String(255) = != ~ ~= =~ Внешний код Розничной продажи
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
giftCards Array(Object) Коллекция подарочных сертификатов, используемых при оплате продажи. Подробнее тут
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Розничной продажи
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Розничной продажи
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler
name String(255) = != ~ ~= =~ Наименование Розничной продажи
Обязательное при ответе Change-handler
noCashSum Float Оплачено картой
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Отгрузке
Обязательное при ответе Только для чтения
positions MetaArray Метаданные позиций Розничной продажи
Обязательное при ответе Expand Change-handler
prepaymentCashSum Float Предоплата наличными
Обязательное при ответе
prepaymentNoCashSum Float Предоплата картой
Обязательное при ответе
prepaymentQrSum Float Предоплата по QR-коду
Обязательное при ответе
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
qrSum Float Оплачено по QR-коду
Обязательное при ответе
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler
retailShift Meta = != Метаданные Розничной смены
Обязательное при ответе Expand Необходимо при создании
retailStore Meta = != Метаданные Точки продаж
Обязательное при ответе Expand
sessionNumber String(255) Номер сессии
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Розничной продажи
Expand Change-handler
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании
sum Int = != < > <= >= Сумма Розничной продажи в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
taxSystem Enum Код системы налогообложения. Подробнее тут
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления Розничной продажи
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler
vatIncluded Boolean Включен ли НДС в цену
Change-handler
vatSum Float Сумма НДС
Обязательное при ответе Change-handler
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент

Работа с полями оплаты розничной продажи

Сумма полей cashSum, noCashSum, qrSum, prepaymentCashSum, prepaymentNoCashSum, prepaymentNoCashSum и advancePaymentSum должна совпадать с суммой по Розничной продаже (т.е. с суммарной стоимостью всех переданных вами позиций). Каждое из полей не может иметь отрицательное значение.

Смешанная оплата со способом по QR-коду недопустима. Если qrSum или prepaymentQrSum ненулевое, то другие поля не могут быть использованы, иначе вернется ошибка.

Если не используются qrSum и prepaymentQrSum (отсутствуют в запросе или передаются нулевыми):

Если используются qrSum и prepaymentQrSum:

Не допускается одновременное использование аванса и предоплаты. Если поле advancePaymentSum ненулевое, то не допускается ненулевое значение для полей prepaymentByQrSum, prepaymentByCardSum, prepaymentCashSum

Позиции Розничной продажи

Позиции Розничной продажи - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Розничной продажи содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler
cost Int Себестоимость (только для услуг)
declaration Array(Object) Информация о прослеживаемости импортных товаров. Подробнее тут
Выводится по запросу Только для чтения
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
Change-handler
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Розничной продажи, а также в составе отдельной Розничной продажи. При работе в составе отдельной Розничной продажи, вы можете отправлять запросы на создание отдельной Розничной продажи с включенным в тело запроса массивом позиций Розничной продажи. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Розничной продажи". Также, при работе в составе отдельной Розничной продажи, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Розничной продажи. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Розничной продажи" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Розничных продаж можно прочитать здесь

Подарочные сертификаты

Подарочные сертификаты Розничной продажи - это список подарочных сертификатов, используемых при оплате розничной продажи. Объект позиции Розничной продажи содержит следующие поля:

Название Тип Описание
name String Номер сертификата
Обязательное при ответе
paymentSum Float Сумма сертификата
Обязательное при ответе

Информация о прослеживаемости импортных товаров

Поле declaration выводится по запросу. Для вывода в позициях документа информации о прослеживаемости импортных товаров необходимо передать в URL запроса дополнительный параметр fields=declaration, например ../retaildemand/{id}/positions?fields=declaration. Подробнее о параметре fields.

Аттрибуты объекта:

Название Тип Описание
gtd String Регистрационный номер партии товара
Только для чтения
rnpt String Грузовая таможенная декларация
Только для чтения
country Meta Страна происхождения товара
Только для чтения
quantity Float Количество товара с указанными ГТД или РНПТ в позиции документа
Только для чтения

Получить Розничные продажи

Запрос всех Розничных продаж на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Розничные продажи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Розничную продажу

Розничная смена, на которую указывает ссылка при создании Розничной продажи обязательно должна быть активной. При создании Розничной продажи через JSON API, дата, указанная в moment продажи должна быть позже даты, указанной в moment активной розничной смены, иначе произойдет ошибка. Обязательные поля при создании новой Розничной продажи:

Массовое создание и обновление Розничных продаж

Массовое создание и обновление Розничных продаж. В теле запроса нужно передать массив, содержащий JSON представления Розничных продаж, которые вы хотите создать или обновить. Обновляемые Розничные продажи должны содержать идентификатор в виде метаданных.

Удалить Розничную продажу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.

Response 200 (application/json) Успешное удаление Розничной продажи.

Массовое удаление Розничных продаж

В теле запроса нужно передать массив, содержащий JSON метаданных Розничных продаж, которые вы хотите удалить.

Метаданные Розничных продаж

Метаданные Розничных продаж

Запрос на получение метаданных Розничных продаж. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Розничных продаж
attributes Массив объектов доп. полей Розничных продаж в формате Метаданных
states Массив статусов Розничных продаж
createShared создавать новые Розничные продажи с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Розничной продажи

Шаблон Розничной продажи

Запрос на получение предзаполненого стандартными значениями шаблона розничной продажи на основе других документов. При получении шаблона розничной продажи, всегда обязательно указывать ссылку на розничную смену. Без связи со сменой, получить шаблон продажи нельзя. Шаблон продажи можно получить на основе:

Розничная продажа

Получить Розничную продажу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.

Изменить Розничную продажу

Запрос на обновление Розничной продажи с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Розничной продажи, кроме тех, что помечены Только для чтения в описании атрибутов Розничной продажи. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.

Позиции Розничной продажи

Отдельный ресурс для управления позициями Розничной продажи. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции

Запрос на получение списка всех позиций данной Розничной продажи.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Розничной продажи.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Розничной продажи

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничной продажи.

Создать позицию

Запрос на создание новой позиции в Розничной продаже. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.

Изменить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничной продажи.

Запрос на обновление отдельной позиции Розничной продажи.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной продажи.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничной продажи.

Response 200 (application/json) Успешное удаление позиции Розничной продажи.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Розничной продажи.

Response 200 (application/json) Успешное удаление позиций Розничной продажи.

Розничная смена

Розничные смены

Средствами JSON API можно запрашивать списки Розничных смен и сведения по отдельным Розничным сменам. Кодом сущности для Розничной смены в составе JSON API является ключевое слово retailshift.

Атрибуты смены

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
acquire Meta Метаданные Банка-эквайера по операциям по карте
Обязательное при ответе Expand
agentAccount Meta Метаданные счета контрагента
Только для чтения Expand
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
bankComission Double Сумма комиссии эквайера за проведение безналичных платежей по банковской карте. Не может превышать общую сумму безналичных платежей по карте. Если не указано, заполняется 0 автоматически.
Обязательное при ответе
bankPercent Double Комиссия банка-эквайера по операциям по карте (в процентах)
Обязательное при ответе
cheque Object Информация о смене ККТ. Подробнее тут
closeDate DateTime = != < > <= >= Дата закрытия смены
contract Meta = != Метаданные договора
Только для чтения Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Розничной смены
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Розничной смены
externalCode String(255) = != ~ ~= =~ Внешний код Розничной смены
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Только для чтения Expand
id UUID = != ID Розничной смены
Обязательное при ответе Только для чтения
meta Meta Метаданные Розничной смены
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата смены
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Розничной смены
Обязательное при ответе
operations Array(Object) Коллекция метаданных связанных операций
Обязательное при ответе Только для чтения Expand
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
paymentOperations Array(Object) Коллекция метаданных платежных операций
Только для чтения Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
proceedsCash Float Выручка наличными
Обязательное при ответе Только для чтения
proceedsNoCash Float Выручка безнал
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
qrAcquire Meta Метаданные Банка-эквайера по операциям по QR-коду
Обязательное при ответе Expand
qrBankComission Double Сумма комиссии эквайера за проведение безналичных платежей по QR-коду. Не может превышать общую сумму безналичных платежей по QR-коду. Если не указано, заполняется 0 автоматически.
Обязательное при ответе
qrBankPercent Double Комиссия банка-эквайера по операция по QR-коду (в процентах)
Обязательное при ответе
receivedCash Float Получено наличными
Обязательное при ответе Только для чтения
receivedNoCash Float Получено безнал
Обязательное при ответе Только для чтения
retailStore Meta = != Метаданные точки продаж
Обязательное при ответе Expand Необходимо при создании
shared Boolean = != Общий доступ
Обязательное при ответе Только для чтения
store Meta Метаданные склада. Если не указано, заполняется с точки продаж автоматически
Обязательное при ответе Expand
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Розничной смены
Обязательное при ответе
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Только для чтения
vatIncluded Boolean Включен ли НДС в цену

О работе с доп. полями Розничных смен можно прочитать здесь

Информация о смене ККТ

Название Тип Описание
start Object Информация об открытии смены. Подробнее тут
end Object Информация о закрытии смены Подробнее тут

Информация об открытии смены ККТ

Название Тип Описание
fnNumber String Номер фискального накопителя
kktRegNumber String Регистрационный номер ККТ
fiscalDocSign String Фискальный признак документа
shiftNumber String Номер смены ККТ
fiscalDocNumber String Номер фискального документа
time DateTime Дата и время открытия смены.

Информация о закрытии смены ККТ

Название Тип Описание
chequesTotal String Количество чеков за смену
fiscalDocNumber String Номер фискального документа
fiscalDocSign String Фискальный признак документа
fiscalDocsTotal String Количество фискальных документов за смену
fnNumber String Номер фискального накопителя
kktRegNumber String Регистрационный номер ККТ
shiftNumber String Номер смены ККТ
time DateTime Дата и время закрытия смены

Получить Розничные смены

Запрос на получение списка всех Розничных смен на данной учетной записи. Результат успешного запроса - JSON представление списка Розничных смен с перечисленными полями:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Розничные смены.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать розничную смену

Запрос на создание новой розничной смены. Обязательные для создания поля:

Название Тип Описание
organization Meta Метаданные юрлица
retailStore Meta Метаданные точки продаж

Изменить розничную смену

Запрос на обновление розничной смены с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной смены.

Удалить Розничную смену

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной смены.

Response 200 (application/json) Успешное удаление Розничной смены.

Метаданные Розничных смен

Метаданные Розничных смен

Запрос на получение метаданных Розничных смен. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Розничных смен
attributes Массив объектов доп. полей Розничных смен в формате Метаданных
createShared создавать новые Розничные смены с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Отдельное доп. поле

Розничная смена

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничной смены.

Получить Розничную смену

Розничный возврат

Средствами JSON API можно создавать и обновлять сведения о Розничных возвратах, запрашивать списки Розничных возвратов и сведения по отдельным Розничным возвратам. Позициями Розничных возвратов можно управлять как в составе отдельного Возврата, так и отдельно - с помощью специальных ресурсов для управления позициями Розничного возврата. Кодом сущности для Розничного возврата в составе JSON API является ключевое слово retailsalesreturn.

Розничные возвраты

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
cashSum Float Оплачено наличными
Обязательное при ответе
code String(255) = != ~ ~= =~ Код Розничного возврата
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Розничного возврата
Только для чтения
demand Meta Метаданные связанной Розничной продажи
Expand
description String(4096) = != ~ ~= =~ Комментарий Розничного возврата
externalCode String(255) = != ~ ~= =~ Внешний код Розничного возврата
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Розничного возврата
Обязательное при ответе Только для чтения
meta Meta Метаданные Розничного возврата
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Розничного возврата
Обязательное при ответе
noCashSum Float Оплачено картой
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Розничного возврата
Обязательное при ответе Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
qrSum Float Оплачено по QR-коду
Обязательное при ответе
rate Object Валюта. Подробнее тут
Обязательное при ответе
retailShift Meta = != Метаданные Розничной смены
Обязательное при ответе Expand Необходимо при создании
retailStore Meta = != Метаданные Точки продаж
Обязательное при ответе Expand Необходимо при создании
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Розничного возврата
Expand
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании
sum Int = != < > <= >= Сумма Розничного возврата в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
taxSystem Enum Код системы налогообложения. Подробнее тут
updated DateTime = != < > <= >= Момент последнего обновления Розничного возврата
Обязательное при ответе Только для чтения
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе
vatIncluded Boolean Включен ли НДС в цену
vatSum Float Сумма НДС
Обязательное при ответе
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент

Позиции Розничного возврата

Позиции Розничного возврата - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Розничного возврата содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
cost Int Себестоимость (выводится, если документ был создан без основания)
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе
id UUID ID позиции
Обязательное при ответе Только для чтения
pack Object Упаковка Товара. Подробнее тут
price Float Цена товара/услуги в копейках
Обязательное при ответе
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе

С позициями можно работать с помощью специальных ресурсов для управления позициями Розничного возврата, а также в составе отдельного Розничного возврата. При работе в составе отдельного Розничного возврата, вы можете отправлять запросы на создание отдельного Розничного возврата с включенным в тело запроса массивом позиций Розничного возврата. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Розничного возврата". Также, при работе в составе отдельного Розничного возврата, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Розничного возврата. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Розничного возврата" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Розничных возвратов можно прочитать здесь

Получить Розничные возвраты

Запрос всех Розничных возвратов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Розничные возвраты.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Розничный возврат

Розничная смена, на которую указывает ссылка при создании Розничного возврата обязательно должна быть активной. При создании Розничного возврата через JSON API, дата, указанная в moment возврата должна быть позже даты, указанной в moment активной розничной смены, иначе произойдет ошибка. Обязательные поля при создании нового Розничного возврата:

При создании возврата:

Массовое создание и обновление Розничных возвратов

Массовое создание и обновление Розничных возвратов. В теле запроса нужно передать массив, содержащий JSON представления Розничных возвратов, которые вы хотите создать или обновить. Обновляемые Розничные возвраты должны содержать идентификатор в виде метаданных.

Удалить Розничный возврат

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.

Response 200 (application/json) Успешное удаление Розничного возврата.

Метаданные Розничных возвратов

Метаданные Розничных возвратов

Запрос на получение метаданных Розничных возвратов. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Розничных возвратов
attributes Массив объектов доп. полей Розничных возвратов в формате Метаданных
states Массив статусов Розничных возвратов
createShared создавать новые Розничные возвраты с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Розничного возврата

Шаблон Розничного возврата на основе

Запрос на получение предзаполненого стандартными значениями шаблона розничного возврата на основе других документов. Шаблон розничного возврата можно получить на основе:

При запросе шаблона только с розничной сменой в результате получиться шаблон возврата без основания. При запросе шаблона с указанием розничной продажи, розничная смена может быть заполнена из нее.

Розничный возврат

Получить Розничный возврат

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.

Изменить Розничный возврат

Запрос на обновление Розничного возврата с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Розничного возврата, кроме тех, что помечены Только для чтения в описании атрибутов Розничного возврата. При обновлении поля organization нужно также обновить поле organizationAccount иначе произойдет ошибка.

Контрагент должен совпадать с контрагентом, указанным в документе, по которому создается возврат.

При обновлении возврата:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.

Позиции Розничного возврата

Отдельный ресурс для управления позициями Розничного возврата. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции

Запрос на получение списка всех позиций данной Розничного возврата.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Розничного возврата.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Розничного возврата

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничного возврата.

Создать позицию

Запрос на создание новой позиции в Розничном возврате. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.

Изменить позицию

Запрос на обновление отдельной позиции Розничного возврата. При обновлении отдельной позиции в возврате можно только изменить количество данной позиции. Причем это количество должно быть в пределах , где n - кол-во данной позиции в документе, по которому создан возврат.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничного возврата.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Розничного возврата.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Розничного возврата.

Response 200 (application/json) Успешное удаление позиции Розничного возврата.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Розничного возврата.

Response 200 (application/json) Успешное удаление позиций Розничного возврата.

Списание

Средствами JSON API можно создавать и обновлять сведения о Списаниях, запрашивать списки Списаний и сведения по отдельным Списаниям. Позициями Списаний можно управлять как в составе отдельного Списания, так и отдельно - с помощью специальных ресурсов для управления позициями Списания. Кодом сущности для Списания в составе JSON API является ключевое слово loss. Больше о Списаниях можно прочитать этой ссылке.

Списания

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler
code String(255) = != ~ ~= =~ Код Списания
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Списания
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Списания
Change-handler
externalCode String(255) = != ~ ~= =~ Внешний код Списания
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Списания
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Списания
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler
name String(255) = != ~ ~= =~ Наименование Списания
Обязательное при ответе Change-handler
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler
owner Meta = != Владелец (Сотрудник)
Expand
positions MetaArray Метаданные позиций Списания
Обязательное при ответе Expand Change-handler
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Списания
Expand Change-handler
store Meta = != Метаданные склада
Обязательное при ответе Expand Необходимо при создании Change-handler
sum Int = != < > <= >= Сумма Списания в копейках
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Списания
Обязательное при ответе Только для чтения Change-handler

Связи с другими документами

Название Описание
salesReturn Ссылка на связанный со списанием возврат покупателя в формате Метаданных
inventory Ссылка на связанную со списанием инвентаризацию в формате Метаданных

Позиции Списания

Позиции Списания - это список товаров/модификаций/серий. Объект позиции Списания содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler
declaration Array(Object) Информация о прослеживаемости импортных товаров. Подробнее тут
Выводится по запросу Только для чтения
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler
reason String(255) Причина списания данной позиции
slot Meta Ячейка на складе. Подробнее тут
Expand
things Array(String) Серийные номера. Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции будет равно количеству серийных номеров, переданных в значении атрибута.
Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Списания, а также в составе отдельного Списания. При работе в составе отдельного Списания, вы можете отправлять запросы на создание отдельного Списания с включенным в тело запроса массивом позиций Списания. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Списания". Также, при работе в составе отдельного Списания, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Списания. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Списания" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Списаний можно прочитать здесь

Информация о прослеживаемости импортных товаров

Поле declaration выводится по запросу. Для вывода в позициях документа информации о прослеживаемости импортных товаров необходимо передать в URL запроса дополнительный параметр fields=declaration, например ../loss/{id}/positions?fields=declaration. Подробнее о параметре fields.

Аттрибуты объекта:

Название Тип Описание
gtd String Регистрационный номер партии товара
Только для чтения
rnpt String Грузовая таможенная декларация
Только для чтения
country Meta Страна происхождения товара
Только для чтения
quantity Float Количество товара с указанными ГТД или РНПТ в позиции документа
Только для чтения

Получить Списания

Запрос всех Списаний на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Списания.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Списание

Запрос на создание нового Списания. Для успешного создания необходимо в теле запроса указать следующие поля:

Массовое создание и обновление Списаний

Массовое создание и обновление Списаний. В теле запроса нужно передать массив, содержащий JSON представления Списаний, которые вы хотите создать или обновить. Обновляемые Списания должны содержать идентификатор в виде метаданных.

Удалить Списание

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.

Response 200 (application/json) Успешное удаление Списания.

Массовое удаление Списаний

В теле запроса нужно передать массив, содержащий JSON метаданных Списаний, которые вы хотите удалить.

Метаданные Списаний

Метаданные Списаний

Запрос на получение метаданных Списаний. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Списаний
attributes Массив объектов доп. полей Списаний в формате Метаданных
states Массив статусов Списаний
createShared создавать новые Списания с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Списания

Шаблон Списания

Шаблон Списания на основе

Запрос на получение предзаполненного списания на основе возврата покупателя. В результате запроса, будет создан предзаполненный шаблон списания на основе переданного возврата покупателя.

Списание

Получить Списание

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.

Изменить Списание

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.

Запрос на обновление списания с указанным id.

Позиции Списания

Отдельный ресурс для управления позициями Списания. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Списания

Запрос на получение списка всех позиций данного Списания.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Списания.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Списания

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Создать позицию

Запрос на создание новой позиции в Списании. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.

Изменить позицию

Запрос на обновление отдельной позиции Списания. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Списания.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id позиции.

Response 200 (application/json) Успешное удаление позиции Списания.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Списания.

Response 200 (application/json) Успешное удаление позиций Списания.

Счет покупателю

Счета покупателям

Средствами JSON API можно создавать и обновлять сведения о Счете покупателю, запрашивать списки Счетов и сведения по отдельным Счетам Покупателям. Позициями Счетов можно управлять как в составе отдельного Счета, так и отдельно - с помощью специальных ресурсов для управления позициями Счета. Кодом сущности для Счета покупателю в составе JSON API является ключевое слово invoiceout. Больше о Счетах Покупателям и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании Change-handler
agentAccount Meta Метаданные счета контрагента
Expand Change-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта Change-handler
code String(255) = != ~ ~= =~ Код Счета покупателю
contract Meta = != Метаданные договора
Expand Change-handler
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Счета покупателю
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Счета покупателю
Change-handler
externalCode String(255) = != ~ ~= =~ Внешний код Счета покупателю
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Счете покупателю
Обязательное при ответе Только для чтения Change-handler
meta Meta Метаданные Счета покупателю
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler
name String(255) = != ~ ~= =~ Наименование Счета покупателю
Обязательное при ответе Change-handler
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler
organizationAccount Meta Метаданные счета юрлица
Expand Change-handler
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Счету покупателю
Обязательное при ответе Только для чтения Change-handler
paymentPlannedMoment DateTime = != < > <= >= Планируемая дата оплаты
Change-handler
positions MetaArray Метаданные позиций Счета покупателю
Обязательное при ответе Expand Change-handler
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler
salesChannel Meta = != Метаданные канала продаж
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
shippedSum Float Сумма отгруженного
Обязательное при ответе Только для чтения Change-handler
state Meta = != Метаданные статуса счета
Expand Change-handler
store Meta = != Метаданные склада
Expand Change-handler
sum Int = != < > <= >= Сумма Счета в установленной валюте
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Счета покупателю
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler
vatIncluded Boolean Включен ли НДС в цену
Change-handler
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения Change-handler

Связи с другими документами

Название Описание
customerOrder Ссылка на Заказ Покупателя, с которым связан этот Счет покупателю в формате Метаданных
payments Массив ссылок на связанные операции в формате Метаданных Только для чтения
demands Массив ссылок на связанные отгрузки в формате Метаданных

Позиции Счета покупателю

Позиции Счета - это список товаров/услуг/модификаций/серий/комплектов. Объект позиции Счета содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Счета, а также в составе отдельного Счета покупателю. При работе в составе отдельного Счета покупателю, вы можете отправлять запросы на создание отдельного Счета покупателю с включенным в тело запроса массивом позиций Счета. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Счета покупателю". Также, при работе в составе отдельного Счета покупателю, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Счета. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Счета" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Счетов покупателям можно прочитать здесь

Получить Счета покупателям

Запрос всех Счетов покупателям на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Счета покупателям.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Счет покупателю

Запрос на создание нового Счета покупателю. Обязательные для создания поля:

Параметр Описание
name номер Счета покупателю
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента (покупателя) в формате Метаданных

Массовое создание и обновление Счетов покупателю

Массовое создание и обновление Счетов покупателю. В теле запроса нужно передать массив, содержащий JSON представления Счетов покупателю, которые вы хотите создать или обновить. Обновляемые Счета покупателю должны содержать идентификатор в виде метаданных.

Удалить Счет покупателю

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателю.

Response 200 (application/json) Успешное удаление Счета покупателю.

Массовое удаление Счетов покупателям

В теле запроса нужно передать массив, содержащий JSON метаданных Счетов покупателям, которые вы хотите удалить.

Метаданные Счетов покупателям

Метаданные Счетов покупателям

Запрос на получение метаданных Счетов покупателям. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Счетов покупателям
attributes Массив объектов доп. полей Счетов покупателям в формате Метаданных
states Массив статусов Счетов покупателям
createShared создавать новые Счета покупателям с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Отдельное доп. поле

Шаблон Счета покупателю

Шаблон Счета покупателю

Запрос на получение предзаполненого стандартными значениями шаблона счета покупателю без связи с каким-либо документом.

Шаблон Счета покупателю на основе

Запрос на получение предзаполненного счета покупателю на основе заказа покупателя или отгрузки. В результате запроса, будет создан предзаполненный шаблон счета покупателю на основе переданного документа.

Счет покупателю

Получить Счет покупателю

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.

Изменить Счет покупателю

Запрос на обновление Счета покупателю с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Счета покупателю, кроме тех, что помечены Только для чтения в описании атрибутов Счета покупателю. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.

Позиции Счета покупателю

Отдельный ресурс для управления позициями Счета покупателю. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Счета покупателю

Запрос на получение списка всех позиций данного Счета покупателю.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Счета покупателю.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Счета покупателя

Отдельная позиция Счета покупателю с указанным id позиции.

Получить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id id позиции Счета покупателю.

Создать позицию

Запрос на создание новой позиции в Счете покупателю. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.

Изменить позицию

Запрос на обновление отдельной позиции Счета. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id id позиции Счета покупателю.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета покупателя.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id id позиции Счета покупателю.

Response 200 (application/json) Успешное удаление позиции Счета.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Счета покупателя.

Response 200 (application/json) Успешное удаление позиций Счета покупателя.

Счет поставщика

Счета поставщиков

Средствами JSON API можно создавать и обновлять сведения о Счете поставщика, запрашивать списки Счетов и сведения по отдельным Счетам Поставщиков. Позициями Счетов можно управлять как в составе отдельного Счета, так и отдельно - с помощью специальных ресурсов для управления позициями Счета. Кодом сущности для Счета поставщика в составе JSON API является ключевое слово invoicein. Больше о Счетах Поставщиков и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения Change-handler
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand Необходимо при создании Change-handler
agentAccount Meta Метаданные счета контрагента
Expand Change-handler
applicable Boolean = != Отметка о проведении
Обязательное при ответе Change-handler
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
Change-handler
code String(255) = != ~ ~= =~ Код Счета поставщика
contract Meta = != Метаданные договора
Expand Change-handler
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения Change-handler
deleted DateTime = != < > <= >= Момент последнего удаления Счета поставщика
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Счета поставщика
Change-handler
externalCode String(255) = != ~ ~= =~ Внешний код Счета поставщика
Обязательное при ответе Change-handler
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Счета поставщика
Обязательное при ответе Только для чтения Change-handler
incomingDate DateTime = != < > <= >= Входящая дата
Change-handler
incomingNumber Float = != ~ ~= =~ Входящий номер
Change-handler
meta Meta Метаданные Счета поставщика
Обязательное при ответе Change-handler
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе Change-handler
name String(255) = != ~ ~= =~ Наименование Счета поставщика
Обязательное при ответе Change-handler
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании Change-handler
organizationAccount Meta Метаданные счета юрлица
Expand Change-handler
owner Meta = != Владелец (Сотрудник)
Expand
payedSum Float Сумма входящих платежей по Счету поставщика
Обязательное при ответе Только для чтения Change-handler
paymentPlannedMoment DateTime = != < > <= >= Планируемая дата оплаты
Change-handler
positions MetaArray Метаданные позиций Счета поставщика
Обязательное при ответе Expand Change-handler
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
project Meta = != Метаданные проекта
Expand Change-handler
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе Change-handler
shared Boolean = != Общий доступ
Обязательное при ответе
shippedSum Float Сумма отгруженного
Обязательное при ответе Только для чтения Change-handler
state Meta = != Метаданные статуса счета
Expand Change-handler
store Meta = != Метаданные склада
Expand Change-handler
sum Int = != < > <= >= Сумма Счета в установленной валюте
Обязательное при ответе Только для чтения Change-handler
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Счета поставщика
Обязательное при ответе Только для чтения Change-handler
vatEnabled Boolean Учитывается ли НДС
Обязательное при ответе Change-handler
vatIncluded Boolean Включен ли НДС в цену
Change-handler
vatSum Float Сумма НДС
Обязательное при ответе Только для чтения Change-handler

Связи с другими документами

Название Описание
payments Массив ссылок на связанные операции в формате Метаданных Только для чтения
purchaseOrder Ссылка на связанный заказ поставщику в формате Метаданных
supplies Ссылки на связанные приемки в формате Метаданных

Позиции Счета поставщика

Позиции Счета - это список товаров/услуг/модификаций/серий. Объект позиции Счета содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения Change-handler
assortment Meta Метаданные товара/услуги/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand Change-handler
discount Float Процент скидки или наценки. Наценка указывается отрицательным числом, т.е. -10 создаст наценку в 10%
Обязательное при ответе Change-handler
id UUID ID позиции
Обязательное при ответе Только для чтения Change-handler
pack Object Упаковка Товара. Подробнее тут
Change-handler
price Float Цена товара/услуги в копейках
Обязательное при ответе Change-handler
quantity Float Количество товаров/услуг данного вида в позиции. Если позиция - товар, у которого включен учет по серийным номерам, то значение в этом поле всегда будет равно количеству серийных номеров для данной позиции в документе.
Обязательное при ответе Change-handler
vat Int НДС, которым облагается текущая позиция
Обязательное при ответе Change-handler
vatEnabled Boolean Включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Обязательное при ответе Change-handler

С позициями можно работать с помощью специальных ресурсов для управления позициями Счета, а также в составе отдельного Счета поставщика. При работе в составе отдельного Счета поставщика, вы можете отправлять запросы на создание отдельного Счета поставщика с включенным в тело запроса массивом позиций Счета. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом "Позиции Счета поставщика". Также, при работе в составе отдельного Счета поставщика, можно отправлять запросы на обновление списка позиций с включенным в тело запроса массивом позиций Счета. При этом важно помнить, что коллекция позиций будет восприниматься как "все позиции Счета" и полностью заменит уже существующую коллекцию при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

О работе с доп. полями Счетов поставщиков можно прочитать здесь

Получить Счета поставщиков

Запрос всех Счетов поставщиков на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Счета поставщиков.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Счет поставщика

Запрос на создание нового Счета поставщика. Обязательные для создания поля:

Параметр Описание
name номер Счета поставщика
organization Ссылка на ваше юрлицо в формате Метаданных
agent Ссылка на контрагента (поставщика) в формате Метаданных

Массовое создание и обновление Счетов поставщика

Массовое создание и обновление Счетов поставщика. В теле запроса нужно передать массив, содержащий JSON представления Счетов поставщика, которые вы хотите создать или обновить. Обновляемые Счета поставщика должны содержать идентификатор в виде метаданных.

Удалить Счет поставщика

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.

Response 200 (application/json) Успешное удаление Счета поставщика.

Массовое удаление Счетов поставщиков

В теле запроса нужно передать массив, содержащий JSON метаданных Счетов поставщиков, которые вы хотите удалить.

Метаданные Счетов поставщиков

Метаданные Счетов поставщиков

Запрос на получение метаданных Счетов поставщиков. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Счетов поставщиков
attributes Массив объектов доп. полей Счетов поставщиков в формате Метаданных
states Массив статусов Счетов поставщиков
createShared создавать новые Счета поставщиков с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Счета поставщика

Шаблон Счета поставщика

Шаблон Счета поставщика на основе

Запрос на получение предзаполненного счета поставщика на основе заказа поставщику или приемки. В результате запроса, будет создан предзаполненный шаблон счета поставщика на основе переданного документа.

Счет поставщика

Получить Счет поставщика

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.

Изменить Счет поставщика

Запрос на обновление Счета поставщика с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Счета поставщика, кроме тех, что помечены Только для чтения в описании атрибутов Счета поставщика. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.

Позиции Счета поставщика

Отдельный ресурс для управления позициями Счета поставщика. С его помощью вы можете управлять позициями большого документа, количество строк в котором превышает лимит на количество строк, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить позиции Счета поставщика

Запрос на получение списка всех позиций данного Счета поставщика.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Счета поставщика.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Позиция Счета поставщика

Отдельная позиция Счета поставщика с указанным id позиции.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Счета поставщика.

Получить позицию

Создать позицию

Запрос на создание новой позиции в Счете поставщика. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.

Изменить позицию

Запрос на обновление отдельной позиции Счета. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Счета поставщика.

Удалить позицию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета поставщика.
positionID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id позиции Счета поставщика.

Response 200 (application/json) Успешное удаление позиции Счета поставщика.

Массовое удаление позиций

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Счета поставщика.

Response 200 (application/json) Успешное удаление позиций Счета поставщика.

Счет-фактура выданный

Счета-фактуры выданные

Средствами JSON API можно создавать и изменять Счета-фактуры выданные, запрашивать списки Счетов-фактур выданных, сведения по отдельным Счетам-фактурам и удалять Счета-фактуры. Счет-фактура может быть создана только на основании отгрузки, возврата поставщику или входящего платежа, без документа-основания счет-фактуру создать нельзя. Кодом сущности для Счета-фактуры выданного в составе JSON API является ключевое слово factureout.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Счета-фактуры выданного
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Счета-фактуры выданного
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Счета-фактуры выданного
externalCode String(255) = != ~ ~= =~ Внешний код Счета-фактуры выданного
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Счета-фактуры выданного
Обязательное при ответе Только для чтения
meta Meta Метаданные Счета-фактуры выданного
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Счета-фактуры выданного
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Счета-фактуры выданного
Expand
stateContractId String(255) Идентификатор государственного контракта, договора (соглашения)
sum Int = != < > <= >= Сумма Счета-фактуры выданного в копейках
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Счета-фактуры выданного
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
demands Массив ссылок на связанные отгрузки в формате Метаданных
payments Массив ссылок на связанные входящие платежи в формате Метаданных
returns Массив ссылок на связанные возвраты поставщикам в формате Метаданных

Другие поля

Название Тип Описание
consignee Meta Метаданные грузополучателя (контрагент или юрлицо)
Expand
paymentNumber String(255) Название платежного документа
paymentDate DateTime Дата платежного документа

О работе с доп. полями Счетов-фактур можно прочитать здесь

Получить выданные Счета-фактуры

Запрос всех Счетов-фактур выданных на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой выданные Счета-фактуры.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Счет-фактуру

Запрос на создание Счета-фактуры на основании отгрузки, входящего платежа или возврата поставщику. Документ-основание должен быть указан в единственном экземпляре.
Для установки paymentNumber, paymentDate значения должны быть переданы в теле Json, так как перечисленные поля не заполняются из документа-основания.

Массовое создание и обновление Счетов-фактур выданных

Массовое создание и обновление Счетов-фактур выданных. В теле запроса нужно передать массив, содержащий JSON представления Счетов-фактур выданных, которые вы хотите создать или обновить. Обновляемые выданные Счета-фактуры должны содержать идентификатор в виде метаданных.

Массовое удаление Счетов-фактур выданных

В теле запроса нужно передать массив, содержащий JSON метаданных Счетов-фактур выданных, которые вы хотите удалить.

Метаданные Счетов-фактур выданных

Метаданные Счетов-фактур

Запрос на получение метаданных Счетов-фактур выданных. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Счетов-фактур выданных
attributes Массив объектов доп. полей Счетов-фактур выданных в формате Метаданных
states Массив статусов Счетов-фактур выданных
createShared создавать новые выданные Счета-фактуры с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 8b0b6c1d-aa6f-11e6-8a84-bc520000008a id Доп. поля.

Шаблон Счета-фактуры выданного

Шаблон Счета-фактуры выданного на основе

Запрос на получение предзаполненного шаблона Счета-фактуры выданного на основе отгрузки, возврата поставщику или входящего платежа. В ответ на запрос вернется предзаполненный шаблон Счета-фактуры выданного, который затем можно будет использовать для создания нового Счета-фактуры с помощью POST запроса.

Счет-фактура выданный

Получить Счет-фактуру выданный

Параметры

Параметр Описание
id string (required) Example: 99d41b01-aa8a-11e6-8af5-581e0000007e id Счета-фактуры.

Изменить Счет-фактуру выданный

Параметры

Параметр Описание
id string (required) Example: 99d41b01-aa8a-11e6-8af5-581e0000007e id Счета-фактуры.

Запрос на обновление Счета-фактуры с указанным id.

Удалить Счет-фактуру выданный

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b20 id Счета-фактуры.

Response 200 (application/json) Успешное удаление Счета-фактуры выданного.

Счет-фактура полученный

Счета-фактуры полученные

Средствами JSON API можно создавать и изменять Счета-фактуры полученные, запрашивать списки Счетов-фактур полученных, сведения по отдельным Счетам-фактурам и удалять Счета-фактуры. Счет-фактура может быть создана только на основании приемки или исходящего платежа, без документа-основания счет-фактуру создать нельзя. Кодом сущности для Счета-фактуры полученного в составе JSON API является ключевое слово facturein.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные контрагента
Обязательное при ответе Expand
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Счета-фактуры полученного
contract Meta = != Метаданные договора
Expand
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Счета-фактуры полученного
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Счета-фактуры полученного
externalCode String(255) = != ~ ~= =~ Внешний код Счета-фактуры полученного
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Счета-фактуры полученного
Обязательное при ответе Только для чтения
meta Meta Метаданные Счета-фактуры полученного
Обязательное при ответе
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Счета-фактуры полученного
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
rate Object Валюта. Подробнее тут
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Счета-фактуры полученного
Expand
sum Int = != < > <= >= Сумма Счета-фактуры полученного в установленной валюте
Обязательное при ответе Только для чтения
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
updated DateTime = != < > <= >= Момент последнего обновления Счета-фактуры полученного
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
supplies Массив ссылок на связанные приемки в формате Метаданных
payments Массив ссылок на связанные исходящие платежи в формате Метаданных

Другие поля

Название Тип Описание
incomingNumber Int Входящий номер
incomingDate DateTime Входящая дата

О работе с доп. полями Счетов-фактур можно прочитать здесь

Получить Счета-фактуры полученные

Запрос всех Счетов-фактур полученных на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Счета-фактуры полученные.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Счет-фактуру

Запрос на создание Счета-фактуры на основании приемки или исходящего платежа. Документ-основание должен быть указан в единственном экземпляре.
Для установки incomingNumber, incomingDate значения должны быть переданы в теле Json, так как перечисленные поля не заполняются из документа-основания.

Массовое создание и обновление Счетов-фактур полученных

Массовое создание и обновление Счетов-фактур полученных. В теле запроса нужно передать массив, содержащий JSON представления Счетов-фактур полученных, которые вы хотите создать или обновить. Обновляемые Счета-фактуры полученные должны содержать идентификатор в виде метаданных.

Массовое удаление Счетов-фактур полученных

В теле запроса нужно передать массив, содержащий JSON метаданных Счетов-фактур полученных, которые вы хотите удалить.

Метаданные Счетов-фактур полученных

Метаданные Счетов-фактур

Запрос на получение метаданных Счетов-фактур полученных. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Счетов-фактур полученных
attributes Массив объектов доп. полей Счетов-фактур полученных в формате Метаданных
states Массив статусов Счетов-фактур полученных
createShared создавать новые Счета-фактуры полученные с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 8b0b6c1d-aa6f-11e6-8a84-bc520000008a id Доп. поля.

Шаблон Счета-фактуры полученного

Шаблон Счета-фактуры полученного на основе

Запрос на получение предзаполненного шаблона Счета-фактуры полученного на основе приемки или исходящего платежа. В ответ на запрос вернется предзаполненный шаблон Счета-фактуры полученного, который затем можно будет использовать для создания нового Счета-фактуры с помощью POST запроса.

Счет-фактура полученный

Получить Счет-фактуру полученный

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета-фактуры.

Изменить Счет-фактуру полученный

Запрос на обновление Счета-фактуры с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета-фактуры.

Удалить Счет-фактуру полученный

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Счета-фактуры.

Response 200 (application/json) Успешное удаление Счета-фактуры полученного.

Техоперация

Средствами JSON API можно создавать и обновлять сведения о Техоперациях, запрашивать списки Техопераций и сведения по отдельным Техоперациям. Позициями Техопераций можно управлять как в составе отдельной Техоперации, так и отдельно - с помощью специальных ресурсов для управления материалами и продуктами Техоперации. Кодом сущности для Техоперации в составе JSON API является ключевое слово processing. Больше о Техоперациях и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Техоперации

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
applicable Boolean = != Отметка о проведении
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция метаданных доп. полей. Поля объекта
code String(255) = != ~ ~= =~ Код Техоперации
created DateTime = != < > <= >= Дата создания
Обязательное при ответе Только для чтения
deleted DateTime = != < > <= >= Момент последнего удаления Техоперации
Только для чтения
description String(4096) = != ~ ~= =~ Комментарий Техоперации
externalCode String(255) = != ~ ~= =~ Внешний код Техоперации
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Техоперации
Обязательное при ответе Только для чтения
materials Array(Object) Список Метаданных материалов Техоперации
Обязательное при ответе Expand
materialsStore Meta Метаданные склада для материалов
Обязательное при ответе Expand Необходимо при создании
meta Meta Метаданные Техоперации
Обязательное при ответе Только для чтения
moment DateTime = != < > <= >= Дата документа
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Техоперации
Обязательное при ответе
organization Meta = != Метаданные юрлица
Обязательное при ответе Expand Необходимо при создании
organizationAccount Meta Метаданные счета юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
printed Boolean = != Напечатан ли документ
Обязательное при ответе Только для чтения
processingPlan Meta Метаданные Техкарты
Expand
processingSum Int Затраты на производство за единицу объема производства
Обязательное при ответе
products Array(Object) Список Метаданных готовых продуктов Техоперации
Обязательное при ответе Expand
productsStore Meta Метаданные склада для продукции
Обязательное при ответе Expand Необходимо при создании
project Meta = != Метаданные проекта
Expand
published Boolean = != Опубликован ли документ
Обязательное при ответе Только для чтения
quantity Float = != < > <= >= Объем производства
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса Техоперации
Expand
syncId UUID = != ID синхронизации. После заполнения недоступен для изменения
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Техоперации
Обязательное при ответе Только для чтения

Связи с другими документами

Название Описание
processingOrder Ссылка на заказ на производство в формате Метаданных

Материалы Техоперации

Материалы Техоперации - это список товаров/модификаций, используемых для производства готовых продуктов. Объект материала Техоперации содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID Техоперации
Обязательное при ответе Только для чтения
quantity Float Количество товаров данного вида в позиции
Обязательное при ответе

Продукты Техоперации

Продукты Техоперации - это список товаров/модификаций, получаемых при производстве. Объект продукта Техоперации содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/серии/модификации, которую представляет собой позиция
Обязательное при ответе Expand
id UUID ID Техоперации
Обязательное при ответе Только для чтения
quantity Float Количество товаров данного вида в позиции
Обязательное при ответе

С материалами и продуктами можно работать с помощью специальных ресурсов для управления позициями Техоперации, а также в составе отдельной Техоперации. При работе в составе отдельной Техоперации, вы можете отправлять запросы на создание отдельной Техоперации с включенными в тело запроса массивами материалов и продуктов Техоперации. Также, при работе в составе отдельной Техоперации, можно отправлять запросы на обновление списка материалов и продуктов с включенными в тело запроса массивами материалов и продуктов Техоперации.

Особенности поведения Техоперации

Поля quantity, processingSum, products, materials тесно связаны с техкартой. Техоперация должна состоять как минимум из одной позиции в готовой продукции. Для этого необходимо привязать техкарту и готовая продукция будет проставлена автоматически из техкарты, либо самостоятельно передать готовую продукцию в поле products.

Получить список Техопераций

Запрос всех Техопераций на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Техоперации.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

Создать Техоперацию

Особенности поведения при создании техоперации с привязкой техкарты

Если в теле запроса передается техкарта и отсутствуют поля products, materials, processingSum, то они будут созданы на основании техкарты. Если не передается поле quantity, то будет выставлено дефолтное значение равное 1. При ином значении количество готовой продукции и материалов техоперации будут пересчитаны кратно передаваемому значению. Если необходимо создать техоперацию с привязкой техкарты, но отличной продукцией или материалами, то нужно передать заполненные поля products, materials. Если необходимо указать пустые материалы, но они присутствуют в техкарте, то следует явно передать пустое значение для поля materials, в противном случае при не указанном поле оно будет взято из привязываемой техкарты.

Обязательные для создания поля с привязкой техкарты:

Особенности поведения при создании техоперации без техкарты

В этом случае в теле запроса обязательно необходимо передать поля products и processingSum. Если не передается поле quantity, то будет выставлено дефолтное значение равное 1.

Обязательные для создания поля без привязки техкарты:

Массовое создание и обновление Техопераций

Массовое создание и обновление Техопераций. В теле запроса нужно передать массив, содержащий JSON представления Техопераций, которые вы хотите создать или обновить. Обновляемые Техоперации должны содержать идентификатор в виде метаданных.

Удалить Техоперацию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техоперации.

Response 200 (application/json) Успешное удаление Техоперации.

Массовое удаление Техопераций

В теле запроса нужно передать массив, содержащий JSON метаданных Техопераций, которые вы хотите удалить.

Метаданные Техопераций

Метаданные Техопераций

Запрос на получение метаданных Техопераций. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Техопераций
attributes Массив объектов доп. полей Техопераций в формате Метаданных
states Массив статусов Техопераций
createShared создавать новые Техоперации с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Доп. поля.

Шаблон Техоперации

Шаблон Техоперации на основе

Запрос на получение предзаполненной техоперации на основе другого документа. В результате запроса будет создан предзаполненный шаблон техоперации на основе переданного документа.

Техоперация

Получить Техоперацию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техоперации.

Изменить Техоперацию

Запрос на обновление Техоперации с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Техоперации, кроме тех, что помечены Только для чтения в описании атрибутов Техоперации.

Особенности поведения при изменении Техоперации

При привязке новой техкарты старые значения готовой продукции, материалы и затраты на производство будут заменены, согласно новой привязываемой техкарты, иначе необходимо передать в теле запроса заполненные поля products, materials, processingSum. Если необходимо указать пустые материалы, но они присутствуют в техкарте, то следует явно передать пустое значение для поля materials. Если не передается поле quantity, то оно останется без изменений и будет равно предыдущему значению в техоперации. Количество готовой продукции и материалов техоперации будут пересчитаны кратно объему производства.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техоперации.

Материалы Техоперации

Отдельный ресурс для управления материалами Техоперации. С его помощью вы можете управлять материалами большого документа, количество материалов в котором превышает лимит на количество материалов, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить материалы Техоперации

Запрос на получение списка всех материалов данной Техоперации.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой материалы Техоперации.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техоперации.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Материал Техоперации

Получить материал

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техоперации.

Добавить материал

Обязательные для создания поля: + assortment - Ссылка на товар/серию/модификацию в формате Метаданных + quantity - Количество товаров данного вида в позиции

Параметры

Параметр Описание
id string (required) Example: f64737f7-df69-11ed-ac12-000c00000004 id Техоперации.

Изменить материал

Для обновления материала нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техоперации.

Удалить материал

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техоперации.

Response 200 (application/json) Успешное удаление материала Техоперации.

Массовое удаление материалов

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Техоперации.

Response 200 (application/json) Успешное удаление материалов Техоперации.

Продукты Техоперации

Отдельный ресурс для управления продуктами Техоперации. С его помощью вы можете управлять продуктами большого документа, количество продуктов в котором превышает лимит на количество продуктов, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить продукты Техоперации

Запрос на получение списка всех продуктов данной Техоперации.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой продукты Техоперации.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техоперации.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Продукт Техоперации

Получить продукт

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id продукта Техоперации.

Добавить продукт

Обязательные для создания поля: + assortment - Ссылка на товар/серию/модификацию в формате Метаданных + quantity - Количество товаров данного вида в позиции

Параметры

Параметр Описание
id string (required) Example: f64737f7-df69-11ed-ac12-000c00000004 id Техоперации.

Изменить продукт

Запрос на обновление отдельного продукта Техоперации. Для обновления продукта нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id продукта Техоперации.

Удалить продукт

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

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техоперации.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техоперации.

Response 200 (application/json) Успешное удаление продукта Техоперации.

Массовое удаление продуктов

Параметры

Параметр Описание
id string (required) Example: 3e1c03bb-684f-11ee-ac12-000c000000b0 id Техоперации.

Response 200 (application/json) Успешное удаление продуктов Техоперации.