МойСклад JSON API 1.1

API Endpoint

https://online.moysklad.ru/api/remap/1.1

Данная версия API устарела, она поддерживается и работает,
но в ней не появляются новые возможности

API для манипуляции с сущностями и создания отчетов в онлайн-сервисе МойСклад.

Общие Сведения ¶

Для того чтобы успешно взаимодействовать с JSON API онлайн-сервиса МойСклад, необходимо аутентифицироваться в системе. МойСклад поддерживает аутентификацию по протоколу Basic Auth, при которой вместе с запросом передаётся заголовок Authorization со значением пары логин:пароль, закодированным в варианте RFC2045-MIME стандарта Base64. Аутентификация по протоколу Basic Auth с автоматической генерацией соответствующего заголовка поддерживается во многих HTTP-клиентах, таких как Postman, curl и т.п.

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

Структура ответов и типы полей поддерживаются нами неизменными
Может быть добавлено новое поле без нарушения структуры ответа
Может быть добавлен новый ресурс

Для JSON API установлены следующие ограничения:

Не более 45 запросов за 3 секундный период от аккаунта
Не более 5 параллельных запросов от одного пользователя
Не более 20 параллельных запросов от аккаунта
Не более 20 Мб данных в одном запросе, отправляемом на сервер

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

В JSON есть несколько видов Метаданных. Один из них - поле meta, которое фигурирует в большинстве JSON представлений объектов, и содержит информацию об объекте или о выдаче, а также может использоваться в качестве ссылки на другой объект. Поле meta представляет собой объект со следующими атрибутами:

href - Ссылка на объект
metadataHref - Ссылка на метаданные сущности (Другой вид метаданных. Присутствует не во всех сущностях)
type - Тип объекта
mediaType - Тип данных, которые приходят в ответ от сервиса, либо отправляются в теле запроса. В рамках данного API всегда равен application/json
uuidHref - Ссылка на объект на UI. Присутствует не во всех сущностях. Может быть использована для получения uuid

Атрибуты расширенного объекта meta

Следующие атрибуты объекта meta появляются, как правило, в методах выдачи списка сущностей/строк отчёта. В них содержится информация о выдаче, пришедшей в ответ. В объектах meta, содержащих данные лишь об одном объекте (например поле meta в объекте context) нижеперечисленные атрибуты не фигурируют.

size - Размер выданного списка
limit - Максимальное количество элементов в выданном списке
offset - Отступ в выданном списке

Метаданные сущности

Другой вид Метаданных. Представляет собой отдельный ресурс, содержащий информацию обо всех объектах сущностей данного типа. Есть не у каждой сущности. Присутствует лишь у тех сущностей, у которых в данной документации описан ресурс “Метаданные <наименование_сущности>”. Как правило содержит информацию о вложенных сущностях, коллекциях и дополнительных полях.

JSON API позволяет получить метаданные всех сущностей с помощью метода /entity/metadata. Также можно ограничить выборку, указав в фильтре type только необходимые сущности.

Пример URL для запроса на получение метаданных с помощью GET:

/entity/metadata?filter=type=product;type=service;type=demand

Пример тела запроса:

{
  "service": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/service/metadata",
      "mediaType": "application/json"
    },
    "priceTypes": [
      {
        "name": "Цена продажи"
      }
    ]
  },
  "product": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
      "mediaType": "application/json"
    },
    "priceTypes": [
      {
        "name": "Цена продажи"
      }
    ]
  },
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
      "mediaType": "application/json"
    }
  }
}

Мета коллекций

meta коллекций содержит все те же атрибуты, что и meta сущностей, однако, если в списке появляется больше позиций, чем умещается на одной странице (size > limit) в объект meta добавляются след. поля:

nextHref - Ссылка на предыдущую страницу сущностей.
previousHref - Ссылка на следующую страницу сущностей.

meta с такими полями можно встретить при выполнении запросов на получение всех объектов определённого типа на учетной записи (например запрос всех отгрузок), а также при запросе всех позиций отдельного документа.

СТРУКТУРА ОШИБОК

Ошибка в данном API представляет собой массив errors, содержащий объекты error, каждый из которых описывает отдельную ошибку.

СТРУКТУРА ОБЪЕКТА error

error - Заголовок ошибки
parameter - Параметр, на котором произошла ошибка
code - Код ошибки (Если поле ничего не содержит, смотрите HTTP status code)
error_message - Сообщение, прилагаемое к ошибке
moreInfo - Ссылка на документацию с описанием полученной ошибки
line - Строка JSON, на которой произошла ошибка
column - Координата элемента в строке line, на котором произошла ошибка
dependencies - Список метаданных зависимых сущностей или документов. Выводится при невозможности удаления сущности, документа, если имеются зависимости от удаляемой сущности, документа
meta - Метаданные сущности, документа на котором произошла ошибка

Возвращаемые HTTP статусы ошибок и их значения:

HTTP status code	Значение
301	Запрашиваемый ресурс находится по другому URL.
303	Запрашиваемый ресурс может быть найден по другому URI и должен быть найден с использоваием GET запроса
400	Ошибка в структуре JSON передаваемого запроса
401	Имя и/или пароль пользователя указаны неверно или заблокированы пользователь или аккаунт
403	У вас нет прав на просмотр данного объекта
404	Запрошенный ресурс не существует
405	http-метод указан неверно для запрошенного ресурса
409	Указанный объект используется и не может быть удалён
410	Версия API больше не поддерживается
412	Не указан обязательный параметр строки запроса или поле структуры JSON
413	Размер запроса или количество элементов запроса превышает лимит (например, количество позиций, передаваемых в массиве positions, превышает 100)
429	Превышен лимит количества запросов
500	При обработке запроса возникла непредвиденная ошибка
502	Сервис временно недоступен
503	Сервис временно отключен
504	Превышен таймаут обращения к сервису, повторите попытку позднее

Также, вместе с телом ответа ошибки, вам могут прийти следующие заголовки (Headers):

X-Lognex-Auth - расширенный код ошибки аутентификации
X-Lognex-Auth-Message - сообщение об ошибке.
X-Lognex-API-Version-Deprecated - дата отключения запрошенной версии API.
Location - URL по которому доступен запрашиваемый ресурс (в случае ответа с кодом 301 или кодом 303)

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

X-RateLimit-Limit - количество запросов, которые равномерно можно сделать в течение интервала до появления 429 ошибки
X-Lognex-Retry-TimeInterval - интервал в миллисекундах, в течение которого можно сделать эти запросы
X-RateLimit-Remaining - Число запросов, которые можно отправить до получения 429 ошибки
X-Lognex-Reset - время до сброса ограничения в миллисекундах. Равно нулю, если ограничение не установлено
X-Lognex-Retry-After - время до сброса ограничения в миллисекундах.

Все коды ошибок и их описания

1000

Сообщение: Элемент URI не является идентификатором
Описание: Вероятнее всего вы пытаетесь обратиться к несуществующему ресурсу. Проверьте указанный вами URI, проверьте правильно ли вы указали ключевое слово сущности и полностью ли вы скопировали ID.

1001

Сообщение: Не указан идентификатор метаданных
Описание: При обращении к пользовательскому справочнику в URI должен быть указан корректный {id} метаданных данного справочника. Его можно уточнить, сделав запрос к метаданным настроек компании companysettings/metadata в массиве customEntities.

1002

Сообщение: Неопознанный путь: {путь}
Описание: Не удалось определить ресурс, по которому был сделан запрос. Проверьте URI по которому совершается запрос.

1003

Сообщение: Отсутствуют метаданные для типа {тип}
Описание: Для данного ресурса нельзя получить метаданные. Ещё раз проверьте документацию по сущности данного типа и убедитесь в наличии ресурса “Метаданные <наименование_сущности>”

1004

Сообщение: Ошибка при формировании результата: {текст ошибки}
Описание: При разборе переданного объекта произошла ошибка. Проверьте корректность переданных данных.

1005

Сообщение: Неизвестный тип: {тип}
Описание: Тип сущности, указанный в URI, не может быть найден. Проверьте корректность ключевого слова.

1006

Сообщение: Создание объектов с указанным идентификатором запрещено
Описание: При создании сущности не нужно указывать в URI запроса id сущности. Запрос на создание должен происходить по тому же URI, по которому происходит запрос на получение списка сущностей данного типа.

1007

Сообщение: Неизвестное поле: {имя поля}
Описание: При обновлении сущности указанное поле не было найдено. Проверьте правильность написания имени поля, а также убедитесь что данное поле присутствует среди атрибутов сущностей этого типа.

1008

Сообщение: Ошибка при загрузке объекта с типом ‘{тип}’ и идентификатором ‘{id}’
Описание: Не удалось загрузить сущность с данным id. Проверьте корректность id. Убедитесь что сущность с данным id присутствует среди списка сущностей данного типа (возможно сущность с данным id была удалена).

1009

Сообщение: Редактирование объектов типа ‘{тип}’ не поддерживается
Описание: Сущность которую вы пытаетесь обновить - только для чтения. Изменение её атрибутов не предусмотрено.

1010

Сообщение: Удаление объектов типа ‘{тип}’ не поддерживается
Описание: Нельзя удалить сущность данного типа. Проверьте, есть ли среди операций данного типа сущностей операция удаления.

1011

Сообщение: Создание объектов типа ‘{тип}’ не поддерживается
Описание: Нельзя создать сущность данного типа. Проверьте, есть ли среди операций данного типа сущностей операция создания.

1012

Сообщение: Не указан идентификатор объекта
Описание: Для операций обновления и удаления необходимо указывать id сущности, над которой производится операция.

1013

Сообщение: Удаление вложенных объектов не поддерживается
Описание: Невозможно удалить вложенные сущности, такие как счета контрагентов. Если вы хотите обнулить значение поля: попробуйте передать null в качестве значения данного поля в запроса не обновление. В случае с позициями документов - вы можете передать пустой массив. Это будет эквивалентно удалению сразу всех позиций из документа.

1014

Сообщение: Неверное значение ‘{значение}’ параметра фильтрации ‘{имя параметра}’
Описание: Вы указали значение неподдерживаемого типа для данного параметра (например передали int вместо boolean). Возможно ошибка в неправильном формате даты и времени.

1015

Сообщение: Указана неверная версия в url: {url}
Описание: Проверьте необходимую версию API в url по которому вы делаете запрос. online.moysklad.ru/api/1.x/... Версии API различаются между собой по количеству доступных ресурсов, а также по способу обработки данных и именно поэтому являются важным элементом идентификации того или иного ресурса.

1016

Сообщение: Доступ запрещен: у вас нет прав на просмотр данного объекта
Описание: Администратор учётной записи ограничил ваши права на просмотр сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1017

Сообщение: Доступ запрещен: у вас нет прав на редактирование данного объекта
Описание: Администратор учётной записи ограничил ваши права на редактирование сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1018

Сообщение: Доступ запрещен: у вас нет прав на удаление данного объекта
Описание: Администратор учётной записи ограничил ваши права на удаление сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1019

Сообщение: Чтение поля ‘{имя поля}’ не поддерживается
Описание: Невозможно чтение поля данного типа.

1020

Сообщение: Родительский объект с типом ‘{тип}’ и идентификатором ‘{id}’ не существует
Описание: Неверный id родительской сущности.

1021

Сообщение: Объект с типом ‘{тип}’ и идентификатором ‘{id}’ не найден
Описание: Не удалось загрузить сущность данного типа с данным id. Проверьте корректность id. Убедитесь что сущность с данным id присутствует среди списка сущностей данного типа (возможно сущность с данным id была удалена)

1022

Сообщение: Ошибка при создании объекта
Описание: Ошибка в процессе создания сущности данного типа.

1023

Сообщение: Ошибка сохранения объекта: дочерний объект с типом ‘{тип}’ и идентификатором ‘{id}’ уже используется и не может быть удален
Описание: Невозможно удалить объект во вложенной коллекции т.к. он уже где-то используется. Например, может возникнуть при удалении позиции из документа, по которому есть возврат, в котором присутствует данная позиция.

1024

Сообщение: Ошибка сохранения объекта: изменять стандартные объекты запрещено
Описание: Вы пытаетесь изменить сущность, которая создаётся по умолчанию в сервисе МойСклад сразу после регистрации учётной записи. Это делать запрещено. (Например изменение стандартных стран и единиц измерения)

1025

Сообщение: Ошибка удаления объекта: удалять стандартные объекты запрещено
Описание: Удаление стандартных объектов, таких как стандартные единицы измерения, валюты, страны и т.п. не поддерживается.

1026

Сообщение: Обновление объектов типа ‘{тип}’ не поддерживается
Описание: Обновление объектов указанного типа не поддерживается в JSON API.

1027

Сообщение: Запрос не содержит объектов
Описание: Тело запросов на создание/обновление должно представляться в виде объекта либо массива JSON.

1028

Сообщение: Объект уже используется и не может быть удален
Описание: Сущность используется в сущностях и документах, перечисленных в ошибке, поэтому её нельзя удалить. Например нельзя удалить товар, который используется в качестве позиции в каком-либо документе.

1029

Сообщение: Шаблоны для типа ‘{тип}’ не поддерживаются
Описание: Невозможно создать предзаполненную сущность данного типа.

1030

Сообщение: Поле для фильтрации ‘{имя поля}’ может быть указано только один раз
Описание: Убедитесь, что каждое поле используется в параметрах фильтрации лишь единожды.

1031

Сообщение: Ошибка генерации шаблона: невозможно создать шаблон объекта на основе указанных полей
Описание: Невозможно создать предзаполненную сущность данного типа на основе другой.

1032

Сообщение: Ошибка фильтрации: характеристика ‘{имя/id характеристики}’ не существует
Описание: У данной модификации нет характеристики с указанным id. Проверьте правильность введённого id и список характеристик для данной модификации.

1033

Сообщение: Ошибка фильтрации: фильтрация по характеристикам модификаций совместима только с группировкой по модификациями
Описание: В отчётах при передаче значения параметра groupBy отличного от variant невозможна фильтрация по характеристикам модификаций.

1034

Сообщение: Ошибка фильтрации: {текст ошибки}
Описание: Ошибка в процессе обработки фильтров. Проверьте переданные фильтры на валидность. Подробнее о параметрах фильтрации вы можете прочесть в соответствующем разделе документации или в документации по сущности, к которой вы пытаетесь применять фильтры.

1035

Сообщение: Ошибка фильтрации: неверный формат даты параметра фильтрации
Описание: Проверьте значение даты и времени. Оно должно соответствовать формату yyyy-MM-dd HH:mm:ss

1036

Сообщение: Ошибка при формировании метаданных
Описание Внутренняя ошибка сервиса. Попробуйте повторить запрос.

1037

Сообщение: Неверно указан Content-Type запроса
Описание Возможно ресурс, к которому вы обращаетесь, требует form-data вместо JSON (или наоборот).

1038

Сообщение: Ошибка в адресе запроса
Описание Проверьте, указываете ли вы валидный адрес запроса.

1039

Сообщение: Операция {HTTP метод} не поддерживается для данного ресурса
Описание Проверьте метод, с которым вы обращаетесь к ресурсу. Убедитесь, что в документации ресурса этот метод описан и его можно применить.

1040

Сообщение: Неверно заданы параметры запроса
Описание Один или несколько параметров запроса заданы некорректно. Проверьте формат параметров согласно документации.

1041

Сообщение: Неверное значение ‘{значение}’ параметра фильтрации ‘{имя параметра}’, допустимые значения: ‘{список допустимых значений}’
Описание: Значение параметра должно входить в список допустимых значений.

1042

Сообщение: Неверное значение ‘{значение}’ параметра сортировки ‘{имя параметра}’, допустимые значения: ‘{список допустимых значений}’
Описание: Значение параметра должно входить в список допустимых значений.

1043

Сообщение: Ваш тарифный план не позволяет работать с CRM
Описание: Ваш тариф не подходит для работы с CRM.

1044

Сообщение: Превышен максимальный размер запроса
Описание: Максимальный размер запроса 10 МБ.

1045

Сообщение: Доступ запрещен: у вас нет прав на создание данного объекта
Описание: Администратор учётной записи ограничил ваши права на создание сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1046

Сообщение: Дочерняя сущность не может изменять свою родительскую сущность
Описание: Возможно вы попробовали подставить позицию(и) из одного документа в другой (Попробуйте удалить meta, id, accountId из документа и позиции(й)).

1047

Сообщение: Вы не можете обновить поле syncId в запросе на обновление сущности
Описание: Поле syncId может быть указано только при создании сущности. Его нельзя изменить в запросе на обновление.

1052

Сообщение: Неверный формат UUID
Описание: Проверьте сгенерированные вами UUID на корректность.

1056

Сообщение: Ошибка аутентификации: {текст ошибки аутентификации}
Описание Проверьте указанные для аутентификации данные. Возможно для данного ресурса требуется другой вид аутентификации.

1058

Сообщение: Не удалось декодировать параметры запроса из URL
Описание Проверьте запрос. Вероятно, в строке присутствуют параметры, которые не были urlencoded.

1059

Сообщение: Некорректный сервер в идентификаторе объекта: ‘{идентификатор}’
Описание Идентификатор объекта содержит сервер, отличный от online.moysklad.ru.

1060

Сообщение: Некорректный тип данных в meta сущности, поле type
Описание Тип данных указанный в поле type метаданных сущности не совпадает с ожидаемым типом.

1061

Сообщение: Отсутствует доступ к API для данного пользователя
Описание Отсутствует доступ к API для данного пользователя - обратитесь к администратору аккаунта.

1062

Сообщение: Неверное значение заголовка ‘Accept’. Поддерживается только значение ‘application/json;charset=utf-8’
Описание Значение заголовка ‘Accept’ может быть только application/json;charset=utf-8.

1063

Сообщение: Ошибка сортировки: неизвестное поле ‘{название поля}’ или сортировка для данного поля не поддерживается
Описание Сортировка для данного поля не поддерживается. Возможно, поле не входит в список поддерживаемых полей.

1064

Сообщение: Доступ запрещен: у вас нет прав на печать данных объектов
Описание Администратор учётной записи ограничил ваши права на печать сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1065

Сообщение: Ошибка сохранения объекта: объект уже изменен/удален в параллельном запросе
Описание Ошибка возникает при попытке изменить объект из нескольких параллельных запросов к API.

1066

Сообщение: Ошибка удаления объекта: объект нельзя переместить в корзину
Описание Удаление в корзину возможно только для документов. Проверьте, является ли удаляемый объект документом.

1067

Сообщение: Ошибка удаления объекта: использование корзины отключено
Описание Отключена опция для удаления документов в корзину - обратитесь к администратору аккаунта.

1068

Сообщение: Точка продаж отключена. Обратитесь к администратору аккаунта
Описание Убедитесь, что Ваш тарифный план поддерживает работу с точками продаж.

1069

Сообщение: Ошибка запроса: несовместимые параметры запроса: ‘{несовместимые параметры}’
Описание Не все параметры запроса могут быть применены одновременно, они перечисленны в тексте ошибки: ‘{несовместимые параметры}’. Следует исключить параметры из запроса, учитывая совместимость.

1070

Сообщение: Ошибка: ваш тарифный план не позволяет вам работать с данным ресурсом
Описание На вашем тарифном плане работа с указанным ресурсом недоступна.

1071

Сообщение: Превышено ограничение на количество попыток регистрации
Описание Вы попытались зарегистрироваться слишком много раз

1072

Сообщение: Превышено ограничение на количество регистраций с указанного адреса
Описание Вы попытались зарегистрироваться слишком много раз

1073

Сообщение: Превышено ограничение на одновременное количество запросов
Описание От вас поступает слишком много параллельных запросов в единицу времени.

1074

Сообщение: Сервис временно недоступен, ведутся технические работы
Описание На сервере проводятся технические работы.

1083

Сообщение: Ошибка при формировании результата: {текст ошибки}
Описание При формировании ответа произошла ошибка на стороне сервера. Попробуйте повторить запрос заново.

1090

Сообщение: Дополнительный справочник {название справочника} используется в: {названия документов} и не может быть удален
Описание Дополнительный справочник используется как дополнительное поле в документах, перечисленных в ошибке.

1999

Сообщение: Неизвестная ошибка
Описание Произошла непредвиденная ошибка. Пожалуйста, обратитесь в поддержку сервиса МойСклад подробно изложив условия при которых эта ошибка произошла.

Ошибки формата

2000

Сообщение: Ошибка формата: отсутствует начало объекта
Описание: В данном месте ожидалось начало объекта. Проверьте тело запроса.

2001

Сообщение: Ошибка формата: входящий запрос не соответствует формату JSON
Описание: Данные должны быть отправлены в формате JSON. Если это так, а ошибка всё-таки возникает - попробуйте добавить Header Content-Type со значением application/json.

2002

Сообщение: Ошибка формата: неименованное внутреннее поле типа массив
Описание: Проверьте указали ли вы наименование поля типа массив. Возможно присутствуют лишние открывающиеся/закрывающиеся скобки в теле запроса.

2003

Сообщение: Ошибка формата: неименованное внутреннее поле типа объект
Описание: Проверьте указали ли вы наименование поля типа “объект”. Возможно присутствуют лишние открывающиеся/закрывающиеся скобки в теле запроса.

2004

Сообщение: Ошибка формата: вложенные массивы недопустимы
Описание: В рамках JSON API не обрабатываются массивы массивов. Проверьте тело запроса на корректность.

2005

Сообщение: Ошибка формата: входящий JSON должен начинаться либо с объекта, либо с массива
Описание: Отсутствует открывающаяся фигурная/квадратная скобка в начале тела запроса.

2006

Сообщение: Ошибка формата: слишком большая вложенность объектов
Описание: Максимальная глубина вложенности в JSON API - 10. Скорректируйте тело запроса и убедитесь, что это ограничение не нарушается.

2007

Сообщение: Ошибка формата: слишком большое число вложенных объектов
Описание: В JSON API в массиве может содержаться не более 100 объектов.

2008

Сообщение: Ошибка формата: запрос на шаблон не должен содержать массив
Описание: С помощью запроса по ресурсу {entity_name}/new можно создать только 1 шаблон. Передача массива значений не поддерживается.

2009

Сообщение: Ошибка формата: запрос на создание/обновление одной сущности не должен содержать массив
Описание: При обновлении отдельной сущности подразумевается, что в теле запроса будет передано её новое представление (одно). В теле запроса должен быть один корневой объект.

2010

Сообщение: Ошибка формата: отсутствует href для meta поля ‘{доп. сообщение}’
Описание: В переданном объекте метаданных отсутствует поле href. Проверьте тело запроса.

2011

Сообщение: Ошибка формата: отсутствует type для meta поля ‘{доп. сообщение}’
Описание: В переданном объекте метаданных отсутствует поле type. Проверьте тело запроса.

2012

Сообщение: Ошибка формата: неизвестный type для meta поля ‘{доп. сообщение}’
Описание: В переданном объекте метаданных указан неизвестный тип. Проверьте тело запроса. Возможно вы указываете неверное ключевое слово для сущности. Проверьте документацию по данной сущности и убедитесь в правильности передаваемого type.

2013

Сообщение: Ошибка формата: неправильное значение href для meta поля ‘{доп. сообщение}’
Описание: Переданный href указывает на несуществующий объект. Убедитесь в корректности ссылки. Ошибка может быть в версии API, типе ресурса (entity/pos/report), ключевом слове сущности/(отчёта), id сущности.

2014

Сообщение: Ошибка формата: отсутствует meta для поля ‘{имя поля}’
Описание: Для полей типа метаданных (ссылок на другие связанные объекты) необходимо значение в виде объекта, содержащего meta.

2015

Сообщение: Ошибка формата: отсутствует id для поля ‘{имя поля}’
Описание: При передаче вложенных сущностей в виде полей необходимо указывать id этих сущностей.

2016

Сообщение: Ошибка формата: значение поля ‘{имя поля}’ не соответствует типу {тип поля}
Описание: Для указанного поле передано значение неверного типа. Исправьте тело запроса.

2017

Сообщение: Ошибка формата: неизвестная ошибка
Описание: Не удалось однозначно классифицировать ошибку. Убедитесь что формат передаваемых вами данных соответствует требуемому. Посмотрите примеры запросов в документации по используемой вами сущности.

2018

Сообщение: Ошибка формата: отсутствует поле для meta
Описание: Вы не указали обязательное поле объекта meta.

2021

Сообщение: Ошибка формата: в объектах типа ‘<тип>’ полю ‘<наименование поля>’ не может быть присвоен объект типа <тип объекта>
Описание: Для сущностей данного типа у указанного поля не может быть выставлено указанное значение. Например, нельзя полю agent отгрузки выставить значение типа employee, тогда как тому же полю входящего платежа можно выставить значение типа employee.

2022

Сообщение: Ошибка формата: слишком большое число элементов вложенной коллекции
Описание: Вложенная коллекция может иметь в составе не более 100 элементов.

2024

Сообщение: Ошибка формата: href указывает на сущность неправильного типа ‘<тип>’, требуется ‘<тип>’
Описание: Переданная ссылка href указывает на сущность неправильного типа.

2025

Сообщение: Ошибка формата: значение <заголовок|параметр|поле> ‘<наименование>’ не соответствует формату даты ‘<формат даты>’
Описание: Переданное значение даты не соответствует формату даты

2028

Сообщение: Ошибка формата: Доп поле ‘{имя доп. поля}’ сущности с id ‘{id}’ содержит не числовое значение
Описание: В получаемом объекте содержится доп поле с некорректным значением

Общие ошибки валидации

3000

Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может быть пустым или отсутствовать
Описание: Необходимое поле не может содержать пустого значения или отсутствовать. Все необходимые поля можно посмотреть в документации по сущности, с которой вы работаете, под заголовком “Атрибуты сущности”. Такие поля помечены как Необходимое.

3001

Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может быть изменено
Описание: Вы пытаетесь изменить поле являющееся полем только для чтения. Все read-only поля можно посмотреть в документации по сущности, с которой вы работаете, под заголовком “Атрибуты сущности”. Такие поля помечены как Только для чтения.

3002

Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может иметь отрицательное значение
Описание: Данное поле принимает только числовые значения больше либо равные нулю.

3003

Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ должно быть больше нуля
Описание: Данное поле принимает только числовые значения больше нуля. Эта ошибка также возвращается при указании значений, которые при округлении до 4-го знака после запятой будут равны нулю (т.е. для значений < 0.00005).

3004

Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не соответствует полю связанного объекта
Описание: Поле возврата не соответствует полю документа-основания. Невозможно изменить значения полей agent, currency, vatIncluded в возвратах на несоответствующие значениям этих же полей в документе-основании.

3005

Сообщение: Ошибка сохранения объекта: неверное значение ‘{значение}’ поля ‘{имя поля}’. Допустимые значения: {список значений}
Описание: Вы пытаетесь присвоить несуществующее значение полю типа “перечисление”(enum). Проверить все возможные значения этого поля вы можете в документации по данной сущности в разделе “Атрибуты сущности”.

3006

Сообщение: Ошибка сохранения объекта: нарушено ограничение уникальности параметра ‘{имя параметра}’
Описание: У указанного поля/параметра должно быть уникальное значение в системе. Например, если включена проверка на уникальность номеров операций, name у разных документов не может быть одинаковым.

3007

Сообщение: Ошибка валидации сохраняемого объекта: ‘{объект}’
Описание: Ошибка при обмене. Проверьте, соблюдает ли все условия передаваемый вами объект.

3008

Сообщение: Ошибка сохранения объекта: значение поля ‘{имя поля}’ превышает максимально допустимое значение
Описание: Значение числового поля превышает максимально допустимое значение: 9 999 999 999.

3009

Сообщение: Ошибка валидации: поле ‘{имя поля}’ не может быть пустым или отсутствовать
Описание: Необходимое поле не может содержать пустого значения или отсутствовать.

3011

Сообщение: Ошибка валидации штрихкода: невозможно добавить к сущности штрихкод длиной более 255 символов
Описание: Исправьте длину штрихкода и попробуйте повторить запрос.

3012

Сообщение: Ошибка валидации: для поля ‘{имя поля}’ массив элементов не должен содержать атомарный тип или null
Описание: Нельзя передавать атомарный тип или null в составе массива.

3013

Сообщение: Ошибка валидации: для поля ‘{имя поля}’ массив элементов не должен содержать сущности с одинаковыми идентификаторами
Описание: Нельзя передавать сущности с одинаковыми идентификаторами в составе массива.

3030

Сообщение: *Ошибка валидации заголовка ‘{название заголовка}’: {описание ошибки} *
Описание: Было передано некорректное значение в заголовке.

Точки продаж

4000

Сообщение: Указанная точка продаж не активна
Описание: Для выполнения операции необходимо активировать точку продаж.

Отчёты комиссионера

5000

Сообщение: Неверный тип договора для отчёта комиссионера. Могут быть использованы только договоры типа ‘Договор комиссии’(Comission).
Описание: При создании / обновлении отчёта комиссионера обязательно указывать договор, который принадлежащит указанному контрагенту и имеет тип ‘Договор комиссии’.

5001

Сообщение: Неверно указан период отчёта комиссионера: конец периода не может быть раньше начала.
Описание: Проверьте указанные даты. Дата в поле commissionPeriodStart должна быть раньше даты в поле commissionPeriodEnd.

5002

Сообщение: Указанный договор заключен с контрагентом, отличным от указанного в поле agent
Описание: При создании / обновлении отчёта комиссионера обязательно указывать договор, который принадлежащит указанному контрагенту и имеет тип ‘Договор комиссии’.

5003

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

Характеристики модификаций

10000

Сообщение: Ошибка сохранения характеристики модификации: поля ‘id’ и ‘name’ не могут быть пустыми
Описание: При обновлении характеристик модификации необходимо указывать вышеуказанные поля. Исправьте тело запроса.

10001

Сообщение: Ошибка сохранения характеристики модификации: поле ‘id’ ссылается на несуществующую характеристику
Описание: По переданному id не удалось найти соответствующую характеристику. Убедитесь в правильности id и повторите запрос.

Статусы

11000

Сообщение: Ошибка инициализации статуса: отсутствует информация о родительской сущности
Описание: Не удалось найти документ, к которому должен быть привязан данный статус. Проверьте id документа, а также, в случае обновления, убедитесь, что документ с данным id не был удалён.

11001

Сообщение: Ошибка инициализации статуса: статус с именем ‘{Наименование статуса}’ не найден
Описание: Проверьте в метаданных сущностей данного типа, что статус с передаваемым именем существует, и исправьте запрос.

Розничные смены (POS)

12000

Сообщение: Ошибка открытия розничной смены: розничная смена находится в корзине
Описание: Данный syncId уже был использован для открытия другой смены. Данная смена уже была удалена. Для открытия новой смены сгенерируйте новый syncId.

12001

Сообщение: Ошибка открытия розничной смены: розничная смена закрыта
Описание: Данный syncId уже был использован для открытия другой смены. Данная смена уже была закрыта. Переоткрыть её невозможно. Для открытия новой смены сгенерируйте новый syncId.

12002

Сообщение: Ошибка закрытия розничной смены: розничная смена удалена
Описание: По переданному id смены не было найдено соответствующего объекта. Смена с данным id либо не существовала, либо была удалена. Проверьте правильность переданного id смены.

12003

Сообщение: Ошибка закрытия розничной смены: розничная смена находится в корзине
Описание: Смена с указанным id находится в корзине. Проверьте правильность указанного вами id смены.

12004

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

12005

Сообщение: Ошибка открытия розничной смены: не найдена точка продаж
Описание: При открытии смены не была найдена точка продаж с указанным id. Проверьте id точки продаж, на которой должна быть открыта новая смена.

12006

Сообщение: Ошибка открытия розничной смены: параметр ‘retailShift’ отсутствует или имеет неверный формат
Описание: Убедитесь в наличии параметра ‘retailShift’.

Отчёт Остатки

13000

Сообщение: Пустой идентификатор операции
Описание: Вы запросили отчёт Остатки по операции, не указав id операции. Убедитесь что id передаётся в качестве параметра.

13001

Сообщение: Операция с указанным идентификатором не найдена
Описание: Не удалось найти операцию с указанным operation.id. Проверьте передаваемый вами id, а также убедитесь что операция с данным id не была удалена.

13002

Сообщение: Операция не может быть выполнена для указанного типа ‘{тип документа}’ документа
Описание: Отчёт Остатки по операциям доступен только для операций типа Отгрузка, Розничная продажа, Заказ покупателя.

13003

Сообщение: Отсутствует доступ к отчету Остатки
Описание: У пользователя отсутствует доступ к отчету Остатки.

Дополнительные поля

14000

Сообщение: Ошибка сохранения дополнительного поля: поле ‘{наименование поля}’ не относится к реестру ‘{тип сущности}’
Описание: В своём запросе пытаетесь использовать дополнительные поля другого типа сущности. Сделайте запрос метаданных по данному типу сущности и используйте дополнительные поля которые придут в ответ
14001
Сообщение: Ошибка сохранения дополнительного поля: обновление дополнительных полей типа ‘Файл’ не поддерживается
Описание: Поле типа файл обновить нельзя.

14002

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

14003

Сообщение: Ошибка сохранения дополнительного поля: идентификатор метаданных указывает на несуществующий объект
Описание: Не удалось найти доп поле с указанным id. Проверьте список доп полей и их id с помощью ресурса метаданных сущности.

14004

Сообщение: Ошибка сохранения дополнительного поля: для объекта типа ‘пользовательский справочник’ необходимо указать поле meta или name
Описание: Хотя бы одно из вышеуказанных полей не должно быть пустым.

14005

Сообщение: Ошибка сохранения дополнительного поля типа ‘Файл’: размер файла превышает максимально допустимый (10 мб)
Описание: Невозможно загрузить в качестве значения дополнительного поля файл размером более 10 мб.

14006

Сообщение: Ошибка сохранения дополнительного поля типа ‘Файл’: отсутствует имя файла
Описание: Поле filename у значения дополнительного поля типа Файл должно быть заполнено.

14007

Сообщение: Ошибка сохранения дополнительного поля типа ‘Файл’: отсутствует поле content
Описание: Поле content у значения дополнительного поля типа Файл должно быть заполнено.

14008

Сообщение: Ошибка сохранения дополнительного поля типа ‘Файл’: недостаточно места в хранилище для сохранения файла
Описание: Место в хранилище, выделенное для вашего аккаунта, закончилось.

14009

Сообщение: Ошибка сохранения дополнительного поля типа ‘{наименование типа поля}’: отсутствует поле value
Описание: Поле value у значения дополнительного поля типа ‘{наименование типа поля}’ должно быть заполнено.

14010

Сообщение: Доступ запрещён: создавать, изменять и удалять дополнительные поля может только пользователь с правами администратора
Описание: создавать, изменять и удалять дополнительные поля может только пользователь с правами администратора.

14011

Сообщение: Ошибка удаления дополнительного поля: неверный формат meta удаляемого дополнительного поля
Описание: По переданной meta не удалось идентифицировать дополнительное поле для удаления.

Модификации

15000

Сообщение: Ошибка сохранения модификации: модификация с данным набором характеристик уже существует для данного товара
Описание: Невозможно иметь 2 модификации товара, у которых наборы значений характеристик будут совпадать. Убедитесь что это условие не нарушается. Иначе: используйте уже существующую модификацию.

15001

Сообщение: Ошибка сохранения модификации: должны быть заданы характеристики
Описание: При создании/обновлении модификации переданный массив характеристик не может отсутствовать или быть пустым.

15002

Сообщение: Ошибка сохранения модификации: нельзя создать модификацию услуги
Описание: Поддерживаются только модификации товаров. Убедитесь в правильности URI по которому происходит запрос.

15003

Сообщение: Ошибка сохранения модификации: нельзя создать модификацию алкогольного товара
Описание: Поддерживаются только модификации обычных товаров. Убедитесь в правильности URI по которому происходит запрос.

15004

Сообщение: Ошибка сохранения модификации: названия характеристик не должны повторяться
Описание: Нельзя создать модификацию с одинаковыми характеристиками.

Товары

16000

Сообщение: Ошибка сохранения товара: свойства алкогольной продукции не могут быть отрицательными
Описание: Алкогольные поля “код алкогольной продукции”, “крепость” и “объём” должны принимать значение строго большее 0.

16001

Сообщение: Ошибка сохранения товара: весовой товар не может использовать учет по серийным номерам
Описание: Товар не может одновременно быть весовым и использовать учёт по серийным номерам. Это - взаимоисключающие признаки.

16002

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

16003

Сообщение: Ошибка сохранения товара: у изображения отсутствует контент
Описание: При передаче изображение в составе товара в запросе на создание товара необходимо указывать поле content

16004

Сообщение: Ошибка сохранения товара: невозможно преобразовать поле content в изображение
Описание: Содержимым поля “content” должно быть изображение закодированное в формате base64 с расширением jpg или png.

16005

Сообщение: Ошибка сохранения товара: Недостаточно места в хранилище.
Описание: Место в хранилище, выделенное для вашей учётной записи закончилось.

16006

Сообщение: Ошибка сохранения товара: размер изображения превышает максимально допустимый(3 мб)
Описание: Попробуйте уменьшить размер изображения.

16007

Сообщение: Ошибка сохранения товара: у изображения отсутствует имя файла
Описание: При загрузке изображения необходимо указать непустое имя файла в поле filename.

16008

Сообщение: Ошибка сохранения товара: для использования упаковок нужно указать единицу измерения товара
Описание: Для использования упаковок должна быть задана единица измерения товара

16102

Сообщение: Ошибка сохранения товара: товар с типом маркировки «{тип маркировки}» не может иметь модификаций.
Описание: У маркированного товара типа “{тип маркировки}” не может быть модификаций

16103

Сообщение: Ошибка сохранения товара: маркированный товар не может учитываться по серийным номерам.
Описание: Товар не может быть одновременно маркированным и учитываться по серийным номерам

16104

Сообщение: Ошибка сохранения товара: маркированный товар не может быть алкогольным.
Описание: Товар не может быть одновременно маркированным и алкогольным

16105

Сообщение: Ошибка сохранения товара: маркированный товар не может быть весовым.
Описание: Товар не может быть одновременно маркированным и весовым

16106

Сообщение: Ошибка сохранения товара: неизвестный тип маркировки товара.
Описание: Тип маркировки товара может быть только одним из следующих: NOT_TRACKED, TOBACCO, SHOES, LP_CLOTHES, LP_LINENS, PERFUMERY, ELECTRONICS, TIRES, MILK, WATER, OTP, NCP

16107

Сообщение: Ошибка сохранения товара: поле ТН ВЭД не может быть указано для: «Табачная продукция».
Описание: У табачной продукции не может быть кода ТН ВЭД

16108

Сообщение: Ошибка сохранения товара: значение поля ТН ВЭД не найдено в справочнике.
Описание: Указанный код ТН ВЭД не существует в классификаторе ТН ВЭД ЕАЭС

16109

Сообщение: Ошибка сохранения товара: поле ТН ВЭД не может быть указано для немаркированной продукции.
Описание: Поле ТН ВЭД может присутствовать только у маркированных товаров

16110

Сообщение: Ошибка сохранения товара: <Текст ошибки>
Описание: Произошла ошибка сохранения маркированного товара

16111

Сообщение: Ошибка сохранения товара: значение поля ТН ВЭД не соответствует типу маркированной продукции
Описание: Тип маркированной продукции определенный по ТН ВЭД не соответсвует выбранному пользователем

Документы

17000

Сообщение: Ошибка сохранения документа: счет организации не принадлежит указанной организации
Описание: Убедитесь что вы указываете подходящий счёт. Если вы обновляете поле organization вместе с ним также должно обновляться поле organizationAccount.

17001

Сообщение: Ошибка сохранения документа: счет контрагента не принадлежит указанному контрагенту
Описание: Убедитесь что вы указываете подходящий счёт. Если вы обновляете поле agent вместе с ним также должно обновляться поле agentAccount.

17002

Сообщение: Ошибка сохранения позиции документа: серийный номер не может быть пустым
Описание: Серийный номер не может быть пустой строкой.

17003

Сообщение: Ошибка сохранения позиции документа: количество зарезервированных товаров не может превышать общее количество
Описание: Количество зарезервированного товара позиции документа не может превышать общее количество товара по документу.

17004

Сообщение: Ошибка сохранения позиции документа: количество товаров в ожидании не может превышать общее количество
Описание: Количество ожидаемого товара позиции документа не может превышать общее количество товара по документу.

17005

Сообщение: Ошибка сохранения связанного документа: отсутствует ссылка на документ-основание
Описание: При сохранении связанного документа необходима ссылка на документ-основание (например при сохранении возврата необходима ссылка на продажу).

17006

Сообщение: Ошибка сохранения связанного документа: несовместимые типы документов - ‘<тип1>’ и ‘<тип2>’
Описание: В качестве связи вы указали документ несоответствующего типа.

17007

Сообщение: Ошибка сохранения позиции документа: НДС не может быть больше 100
Описание: Процент НДС может принимать значения от 0 до 100.

17008

Сообщение: Ошибка сохранения позиции документа: скидка не может быть больше 100
Описание: Процент скидки может принимать значения от 0 до 100.

17009

Сообщение: Ошибка сохранения документа: дата ‘{тип документа}’ не попадает в открытый для редактирования период
Описание: Данный документ относится к закрытому периоду. Редактирование документа невозможно.

17010

Сообщение: Ошибка сохранения документа: вы не можете проводить документы со складом-приемником из другого отдела
Описание: В метаданных документа запрещено проводить документы со складом-приемником из другого отдела.

17011

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

17012

Сообщение: Ошибка сохранения документа: вы не можете сохранять документы со складом-приемником из другого отдела
Описание: В метаданных документа запрещено сохранять документы со складом-приемником из другого отдела.

17013

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

17014

Сообщение: Ошибка сохранения документа: вы не можете снять проведение у документа типа <тип>, по которому был проведен возврат
Описание: Нельзя снять проведение у данного документа, поскольку для него уже был проведен возврат.

17016

Сообщение: Ошибка сохранения документа: комплект не может быть в составе позиции документа типа {тип_документа}
Описание: Комплект не может быть позицией в следующих документах: заказ поставщику, счет поставщика, приемка, возврат поставщику, выданный отчет комиссионера, полученный отчет комиссионера, списание, оприходование, перемещение, инвентаризация, тех. карта, тех. операция, внутренний заказ.

17018

Сообщение: Ошибка сохранения документа: количество комплектов должно быть целым числом
Описание: Количество комплектов в позиции должно быть целым числом

17020

Сообщение: Ошибка сохранения позиции документа: товар упаковки и товар позиции отличаются
Описание: Для данной позиции документа товар из упаковки и указанный товар отличаются

17022

Сообщение: Ошибка сохранения документа: {вид ассортимента} не может быть в составе позиции документа типа {тип_документа}
Описание: Добавляемый вид ассортимента не может быть позицией в этом типе документа

17101

Сообщение: Ошибка сохранения документа: для товара <наименование товара> не установлен признак маркированной продукции. Измените товар для сохранения кодов маркировки
Описание: Установите для товара признак маркированной продукции ‘trackingType’ соответствующей категории

17102

Сообщение: Ошибка сохранения документа: неверный формат кода маркировки <значение КМ / КМ ТУ / КМ ПУ>
Описание:

Код маркировки для всех категорий маркированной продукции должен соответствовать формату:

01+GTIN+21+SERIAL. GTIN - идентификатор товара из 14 цифр, SERIAL - серийный номер из 13 символов. Пример: 010463003759026521K6UT)6\"pIG-<

Исключения:

Табачная продукция продукция, пачка: GTIN+SERIAL. GTIN - идентификатор товара из 14 цифр, SERIAL - серийный номер из 7 символов.
Табачная продукция продукция, блок (упаковка): 01+GTIN+21+SERIAL. GTIN - идентификатор товара из 14 цифр, SERIAL - серийный номер из 7 символов. Пример: 010463003407002921tXXXu%d
Фотокамеры и лампы-вспышки:01+GTIN+21+SERIAL. GTIN - идентификатор товара из 14 цифр, SERIAL - серийный номер из 20 символов.
Код маркировки транспортной упаковки продукции должен содержать 18 цифр - формат GS1.

17103

Сообщение: Ошибка сохранения документа: в документе несколько одинаковых кодов <значение КМ / КМ ТУ / КМ ПУ>
Описание: Среди кодов маркировки есть дублирующиеся. Удалите дубликаты кодов маркировки для сохранения позиции

17104

Сообщение: Ошибка сохранения документа: код маркировки <КМ> не может содержать вложенные коды
Описание: Допустимо сохранять список кодов маркировки trackingcode, список потребительских упаковок consumerpack, список транспортных упаковок transportpack, список кодов маркировки trackingcode вложенных в транспортные упаковки transportpack или потребительские упаковки consumerpack, список потребительских упаковок consumerpack вложенных в транспортные упаковки transportpack. Сохранение других вложенных структур не поддерживается

17105

Сообщение: Ошибка сохранения документа: код маркировки транспортной упаковки <КМ ТУ> не может содержать вложенные коды транспортных упаковок
Описание: Допустимо сохранять список кодов маркировки trackingcode и список потребительских упаковок consumerpack вложенных в транспортные упаковки transportpack. Не поддерживается сохранение транспортных упаковок вложенных в транспортные упаковки

17106

Сообщение: Ошибка сохранения документа: код маркировки потребительской упаковки не может содержать вложенные коды
Описание: Допустимо сохранять список кодов маркировки trackingcode вложенных в транспортные упаковки transportpack. Не поддерживается сохранение кодов маркировки trackingcode вложенных в потребительские упаковки consumerpack

17107

Сообщение: Ошибка сохранения документа: код маркировки транспортной упаковки <КМ ТУ> не может одновременно содержать вложенные коды товаров и потребительских упаковок
Описание: Допустимо сохранять список кодов маркировки trackingcode или список потребительских упаковок consumerpack вложенных в транспортные упаковки transportpack. Не поддерживается их одновременное сохранение для одной транспортной упаковки

Продажи/Отгрузки

18000

Сообщение: Ошибка сохранения продажи: сумма ‘cashSum’, ‘noCashSum’, ‘prepaymentCashSum’ и ‘prepaymentNoCashSum’ не соответствует сумме по документу
Описание: Сумма полей cashSum, noCashSum, prepaymentCashSum и prepaymentNoCashSum должна быть равна значению поля sum или отличаться менее чем на 10 единиц. В случае создания документа и указании вышеупомянутых полей в теле запроса, ответственность за подсчёт sum ложится на пользователя. sum считается как общая сумма по всем позициям документа.

18002

Сообщение: Ошибка сохранения документа: отгрузка по комиссионному договору не может содержать комплект в составе позиций
Описание: В отгрузку нельзя добавить комплект, если для неё указан договор типа “Комиссионный”".

Возвраты

19000

Сообщение: Ошибка сохранения возврата: розничная смена уже закрыта
Описание: Нельзя сохранить возврат в закрытую розничную смену. Убедитесь что используете идентификатор активной смены.

19001

Сообщение: Ошибка сохранения розничного возврата: поля ‘cashSum’ и ‘noCashSum’ являются обязательными для возврата без основания
Описание: Поля ‘cashSum’ и ‘noCashSum’ являются обязательными для возврата без основания. Убедитесь, что они заполнены.

19002

Сообщение: Ошибка сохранения розничного возврата: сумма ‘cashSum’ и ‘noCashSum’ не соответствует сумме по документу
Описание: Сумма полей cashSum и noCashSum должна быть равна значению поля sum или отличаться менее чем на 10 единиц. В случае создания документа и указании вышеупомянутых полей в теле запроса, ответственность за подсчёт sum ложится на пользователя. sum считается как общая сумма по всем позициям документа.

Приёмки

20000

Сообщение: Ошибка сохранения приемки: нельзя указать накладные расходы с договором комиссии
Описание: Если к приёмке привязан договор типа “Договор комиссии”, то нельзя указать какое-либо значение в поле overhead.

Перемещения

21000

Сообщение: Ошибка сохранения перемещения: нельзя провести перемещение со склада на этот же склад
Описание: Убедитесь, что в полях sourceStore и targetStore указываете склады с разными идентификаторами.

Платежи

22000

Сообщение: Ошибка сохранения платежа: распределенная сумма превышает сумму платежа
Описание: Сумма, указанная в linkedSum больше чем sum платежа.

22001

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

22002

Сообщение: Ошибка сохранения платежа: некорректная статья расходов: ‘{категория расходов}’
Описание: Платежу нельзя присвоить данную статью расходов.

Группы товаров

23000

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

23001

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

Инвентаризация

24001

Сообщение: Ошибка создания шаблона списания: инвентаризация не требует проведения списания
Описание: Инвентаризация не содержит недостачи, либо все необходимые списания уже созданы.

24002

Сообщение: Ошибка создания шаблона оприходования: инвентаризация не требует проведения оприходования
Описание: Инвентаризация не содержит избытка, либо все необходимые оприходования уже созданы.

24003

Сообщение: Ошибка сохранения инвентаризации: услуга не может быть позицией инвентаризации
Описание: Услуга не может быть позицией инвентаризации.

24004

Сообщение: Ошибка сохранения инвентаризации: инвентаризация не может содержать дублирующихся позиций
Описание: Товар/Услуга/Модификация/Серия/Комплект может быть добавлен(а) в инвентаризацию только единожды.

Технологические операции

25001

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

25002

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

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

26001

Сообщение: Ошибка сохранения заказа на производство: материалы заказа не соответствуют материалам тех. карты
Описание: Проверьте соответствие материалов заказа на производство и тех. карты.

26002

Сообщение: Ошибка сохранения заказа на производство: новые товары не могут быть добавлены в заказ
Описание: Проверьте заказ на наличие новых товаров.

Прайс-листы

27000

Сообщение: Ошибка сохранения описания таблицы, ‘{описание ошибки}’
Описание: На создание таблицы Прайс-листа налагаются следующие ограничения: для описанного столбца не может отсутствовать или быть пустым название, в пределах одного Прайс-листа столбцы должны быть уникальные по названию.

27001

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

27002

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

27003

Сообщение: Ошибка сохранения позиции, нельзя в прайс-листе указывать серии
Описание: Нельзя в прайс-листе указывать серии, только товары, услуги и модификации.

Контрагенты

28000

Сообщение: Ошибка сохранения контрагента: неизвестный тип цены: ‘<Тип цены>’
Описание: Неизвестный тип цены. Список допустимых можно запросить в метаданных товаров.

Комплекты

29000

Сообщение: Ошибка сохранения комплекта: некорректное число компонентов
Описание: Поддерживается от одного до пятидесяти компонентов в одном комплекте.

29001

Сообщение: Ошибка сохранения комплекта: дополнительные расходы и состав компонентов не могут быть изменены, так как комплект уже используется
Описание: Уберите зависимые комплекты из документов.

29003

Сообщение: Ошибка сохранения комплекта: комплект содержит повторяющиеся компоненты
Описание: Проверьте состав компонентов комплекта и попробуйте снова.

29004

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

Веб-хуки

30000

Сообщение: Ошибка сохранения webhook: неподдерживаемый тип сущности ‘{тип}’
Описание: В веб-хуках можно использовать любые типы сущностей, доступные через Remap API, кроме вложенных. Например, product или demand.

30001

Сообщение: Ошибка сохранения webhook: неизвестный HTTP-метод ‘{метод}’. Допустимый: POST
Описание: В веб-хуках можно указывать только поддерживаемые HTTP методы. Допустимым сейчас является POST.

30002

Сообщение: Ошибка сохранения webhook: неизвестное действие ‘{действие}’. Допустимые: CREATE, UPDATE, DELETE
Описание: В веб-хуках можно указывать только доступные действия: CREATE, UPDATE, DELETE.

30003

Сообщение: Ошибка сохранения webhook: webhook с данным набором параметров уже существует
Описание: В веб-хуках на пару (сущность, действие) может быть установлен только один веб-хук.

30004

Сообщение: Необходимы права администратора для работы с webhook
Описание: Управление веб-хуками доступно только пользователям с правами администратора.

30005

Сообщение: Ошибка сохранения webhook: значение поля url не является корректным адресом запроса
Описание: Значение поля url не является корректным адресом запроса. Проверьте адрес запроса на соответствие формату http, https адреса запроса.

30006

Сообщение: Ваш тарифный план не позволяет создавать или обновлять веб-хуки
Описание: Создание и обновление веб-хуков доступно на всех тарифах кроме бесплатного.

30010

Сообщение: Ошибка сохранения webhook: длина url адреса больше 255 символов
Описание: Количество символов в url адресе должно быть меньше 256.

Валюты

31000

Сообщение: Валюту учета нельзя удалить
Описание: Валюту учета нельзя удалить.

Договоры

32001

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

32002

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

Печатные формы

33000

Сообщение: Ошибка формирования печатной формы: не найден шаблон печатной формы
Описание: Шаблон, указанный при формировании печатной формы не существует. Проверьте корректность указанного шаблона для печати.

33001

Сообщение: Ошибка формирования печатной формы: неизвестный формат
Описание: Проверьте, что указанный формат входит в список перечисленных: xls, pdf, html, ods.

33002

Сообщение: Ошибка формирования печатной формы: ‘<текст ошибки>’
Описание: Текст ошибки указывает на проблемы, возникшие при печати документа.

33003

Сообщение: Ошибка формирования печатной формы: отсутствует ссылка на шаблон для печати
Описание: Для того, чтобы сгенерировать печатную форму, необходимо отправить шаблон.

33004

Сообщение: Ошибка формирования печатной формы: отсутствует поле count для шаблона печатной формы
Описание: При печати комплектов необходимо указывать поле count - число копий печатной формы в комплекте.

33005

Сообщение: Ошибка формирования печатной формы: указаны оба поля для ссылок на шаблон: template и templates.
Описание: Возможно указать только одно из полей запроса template или templates.

33006

Сообщение: Ошибка формирования печатной формы: поле count для шаблона печатной формы может принимать только целые значения в диапазоне от 1 до 10
Описание: Поле count должно быть в интервале [1, 10].

33007

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

33008

Сообщение: Ошибка формирования печатной формы: отсутствует количество ценников/термоэтикеток
Описание: Для того, чтобы сгенерировать печатную форму для товара, необходимо отправить количество.

33009

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

33010

Сообщение: Ошибка формирования печатной формы комплекта документов: для указанной сущности не было передано подходящих шаблонов печатной формы.
Описание: Чтобы напечатать комплект документов, нужно передать хотя бы 1 подходящий для данной сущности шаблон печатной формы.

33011

Сообщение: Ошибка формирования печатной формы комплекта документов: сущность для печати комплекта должна быть документом
Описание: Невозможно напечатать комплект документов для сущности, не являющейся документом.

33012

Сообщение: Печать для типа ‘{тип}’ не поддерживается
Описание: Печать не поддерживается для данного типа.

Публикации

34000

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

34001

Сообщение: Не удалось создать публикацию. Проверьте корректность шаблона.
Описание: Во время генерации документа возникла ошибка. Проверьте корректность передаваемого шаблона.

34002

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

34003

Сообщение: Ошибка: нельзя работать с публикацией сущности так как к ней отсутствует доступ на ‘<чтение, запись>’.
Описание: Работа пользователя с публикациями документов возможна, если есть право на чтение и право печати сущности данного типа.

Счета-фактуры

35000

Сообщение: Ошибка формирования счета-фактуры: передано более 1 документа-основания в коллекции
Описание: Счет-фактура может быть создан только на основании одного документа. Проверьте, что был передан один массив связанных документов с одним документом-основанием.

35001

Сообщение: Ошибка формирования счета-фактуры: документ уже внесен в счет-фактуру
Описание: Счет-фактура уже создан на основании переданного документа.

Шаблоны

36000

Сообщение: Ошибка формирования шаблона: передано более 1 документа-основания для формирования шаблона
Описание: Не удалось сформировать предзаполненную сущность из-за того что передано более 1 документа-основания.

Задачи

37000

Сообщение: Ошибка: вы не можете работать с задачами, т.к. в вашем тарифном плане отсутствует опция CRM
Описание: Вы не можете создавать, редактировать и удалять задачи без тарифной опции CRM.

37001

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

38000

Сообщение: Необходимы права администратора для работы с аудитом
Описание: Просмотр изменений доступен только пользователям с правами администратора.

Пользовательские справочники

41000

Сообщение: Ошибка: пользовательский справочник с идентификатором ‘{идентификатор}’ не найден
Описание: Пользовательский справочник с указанным идентификатором не найден

41001

Сообщение: Ошибка: ваш тариф не позволяет работать с пользовательскими справочниками
Описание: Для тарифов “Бесплатный”, “Бесплатный 2014” и “Индивидуальный” не поддерживается работа с пользовательскими справочниками.

Сотрудники

43001

Сообщение: Ошибка сохранения сотрудника: у изображения отсутствует контент
Описание: При передаче изображения в запросе на изменение сотрудника необходимо указывать поле content

43002

Сообщение: Ошибка сохранения сотрудника: невозможно преобразовать поле content в изображение
Описание: Содержимым поля content должно быть изображение, закодированное в формате base64 с расширением jpg или png.

43003

Сообщение: Ошибка сохранения сотрудника: Недостаточно места в хранилище.
Описание: Место в хранилище, выделенное для вашей учётной записи закончилось.

43004

Сообщение: Ошибка сохранения сотрудника: размер изображения превышает максимально допустимый(3 мб)
Описание: Попробуйте уменьшить размер изображения.

43005

Сообщение: Ошибка сохранения сотрудника: у изображения отсутствует имя файла
Описание: При загрузке изображения необходимо указать непустое имя файла в поле filename.

43006

Сообщение: Ошибка сохранения сотрудника: неверный формат ИНН
Описание: Проверьте, чтобы формат ИНН соответствовал формату ИНН физического лица.

Скачивание изображений

44000

Сообщение: Метод POST не поддерживается для URL ’’
Описание: HTTP метод POST не поддерживается для запроса на скачивание изображения.

44001

Сообщение: Метод PUT не поддерживается для URL ’’
Описание: HTTP метод PUT не поддерживается для запроса на скачивание изображения.

44002

Сообщение: Метод DELETE не поддерживается для URL’’
Описание: HTTP метод DELETE не поддерживается для запроса на скачивание изображения.

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

47000

Сообщение: Тарифное ограничение: {описание ограничения}
Описание: Сработало тарифное ограничение для текущего тарифа.

Изображения

47000

Сообщение: Ошибка при работе с изображением: файловое хранилище недоступно
Описание: Внутренняя ошибка на сервере. Попробуйте повторить запрос позже.

Список сущностей, у которых есть доп. поля:

Договор
Контрагент
Юрлицо
Проект
Склад
Сотрудник
Товар
Услуга
Комплект
Серия
Все документы:

Дополнительные поля сущности - внутренняя коллекция attributes. Представлена в виде массива объектов с полями:

meta - Ссылка на метаданные доп. поля.
id - Id соответствующего доп. поля.
name - Наименование доп. поля
value - Значение, указанное в доп. поле.

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

meta - Ссылка на метаданные доп. поля
id - Id доп. поля
name - Наименование доп. поля
type - Тип доп. поля
required - Флажок о том, является ли доп. поле обязательным

Возможные значения типа доп. поля (поле type) и соответствующие им значения типа в JSON, а также типы атрибута value в JSON объекта доп поля при соответствующем type:

Тип атрибута	Значение поля type в JSON	Тип поля value в JSON
Строка	string	string
Число целое	long	number
Дата	time	string
Справочник	{entityType}	object **
Файл	file	string
Число дробное	double	number
Флажок	boolean	boolean
Текст	text	string
Ссылка	link	string

Дополнительные поля типов Файл и Флажок не могуть быть обязательными (поле required не может быть true).

Отдельного упоминания заслуживает тип Атрибута Справочник. Значение type в представлении объекта атрибута будет разным, в зависимости от того, справочник каких сущностей был выбран при создании Атрибута. Ниже представлена таблица, в которой при выбранном типе Атрибута “Справочник” показаны значения поля type в зависимости от выбранного типа сущностей в справочнике.

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

meta - Ссылка на метаданные доп. поля
customEntityMeta - Ссылка на метаданные пользовательского справочника
id - ID доп. поля
name - Наименование доп. поля
type - Тип доп. поля
required - Флажок о том, является ли доп. поле обязательным

Тип сущностей справочника	Значение поля type в JSON (entityType)
[Контрагент]	counterparty
[Товар]	product
[Склад]	store
[Проект]	project
[Договор]	contract
[Сотрудник]	employee
Имя_пользовательского справочника	customentity

При выбранном типе Атрибута “Справочник” атрибут value в его представлении будет объектом со следующими свойствами:

meta - Метаданные, представляющие собой ссылку на сущность из соответствующего справочника
name - Наименование соответствующей сущности

Обнуление доп. поля типа “Справочник” происходит так же, как и при работе с другими доп. полям. В запросе на обновление в коллекции attributes следует указать объект с id данного поля, а в качестве value передать null.

С коллекцией доп. полей можно работать только в контексте отдельной сущности. Доп. поля и их значения можно передать как коллекцию структур {id : uuid, value : “”} в теле запроса как на создание, так и на обновление сущности. Опционально можно передать также значение полей meta и name. В переданном массиве объектов можно указать не все доп. поля - проинициализируются/обновятся только указанные. Если для доп. поля указан id, которого нет в метаданных сущности, то возникнет ошибка.

При обновлении значений доп.полей если в теле запроса на обновление сущности в массиве доп. полей:

Не указаны id каких-либо доп.полей, которым в данной сущности уже присвоено значение - соответствующие доп. поля обновлены не будут.
Указаны id, доп. полей, которым в данной сущности уже присвоено значение - соответствующим доп. полям будет присвоено переданное значение.
Указаны id, доп. полей, которым в данной сущности ещё не присвоено значение - соответствующим доп. полям эти новые значения будут присвоены.

Для загрузки значения для доп. поля типа файл нужно в JSON при создании или обновлении для значения поля указать объект следующей структуры:

filename - Имя файла Необходимое
content - Байты файла, закодированные в base64 Необходимое

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

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

Работа с позициями в рамках отдельного документа

При работе с позициями в рамках отдельного документа, их можно передавать как поле positions, представляющее собой массив позиций документа, в составе объекта, использующегося в запросе на изменение или создание документа. В таком случае, массив позиций воспринимается как множество всех позиций документа и полностью заменяет (в случае запроса на обновление) все уже существующие позиции в документе. В случае запроса на обновление, все позиции, которые существовали ранее в документе, но не были переданы в теле запроса на обновление, будут удалены, все существующие позиции, id которых совпал с id передаваемых позиций в теле запроса, будут обновлены, а новые позиции, которых ранее не было среди существующих позиций документа, будут добавлены в список позиций.

Работа с позициями документов с помощью специальных ресурсов

В JSON API предусмотрены специальные ресурсы для управления позициями документов. Эти ресурсы как правило доступны по следующему URI и с помощью них вы сможете удалять позиции из документа, сделав запрос с методом DELETE по URL соответствующего ресурса с указание id позиции:

/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions

Пример URL для запроса на удаление с помощью DELETE:

/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/179dd832-960c-11e6-8a84-bae5000000dc

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

/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/{id отдельной позиции}

Оба способа работы с позициями также описаны в документации по каждому из документов.

Также возможно массовое удаление позиций документа, используя метод POST по URL соответствующего ресурса. В теле запроса необходимо указать массив удаляемых позиций, указав поле meta у каждой из позиций.

Пример URL для запроса на массовое удаление позиций с помощью POST:

/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/delete

Пример тела запроса:

[
  {
    "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727cf336-0310-11e6-9464-e4de00000013",
        "type": "demandposition",
        "mediaType": "application/json"
    }
  },
  {
    "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727cfce0-0310-11e6-9464-e4de00000014",
        "type": "demandposition",
        "mediaType": "application/json"
    }
  },
  {
    "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727d057f-0310-11e6-9464-e4de00000015",
        "type": "demandposition",
        "mediaType": "application/json"
    }
  }
]

Сущностям, у которых среди атрибутов присутствует поле syncId, оно необходимо для того, чтобы в случае сбоя при повторной отправке запроса на создание новой сущности не происходило дублирование объектов. Если в теле запроса на создание сущности указать сгенерированный на клиенте syncId, то при повторной отправке этого же запроса (с тем же syncId) вместо создания сущности с идентичными полями в ответ придёт ранее созданная сущность.

При создании объекта достаточно заполнить только поля, помеченные Необходимое. Данные поля используются только при создании, при обновлении они не требуются. Поля, помеченные Только для чтения, игнорируются при создании/обновлении объекта.

При использовании метода POST вы можете указать в теле запроса вместо одной - массив сущностей. Для этого, вам нужно передать массив (начать тело запроса с [ и закончить ]), который будет содержать JSON представления объектов, которые вы хотите создать или обновить. Обновляемые сущности должные содержать идентификатор в виде метаданных.

В рамках JSON API можно удалить значение из поля типа объект (если это поле не является обязательным, или же если данное поле в основном интерфейсе может содержать пустое значение). Например: поле Договор(contract) в любом из документов. Сделать это можно передав в запросе на обновление сущносте в данное поле null. Например: { "contract": null }. Удаление валюты из документов ({rate: null}) равносильно изменению валюты документа на валюту по умолчанию. В результате все цены и суммы будут пересчитаны. Накладные расходы также будут пересчитаны, если они не были указаны явно.

Если какое-то из полей сущности не было заполнено и, при этом оно не является обязательным, оно не будет выдано в JSON представлении этой сущности.

В JSON API поля типа дата-время (момент времени) - это строка в формате:

Без миллисекунд: ГГГГ-ММ-ДД ЧЧ:мм:сс
С миллисекундами: ГГГГ-ММ-ДД ЧЧ:мм:сс.ммм Для получения полей типа дата-время с миллисекундами в формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС.ммм нужно добавить специальный заголовок к запросу:
X-Lognex-Format-Millisecond со значением true.
Без секунд: ГГГГ-ММ-ДД ЧЧ:мм Только для параметров фильтрации.

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

incomingDate
commisionPeriodStart
commisionPeriodEnd
certificateDate
moment
deliveryPlannedMoment
paymentPlannedMoment
firstDemandDate
lastDemandDate
дополнительное поле с типом Дата

Для сортировки списка объектов можно использовать url параметр order. Значение этого параметра - urlencoded строка с условиями сортировки, перечисленными через ;. (Все примеры ниже указаны без urlencoded для лучшей читаемости) Каждое условие сортировки- это сочетание названия поля, запятой (опционально, если указывается направление сортировки), направления сортировки (опционально; может принимать значения asc и desc. Значение по умолчанию - asc).

Сортировка поддерживается для следующих типов полей: числовой, строковый, дата-время, логический и uuid.

Примеры запросов с сортировкой:

https://online.moysklad.ru/api/remap/1.1/entity/supply?order=name
https://online.moysklad.ru/api/remap/1.1/entity/product?order=code,desc
https://online.moysklad.ru/api/remap/1.1/entity/product?order=name;code,desc
https://online.moysklad.ru/api/remap/1.1/entity/product?order=name,desc;code,asc

Сортировка по одному полю (Deprecated)

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

order - название поля, по которому будет производиться сортировка.
direction - направление сортировки. Может принимать значения asc и desc. Значение по умолчанию - asc.

Примеры запросов с сортировкой:

https://online.moysklad.ru/api/remap/1.1/entity/product?order=name&direction=asc
https://online.moysklad.ru/api/remap/1.1/entity/supply?order=moment&direction=desc
https://online.moysklad.ru/api/remap/1.1/entity/demand?order=applicable&direction=asc

Для перехода с deprecated-формата сортировки на актуальный вы можете воспользоваться таблицей примеров маппинга url параметров

Url параметры (deprecated-формат)	Url параметры (актуальный формат)
`order=name`	`order=name`
`order=name&direction=asc`	`order=name,asc` либо `order=name`
`order=moment&direction=desc`	`order=moment,desc`

Для фильтрации выборки по нескольким полям можно использовать url параметр filter. Значение этого параметра - urlencoded строка с поисковыми условиями, перечисленными через ;. Для использования самого символа ; в текстовых фильтрах необходимо указывать два символа \;. (Все примеры ниже указаны без urlencoded для лучшей читаемости) Каждое поисковое условие - это сочетание названия поля, оператора и константы. Фильтровать можно по всем полям, значения которых являются примитивными типами. Т.е. нельзя фильтровать поля-объекты и поля-массивы, все остальные поля могут быть использованы в параметре filter.

Допустимые операторы: ['=', '>', '<', '>=', '<=', '!=', '~', '~=', '=~']

Если в поисковом запросе несколько раз встречается условие типа “равенство” = применённое к одному и тому же полю, то такое условие интерпретируется как совокупность условий, разделённых логическим оператором ИЛИ.

Например условие filter=sum=100;sum=150 будет интерпретировано как sum=100 ИЛИ sum=150 или же sum in (100, 150)

Если же встречается несколько условий вида “не равно” !=, наложенных на одну и ту же переменную, то они интерпретируются как совокупность условий разделённых логическим оператором И.

Например условие filter=name!=0001;name!=0002 будет эквивалентно следующим (взаимно эквивалентным) условиям : name != 0001 И name != 0002 или name not in (0001, 0002)

Если на одно из полей наложено ограничение типа “равенство”, а затем на него накладывается ограничение типа неравенство - в таком случае произойдёт ошибка.

Например условие filter=sum=100;sum>99 вызовет ошибку.

Допускается использование одновременно нескольких одинаковых операторов сравнения ['>', '<', '>=', '<='] для одного поля. При этом будет использовано лишь первое значение.

Например условие filter=sum>99;sum>100 будет аналогично условию filter=sum>99. В будущих версиях такое условие будет вызывать ошибку.

Фильтры, применённые к разным полям объединяются через логическое И, т.е. в запросе вида:

filter=sum=100;moment>2016-10-11 12:00:00 выборка будет отфильтрована и по сумме и по дате.

Проверка на пустое значение

Если в строке фильтрации указать конструкцию вида: <имя_поля>=; то в выборку попадут только объекты, где данное поле равно null (т.е. отсутствует значение), а если тип поля - строковое, то будет также выполнена проверка на пустую строку, т.е. поле=’’. Конструкция <имя_поля>!=; выполнит проверку на присутствие значения. С помощью данной конструкции можно проверить наличие значения в ссылочном поле.

Фильтрация документов

Для фильтрации выборки документов следует использовать параметр isDeleted. Может принимать значения true и false.

При указании значения true вернутся все документы данного типа, находящиеся в корзине.
При указании значения false вернутся только неудалённые документы.
Можно вывести все документы: и удалённые, и нет, указав в запросе оба значения данного параметра: filter=isDeleted=true;isDeleted=false.

Фильтрация сущностей

Для фильтрации выборки сущностей следует использовать параметр archived. Данный параметр принимает значения true и false.

При указании значения true вернутся все сущности данного типа, находящиеся в архиве.
При указании значения false вернутся только не архивные сущности.
Можно вывести все сущности: и архивные, и нет, указав в запросе оба значения данного параметра: filter=archived=true;archived=false. Фильтровать по параметру archived можно только те сущности, у которых данный параметр присутствует в списке полей.

Фильтрация ссылочных полей

С помощью filter можно фильтровать ссылочные поля. Если в сущности присутствует ссылочное поле в виде метаданных, можно использовать следующую конструкцию для того чтобы отфильтровать по этому полю выборку:

filter=<имя_поля>=<ссылка>

Пример ссылки:

http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>

Вот несколько примеров:

filter=agent=http://online.moysklad.ru/api/remap/1.1/entity/counterparty/<id>
filter=ownAgent=http://online.moysklad.ru/api/remap/1.1/entity/organization/<id>

Ссылочные поля, доступные для фильтрации:

agent
ownAgent
owner
group
parent
contract
project
organization
store
agentStore
supplier

Для розничных операций (“Розничная смена”, “Розничная продажа”, “Розничный возврат”, “Внесение денег”, “Выплата денег”) также доступна фильтрация по:

retailstore

Примеры запросов для фильтрации :

https://online.moysklad.ru/api/remap/1.1/entity/demand?filter=moment>2016-10-11 12:00:00;moment<2016-10-11 13:00:00;sum=100;name=0010;name=0011
https://online.moysklad.ru/api/remap/1.1/entity/counterparty?filter=name=Иван;phone=89269269222;email=vanyan@mail.krut

Фильтрация по полям типа ID

С помощью filter можно фильтровать поля типа ID.

filter=<имя_поля>=<ID>

Пример ID:

94975104-3cad-11e8-1e44-bd4d00000084

Например:

filter=productid=94975104-3cad-11e8-1e44-bd4d00000084

Фильтрация по дополнительным полям

С помощью filter можно фильтровать по дополнительным полям. Список дополнительных полей сущности указан в ее метаданных https://online.moysklad.ru/api/remap/1.1/entity/product/metadata Можно использовать следующую конструкцию для того чтобы отфильтровать по дополнительному полю выборку:

filter=<ссылка на доп.поле>=<значение>

для доп.полей типа справочник:

filter=<ссылка на доп.поле>=<ссылка на сущность>

Пример ссылки на доп.поле

http://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id>

Пример ссылки на сущность:

http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>

для доп.полей типа пользовательский справочник

http://online.moysklad.ru/api/remap/1.1/entity/customentity/<customentity_id>/<id>

Примеры фильтра:

filter=https://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id> =42
filter=https://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id> =http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>

При фильтрации по сущности, на которую у текущего пользователя нет прав на просмотр в ответе придёт пустой список. Например, при фильтрации задач (task) по автору (author), который является сотрудником, которого не может просматривать текущий пользователь, в ответ вернётся пустой список задач.

В JSON API сервиса МойСклад предусмотрена возможность фильтрации списка сущностей с помощью специальных параметров. Все параметры фильтрации передаются как URL параметры.

updatedFrom Параметр строкового типа. В качестве значения должна быть передана строка в формате дата + время с точностью до секунд. В отфильтрованную выборку попадут все объекты, момент обновления которых больше или равен значению, указанному в параметре.

Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)
updatedTo Параметр строкового типа. В качестве значения должна быть передана строка в формате дата + время с точностью до секунд. В отфильтрованную выборку попадут все объекты, момент обновления которых меньше или равен значению, указанному в параметре.

Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)
updatedBy Параметр строкового типа. В качестве значения должен быть передан uid (логин пользователя, admin@admin). В отфильтрованную выборку попадут все объекты, автором последних изменений которых является пользователь с uid, указанным в значении параметра.

Формат строки : uid

Также есть дополнительные фильтры для Документов:

state.name Параметр строкового типа. В качестве значения должно передаваться наименование статуса, выставленного на документы. В отфильтрованную выборку попадут все документы данного типа, на которые выставлен статус с указанным именем.
state.id Параметр строкового типа. В качестве значения должен передаваться id статуса, выставленного на документы. В отфильтрованную выборку попадут все документы данного типа, на которые выставлен статус с указанным id.

Формат строки : uuid
organization.id Параметр строкового типа. В качестве значения должен передаваться id юрлица, от имени которого создан документ. В отфильтрованную выборку попадут все документы данного типа, которые были созданы юрлицом с указанным id.

Формат строки : uuid

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

search Параметр фильтрации, с помощью которого можно осуществить поиск в списке сущностей. Поиск происходит по основным строковым полям сущностей данного типа. Результатом поиска будет отсортированный по релевантности список сущностей данного типа, прошедших фильтрацию по переданной поисковой строке. В отличии от фильтрации выборки с помощью параметра filter, при которой значения проверяются на точное совпадение указанным, при контекстном поиске проверка на совпадение не строгая. Таким образом, если осуществлять фильтрацию вида ../entity/<entity_type>?filter=name=120 в отфильтрованную выборку попадут только те сущности, поле name у которых имеет значение 120 и никакие другие. При контекстном поиске вида ../entity/<entity_type>?search=120 будут выведены как сущности с name равным 120, так и сущности, в имени (или в другом строковом поле) которых 120 является началом какого-то слова, например 12003, пазл детский 1200 штук и т.п. Причем, если ввести несколько слов ../entity/<entity_type>?search=120 возврат и поиск идёт по полям name и description, то будут выведены как сущности с name равным 1200 и с description равным возврат из-за деффекта, так и сущности с именем 777 с описанием розничный возврат на улице 120 летия.
- Примеры запросов контекстного поиска (значения должны быть urlencoded):
  - https://online.moysklad.ru/api/remap/1.1/entity/project?search=реструктуризация
  - https://online.moysklad.ru/api/remap/1.1/entity/move?search=ул.Вавилова
  - https://online.moysklad.ru/api/remap/1.1/entity/counterparty?search=петров

В JSON API для строковых полей есть специальный оператор фильтрации “подобие”.

~ обычное подобие. Ищет любое вхождение подстроки, следующей после оператора, в значении поля. Например, ?filter=code~ms найдёт все сущности, у которых в коде встречается подстрока “ms”.
~= левое подобие. Ищет соответствие по префиксу значения. Например ?filter=code~=ms найдёт все сущности, у которых код начинается на “ms”.
=~ правое подобие. Ищет соответствие по постфиксу. Например ?filter=code=~ms найдёт все сущности, у которых код оканчивается на “ms”.

Операторы подобия работают исключительно с полями строкового типа и не учитывают регистр. К полям типа uuid и дата-время они неприменимы.

В JSON API можно получать ответы от сервера в виде pretty-print JSON (JSON с отступами вместо JSON в одну строку). Для этого нужно добавить специальный заголовок к запросу:
Lognex-Pretty-Print-JSON со значением true.

В JSON API можно задавать цены позиций и себестоимость с дробными частями копеек. Для этого нужно добавить специальный заголовок к запросу:
X-Lognex-Precision со значением true.
Если не использовать этот заголовок, цены и себестоимость округляются до копеек.

В JSON API для скачивания файла формируется редирект на временный URL файла. Для корректной работы необходимо поддерживать обработку редиректов.

Возвращает данные о сотруднике, от лица которого происходит запрос. Доступ к сущности осуществляется по эндпоинту /context/employee

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

meta - Метаданные о Сотруднике
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
shared - Общий доступ
group - Отдел сотрудника в формате Метаданных
version - Версия сущности Только для чтения
updated - Момент последнего обновления сущности Только для чтения
name - Имя сотрудника в формате “Фамилия И. О.” Только для чтения
description - Комментарий к Сотруднику
externalCode - Внешний код Сотрудника Только для чтения
archived - Добавлен Сотрудник в архив
created - Момент создания Сотрудника Только для чтения
uid - Логин Сотрудника Только для чтения
email - Электронна почта сотрудника Только для чтения
phone - Телефон сотрудника
firstName - Имя
middleName - Отчество
lastName - Фамилия
fullName - Имя Отчество Фамилия Только для чтения
shortFio - Краткое ФИО Только для чтения
cashier - Кассир Только для чтения
attributes - Дополнительные поля Сотрудника в формате Метаданных
image - Фотография сотрудника
inn - ИНН сотрудника (в формате ИНН физического лица)
position - Должность сотрудника
permissions - Перечисление пермиссий сотрудника

Атрибуты вложенных сущностей

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

Пермиссии сотрудника

Объект пермиссий сотрудника включает в себя пермиссии сущностей, часть тарифных и пользовательских пермиссий. Поля объекта представляют собой отдельную пермиссию, где имя указывает на тип пермиссии, а значение представляет собой объект со значениями пермиссий в формате <тип пермиссии>: <значение>.

Пользовательские и тарифные пермиссии

dashboard - Просматривать показатели
stock - Просматривать остатки по товарам
customAttributes - Работа с доп. полями
pnl - Просматривать прибыльность
company_crm - Просматривать показатели
tariff_crm - Присутствует ли опция CRM на аккаунте
audit_dashboard - Просматривать аудит
admin - Является ли сотрудник админом
dashboardMoney - Видеть остатки денег

При наличии соответствующей пермиссии объект содержит поле VIEW со значением ALL

Список пермиссий сущностей

Имеется три возможных типа значений пермиссий сущности: OPERATION, DICTIONARY, BASE. Данные типы имеют следующие поля:

типы значений пермиссий сущности	view	create	update	delete	print	approve
OPERATION	+	+	+	+	+	+
DICTIONARY	+	+	+	+	+	-
BASE	+	+	+	+	-	-

Описание пермиссий сущностей

view - Смотреть
create - Создавать
update - Редактировать
delete - Удалять
print - Печатать
approve - Проводить

Возможные значения полей `view`, `create`, `update`, `delete`, `approve`, `print`

OWN - Только свои
OWN_SHARED - Свои и общие
OWN_GROUP - Свои и отдела
OWN_GROUP_SHARED - Свои, отдела и общие
ALL - Все
Отсутствует - Ни на кого

Пермиссии сущностей и документов, которые присутствуют в запросе

Название	Возможные значения	Описание
company	DICTIONARY	Контрагенты
myCompany	BASE	Юр. Лица
good	DICTIONARY	Товары и Услуги
project	BASE	Проекты
contract	DICTIONARY	Договоры
employee	BASE	Сотрудники
currency	BASE	Валюты
warehouse	BASE	Склады
customEntity	BASE	Элементы пользовательских справочников
retailStore	BASE	Точка продаж
country	BASE	Страны
uom	BASE	Единицы измерения
purchaseReturn	OPERATION	Возврат поставщику
demand	OPERATION	Отгрузка
salesReturn	OPERATION	Возврат покупателя
loss	OPERATION	Списание
enter	OPERATION	Оприходование
move	OPERATION	Перемещение
inventory	DICTIONARY	Инвентаризация
processing	BASE	Тех. операции
invoiceIn	OPERATION	Счет поставщику
invoiceOut	OPERATION	Счет покупателям
purchaseOrder	OPERATION	Заказ поставщикам
customerOrder	OPERATION	Заказ покупателям
internalOrder	OPERATION	Внутренние заказы
processingOrder	OPERATION	Заказ на производство
factureIn	OPERATION	Счета-фактуры полученные
factureOut	OPERATION	Счета-фактуры выданные
paymentIn	OPERATION	Входящий платеж
paymentOut	OPERATION	Исходящий платеж
cashIn	OPERATION	Приходной ордер
cashOut	OPERATION	Расходной ордер
priceList	OPERATION	Прайс-лист
retailDemand	OPERATION	Продажи
retailSalesReturn	OPERATION	Возвраты
supply	OPERATION	Приемки
processingPlan	BASE	Тех. Карты
commissionReportIn	OPERATION	Полученный отчет комиссионера
commissionReportOut	OPERATION	Выданный отчет комиссионер
retailShift	DICTIONARY	Смены
retailDrawerCashIn	OPERATION	Внесения
retailDrawerCashOut	OPERATION	Выплаты
bonusTransaction	OPERATION	Бонусные баллы
prepayment	OPERATION	Предоплаты
prepaymentReturn	OPERATION	Возврат предоплаты
cashboxAdjustment	DICTIONARY	Корректировка остатков в кассе
accountAdjustment	DICTIONARY	Корректировка остатков на счете
counterpartyAdjustment	DICTIONARY	Корректировка баланса контрагента
webhook	DICTIONARY	Вебхуки
task	Особый	Задачи

Пермиссии для задач

Пермиссии script для задач имеют следующие поля:

Название	Описание	Возможные значения
view	Смотреть	Отсутствует, AUTHOR_OR_ASSIGNEE, ALL
create	Создавать	Отсутствует, ALL
update	Редактировать	Отсутствует, AUTHOR, AUTHOR_OR_ASSIGNEE, ALL
delete	Удалять	Отсутствует, AUTHOR, AUTHOR_OR_ASSIGNEE, ALL
done	Выполнять	Отсутствует, ASSIGNEE, AUTHOR_OR_ASSIGNEE, ALL

Возможные значения полей `view`, `create`, `update`, `delete`, `done` для задач

Название	На какие задачи распространяется
AUTHOR_OR_ASSIGNEE	Созданные пользователем и назначенные ему
ASSIGNEE	Назначенные
AUTHOR	Созданные пользователем
ALL	Возможность совершать действие над любыми задачами
Отсутствует	Нет прав ни на какие задачи

Получить контекст сотрудника ¶

GET https://online.moysklad.ru/api/remap/1.1/context/employee

Responses200

Успешный запрос. Результат - JSON представление информации о контексте запроса Cотрудника.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/5bf6430e-204c-11ec-c0a8-300d00000042?expand=cashier.retailStore",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
    "type": "employee",
    "mediaType": "application/json",
    "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=5bf6430e-204c-11ec-c0a8-300d00000042"
  },
  "id": "5bf6430e-204c-11ec-c0a8-300d00000042",
  "accountId": "59de7a4b-204c-11ec-c0a8-300e00000002",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/5bf6430e-204c-11ec-c0a8-300d00000042",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=5bf6430e-204c-11ec-c0a8-300d00000042"
    }
  },
  "shared": true,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/59e4a97a-204c-11ec-c0a8-300e00000003",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "updated": "2021-09-28 14:08:07.359",
  "name": "Администратор",
  "externalCode": "YuqqVXgviyQsimcElBCDl0",
  "archived": false,
  "created": "2021-09-28 14:08:07.359",
  "uid": "admin@f1",
  "email": "f@f.ru",
  "lastName": "Администратор",
  "fullName": "Администратор",
  "shortFio": "Администратор",
  "cashiers": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/retailstore/5d9c8f7a-204c-11ec-c0a8-300d00000096/cashiers/5d9ce2d8-204c-11ec-c0a8-300d00000097",
        "type": "cashier",
        "mediaType": "application/json"
      }
    }
  ],
  "permissions": {
    "currency": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "uom": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "productfolder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "product": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "bundle": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "service": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "consignment": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "variant": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "store": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "counterparty": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "organization": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "employee": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "settings": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "contract": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "project": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "country": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "customentity": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "demand": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "customerorder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "internalorder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "invoiceout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "invoicein": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "paymentin": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "paymentout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "cashin": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "cashout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "supply": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "salesreturn": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "purchasereturn": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "retailstore": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "receipttemplate": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "retailstorestatus": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "retailshift": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "retaildemand": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "retailsalesreturn": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "retaildrawercashin": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "retaildrawercashout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "prepayment": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "prepaymentreturn": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "purchaseorder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "move": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "enter": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "loss": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "facturein": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "factureout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "commissionreportin": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "commissionreportout": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "pricelist": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "processingplanfolder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "processingplan": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "processing": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "processingorder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "counterpartyadjustment": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "assortment": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "inventory": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "bonustransaction": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "approve": "ALL",
      "print": "ALL"
    },
    "crptorder": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "print": "ALL"
    },
    "webhook": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL"
    },
    "task": {
      "view": "ALL",
      "create": "ALL",
      "update": "ALL",
      "delete": "ALL",
      "done": "ALL"
    },
    "dashboard": {
      "view": "ALL"
    },
    "stock": {
      "view": "ALL"
    },
    "customAttributes": {
      "view": "ALL"
    },
    "pnl": {
      "view": "ALL"
    },
    "company_crm": {
      "view": "ALL"
    },
    "tariff_crm": {
      "view": "ALL"
    },
    "audit_dashboard": {
      "view": "ALL"
    },
    "admin": {
      "view": "ALL"
    },
    "dashboardMoney": {
      "view": "ALL"
    }
  }
}

Получить контекст сотрудника
GET`/context/employee`

Запрос на получение контекста запроса Cотрудника

Замена ссылок объектами с помощью expand ¶

В JSON API, в составе сущностей можно встретить ссылки на связанные объекты. Ссылки выводятся в формате Метаданных. Для того, чтобы вместо ссылок получить связанные объекты, не обязательно делать отдельные запросы для каждого из них. Вместо этого, вместе с запросом на получение сущности, нужно передать параметр expand. В качестве значения данного параметра нужно перечислить через запятую все необходимые поля-ссылки, на месте которых вы бы хотели видеть связанные объекты. В результате запроса с таким параметром, в ответе вы получите объект с развернутыми вложенными объектами вместо ссылок. К примеру, в документах, имеющих в составе поле agent, вместо ссылки на контрагента будет выведен объект со всеми полями сущности “Контрагент”, описанными тут. Максимальный уровень вложенности expand : 3.

Также expand можно применять для результатов операций создания и обновления.

Ниже показаны примеры использования expand на Возврате покупателя. В примерах представлены только поля meta и demand.

GET https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089

Responses200

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
    "type": "salesreturn",
    "mediaType": "application/json"
  },
  ...
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
      "type": "demand",
      "mediaType": "application/json"
    }
  }
}

Возврат без expand
GET`/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089`

Объект возврата покупателя в его обычном представлении, имеющий ссылку на отгрузку

GET https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand

Responses200

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
    "type": "salesreturn",
    "mediaType": "application/json"
  },
  ...
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
      "type": "demand",
      "mediaType": "application/json"
    },
    "id": "f99544d7-4a98-11e6-8a84-bae50000007f",
    "accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
    "owner": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    },
    "shared": false,
    "group": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
        "type": "group",
        "mediaType": "application/json"
      }
    },
    ...
    "positions": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f/positions",
        "type": "demandposition",
        "mediaType": "application/json",
        "size": 2,
        "limit": 100,
        "offset": 0
      }
    },
    "vatEnabled": true,
    "vatIncluded": true,
    "payedSum": 0,
    "returns": [
      {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
          "type": "salesreturn",
          "mediaType": "application/json"
        }
      }
    ]
  }
}

Возврат с expand отгрузки
GET`/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand`

Передаём параметр expand=demand. В ответ придёт возврат покупателя, у которого вместо ссылки на отгрузку, по которой производится возврат, будет вложенный объект со всеми полями данной отгрузки.

GET https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand.agent

Responses200

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand.agent",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
    "type": "salesreturn",
    "mediaType": "application/json"
  },
  ...
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f?expand=agent",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
      "type": "demand",
      "mediaType": "application/json"
    },
    ...
    "agent": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/147c1f1b-32ca-11e6-8a84-bae500000004",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      ...
      "name": "Агент1",
      "code": "УТ0003074",
      "externalCode": "kAgs4Xbhiz2Sp5oP2OCaB2",
      "archived": false,
      "legalTitle": "Общество с ограниченной ответственностью «Агент1»",
      "legalAddress": "107023, г. Москва, Барабанный переулок, дом № 42, строение 2",
      "inn": "7719864242",
      "kpp": "771901001",
      ...
    },
    ...
    "positions": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f/positions",
        "type": "demandposition",
        "mediaType": "application/json",
        "size": 2,
        "limit": 100,
        "offset": 0
      }
    },
    "vatEnabled": true,
    "vatIncluded": true,
    "payedSum": 0,
    "returns": [
      {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
          "type": "salesreturn",
          "mediaType": "application/json"
        }
      }
    ]
  }
  ...
}

Expand с глубиной 2
GET`/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand.agent`

Теперь развернем поле agent у вложенной в возврат отгрузки (demand). В ответ придёт возврат покупателя с развёрнутой отгрузкой (demand), внутри которой будет развёрнутый объект контрагента (agent).
В данном запросе продемонстрирован уровень вложенности параметра expand равный двум.

POST https://online.moysklad.ru/api/remap/1.1/entity/demand?expand=agent

RequestsПример

Пример создания отгрузки с параметром запроса expand.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "0001",
  "organization": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
      "type": "organization",
      "mediaType": "application/json"
    }
  },
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078",
      "type": "counterparty",
      "mediaType": "application/json"
    }
  },
  "store": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/store/850ee995-f504-11e5-8a84-bae500000160",
      "type": "store",
      "mediaType": "application/json"
    }
  }
}

Responses200

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
    "type": "demand",
    "mediaType": "application/json",
    "uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=1c3f30d2-88b9-11e7-9464-e4de00000000"
  },
  "id": "1c3f30d2-88b9-11e7-9464-e4de00000000",
  "accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2017-08-24 13:43:47",
  "name": "0001",
  "externalCode": "UoaXR1oZhS9LOHzdUi42R1",
  "moment": "2017-08-24 13:43:00",
  "applicable": true,
  "rate": {
    "currency": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/d959dce8-6703-11e7-9464-e4de00000058",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
        "type": "currency",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#currency/edit?id=d959dce8-6703-11e7-9464-e4de00000058"
      }
    }
  },
  "sum": 0,
  "store": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/store/d95915ff-6703-11e7-9464-e4de00000053",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/store/metadata",
      "type": "store",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=d95915ff-6703-11e7-9464-e4de00000053"
    }
  },
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=d9593e70-6703-11e7-9464-e4de00000054"
    },
    "id": "d9593e70-6703-11e7-9464-e4de00000054",
    "accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
    "owner": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
      }
    },
    "shared": false,
    "group": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
        "type": "group",
        "mediaType": "application/json"
      }
    },
    "version": 8,
    "updated": "2017-08-18 17:49:23",
    "name": "ООО \"Поставщик\"",
    "externalCode": "YWKWXePEi9jBAmxriBpc93",
    "archived": false,
    "created": "2017-07-12 16:13:08",
    "companyType": "legal",
    "legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
    "legalAddress": "г.Москва, ул.Строителей, д.12",
    "inn": "7736570901",
    "kpp": "773601001",
    "accounts": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/accounts",
        "type": "account",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "tags": [
      "bbbvcc",
      "ss"
    ],
    "contactpersons": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/contactpersons",
        "type": "contactperson",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "notes": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/notes",
        "type": "note",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "state": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/d9efdc3b-6703-11e7-9464-e4de00000066",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "state",
        "mediaType": "application/json"
      }
    },
    "salesAmount": 4500
  },
  "organization": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/organization/metadata",
      "type": "organization",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#mycompany/edit?id=d955aa70-6703-11e7-9464-e4de00000051"
    }
  },
  "documents": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/documents",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "created": "2017-08-24 13:43:48",
  "positions": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/positions",
      "type": "demandposition",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "vatEnabled": true,
  "vatIncluded": true,
  "vatSum": 0,
  "payedSum": 0
}

Создание отгрузки с expand
POST`/entity/demand?expand=agent`

Развернем поле agent у создаваемой отгрузки. В ответ придёт созданная отгрузка с развёрнутым объектом контрагента (agent).

PUT https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000?expand=agent,organization

RequestsПример

Пример редактирования отгрузки с параметром запроса expand.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "3738"
}

Responses200

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000?expand=agent,organization",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
    "type": "demand",
    "mediaType": "application/json",
    "uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=1c3f30d2-88b9-11e7-9464-e4de00000000"
  },
  "id": "1c3f30d2-88b9-11e7-9464-e4de00000000",
  "accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 1,
  "updated": "2017-08-24 13:53:07",
  "name": "3738",
  "externalCode": "UoaXR1oZhS9LOHzdUi42R1",
  "moment": "2017-08-24 13:43:00",
  "applicable": true,
  "rate": {
    "currency": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/d959dce8-6703-11e7-9464-e4de00000058",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
        "type": "currency",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#currency/edit?id=d959dce8-6703-11e7-9464-e4de00000058"
      }
    }
  },
  "sum": 0,
  "store": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/store/d95915ff-6703-11e7-9464-e4de00000053",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/store/metadata",
      "type": "store",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=d95915ff-6703-11e7-9464-e4de00000053"
    }
  },
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=d9593e70-6703-11e7-9464-e4de00000054"
    },
    "id": "d9593e70-6703-11e7-9464-e4de00000054",
    "accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
    "owner": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
      }
    },
    "shared": false,
    "group": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
        "type": "group",
        "mediaType": "application/json"
      }
    },
    "version": 8,
    "updated": "2017-08-18 17:49:23",
    "name": "ООО \"Поставщик\"",
    "externalCode": "YWKWXePEi9jBAmxriBpc93",
    "archived": false,
    "created": "2017-07-12 16:13:08",
    "companyType": "legal",
    "legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
    "legalAddress": "г.Москва, ул.Строителей, д.12",
    "inn": "7736570901",
    "kpp": "773601001",
    "accounts": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/accounts",
        "type": "account",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "tags": [
      "bbbvcc",
      "ss"
    ],
    "contactpersons": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/contactpersons",
        "type": "contactperson",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "notes": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/notes",
        "type": "note",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "state": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/d9efdc3b-6703-11e7-9464-e4de00000066",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "state",
        "mediaType": "application/json"
      }
    },
    "salesAmount": 4500
  },
  "organization": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/organization/metadata",
      "type": "organization",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#mycompany/edit?id=d955aa70-6703-11e7-9464-e4de00000051"
    },
    "id": "d955aa70-6703-11e7-9464-e4de00000051",
    "accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
    "owner": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json",
        "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
      }
    },
    "shared": true,
    "group": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
        "type": "group",
        "mediaType": "application/json"
      }
    },
    "version": 0,
    "updated": "2017-07-12 16:13:09",
    "name": "reqwy",
    "externalCode": "PRLKDfmQgwj7TGtiYWrrZ3",
    "archived": false,
    "created": "2017-07-12 16:13:08",
    "companyType": "legal",
    "legalTitle": "reqwy",
    "email": "erqw@ss.ru",
    "accounts": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051/accounts",
        "type": "account",
        "mediaType": "application/json",
        "size": 0,
        "limit": 100,
        "offset": 0
      }
    },
    "isEgaisEnable": false,
    "payerVat": true,
    "director": "Администратор",
    "chiefAccountant": "Администратор"
  },
  "documents": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/documents",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "created": "2017-08-24 13:43:48",
  "positions": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/positions",
      "type": "demandposition",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "vatEnabled": true,
  "vatIncluded": true,
  "vatSum": 0,
  "payedSum": 0
}

Редактирование отгрузки с expand
PUT`/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000?expand=agent,organization`

Теперь обновим эту отгрузку и развернем у неё поля agent и organization. В ответ придёт изменённая отгрузка с развёрнутым объектом контрагента (agent) и развёрнутым объектом юрлица (organization).

Доп. поля сущностей ¶

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

Структура объекта доп. поля подробно описана в секции Работа с дополнительными полями.

GET https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes

Responses200

Успешный запрос. Результат - JSON представление списка доп. полей.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
    "mediaType": "application/json"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/9862d46e-6500-11e8-9464-e4de00000045",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "9862d46e-6500-11e8-9464-e4de00000045",
      "name": "Строковое",
      "type": "string",
      "required": false
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98630aee-6500-11e8-9464-e4de00000046",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "98630aee-6500-11e8-9464-e4de00000046",
      "name": "Целочисленное",
      "type": "long",
      "required": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98630f62-6500-11e8-9464-e4de00000047",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "98630f62-6500-11e8-9464-e4de00000047",
      "name": "Поле-дата",
      "type": "time",
      "required": false
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986314b4-6500-11e8-9464-e4de00000048",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "986314b4-6500-11e8-9464-e4de00000048",
      "name": "Справочник-товар",
      "type": "productfolder",
      "required": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986318cd-6500-11e8-9464-e4de00000049",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "986318cd-6500-11e8-9464-e4de00000049",
      "name": "Файловое",
      "type": "file",
      "required": false
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98631cbf-6500-11e8-9464-e4de0000004a",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "98631cbf-6500-11e8-9464-e4de0000004a",
      "name": "Дробное число",
      "type": "double",
      "required": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986320d6-6500-11e8-9464-e4de0000004b",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "986320d6-6500-11e8-9464-e4de0000004b",
      "name": "Булиновое",
      "type": "boolean",
      "required": false
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98632583-6500-11e8-9464-e4de0000004c",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "98632583-6500-11e8-9464-e4de0000004c",
      "name": "Текстовое",
      "type": "text",
      "required": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98632a03-6500-11e8-9464-e4de0000004d",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "98632a03-6500-11e8-9464-e4de0000004d",
      "name": "Ссылочное",
      "type": "link",
      "required": false
    }
  ]
}

Получить все доп поля для указанного типа
GET`/entity/{entityType}/metadata/attributes`

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

meta Метаданные о выдаче,
rows - Массив JSON объектов, представляющих собой доп. поля.

URI Parameters

СкрытьПоказать

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

entityType

string (optional) Example: demand

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

POST https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes

RequestsПримерСоздать + обновитьПользовательский справочник

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

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "name": "Строковое",
    "type": "string",
    "required": false
  },
  {
    "name": "Целочисленное",
    "type": "long",
    "required": true
  }
]

Responses200

Успешный запрос. Результат - JSON представление созданных доп. полей отгрузок.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
      "type": "attributemetadata",
      "mediaType": "application/json"
    },
    "id": "7bc578d8-6501-11e8-9464-e4de00000004",
    "name": "Строковое",
    "type": "string",
    "required": false
  },
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bd3d688-6501-11e8-9464-e4de00000005",
      "type": "attributemetadata",
      "mediaType": "application/json"
    },
    "id": "7bd3d688-6501-11e8-9464-e4de00000005",
    "name": "Целочисленное",
    "type": "long",
    "required": true
  }
]

Пример создания нового доп. поля Отгрузок и обновления существующего одним запросом.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
      "type": "attributemetadata",
      "mediaType": "application/json"
    },
    "id": "7bc578d8-6501-11e8-9464-e4de00000004",
    "name": "Строковое поле",
    "required": true
  },
  {
    "name": "Целочисленное2",
    "type": "long",
    "required": true
  }
]

Responses200

Успешный запрос. Результат - JSON представление созданного и обновлённого доп. полей отгрузок.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
      "type": "attributemetadata",
      "mediaType": "application/json"
    },
    "id": "7bc578d8-6501-11e8-9464-e4de00000004",
    "name": "Строковое поле",
    "type": "string",
    "required": true
  },
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/c66edb30-6501-11e8-9464-e4de00000008",
      "type": "attributemetadata",
      "mediaType": "application/json"
    },
    "id": "c66edb30-6501-11e8-9464-e4de00000008",
    "name": "Целочисленное2",
    "type": "long",
    "required": true
  }
]

Пример создания дополнительного поля типа пользовательский справочник.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "customEntityMeta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/companysettings/metadata/customEntities/0347beb0-a785-11e9-ac12-000800000003",
    "type": "customentitymetadata",
    "mediaType": "application/json"
  },
  "name": "Доп поле типа пользовательский справочник",
  "type": "customentity",
  "required": false
}

Responses200

Успешный запрос. Результат - JSON представление созданного доп. поля.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "hhttps://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/53eb36a5-a78a-11e9-ac12-000c00000000",
    "type": "attributemetadata",
    "mediaType": "application/json"
  },
  "customEntityMeta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/companysettings/metadata/customEntities/0347beb0-a785-11e9-ac12-000800000003",
    "type": "customentitymetadata",
    "mediaType": "application/json"
  },
  "id": "53eb36a5-a78a-11e9-ac12-000c00000000",
  "name": "Доп поле типа пользовательский справочник",
  "type": "customentity",
  "required": false
}

Создать доп. поля
POST`/entity/{entityType}/metadata/attributes`

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

URI Parameters

СкрытьПоказать

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

entityType

string (optional) Example: demand

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

POST https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/delete

RequestsПример

Пример запроса на удаление нескольких доп. полей отгрузок.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986318cd-6500-11e8-9464-e4de00000049",
      "type": "attributemetadata",
      "mediaType": "application/json"
    }
  },
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98631cbf-6500-11e8-9464-e4de0000004a",
      "type": "attributemetadata",
      "mediaType": "application/json"
    }
  }
]

Responses200

Удалить доп. поля
POST`/entity/{entityType}/metadata/attributes/delete`

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

URI Parameters

СкрытьПоказать

entityType: string (optional) Example: demand
тип сущностей, для которых осуществляется управление доп. полями.

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

GET https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешный запрос. Результат - JSON представление отдельного доп. поля отгрузок

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
    "type": "attributemetadata",
    "mediaType": "application/json"
  },
  "id": "7bc578d8-6501-11e8-9464-e4de00000004",
  "name": "Строковое поле",
  "type": "string",
  "required": true
}

Получить доп. поле
GET`/entity/{entityType}/metadata/attributes/{id}`

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

URI Parameters

СкрытьПоказать

entityType: string (optional) Example: demand
тип сущностей, для которых осуществляется управление доп. полями.
id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id доп. поля

PUT https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7944ef04-f831-11e5-7a69-971500188b19

RequestsПример

Пример запроса на обновление отдельного доп. поля отгрузок.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "обновлённое Строковое поле",
  "required": false
}

Responses200

Успешный запрос. Результат - JSON представление обновлённого доп. поля отгрузок.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
    "type": "attributemetadata",
    "mediaType": "application/json"
  },
  "id": "7bc578d8-6501-11e8-9464-e4de00000004",
  "name": "обновлённое Строковое поле",
  "type": "string",
  "required": false
}

Изменить доп. поле
PUT`/entity/{entityType}/metadata/attributes/{id}`

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

URI Parameters

СкрытьПоказать

entityType: string (optional) Example: demand
тип сущностей, для которых осуществляется управление доп. полями.
id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id доп. поля

DELETE https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Удалить доп. поле
DELETE`/entity/{entityType}/metadata/attributes/{id}`

Действие доступно только для пользователя с правами администратора.
Запрос на удаление доп. поля отгрузок с указанным id.

URI Parameters

СкрытьПоказать

entityType: string (optional) Example: demand
тип сущностей, для которых осуществляется управление доп. полями.
id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id доп. поля

Контрагент ¶

Контрагенты ¶

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

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

Первое условие поиска:

По наименованию Контрагента name
По коду Контрагента code
По полному наименованию Контрагента legalTitle
По номеру дисконтной карты Контрагента discountCardNumber
По адресу электронной почты email
По комментарию description
По номеру городского телефона phone

Второе условие поиска по всем событиям контрагента:

По тексту событий контрагента description

Третье условие поиска по полям из всех контактных лиц фирмы контрагента (contactpersons):

По имени контактного лица name
По почте контактного лица email
По номеру телефона контактного лица phone

meta - Метаданные объекта
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
shared - Общий доступ
group - Отдел сотрудника в формате Метаданных
syncId - ID синхронизации. После заполнения недоступен для изменения.
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
name - Наименование Контрагента Необходимое
description - Комментарий к Контрагенту
code - Код Контрагента
externalCode - Внешний код Контрагента Только для чтения
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса
actualAddress - Фактический адрес Контрагента
actualAddressFull - Фактический адрес Контрагента с детализацией по отдельным полям.
accounts - Ссылка на счета Контрагента (массив)
companyType - Тип Контрагента. [Юридическое лицо, Индивидуальный предприниматель, Физическое лицо]. В зависимости от значения данного поля набор выводимых реквизитов контрагента может меняться. Подробнее тут
discountCardNumber - номер дисконтной карты Контрагента
state - Статус Контрагента в формате Метаданных
salesAmount - Сумма продаж Только для чтения
Поля реквизитов

legalTitle - Полное наименование для Контрагента типа [Юридическое лицо]. Игнорируется для Контрагентов типа [Индивидуальный предприниматель, Физическое лицо], если передано одно из значений для ФИО и формируется автоматически на основе получаемых ФИО Контрагента.
legalLastName - Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо].
legalFirstName - Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо].
legalMiddleName - Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо].
legalAddress - Юридический адрес Контрагента
legalAddressFull - Юридический адрес Контрагента с детализацией по отдельным полям.
inn - ИНН
kpp - КПП
ogrn - ОГРН
ogrnip - ОГРНИП
okpo - ОКПО
certificateNumber - Номер свидетельства
certificateDate - Дата свидетельства

tags - Группы (массив)
contactpersons - Ссылка на контактные лица фирмы Контрагента (массив)
attributes - Коллекция доп. полей в формате Метаданных
discounts - Массив ссылок на скидки в формате Метаданных Только для чтения

Массив может содержать персональные и накопительные скидки. Персональная скидка выводится, если хотя бы раз изменялся процент скидки для контрагента, значение будет указано в поле personalDiscount. Накопительная скидка выводится, если для контрагента хотя бы раз устанавливалась коррекция суммы накоплений по скидке, значение будет указано в поле demandSumCorrection. Формат вывода скидок можно посмотреть в разделе Скидки.

notes - Массив ссылок на события Контрагента в формате Метаданных
priceType - Тип цены Контрагента (строка или null)

postalCode - Почтовый индекс
country - Ссылка на страну в формате Метаданных
region - Ссылка на регион в формате Метаданных
city - Город
street - Улица
house - Дом (Максимальная длина - 30 символов)
apartment - Квартира (Максимальная длина - 30 символов)
addInfo - Другое
comment - Комментарий

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

id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
isDefault - Является ли счёт основным счётом Контрагента
accountNumber - Номер счёта Необходимо
bankName - Наименование банка
bankLocation - Адрес банка
correspondentAccount - Корр счет
bic - БИК

id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
name - ФИО контактного лица Необходимое
description - Описание контактного лица
externalCode - Внешний код контактного лица
email - Адрес электронной почты контактного лица
phone - Номер телефона контактного лица
position - Должность контактного лица
agent - Ссылка на Контрагента (тип Мета)

meta - Метаданные объекта
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении/удалении события Контрагента Только для чтения
created - Момент создания события Контрагента Только для чтения
description - Текст события Контрагента Необходимое
agent - Ссылка на Контрагента (тип Мета) Только для чтения
author - Создатель события, ссылка на сотрудника (тип Мета) Только для чтения

В зависимости от типа контрагента companyType в составе его объекта будут выводиться разные наборы реквизитов. Типы контрагента и соответствующие значения, которые могут быть переданы в данном поле:

Тип контрагента	Значение поля companyType
Юридическое лицо	legal
Индивидуальный предприниматель	entrepreneur
Физическое лицо	individual

Если тип контрагента Юридическое лицо, будут выведены следующие поля реквизитов:

legalTitle - Полное наименование Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
kpp - КПП
ogrn - ОГРН
okpo - ОКПО

Если тип контрагента Индивидуальный предприниматель, будут выведены следующие поля реквизитов:

legalTitle - Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
legalLastName - Фамилия Контрагента
legalFirstName - Имя Контрагента
legalMiddleName - Отчество Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
okpo - ОКПО
ogrnip - ОГРНИП
certificateNumber - Номер свидетельства
certificateDate - Дата свидетельства

Если тип контрагента Физическое лицо, будут выведены следующие поля реквизитов:

legalTitle - Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
legalLastName - Фамилия Контрагента
legalFirstName - Имя Контрагента
legalMiddleName - Отчество Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН

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

id - ID в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
syncId - ID синхронизации
version - Версия сущности
updated - Момент последнего обновления Контрагента
updatedBy - Автор последнего обновления сущности в формате uid (admin@admin)
name - Наименование Контрагента
description - Комментарий к Контрагенту
code - Код Контрагента
externalCode - Внешний код Контрагента
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса
actualAddress - Фактический адрес Контрагента
companyType - Тип Контрагента
discountCardNumber - номер дисконтной карты Контрагента
state - Статус Контрагента
legalTitle - Полное наименование Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
kpp - КПП
priceType - Тип цены Контрагента (строка или null)

id - ID в формате UUID
version - Версия сущности
updated - Момент последнего обновления Контрагента
updatedBy - Автор последнего обновления сущности в формате uid (admin@admin)
name - Наименование Контрагента
description - Комментарий к Контрагенту
externalCode - Внешний код Контрагента
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty

Responses200

Успешный запрос. Результат - JSON представление списка Контрагентов.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json",
    "size": 4,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "id": "12a8b923-692c-11e6-8a84-bae500000053",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": false,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 2,
      "updated": "2016-08-23 15:21:09",
      "name": "ООО \"Поставщик\"",
      "externalCode": "aZBfWOKzj-lcq7c7IWZON3",
      "archived": false,
      "created": "2007-02-07 17:16:41",
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
      "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
      "legalAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "123",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
      "actualAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "111",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "inn": "7736570901",
      "kpp": "773601001",
      "accounts": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/accounts",
          "type": "account",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "tags": [],
      "contactpersons": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/contactpersons",
          "type": "contactperson",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "notes": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/notes",
          "type": "note",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "state": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
          "type": "state",
          "mediaType": "application/json"
        }
      },
      "salesAmount": 0,
      "priceType": "Цена летняя"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "id": "12a8e347-692c-11e6-8a84-bae500000055",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": false,
      "created": "2007-02-07 17:16:41",
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 1,
      "updated": "2016-08-23 15:21:09",
      "name": "ООО \"Покупатель\"",
      "externalCode": "DTItQRbDhyl472ZqC5OWw2",
      "archived": false,
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Покупатель\"",
      "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
      "legalAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "123",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
      "actualAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "111",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "inn": "7736570902",
      "kpp": "773601002",
      "accounts": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/accounts",
          "type": "account",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "tags": [],
      "contactpersons": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/contactpersons",
          "type": "contactperson",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "notes": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/notes",
          "type": "note",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "id": "12c9ebcf-692c-11e6-8a84-bae50000005d",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": false,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 1,
      "updated": "2016-08-23 15:21:09",
      "name": "Розничный покупатель",
      "externalCode": "lBvYwLWMiBsct7sVRrFnJ2",
      "archived": false,
      "created": "2007-02-07 17:16:41",
      "companyType": "legal",
      "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
      "legalAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "123",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
      "actualAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "111",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "accounts": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/accounts",
          "type": "account",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "tags": [],
      "contactpersons": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/contactpersons",
          "type": "contactperson",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "notes": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/notes",
          "type": "note",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      },
      "id": "df2fdd2d-6934-11e6-8a84-bae500000049",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": false,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 0,
      "updated": "2016-08-23 16:24:08",
      "name": "rtr",
      "externalCode": "rRlzrdZmjql9r9dveXPE43",
      "archived": false,
      "created": "2007-02-07 17:16:41",
      "companyType": "legal",
      "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
      "legalAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "123",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
      "actualAddressFull": {
        "postalCode": "125009",
        "country": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
            "type": "country",
            "mediaType": "application/json"
          }
        },
        "region": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
            "type": "region",
            "mediaType": "application/json"
          }
        },
        "city": "Москва",
        "street": "ул Тверская",
        "house": "1",
        "apartment": "111",
        "addInfo": "addinfo",
        "comment": "some words about address"
      },
      "accounts": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/accounts",
          "type": "account",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "tags": [],
      "contactpersons": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/contactpersons",
          "type": "contactperson",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "notes": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/notes",
          "type": "note",
          "mediaType": "application/json",
          "size": 0,
          "limit": 100,
          "offset": 0
        }
      },
      "state": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
          "type": "state",
          "mediaType": "application/json"
        }
      },
      "salesAmount": 0
    }
  ]
}

Получить список Контрагентов
GET`/entity/counterparty`

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

meta Метаданные о выдаче,
context - Метаданные о сотруднике, выполнившем запрос.
rows - Массив JSON объектов, представляющих собой Контрагентов.

URI Parameters

СкрытьПоказать

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

POST https://online.moysklad.ru/api/remap/1.1/entity/counterparty

RequestsПример 1Пример 2Пример 3Пример с доп полями

Пример типичного запроса для создания Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "ООО Радуга",
  "description": "Сеть стройматериалов Радуга ЭКСПО",
  "code": "rainbowCode",
  "externalCode": "extRainbw",
  "email": "raduga@stroi.ru",
  "phone": "+7 495 331 22 33",
  "fax": "1257752",
  "actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
  "legalTitle": "Общество с ограниченой ответственностью \"Радуга\"",
  "legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
  "inn": "125152124152",
  "kpp": "12155521",
  "ogrn": "1251512",
  "okpo": "201355",
  "tags": [
    "Строители",
    "Радуга",
    "Ремонт"
  ],
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  },
  "priceType": "Цена летняя"
}

Responses200

Успешный запрос. Результат - JSON представление созданного Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "b80ea81b-7058-11e6-8a84-bae500000000",
  "accountId": "1185513e-692c-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2016-09-01 18:28:22",
  "name": "ООО Радуга",
  "externalCode": "o7732zkki541HDkZZD1Yt3",
  "archived": false,
  "companyType": "legal",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  },
  "priceType": "Цена летняя"
}

Пример запроса на создание Контрагента с указанием только лишь его имени

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "ООО Радуга"
}

Responses200

Успешный запрос. Результат - JSON представление созданного Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "b80ea81b-7058-11e6-8a84-bae500000000",
  "accountId": "1185513e-692c-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2016-09-01 18:28:22",
  "name": "ООО Радуга",
  "externalCode": "o7732zkki541HDkZZD1Yt3",
  "archived": false,
  "created": "2007-02-07 17:16:41",
  "companyType": "legal",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  }
}

Пример запроса на создание Контрагента с указанием юридических реквизитов для типа Индивидуальный Предприниматель.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "ИП Иванов",
  "code": "someCode",
  "externalCode": "extCode",
  "companyType": "entrepreneur",
  "legalLastName": "Иванов",
  "legalFirstName": "Иван",
  "legalMiddleName": "Иванович",
  "actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
  "legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
  "inn": "87654321",
  "kpp": "15312532",
  "ogrn": "12345",
  "okpo": "12345",
  "ogrnip": "58632598y21jk"
}

Responses200

Успешный запрос. Результат - JSON представление созданного Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json",
    "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=45fd2f10-b0ae-11ea-0a80-163500000000"
  },
  "id": "45fd2f10-b0ae-11ea-0a80-163500000000",
  "accountId": "02865f48-b0ae-11ea-0a80-203a00000002",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/02e06bea-b0ae-11ea-0a80-1d9c00000034",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=02e06bea-b0ae-11ea-0a80-1d9c00000034"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/02877fda-b0ae-11ea-0a80-203a00000003",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2020-06-17 18:21:53",
  "name": "ИП Иванов",
  "code": "someCode",
  "externalCode": "extCode",
  "archived": false,
  "created": "2020-06-17 18:21:53",
  "companyType": "entrepreneur",
  "legalTitle": "Индивидуальный предприниматель Иванов Иван Иванович",
  "legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
  "legalAddressFull": {
    "addInfo": "г.Москва ул Авиастроителей д 93 к 12"
  },
  "actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
  "actualAddressFull": {
    "addInfo": "г.Москва ул Академика Миля дом 15 к 21"
  },
  "inn": "87654321",
  "okpo": "12345",
  "ogrnip": "58632598y21jk",
  "legalLastName": "Иванов",
  "legalFirstName": "Иван",
  "legalMiddleName": "Иванович",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/03935900-b0ae-11ea-0a80-1d9c0000008c",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "state",
      "mediaType": "application/json"
    }
  },
  "salesAmount": 0
}

Пример запроса для создания Контрагента с доп полями в теле запроса.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "ООО Овощ Экспресс",
  "description": "Сеть доставки овощей",
  "code": "ovoshexpressCode",
  "externalCode": "extVagetable",
  "email": "ovosh@delivery.ru",
  "phone": "+7 495 662 12 23",
  "fax": "1052034",
  "legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
  "legalAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "123",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "actualAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "111",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "inn": "1251521244152",
  "kpp": "121555212",
  "ogrn": "1251552",
  "okpo": "201323",
  "tags": [
    "Овощи",
    "Еда",
    "Доставка"
  ],
  "attributes": [
    {
      "id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
      "name": "Коэффициент скидки",
      "type": "double",
      "value": 0.75
    },
    {
      "id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
      "name": "Последний заключённый договор",
      "type": "time",
      "value": "2016-06-07 12:52:33"
    },
    {
      "id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
      "name": "Партнёрское юрлицо",
      "type": "boolean",
      "value": false
    }
  ],
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  }
}

Responses200

Успешный запрос. Результат - JSON представление созданного Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "88fc07ac-2c8d-11e6-8a84-bae500000050",
  "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2016-06-07 11:55:08",
  "name": "ООО Овощ Экспресс",
  "description": "Сеть доставки овощей",
  "code": "ovoshexpressCode",
  "externalCode": "extVagetable",
  "archived": false,
  "created": "2007-02-07 17:16:41",
  "legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
  "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
  "legalAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "123",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
  "actualAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "111",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "inn": "1251521244152",
  "kpp": "121555212",
  "ogrn": "1251552",
  "okpo": "201323",
  "email": "ovosh@delivery.ru",
  "phone": "+7 495 662 12 23",
  "fax": "1052034",
  "attributes": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d129ff5-2c8c-11e6-8a84-bae5000000f3",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
      "type": "double",
      "name": "Коэффициент скидки",
      "value": 0.75
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
      "name": "Последний заключённый договор",
      "type": "time",
      "value": "2016-06-07 12:52:33"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
      "name": "Партнёрское юрлицо",
      "type": "boolean",
      "value": false
    }
  ],
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [
    "доставка",
    "еда",
    "овощи"
  ],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  }
}

Создать Контрагента
POST`/entity/counterparty`

Создать нового Контрагента

Контрагент создаётся на основе переданного объекта JSON, который содержит представление нового Контрагента.

DELETE https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешное удаление Контрагента.

Удалить Контрагента
DELETE`/entity/counterparty/{id}`

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

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента

Метаданные Контрагентов ¶

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata

Responses200

Успешный запрос. Результат - JSON представление доп. полей Контрагентов.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "mediaType": "application/json"
  },
  "attributes": [
    {
      "id": "5290a290-0313-11e6-9464-e4de00000020",
      "name": "attribute_name",
      "type": "boolean",
      "required": false
    }
  ],
  "states": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
        "type": "state",
        "mediaType": "application/json"
      },
      "id": "fb56c504-2e58-11e6-8a84-bae500000069",
      "accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
      "name": "Новый",
      "color": 15106326,
      "stateType": "Regular",
      "entityType": "counterparty"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56cae3-2e58-11e6-8a84-bae50000006a",
        "type": "state",
        "mediaType": "application/json"
      },
      "id": "fb56cae3-2e58-11e6-8a84-bae50000006a",
      "accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
      "name": "Подтвержден",
      "color": 40931,
      "stateType": "Regular",
      "entityType": "counterparty"
    }
  ],
  "createShared": false
}

Метаданные Контрагентов
GET`/entity/counterparty/metadata`

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

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

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

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

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020

Responses200

Успешный запрос. Результат - JSON представление отдельного доп. поля.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020",
    "type": "attributemetadata",
    "mediaType": "application/json"
  },
  "id": "5290a290-0313-11e6-9464-e4de00000020",
  "name": "attribute_name",
  "type": "boolean",
  "required": false
}

Отдельное доп. поле
GET`/entity/counterparty/metadata/attributes/{id}`

Запрос на получение информации по отдельному дополнительному полю.

URI Parameters

СкрытьПоказать

id: string (required) Example: 5290a290-0313-11e6-9464-e4de00000020
id Доп. поля

Контрагент ¶

Контрагент, обращение к которому происходит по значению его id.

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19

RequestsПример 1Пример 2

Responses200

Успешный запрос. Результат - JSON представление Контрагента с указанным id.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "b80ea81b-7058-11e6-8a84-bae500000000",
  "accountId": "1185513e-692c-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2016-09-01 18:28:22",
  "name": "ООО Радуга",
  "externalCode": "o7732zkki541HDkZZD1Yt3",
  "archived": false,
  "created": "2007-02-07 17:16:41",
  "companyType": "legal",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
      "type": "state",
      "mediaType": "application/json"
    }
  },
  "salesAmount": 0,
  "priceType": "Цена летняя",
  "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
  "legalAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "123",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
  "actualAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "111",
    "addInfo": "addinfo",
    "comment": "some words about address"
  }
}

Responses200

Успешный запрос. Результат - JSON представление Контрагента типа Индивидуальный Предприниматель с указанным id.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json",
    "uuidHref": "https://online.moysklad.ru/app/#company/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
  },
  "id": "7944ef04-f831-11e5-7a69-971500188b19",
  "accountId": "02865f48-b0ae-11ea-0a80-203a00000002",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/02e06bea-b0ae-11ea-0a80-1d9c00000034",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json",
      "uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=02e06bea-b0ae-11ea-0a80-1d9c00000034"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/02877fda-b0ae-11ea-0a80-203a00000003",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 0,
  "updated": "2020-06-17 18:21:53",
  "name": "ИП Иванов",
  "code": "someCode",
  "externalCode": "extCode",
  "archived": false,
  "created": "2020-06-17 18:21:53",
  "companyType": "entrepreneur",
  "legalTitle": "Индивидуальный предприниматель Иванов Иван Иванович",
  "legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
  "legalAddressFull": {
    "addInfo": "г.Москва ул Авиастроителей д 93 к 12"
  },
  "actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
  "actualAddressFull": {
    "addInfo": "г.Москва ул Академика Миля дом 15 к 21"
  },
  "inn": "87654321",
  "okpo": "12345",
  "ogrnip": "58632598y21jk",
  "legalLastName": "Иванов",
  "legalFirstName": "Иван",
  "legalMiddleName": "Иванович",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "state": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/03935900-b0ae-11ea-0a80-1d9c0000008c",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "state",
      "mediaType": "application/json"
    }
  },
  "salesAmount": 0
}

Получить Контрагента
GET`/entity/counterparty/{id}`

Возвращает JSON представление Контрагента с указанным id.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.

PUT https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19

RequestsПримерПример c доп полями

Headers

Content-Type: application/json

BodyСкрытьПоказать

В теле запроса можно указать только те поля, которые необходимо изменить у Контрагента

Responses200

Успешное обновление. Результат - JSON представление обновлённого Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "6a9c3857-2c8b-11e6-8a84-bae500000047",
  "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 3,
  "updated": "2016-06-07 12:13:31",
  "name": "ООО Радуга ЭКСПО",
  "description": "Сеть рынков стройматериалов Радуга ЭКСПО",
  "code": "raduga",
  "externalCode": "extRainbow",
  "archived": false,
  "created": "2007-02-07 17:16:41",
  "legalTitle": "Общество с ограниченой ответственностью \"Радуга ЭКСПО\"",
  "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
  "legalAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "123",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
  "actualAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "111",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "inn": "1251581244152",
  "kpp": "121557212",
  "ogrn": "1253552",
  "okpo": "201313",
  "email": "raduga@retail.ru",
  "phone": "+7 495 162 32 23",
  "fax": "1052054",
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [
    "жжот",
    "строители",
    "бетон",
    "ремонт",
    "радуга"
  ],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  }
}

Пример запроса для обновления Контрагента с доп полями в теле запроса.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "ООО Овощ Экспресс",
  "description": "Сеть экспресс-доставки овощей",
  "code": "ovoshexpresscode",
  "externalCode": "externalVagetable",
  "email": "ovoshi@delivery.ru",
  "phone": "+7 495 162 12 23",
  "fax": "1052014",
  "legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
  "inn": "1251581244152",
  "kpp": "121557212",
  "ogrn": "1253552",
  "okpo": "201313",
  "tags": [
    "Овощи",
    "Еда",
    "Доставка",
    "Экспресс",
    "Едовозы"
  ],
  "contactpersons": [
    {
      "name": "Вася",
      "description": "Овощерез Вася",
      "position": "Овощерез"
    },
    {
      "name": "Петя",
      "position": "Овощевоз"
    }
  ],
  "accounts": [
    {
      "isDefault": true,
      "accountNumber": "12512568161257981",
      "bankName": "ОАО Сбербанк",
      "bankLocation": "г Москва Ул Вавилова 19",
      "correspondentAccount": "375632785587",
      "bic": "1234532"
    },
    {
      "accountNumber": "12512568161257982",
      "bankName": "ВТБ",
      "bic": "7654352"
    }
  ],
  "attributes": [
    {
      "id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
      "name": "Коэффициент скидки",
      "type": "double",
      "value": 0.35
    },
    {
      "id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
      "name": "Последний заключённый договор",
      "type": "time",
      "value": "2016-06-07 10:52:33"
    },
    {
      "id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
      "name": "Партнёрскоё юрлицо",
      "type": "boolean",
      "value": true
    }
  ]
}

Responses200

Успешное обновление. Результат - JSON представление обновлённого Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
    "type": "counterparty",
    "mediaType": "application/json"
  },
  "id": "88fc07ac-2c8d-11e6-8a84-bae500000050",
  "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
  "owner": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  },
  "shared": false,
  "group": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
      "type": "group",
      "mediaType": "application/json"
    }
  },
  "version": 3,
  "updated": "2016-06-07 12:08:25",
  "name": "ООО Овощ Экспресс",
  "description": "Сеть экспресс-доставки овощей",
  "code": "ovoshexpresscode",
  "externalCode": "externalVagetable",
  "archived": false,
  "created": "2007-02-07 17:16:41",
  "legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
  "legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
  "legalAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "123",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
  "actualAddressFull": {
    "postalCode": "125009",
    "country": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
        "type": "country",
        "mediaType": "application/json"
      }
    },
    "region": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
        "type": "region",
        "mediaType": "application/json"
      }
    },
    "city": "Москва",
    "street": "ул Тверская",
    "house": "1",
    "apartment": "111",
    "addInfo": "addinfo",
    "comment": "some words about address"
  },
  "inn": "1251581244152",
  "kpp": "121557212",
  "ogrn": "1253552",
  "okpo": "201313",
  "email": "ovoshi@delivery.ru",
  "phone": "+7 495 162 12 23",
  "fax": "1052014",
  "attributes": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d129ff5-2c8c-11e6-8a84-bae5000000f3",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
      "name": "Коэффициент скидки",
      "type": "double",
      "value": 0.35
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
      "name": "Последний заключённый договор",
      "type": "time",
      "value": "2016-06-07 10:52:33"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
        "type": "attributemetadata",
        "mediaType": "application/json"
      },
      "id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
      "name": "Партнёрское юрлицо",
      "type": "boolean",
      "value": true
    }
  ],
  "accounts": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/accounts",
      "type": "account",
      "mediaType": "application/json",
      "size": 2,
      "limit": 100,
      "offset": 0
    }
  },
  "tags": [
    "овощи",
    "доставка",
    "еда",
    "едовозы",
    "экспресс"
  ],
  "contactpersons": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons",
      "type": "contactperson",
      "mediaType": "application/json",
      "size": 2,
      "limit": 100,
      "offset": 0
    }
  },
  "notes": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/notes",
      "type": "note",
      "mediaType": "application/json",
      "size": 0,
      "limit": 100,
      "offset": 0
    }
  }
}

Изменить Контрагента
PUT`/entity/counterparty/{id}`

Обновляется представление Контрагента с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Контрагента, кроме тех, что помечены Только для чтения в описании атрибутов Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются. Поля account и contactpersons обновляются как элементы вложенных коллекций. При обновлении, переданные элементы данных коллекций обрабатываются как “Все элементы данной коллекции” и полностью заменяют элементы, ранее присутствовавшие в ней.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.

Счета Контрагента ¶

Список счетов Контрагента с указанным id.

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/accounts

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts",
    "type": "account",
    "mediaType": "application/json",
    "size": 2,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts/04c5d0dc-2c92-11e6-8a84-bae5000000f6",
        "type": "account",
        "mediaType": "application/json"
      },
      "id": "04c5d0dc-2c92-11e6-8a84-bae5000000f6",
      "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
      "version": 0,
      "updated": "2016-06-07 12:27:13",
      "isDefault": false,
      "accountNumber": "125917666032321985647",
      "bankName": "ВТБ",
      "bankLocation": "ул Сахаровского д 153",
      "correspondentAccount": "12512578256712",
      "bic": "1258617"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts/6a9c43ce-2c8b-11e6-8a84-bae500000048",
        "type": "account",
        "mediaType": "application/json"
      },
      "id": "6a9c43ce-2c8b-11e6-8a84-bae500000048",
      "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
      "version": 1,
      "updated": "2016-06-07 11:39:58",
      "isDefault": true,
      "accountNumber": "236174374372272747234743274",
      "bankName": "ОАО Сбербанк",
      "bankLocation": "ул Ваивлова д 19",
      "correspondentAccount": "251632427568",
      "bic": "125125125"
    }
  ]
}

Получить счета Контрагента
GET`/entity/counterparty/{id}/accounts`

Возвращает массив JSON представлений счетов Контрагента.

URI Parameters

СкрытьПоказать

id

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Контрагента.

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

Счет Контрагента ¶

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/accounts/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/accounts/a6aa5466-2ca2-11e6-8a84-bae500000017",
    "type": "account",
    "mediaType": "application/json"
  },
  "id": "a6aa5466-2ca2-11e6-8a84-bae500000017",
  "accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
  "version": 0,
  "updated": "2016-06-07 14:26:17",
  "isDefault": false,
  "accountNumber": "12512568161257982",
  "bankName": "ВТБ",
  "bic": "7654352"
}

Получить счет Контрагента
GET`/entity/counterparty/{id}/accounts/{accountId}`

Возвращает JSON представление счета Контрагента.

URI Parameters

СкрытьПоказать

id

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Контрагента.

accountId

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Счёта.

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

Контактные лица Контрагента ¶

Получить список контактных лиц Контрагента с указанным id.

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
    "type": "contactperson",
    "mediaType": "application/json",
    "size": 3,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/43e39375-7059-11e6-8a84-bae5000000cb",
        "type": "contactperson",
        "mediaType": "application/json"
      },
      "id": "43e39375-7059-11e6-8a84-bae5000000cb",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "version": 0,
      "updated": "2016-09-01 18:32:17",
      "name": "Адвокатов Петр Сергеевич",
      "description": "Адвокат",
      "externalCode": "asI0ncJch5jkgxxlCQKiH1",
      "email": "advopetr@mail.ru",
      "phone": "87127418",
      "position": "Адвокат",
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/308142fc-7059-11e6-8a84-bae5000000c6",
        "type": "contactperson",
        "mediaType": "application/json"
      },
      "id": "308142fc-7059-11e6-8a84-bae5000000c6",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "version": 1,
      "updated": "2016-09-01 18:31:44",
      "name": "Travolta Jehn",
      "description": "Траволта на связи",
      "externalCode": "9QZNh3dbiLu1-V9bmmLKu0",
      "email": "travolta@mail.ru",
      "phone": "125815120",
      "position": "Секретарь",
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/13af74bf-7059-11e6-8a84-bae5000000c3",
        "type": "contactperson",
        "mediaType": "application/json"
      },
      "id": "13af74bf-7059-11e6-8a84-bae5000000c3",
      "accountId": "1185513e-692c-11e6-8a84-bae500000001",
      "version": 1,
      "updated": "2016-09-01 18:30:56",
      "name": "Панин Алексей Олегович",
      "description": "Бухгалтерия",
      "externalCode": "Gaizui5siLqoUbZ3jpE2I2",
      "email": "mail@mail.rq",
      "phone": "12412512512",
      "position": "Бухгалтер",
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      }
    }
  ]
}

Список контактных лиц
GET`/entity/counterparty/{id}/contactpersons`

Возвращает массив JSON представлений контактных лиц Контрагента.

URI Parameters

СкрытьПоказать

id

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Контрагента.

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

POST https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons

RequestsПример

Пример запроса на создание контактного лица Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "Пётр",
  "code": "Petya the deliverer",
  "externalCode": "-odJxBw7i06O0GhSc28S90",
  "email": "petr@ovoshy.com",
  "phone": "+777 666 228",
  "position": "овощедоставщик"
}

Responses200

Успешное создание.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons/ceba215c-d5cb-11e7-0532-9eed00000005",
      "type": "contactperson",
      "mediaType": "application/json"
    },
    "id": "ceba215c-d5cb-11e7-0532-9eed00000005",
    "accountId": "eb9ac8c0-d511-11e7-0532-9eed00000001",
    "version": 0,
    "updated": "2017-11-30 15:41:38",
    "name": "Пётр",
    "code": "Petya the deliverer",
    "externalCode": "-odJxBw7i06O0GhSc28S90",
    "email": "petr@ovoshy.com",
    "phone": "+777 666 228",
    "position": "овощедоставщик",
    "agent": {
      "meta": {
        "href": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19",
        "metadataHref": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json",
        "uuidHref": "http://online.moysklad.ru/app/#company/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
      }
    }
  }
]

Создать контактное лицо
POST`/entity/counterparty/{id}/contactpersons`

Создать контактное лицо Контрагента с указанным id.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.

Контактное лицо ¶

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons/94433ed3-2c9f-11e6-8a84-bae500000010",
    "type": "contactperson",
    "mediaType": "application/json"
  },
  "id": "94433ed3-2c9f-11e6-8a84-bae500000010",
  "accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
  "version": 2,
  "updated": "2016-06-07 14:04:17",
  "name": "Пётр",
  "code": "Petya the deliverer",
  "externalCode": "-odJxBw7i06O0GhSc28S90",
  "email": "petr@ovoshy.com",
  "phone": "+777 666 228",
  "position": "овощедоставщик",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json"
    }
  }
}

Получить контактное лицо
GET`/entity/counterparty/{id}/contactpersons/{contactpersonId}`

Возвращает JSON представление отдельного контактного лица Контрагента.

URI Parameters

СкрытьПоказать

id

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Контрагента.

contactpersonId

string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id контактного лица.

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

PUT https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons/7944ef04-f831-11e5-7a69-971500188b19

RequestsПример

Пример запроса на обновление контактного лица Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "Пётр",
  "code": "Petya the deliverer",
  "email": "petr@ovoshy.com",
  "phone": "+777 666 228",
  "position": "овощедоставщик"
}

Responses200

Успешное обновление.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons/94433ed3-2c9f-11e6-8a84-bae500000010",
    "type": "contactperson",
    "mediaType": "application/json"
  },
  "id": "94433ed3-2c9f-11e6-8a84-bae500000010",
  "accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
  "version": 2,
  "updated": "2016-06-07 14:04:17",
  "name": "Пётр",
  "code": "Petya the deliverer",
  "externalCode": "-odJxBw7i06O0GhSc28S90",
  "email": "petr@ovoshy.com",
  "phone": "+777 666 228",
  "position": "овощедоставщик",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json"
    }
  }
}

Изменить контактное лицо
PUT`/entity/counterparty/{id}/contactpersons/{contactpersonId}`

Обновить контактное лицо Контрагента с указанным id. Обновляются все поля, указанные в JSON объекте запроса, кроме помеченных Только для чтения в описании атрибутов контактных лиц Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.
contactpersonId: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id контактного лица.

События Контрагента ¶

Получить список событий Контрагента с указанным id.

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes",
    "type": "note",
    "mediaType": "application/json",
    "size": 2,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/7e391b16-3efd-11e7-8af5-581e0000009d",
        "type": "note",
        "mediaType": "application/json"
      },
      "id": "7e391b16-3efd-11e7-8af5-581e0000009d",
      "accountId": "b127966a-3efa-11e7-8af5-581e00000001",
      "version": 0,
      "created": "2017-05-22 17:46:52",
      "description": "второе событие",
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      },
      "author": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/b1876a85-3efa-11e7-8af5-581e0000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/7b919056-3efd-11e7-8af5-581e0000009a",
        "type": "note",
        "mediaType": "application/json"
      },
      "id": "7b919056-3efd-11e7-8af5-581e0000009a",
      "accountId": "b127966a-3efa-11e7-8af5-581e00000001",
      "version": 0,
      "created": "2017-05-22 17:46:47",
      "description": "первое событие",
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      },
      "author": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/b1876a85-3efa-11e7-8af5-581e0000002a",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      }
    }
  ]
}

Список событий
GET`/entity/counterparty/{id}/notes`

Возвращает массив JSON представлений событий Контрагента.

URI Parameters

СкрытьПоказать

id

string (required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056

id Контрагента.

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

POST https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes

RequestsПример

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

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "description": "текст"
}

Responses200

Успешный запрос. Результат - JSON представление добавленного события.

Headers

Content-Type: application/json

BodyСкрытьПоказать

[
  {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
      "type": "note",
      "mediaType": "application/json"
    },
    "id": "50b318cb-3cb0-11e7-8af5-581e00000007",
    "accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
    "version": 0,
    "created": "2017-05-19 19:29:22",
    "description": "текст",
    "agent": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
        "type": "counterparty",
        "mediaType": "application/json"
      }
    },
    "author": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  }
]

Добавить событие
POST`/entity/counterparty/{id}/notes`

URI Parameters

СкрытьПоказать

id: string (required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056
id Контрагента.

Событие ¶

GET https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/notes/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешный запрос.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
    "type": "note",
    "mediaType": "application/json"
  },
  "id": "50b318cb-3cb0-11e7-8af5-581e00000007",
  "accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
  "version": 0,
  "created": "2017-05-19 19:29:22",
  "description": "текст",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json"
    }
  },
  "author": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  }
}

Получить событие
GET`/entity/counterparty/{id}/notes/{noteId}`

Возвращает JSON представление отдельного события Контрагента.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.
noteId: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id события.

PUT https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/notes/7944ef04-f831-11e5-7a69-971500188b19

RequestsПример

Пример запроса на обновление события Контрагента.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "description": "измененный текст"
}

Responses200

Успешное обновление.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
    "type": "note",
    "mediaType": "application/json"
  },
  "id": "50b318cb-3cb0-11e7-8af5-581e00000007",
  "accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
  "version": 1,
  "created": "2017-05-19 19:29:22",
  "description": "измененный текст",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
      "type": "counterparty",
      "mediaType": "application/json"
    }
  },
  "author": {
    "meta": {
      "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
      "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
      "type": "employee",
      "mediaType": "application/json"
    }
  }
}

Изменить событие
PUT`/entity/counterparty/{id}/notes/{noteId}`

Обновить событие Контрагента с указанным id. Обновляются все поля, указанные в JSON объекте запроса, кроме помеченных Только для чтения в описании атрибутов событий Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Контрагента.
noteId: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id события.

DELETE https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007

Responses200

Успешное удаление События.

Удалить событие
DELETE`/entity/counterparty/{id}/notes/{noteId}`

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

URI Parameters

СкрытьПоказать

id: string (required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056
id Контрагента.
noteId: string (required) Example: 50b318cb-3cb0-11e7-8af5-581e00000007
id события

Ассортимент ¶

Сущность assortment представляет собой список всех товаров, услуг, комплектов, серий и модификаций с полями stock, reserve, inTransit, quantity, показывающими остаток, резерв, ожидание и доступно каждой из сущностей (для комплектов не выводятся поля остатков и резерва). Данные поля могут быть рассчитаны в зависимости от даты и склада с использованием параметров запроса stockmoment и stockstore.

С помощью параметра filter=search=<значение> можно произвести префиксный поиск по строковым полям, выводимым в ассортименте:

по наименованию элемента Ассортимента name
по имени модификации name
по коду code
по коду модификации code
по артикулу article
по штрихкоду barcode
по штрихкоду модификации barcode
по штрихкоду упаковок товаров barcode

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

Пример (не URL encoded): filter=search=some_random_string.

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

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

по наименованию элемента ассортимента name
по описанию description

Для фильтрации по полю productFolder необходимо использовать filter=productFolder=<href>, где указать href группы товаров.

Пример: ?filter=productFolder=https://online.moysklad.ru/api/remap/1.1/entity/productfolder/a3ff313d-a2f7-11e9-ac12-000d00000007.

id - ID в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
version - Версия сущности
updated - Момент последнего обновления сущности
updatedBy - Автор последнего обновления сущности в формате uid (admin@admin)
name - Наименование
description - Описание сущности
externalCode - Внешний код сущности
archived - Отметка о том, добавлена ли сущность в архив
code - Код сущности
productFolder - Группа товаров
article - Артикул товара или комплекта
supplier - Ссылка на контрагента-поставщика

name - Наименование
code - Код сущности

GET https://online.moysklad.ru/api/remap/1.1/entity/assortment

Responses200

Успешный запрос. Результат - JSON представление списка всех товаров, услуг, модификация и серий.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/assortment",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/assortment/metadata",
    "type": "assortment",
    "mediaType": "application/json",
    "size": 7,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "id": "35427052-36e7-11e7-8a7f-40d0000000d1",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": true,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 0,
      "updated": "2017-05-12 10:47:11",
      "name": "product",
      "code": "00001",
      "externalCode": "LsAGeHdbgyQ3oSlTzZUvH0",
      "archived": false,
      "pathName": "",
      "vat": 18,
      "effectiveVat": 18,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        }
      },
      "image": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/download/28ca8201-36e7-11e7-8a7f-40d0000000cd",
          "mediaType": "application/octet-stream"
        },
        "title": "product_image",
        "filename": "product_image.png",
        "size": 64211,
        "updated": "2017-05-12 10:46:50",
        "miniature": {
          "href": "https://online.moysklad.ru/api/remap/1.1/download/28ca8201-36e7-11e7-8a7f-40d0000000cd?miniature=true",
          "mediaType": "image/png"
        },
        "tiny": {
          "href": "https://online.moysklad.ru/app/download/28ca6fbb-36e7-11e7-8a7f-40d0000000cc.png",
          "mediaType": "image/png"
        }
      },
      "minPrice": 1000,
      "salePrices": [
        {
          "value": 1500,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "supplier": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/1076cf8b-36e7-11e7-8a7f-40d000000093",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
          "type": "counterparty",
          "mediaType": "application/json"
        }
      },
      "buyPrice": {
        "value": 500,
        "currency": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
            "type": "currency",
            "mediaType": "application/json"
          }
        }
      },
      "article": "100000000",
      "weight": 0,
      "volume": 0,
      "barcodes": [
        "2000000000015"
      ],
      "modificationsCount": 0,
      "isSerialTrackable": false,
      "trackingType": "NOT_TRACKED",
      "stock": 0,
      "reserve": 0,
      "inTransit": 0,
      "quantity": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/consignment/c66f4b17-36e7-11e7-8a7f-40d000000113",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/consignment/metadata",
        "type": "consignment",
        "mediaType": "application/json"
      },
      "id": "c66f4b17-36e7-11e7-8a7f-40d000000113",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "version": 0,
      "updated": "2017-05-12 10:51:15",
      "name": "product / consignment",
      "code": "1012",
      "externalCode": "g9BOLNRZglk9NMOHxcrVV0",
      "label": "consignment",
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json"
        }
      },
      "stock": 0,
      "reserve": 0,
      "inTransit": 0,
      "quantity": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/service/437f2d67-36e7-11e7-8a7f-40d0000000df",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/service/metadata",
        "type": "service",
        "mediaType": "application/json"
      },
      "id": "437f2d67-36e7-11e7-8a7f-40d0000000df",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": true,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 0,
      "updated": "2017-05-12 10:47:35",
      "name": "service",
      "code": "00002",
      "externalCode": "DDBfxV4djLuOlbr80-I1A0",
      "archived": false,
      "pathName": "",
      "vat": 18,
      "effectiveVat": 18,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        }
      },
      "minPrice": 500,
      "salePrices": [
        {
          "value": 1500,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "buyPrice": {
        "value": 700,
        "currency": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
            "type": "currency",
            "mediaType": "application/json"
          }
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/metadata",
        "type": "bundle",
        "mediaType": "application/json"
      },
      "id": "4f75d130-36e7-11e7-8a7f-40d0000000ef",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": true,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 0,
      "updated": "2017-05-12 10:47:55",
      "name": "bundle",
      "code": "00003",
      "externalCode": "ndWrlXCZjm9uSyLk57KOD0",
      "archived": false,
      "pathName": "",
      "vat": 18,
      "effectiveVat": 18,
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        }
      },
      "minPrice": 0,
      "salePrices": [
        {
          "value": 0,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "article": "50000000",
      "weight": 0,
      "volume": 0,
      "barcodes": [
        "2000000000046"
      ],
      "trackingType": "NOT_TRACKED",
      "components": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef/components",
          "type": "bundlecomponent",
          "mediaType": "application/json",
          "size": 1,
          "limit": 100,
          "offset": 0
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "id": "6830a346-36e7-11e7-8a7f-40d0000000f8",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "owner": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
          "type": "employee",
          "mediaType": "application/json"
        }
      },
      "shared": true,
      "group": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
          "type": "group",
          "mediaType": "application/json"
        }
      },
      "version": 0,
      "updated": "2017-05-12 10:48:37",
      "name": "product2",
      "code": "00004",
      "externalCode": "bxviUUtwg4C6y4RdOc2GS3",
      "archived": false,
      "pathName": "",
      "uom": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
          "type": "uom",
          "mediaType": "application/json"
        }
      },
      "minPrice": 1000,
      "salePrices": [
        {
          "value": 1800,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "buyPrice": {
        "value": 700,
        "currency": {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
            "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
            "type": "currency",
            "mediaType": "application/json"
          }
        }
      },
      "article": "2000000000000",
      "weight": 0,
      "volume": 0,
      "barcodes": [
        "2000000000053"
      ],
      "modificationsCount": 2,
      "isSerialTrackable": false,
      "trackingType": "SHOES",
      "stock": 0,
      "reserve": 0,
      "inTransit": 0,
      "quantity": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/68379863-36e7-11e7-8a7f-40d0000000fd",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "id": "68379863-36e7-11e7-8a7f-40d0000000fd",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "version": 0,
      "updated": "2017-05-12 10:48:37",
      "name": "product2 (blue)",
      "code": "00002",
      "externalCode": "BrmW28jLhRMI-jOPUdfWW0",
      "archived": false,
      "characteristics": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5",
            "type": "attributemetadata",
            "mediaType": "application/json"
          },
          "id": "682beecc-36e7-11e7-8a7f-40d0000000f5",
          "name": "color",
          "value": "blue"
        }
      ],
      "salePrices": [
        {
          "value": 1800,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "barcodes": [
        "2000000000060"
      ],
      "product": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json"
        },
        "trackingType": "SHOES"
      },
      "stock": 0,
      "reserve": 0,
      "inTransit": 0,
      "quantity": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/6839f0fa-36e7-11e7-8a7f-40d000000101",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata",
        "type": "variant",
        "mediaType": "application/json"
      },
      "id": "6839f0fa-36e7-11e7-8a7f-40d000000101",
      "accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
      "version": 0,
      "updated": "2017-05-12 10:48:37",
      "name": "product2 (red)",
      "code": "00003",
      "externalCode": "i0u4rktiiVX6BWL60IVkJ1",
      "archived": false,
      "characteristics": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5",
            "type": "attributemetadata",
            "mediaType": "application/json"
          },
          "id": "682beecc-36e7-11e7-8a7f-40d0000000f5",
          "name": "color",
          "value": "red"
        }
      ],
      "salePrices": [
        {
          "value": 1800,
          "currency": {
            "meta": {
              "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
              "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
              "type": "currency",
              "mediaType": "application/json"
            }
          },
          "priceType": "Цена продажи"
        }
      ],
      "barcodes": [
        "2000000000077"
      ],
      "product": {
        "meta": {
          "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
          "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
          "type": "product",
          "mediaType": "application/json"
        },
        "trackingType": "SHOES"
      },
      "stock": 0,
      "reserve": 0,
      "inTransit": 0,
      "quantity": 0
    }
  ]
}

Получить Ассортимент
GET`/entity/assortment`

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

URI Parameters

СкрытьПоказать

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

stockstore

string (optional)

Ссылка на склад, по которому нужно получить остатки. Формат - URI.

stockmoment

string (optional)

Момент времени, на который нужно вывести остатки. Формат строки:

YYYY-MM-DD HH:MM:SS.

scope

string (optional)

Параметр фильтрации по типу объектов. Принимает одно из значений:

product - будут выведены только товары
variant - будут выведены товары и модификации
consignment - будут выведены все сущности (аналогично отсутствию параметра)

stockmode

string (optional)

Вид Остатка. Параметр совместим только с параметрами: limit, offset, stockstore, stockmoment, quantitymode. Если указаны параметры отличные от совместимых в ответ вернется ошибка с кодом 1069.

Допустимые значения [all, positiveOnly, negativeOnly, empty, nonEmpty]

По умолчанию параметр stockmode имеет значение all. Если вы хотите увидеть объекты с нулевым или отрицательным остатком, нужно указать соответствующее значение данного параметра

quantitymode

string (optional)

Фильтр по полю Доступно. Параметр совместим только с параметрами: limit, offset, stockstore, stockmoment, stockmode. Если указаны параметры отличные от совместимых в ответ вернется ошибка с кодом 1069.

Допустимые значения [all, positiveOnly, negativeOnly, empty, nonEmpty]

По умолчанию параметр quantitymode имеет значение all. Если вы хотите увидеть объекты с нулевым или отрицательным значением поля Доступно, нужно указать соответствующее значение данного параметра.

Валюта ¶

Валюты ¶

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

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

по краткому наименованию Валюты name

meta - Метаданные объекта
name - Краткое наименование Валюты Необходимое
fullName - Полное наименование Валюты
code - Цифровой код Валюты Необходимое
isoCode - Буквенный код Валюты Необходимое
rate - Курс Валюты
multiplicity - Кратность курса Валюты
indirect - Признак обратного курса Валюты
rateUpdateType - Способ обновления курса Валюты Только для чтения
majorUnit - Формы единиц целой части Валюты
minorUnit - Формы единиц дробной части Валюты
archived - Добавлена ли Валюта в архив
system - Основана ли валюта на валюте из системного справочника Только для чтения
default - Является ли валюта валютой учета Только для чтения

name - Краткое наименование Валюты
fullName - Полное наименование Валюты
code - Цифровой код Валюты
isoCode - Буквенный код Валюты
multiplicity - Кратность курса Валюты
archived - Добавлена ли Валюта в архив
default - Является ли валюта валютой учета

id - ID в формате UUID
name - Краткое наименование Валюты
fullName - Полное наименование Валюты
code - Цифровой код Валюты
isoCode - Буквенный код Валюты
multiplicity - Кратность курса Валюты
archived - Добавлена ли Валюта в архив
default - Является ли валюта валютой учета

Поля majorUnit и minorUnit содержат в себе следующие атрибуты:

gender - Грамматический род единицы валюты (допустимые значения masculine - мужской, feminine - женский)
s1 - Форма единицы, используемая при числительном 1
s2 - Форма единицы, используемая при числительном 2
s5 - Форма единицы, используемая при числительном 5

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

GET https://online.moysklad.ru/api/remap/1.1/entity/currency/

Responses200

Успешный запрос. Результат - JSON представление списка Валют.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
    "type": "currency",
    "mediaType": "application/json",
    "size": 2,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
        "type": "currency",
        "mediaType": "application/json"
      },
      "system": false,
      "name": "руб",
      "fullName": "Рубль",
      "rate": 1,
      "multiplicity": 1,
      "indirect": false,
      "rateUpdateType": "manual",
      "code": "643",
      "isoCode": "RUB",
      "majorUnit": {
        "gender": "masculine",
        "s1": "рубль",
        "s2": "рубля",
        "s5": "рублей"
      },
      "minorUnit": {
        "gender": "feminine",
        "s1": "копейка",
        "s2": "копейки",
        "s5": "копеек"
      },
      "archived": false,
      "default": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
        "type": "currency",
        "mediaType": "application/json"
      },
      "system": true,
      "name": "доллар",
      "fullName": "Доллар США",
      "rate": 63,
      "multiplicity": 1,
      "indirect": false,
      "rateUpdateType": "manual",
      "code": "840",
      "isoCode": "USD",
      "majorUnit": {
        "gender": "masculine",
        "s1": "доллар",
        "s2": "доллара",
        "s5": "долларов"
      },
      "minorUnit": {
        "gender": "masculine",
        "s1": "цент",
        "s2": "цента",
        "s5": "центов"
      },
      "archived": false,
      "default": false
    }
  ]
}

Получить Валюты
GET`/entity/currency/`

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

meta Метаданные о выдаче,
context - Метаданные о сотруднике, выполнившем запрос.
rows - Массив JSON объектов, представляющих собой валюты.

URI Parameters

СкрытьПоказать

limit

number (optional) Default: 25 Example: 100

Максимальное количество сущностей для извлечения.

Допустимые значения 1 - 100

offset

number (optional) Default: 0 Example: 40

Отступ в выдаваемом списке сущностей

POST https://online.moysklad.ru/api/remap/1.1/entity/currency/

RequestsПример

Пример запроса на создание новой валюты.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "доллар",
  "rate": 63,
  "code": "840",
  "isoCode": "USD"
}

Responses200

Успешный запрос. Результат - JSON представление созданной Валюты.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
    "type": "currency",
    "mediaType": "application/json"
  },
  "system": false,
  "name": "доллар",
  "rate": 63,
  "multiplicity": 1,
  "indirect": false,
  "rateUpdateType": "manual",
  "code": "840",
  "isoCode": "USD",
  "majorUnit": {
    "gender": "masculine"
  },
  "minorUnit": {
    "gender": "masculine"
  },
  "archived": false,
  "default": false
}

Создать новую Валюту
POST`/entity/currency/`

Запрос на создание новой валюты. Обязательные поля для создание валюты - name, code и isoCode. В теле запроса нельзя указать курс валюты (rate) равным нулю.

DELETE https://online.moysklad.ru/api/remap/1.1/entity/currency/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешное удаление Валюты.

Удалить Валюту
DELETE`/entity/currency/{id}`

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

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id Валюты

Валюта ¶

Работа с Валютой с указанным id.

GET https://online.moysklad.ru/api/remap/1.1/entity/currency/7944ef04-f831-11e5-7a69-971500188b19

Responses200

Успешный запрос. Результат - JSON представление запрошенной Валюты.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
    "type": "currency",
    "mediaType": "application/json"
  },
  "system": false,
  "name": "руб",
  "fullName": "Рубль",
  "rate": 1,
  "multiplicity": 1,
  "indirect": false,
  "rateUpdateType": "manual",
  "code": "643",
  "isoCode": "RUB",
  "majorUnit": {
    "gender": "masculine",
    "s1": "рубль",
    "s2": "рубля",
    "s5": "рублей"
  },
  "minorUnit": {
    "gender": "feminine",
    "s1": "копейка",
    "s2": "копейки",
    "s5": "копеек"
  },
  "archived": false,
  "default": true
}

Получить Валюту
GET`/entity/currency/{id}`

Запрос на получение Валюты с указанным id.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id валюты

PUT https://online.moysklad.ru/api/remap/1.1/entity/currency/7944ef04-f831-11e5-7a69-971500188b19

RequestsПример

Пример запроса на обновление валюты.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "name": "долл",
  "rate": 66,
  "code": "dollarusd",
  "isoCode": "USD"
}

Responses200

Успешный запрос. Результат - JSON представление обновлённой Валюты.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
    "type": "currency",
    "mediaType": "application/json"
  },
  "system": false,
  "name": "долл",
  "rate": 66,
  "multiplicity": 1,
  "indirect": false,
  "rateUpdateType": "manual",
  "code": "dollarusd",
  "isoCode": "USD",
  "majorUnit": {
    "gender": "masculine"
  },
  "minorUnit": {
    "gender": "masculine"
  },
  "archived": false,
  "default": false
}

Изменить Валюту
PUT`/entity/currency/{id}`

Запрос на обновление существующей валюты. В теле запроса нельзя указать курс валюты (rate) равным нулю, а также пустые поля name, code, isoCode. Нельзя изменять значения полей name, fullName, code, isoCode, majorUnit, minorUnit для валют, основанных на системном справочнике валют. Нельзя изменять курс валюты учета. Нельзя изменить курс валюты с автоматическим обновлением.

URI Parameters

СкрытьПоказать

id: string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19
id валюты

Товар ¶

Товары ¶

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

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

по наименованию товара (name)
по коду товара (code)
по артикулу (article)

meta - Метаданные объекта
id - ID Товара в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
shared - Общий доступ
group - Отдел сотрудника в формате Метаданных
syncId - ID синхронизации. После заполнения недоступен для изменения.
version - Версия сущности Только для чтения
updated - Момент последнего обновления сущности Только для чтения
name - Наименование Товара Необходимое
description - Описание Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар Только для чтения
vat - НДС %
effectiveVat - Реальный НДС % Только для чтения
productFolder - Ссылка на группу Товаров в формате Метаданных
uom - Ссылка на единицы измерения в формате Метаданных
image - Изображение Товара
minPrice - Минимальная цена
buyPrice - Закупочная цена
salePrices - Цены продажи
supplier - Ссылка на контрагента-поставщика в формате Метаданных
attributes - Коллекция доп. полей в формате Метаданных
country - Ссылка на страну в формате Метаданных
article - Артикул
weighed - Весовой товар
tobacco - Табачная продукция. Не может быть указан вместе с alcoholic, weighed и isSerialTrackable
weight - Вес
volume - Объём
packs - Упаковки Товара
barcodes - Массив штрихкодов товара
alcoholic - Объект, содержащий поля алкогольной продукции.
- excise - Содержит акцизную марку
- type - Код вида продукции
- strength - Крепость
- volume - Объём тары
modificationsCount - Количество модификаций у данного товара Только для чтения
minimumBalance - Неснижаемый остаток
isSerialTrackable - Учет по серийным номерам. Не может быть указан вместе с alcoholic и weighed
things - Серийные номера Только для чтения
trackingType - Тип маркируемой продукции
- NOT_TRACKED - Без маркировки
- TOBACCO - Тип маркировки “Табак”
- SHOES - Тип маркировки “Обувь”
- LP_CLOTHES - Тип маркировки “Одежда”
- LP_LINENS - Тип маркировки “Постельное белье”
- PERFUMERY - Духи и туалетная вода
- ELECTRONICS - Фотокамеры и лампы-вспышки
- TIRES - Шины и покрышки
- MILK - Тип маркировки “Молочная продукция”
- WATER - Тип маркировки “Упакованная вода”
- OTP - Альтернативная табачная продукция
- NCP - Никотиносодержащая продукция
tnved - Код ТН ВЭД
paymentItemType - Признак предмета расчета
- GOOD - Товар
- EXCISABLE_GOOD - Подакцизный товар
- COMPOUND_PAYMENT_ITEM - Составной предмет расчета
- ANOTHER_PAYMENT_ITEM - Иной предмет расчета
discountProhibited - Признак запрета скидок.
taxSystem - Код системы налогообложения.

Система налогообложения	Значение поля taxSystem
Совпадает с группой	TAX_SYSTEM_SAME_AS_GROUP
ОСН	GENERAL_TAX_SYSTEM
УСН. Доход	SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход	SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН	UNIFIED_AGRICULTURAL_TAX
ЕНВД	PRESUMPTIVE_TAX_SYSTEM
Патент	PATENT_BASED

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

id - ID Товара в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
syncId - ID синхронизации
version - Версия сущности
updated - Момент последнего обновления сущности
updatedBy - Автор последнего обновления сущности в формате uid (admin@admin)
name - Наименование Товара
description - Описание Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар
vat - НДС %
supplier - Ссылка на контрагента-поставщика
article - Артикул
weighed - Весовой товар
weight - Вес
volume - Объём
minimumBalance - Неснижаемый остаток
isSerialTrackable - Учет по серийным номерам

id - ID Товара в формате UUID
version - Версия сущности
updated - Момент последнего обновления сущности
name - Наименование Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар
weighed - Весовой товар
weight - Вес
volume - Объём
isSerialTrackable - Учет по серийным номерам

id - ID в формате UUID Только для чтения
uom - Ссылка на единицы измерения в формате Метаданных Необходимое
quantity - Количество Товаров в упаковке данного вида Необходимое
barcodes - Массив штрихкодов упаковок товаров. Данный массив может содержать не более одного штрихкода. Если штрихкод в массиве отсутствует, то данное поле не выводится. В версии API 1.1 был удалён отдельный ресурс для работы с упаковками товаров. Теперь упаковки - вложенная коллекция. Для того, чтобы создать новую упаковку для данного товара, нужно в запросе на обновление товара указать её как элемент поля packs, а в её составе указать ссылку в формате meta на единицу измерения и количество товаров в упаковке. Для упаковки товара нельзя указать ссылку на единицу измерения, совпадающую с единицей измерения товара, иначе возникнет ошибка. При обновлении штрихкодов упаковки в рамках обновления товара, переданная коллекция штрихкодов упаковки полностью заменяет имеющуюся до этого коллекцию. Для обновления списка упаковок товара, необходимо в рамках обновления товара передать новую коллекцию упаковок. Новая коллекия упаковок товара полностью заменит старую коллекцию.

Метаданные Товаров содержат информацию о дополнительных полях и типах цен Товаров.

Типы цен - поле priceType, вложенное в объекты коллекции salePrices. Его значение - наименование соответствующего типа цен.

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

meta - Метаданные
attributes - коллекция всех существующих доп. полей Товаров в формате Метаданных
priceTypes - коллекция всех существующих типов цен.
createShared - создавать новые товары с меткой “Общий”

Структуры объектов отдельных коллекций:

name - Наименование типа цен

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

meta - Метаданные, содержащие ссылку на поставщика. Тип поставщика - Контрагент. Описание сущности Контрагент вы можете посмотреть здесь

value - Значение цены
currency - Ссылка на валюту в формате Метаданных
priceType - Тип цены

value - Значение цены
currency - Ссылка на валюту в формате Метаданных

Структура поля image, которое вы получите при запросе товара с изображением:

meta - Метаданные об изображении
title - Название изображения
filename - Имя файла
size - Размер файла в байтах
updated - Дата последнего изменения
miniature - Ссылка на миниатюру изображения в формате Метаданных
tiny - Ссылка на уменьшенное изображение в формате Метаданных

Загрузка

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

filename - имя файла с расширением. Например - “банан.png”
content - Изображение, закодированное в формате Base64.

Если в запросе на обновление не будет полей filename и content, то весь объект image, если он присутствует в Body, будет проигнорирован, т.к. сервер посчитает, что его обновление не требуется.

meta - Метаданные, содержащие ссылку на группу Товара. Описание сущности Группа вы можете посмотреть здесь Обновление этого атрибута также обновит атрибут pathName.

weighed - Поле, показывающее является ли товар весовым. Если его значение false - поле не отображается. Если в основном интерфейсе у товара стоит отметка об учёте его по серийным номерам, выставить значение данного поля на true невозможно.

Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.

GET https://online.moysklad.ru/api/remap/1.1/entity/product

Responses200

Успешный запрос. Результат - JSON представление списка Товаров.

Headers

Content-Type: application/json

BodyСкрытьПоказать

{
  "context": {
    "employee": {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
        "type": "employee",
        "mediaType": "application/json"
      }
    }
  },
  "meta": {
    "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/",
    "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
    "type": "product",
    "mediaType": "application/json",
    "size": 5,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/remap/1.1/entity/product/26b36824-2c83-11e6-8a84-bae50000001b",
        "metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
        "type": "product",
        "mediaType": "application/json"
      },
      "id": "26b36824-2c83-11e6-8a84-bae50000001b",
      "accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
      "owner": {
        "m

API Endpoint

https://online.moysklad.ru/api/remap/1.1

Общие Сведения ¶

Аутентификация ¶

Замечания по разработке клиентских приложений ¶

Ограничения ¶

Метаданные ¶

Атрибуты расширенного объекта meta

Метаданные сущности

Мета коллекций

Обработка ошибок ¶

СТРУКТУРА ОШИБОК

СТРУКТУРА ОБЪЕКТА error

Возвращаемые HTTP статусы ошибок и их значения:

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

Все коды ошибок и их описания

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1052

1056

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

Аутентификация

Замечания по разработке клиентских приложений

Ограничения

Метаданные

Обработка ошибок