MT 3.0: СправкаAppearance
Описание формата обмена данными
На мобильном устройстве (далее — МУ) приложение «Агент Плюс: Мобильная торговля 3.0» использует для хранения данных собственную локальную базу данных (далее — БД).
В процессе работы с приложением в локальной БД создаются новые записи, данные из которых могут быть выгружены в учётную систему. Также данные могут загружаться из внешней учётной системы. Обмен данными происходит посредством специальных файлов обмена данными. В процессе обмена данные выгружаются из локальной БД в файл обмена данными. В дальнейшем этот файл передаётся в центральную базу данных (далее — ЦБД). При приёме данных в локальную БД МУ происходит обратная процедура — файл обмена данными принимается из ЦБД и загружается в локальную БД.
Структура файла обмена данными
Файл обмена данными представляет собой ZIP-архив, который может быть защищен паролем.
Загружаемый в МУ архив с данными имеет название «From1C.zip». Внутри архива могут находиться следующие файлы:
- JSON-файл описания данных «FromCDB.xml».
При выгрузке данных из МУ формируется архив с названием «To1C.zip» и внутри архива могут находиться следующие файлы:
- JSON-файл описания данных «ToCDB.xml».
JSON-файл содержит два корневых тэга «catalogs» и «documents». Внутри тэгов «catalogs» и «documents» содержатся специальные тэги, описывающие состав объектов.
Пример:
{ «catalogs»: {
«documents»: {
}
Формат описания значений.
В файлах обмена данными значения указываются в строковом представлении, все значения заключаются в двойные кавычки, как того требует формат JSON.
Список типов значений.
| Тип значения | Примеры представления |
|---|---|
| id | «51ed67a4-7220-11df-b336-0011955cba6b» Идентификатор id имеет строго определенную структуру. Он состоит из 5 групп символов. Первая группа состоит из 8 символов, вторая – из 4 символов, третья – из 4 символов, четвертая – из 4 символов, пятая группа – из 12 символов. Не допускаются пробелы перед идентификатором и после идентификатора, указание разделителей «-» между символами в приведенных выше позициях обязательно. Фигурные скобки перед и после идентификатора недопустимы (принятое обозначение для идентификаторов в OLE). Допустимые символы в идентификаторе: от «0» до «9» и от «A» до «F» (или от «a» до «f»). |
| Булево | Логический тип данных. Значения имеют два значения «true» и «false». |
| Строка | «Сидоров А.В.» Произвольная строка |
| Число | «100» «12.56» В качестве разделителя дробной части используется точка, не допускаются разделители триад. Для многих реквизитов с типом «Число» длина является неограниченной, для обозначения которой используется символ «». Например, длина, заданная как «.3», означает, что может быть задано число любой длины с точностью до 3 символов. |
Константы
Константы описываются в файле обмена данными при помощи тэга CONSTANTS и вложенных в него тэгов.
Тэг CONSTANTS описывает константы. Содержит вложенные тэги: ELEMENTS, KILLEDS, CONFIRMATIONS. Атрибутов в тэге CONSTANTS не предусмотрено.
- Тэг ELEMENTS задает список констант. Содержит вложенные тэги ITEM. Атрибутов в тэге не предусмотрено.
- Тэг ITEM задает константу. Атрибуты тэга ITEM:
- GUID – строковое представление уникального идентификатора константы.
- VALUE – строковое представление значения константы.
- Тэг KILLEDS задает список удаленных констант. Содержит вложенные тэги ITEM. Атрибутов в тэге не предусмотрено.
- Тэг ITEM задает удаленную константу. Атрибуты тэга ITEM:
- GUID – строковое представление уникального идентификатора константы.
- Тэг CONFIRMATIONS задает список подтвержденных констант. Содержит вложенные тэги ITEM. Тэг CONFIRMATIONS используется только при загрузке данных. Константы, заданные в этом тэге, далее не рассматриваются как измененные (или созданные) и не будут попадать в файл выгрузки в дальнейшем. Атрибутов в тэге не предусмотрено.
- Тэг ITEM задает подтвержденную константу. Атрибуты тэга ITEM:
- GUID – строковое представление уникального идентификатора константы.
Пример
<?xml version="1.0" encoding="utf-16"?>
<DATA>
<CONSTANTS>
...
</CONSTANTS>
</DATA>Справочники
Справочники предназначены для хранения различной информации.
Справочники описываются в файле обмена данными при помощи тэга «catalogs» и вложенных в него тэгов.
Тэг «catalogs» задает справочники.
Тэг «catalog» описывает справочник. Содержит вложенные тэги: extra, companies, pointsOfSale, contractors, pointsOfSaleContractorsRelations, warehouse, priceType, paymentType, products, productsGroupsRelations, groups, stockBalances, prices, units, unitClassifier, agreements, contracts.
Список справочников
| Название справочника | Описание |
|---|---|
| Организации | Справочник «Организации» предназначен для хранения информации об организациях, от имени которых оформляются документы. |
| Торговые точки | Справочник «Торговые точки» предназначен для хранения информации о торговых точках. |
| Контрагенты | Справочник «Контрагенты» предназначен для хранения информации о контрагентах, а также о группах контрагентов при иерархической группировке справочника. |
| Связи контрагентов с торговыми точками | Справочник «Связи контрагентов с торговыми точками» предназначен для хранения информации о закреплении контрагентов за торговыми точками. |
| Склады | Справочник «Склады» предназначен для хранения списка складов, на которых располагаются товары. |
| Типы цен | Справочник «Типы цен» предназначен для хранения списка типов цен. |
| Способы оплаты | Справочник «Способы оплаты» предназначен для хранения способов оплаты товаров. |
| Номенклатура | Справочник «Номенклатура» предназначен для хранения информации о товарах и услугах, а также о группах номенклатуры при группировке товаров по иерархии или по категориям. |
| Группы товаров | Справочник «Группы товаров» предназначен для хранения информации о товарных группах. |
| Связи номенклатурных групп | Справочник «Связи номенклатурных групп» предназначен для хранения информации о закреплении единицы номенклатуры за товарной группой. |
| Остатки | Справочник «Остатки» предназначен для хранения информации об остатках товара на складе. |
| Цены | Справочник «Цены» предназначен для хранения значений цены товара при различных типах цен. |
| Единицы измерения | Справочник «Единицы измерения» предназначен для хранения информации обо всех единицах измерения номенклатурных позиций. |
| Классификатор единиц измерения | Справочник «Классификатор единиц измерения» предназначен для хранения информации обо всех имеющихся в ЦБД единицах измерения. |
| Соглашения | Справочник «Соглашения» предназначен для хранения информации о товарных соглашениях. |
| Договоры | Справочник «Договоры» предназначен для хранения информации о договорах, заключенных с контрагентами. |
| Штрих-коды | Справочник «Штрих-коды» предназначен для хранения штрих-кодов для товаров, по которым производится поиск товаров при сканировании. |
| Дополнительный | Справочник «Дополнительный» предназначен для хранения настроек обмена. |
| Пункты разгрузки | Справочник «Пункты разгрузки» предназначен для хранения информации о пунктах разгрузки. |
| Связи контрагентов с пунктами разгрузки | Справочник «Связи контрагентов с пунктами разгрузки» предназначен для хранения информации о связях контрагентов с пунктами разгрузки. |
| Долги | Справочник «Долги» предназначен для учета взаиморасчетов с контрагентами и хранения информации о задолженностях контрагентов. |
| Сегменты клиентов | Справочник «Сегменты клиентов» предназначен для хранения информации о различных сегментах клиентов, в том числе по которым запрещена отгрузка товаров клиентам, нарушившим условия договора. |
| План продаж | Справочник «План продаж» предназначен для хранения информации о планируемых продажах за определенный период. |
| Банковские счета | Справочник «Банковские счета» предназначен для хранения информации о банковских счетах и реквизитах. |
Список документов
| Название справочника | Описание |
|---|---|
| Заказ | Документ «Заказ» предназначен для оформления выбранных товаров. |
| Мерчендайзинг | Документ «Мерчендайзинг» предназначен для сбора информации о представленном ассортименте товаров в торговых точках. |
| ПКО | Документ «ПКО» (Приходный кассовый ордер) предназначен для оформления факта получения денежных средств от контрагентов. |
Организации
Справочник «Организации» предназначен для хранения информации об организациях, от имени которых оформляются документы.
Название справочника — companies.
Список атрибутов справочника «Организации»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| useVAT | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС (по умолчанию); true – учитывать НДС. Признак регулирует использование НДС, если в ЦБД отключено использование договоров. |
| phones | Массив | Телефоны организации. Необязателен |
| emails | Массив | Адреса электронной почты. Необязателен |
| name | Строка | Наименование организации. |
| addressJur | Строка | Юридический адрес организации. Необязателен |
| inn | Строка | Индивидуальный номер налогоплательщика (ИНН). |
| kpp | Строка | Код причины постановки на учет в Государственной налоговой инспекции (КПП). |
| ogrn | Строка | Основной государственный регистрационный номер записи о создании юридического лица (ОГРН). |
| addressFact | Строка | Фактический адрес организации. Необязателен |
| prefix | Строка | Префикс организации, который указывается перед номером документа. Необязателен |
Торговые точки
Справочник «Торговые точки» предназначен для хранения информации о торговых точках.
Название справочника — pointsOfSale.
Список атрибутов справочника «Торговые точки»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование торговой точки. |
| address | Строка | Адрес торговой точки. |
| delivAddress | Строка | Адрес доставки. |
| phones | Массив | Номера телефонов. Необязателен |
| emails | Массив | Адреса электронной почты. Необязателен |
| latitude | Строка | Географическая широта местоположения торговой точки в формате координат NMEA. Атрибут необходим для отображения торговой точки на карте. Необязателен |
| longitude | Строка | Географическая долгота местоположения торговой точки в формате координат NMEA. Атрибут необходим для отображения торговой точки на карте. Необязателен |
| comment | Строка | Текстовый комментарий к торговой точке. |
| debt | Строка | Сумма общего долга торговой точки (в том числе и долги по документам в ЦБД). Необязателен |
| debtExpirationDate | Строка | Дата истечения срока платежа. |
| schedule | Строка | График работы. |
| defaultUnloadingPointId | id | Уникальный идентификатор пункта разгрузки по умолчанию. |
Контрагенты
Справочник »Контрагенты» предназначен для хранения информации о контрагентах.
Название справочника — contractors.
Список атрибутов справочника «Контрагенты»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование контрагента. |
| inn | Строка | Индивидуальный номер налогоплательщика (ИНН). |
| kpp | Строка | Код причины постановки на учет в Государственной налоговой инспекции (КПП). |
| rceoCode | Строка | Код по ОКПО. Необязателен, используется в печатных формах. документов |
| comment | Строка | Текстовый комментарий о контрагенте. Необязателен |
| paymentAccount | Строка | Номер Расчётный счет контрагента. Необязателен, используется в печатных формах документов. |
| factAddress | Строка | Фактический адрес контрагента. Необязателен |
| jurAddress | Строка | Юридический адрес организации. Необязателен |
| phones | Массив | Номера телефонов. Необязателен |
| emails | Массив | Адреса электронной почты. Необязателен |
| defaultUnloadingPointId | id | Уникальный идентификатор пункта разгрузки по умолчанию. |
Связи контрагентов с торговыми точками
«Связи контрагентов с торговыми точками» предназначен для хранения информации о соответствии контрагентов и торговых точек.
Название справочника — pointsOfSaleContractorsRelations.
Список атрибутов справочника «Связи контрагентов с торговыми точками»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| contractorId | id | Уникальный идентификатор контрагента. |
| pointOfSaleId | id | Уникальный идентификатор торговой точки. |
Склады
Справочник «Склады» предназначен для хранения списка складов, на которых располагаются товары.
Название справочника — warehouse.
Список атрибутов справочника «Склады»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование склада. |
Типы цен
Справочник «Типы цен» предназначен для хранения списка типов цен.
Название справочника — priceType.
Список атрибутов справочника «Типы цен»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование типа цены. |
| includesVAT | Булево | Признак учета НДС. Возможные значения: false – цена не включает НДС (по умолчанию); true – цена включает НДС. |
Способы оплаты
Справочник «Способы оплаты» предназначен для хранения способов оплаты товаров.
Название справочника — paymentType.
Список атрибутов справочника «Способы оплаты»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование способа оплаты. |
Номенклатура
Справочник «Номенклатура» предназначен для хранения информации о товарах и услугах, а также о группах номенклатуры при группировке товаров по иерархии или по категориям.
Название справочника — products.
Список атрибутов справочника «Номенклатура»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование товара. |
| comment | Строка | Текстовый комментарий о номенклатуре. Необязателен |
| vatRate | Строка | Ставка НДС в процентах, применяемая для товаров. Используется в случае если для организации, выбранной в документ, включено использование НДС. |
| unitClassifierId | id | Уникальный идентификатор базовой единицы измерения. |
| mageId | id | Уникальный идентификатор основного изображения товара. Необязателен |
| isImage | Булево | Признак наличия изображения. |
| article | Строка | Артикул. |
Группы товаров
Справочник «Группы товаров» предназначен для хранения информации о товарных группах.
Название справочника — groups.
Список атрибутов справочника «Группы товаров»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование группы товаров. |
| parentId | id | Уникальный идентификатор. |
Связи номенклатурных групп
Справочник «Связи номенклатурных групп» предназначен для хранения информации о закреплении единицы номенклатуры за товарной группой.
Название справочника — productsGroupsRelations.
Список атрибутов справочника «Связи номенклатурных групп»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара. |
| groupId | id | Уникальный идентификатор группы товара. |
Остатки
Справочник «Остатки» предназначен для хранения информации об остатках товара на складе.
Название справочника — stockBalances.
Список атрибутов справочника «Остатки»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| warehouseId | id | Уникальный идентификатор склада. |
| productId | id | Уникальный идентификатор товара. |
| balance | Строка | Остаток товара на складе. |
Цены
Справочник «Цены» предназначен для хранения значений цены товара при различных типах цен.
Название справочника — prices.
Список атрибутов справочника «Цены»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| priceTypeId | id | Уникальный идентификатор типа цены. |
| productId | id | Уникальный идентификатор товара. |
| unitId | id | Уникальный идентификатор упаковки. |
| value | Строка | Значение цены. |
Единицы измерения
Справочник «единицы измерения» предназначен для хранения информации о всех единицах измерения номенклатурных позиций.
Название справочника — units.
Список атрибутов справочника «Единицы измерения»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование группы товаров. |
| classifierId | id | Уникальный идентификатор классификатора единиц измерения. |
| productId | id | Уникальный идентификатор товара. |
| coefficient | Строка | Коэффициент упаковки. |
| grossWeight | Строка | Вес товара. |
Классификатор упаковок
Справочник «Классификатор единиц измерения» предназначен для хранения информации о всех имеющихся в ЦБД единицах измерения.
Название справочника — unitClassifier.
Список атрибутов справочника «Классификатор единиц измерения»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование единицы измерения. |
| code | Строка | Код классификатора единиц измерения. |
Соглашения
Справочник «Соглашения» предназначен для хранения информации о товарных соглашениях.
Название справочника — agreements.
Список атрибутов справочника «Соглашения»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование соглашения. |
| ourCompanyId | id | Уникальный идентификатор организации. |
| contractorId | id | Уникальный идентификатор контрагента. |
| pointOfSaleId | id | Уникальный идентификатор торговой точки. Необязателен. |
| priceTypeId | pointOfSaleId | Уникальный идентификатор типа цены. |
| warehouseId | pointOfSaleId | Уникальный идентификатор склада. Необязателен. |
| seContract | pointOfSaleId | Уникальный идентификатор договора. |
Договоры
Справочник «Договоры» предназначен для хранения информации о договорах, заключенных с контрагентами.
Название справочника — contracts.
Список атрибутов справочника «Договоры»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование договора. |
| ourCompanyId | id | Уникальный идентификатор организации. |
| contractorId | id | Уникальный идентификатор контрагента. |
| pointOfSaleId | id | Уникальный идентификатор торговой точки. |
| defaultUnloadingPointId | id | Уникальный идентификатор пункта разгрузки по умолчанию. |
Штрихкоды
Справочник «Штрих-коды» предназначен для хранения штрих-кодов для товаров, по которым производится поиск товаров при сканировании.
Название справочника — barcodes.
Список атрибутов справочника «Штрих-коды»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара. |
| code | Строка | Значение штрих-кода. |
| type | Строка | Тип штрих-кода. |
Дополнительный
Справочник «Дополнительный» предназначен для хранения настроек обмена.
Название справочника — extra.
Список атрибутов справочника «Дополнительный»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| useAgreement | Булево | Использовать соглашения. |
| useContract | Булево | Использовать договоры. |
| useUnloadingPoints | Булево | Использовать пункты разгрузки. |
| ourCompanyId | id | Основная организация. |
| warehouseId | id | Основной склад. |
| priceTypeId | id | Основной вид цены. |
Пункты разгрузки
Справочник «Пункты разгрузки» предназначен для хранения информации о пунктах разгрузки.
Название справочника — unloadingPoints.
Список атрибутов справочника «Пункты разгрузки»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор справочника. |
| name | Строка | Наименование пункта разгрузки. |
| address | Строка | Адрес пункта разгрузки. |
| kpp | Строка | КПП. |
| license | Строка | Лицензия. |
Связи контрагентов с пунктами разгрузки
Справочник «Связи контрагентов с пунктами разгрузки» предназначен для хранения информации о связях контрагентов с пунктами разгрузки.
Название справочника — unloadingPointsRelations.
Список атрибутов справочника «Связи контрагентов с пунктами разгрузки»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| contractorId | id | Уникальный идентификатор контрагента. |
| unloadingPointId | id | Уникальный идентификатор пункта разгрузки. |
| defaultUnloadingPointId | id | Уникальный идентификатор пункта разгрузки по умолчанию. |
Долги
Справочник «Долги» предназначен для учета взаиморасчетов с контрагентами и хранения информации о задолженностях контрагентов.
Название справочника — debts.
Список атрибутов справочника «Долги»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ, на основании которого возник долг. Значение указывается из справочника «Организации». |
| contractorId | id | Идентификатор контрагента, для которого оформлен документ, на основании которого возник долг. Т.е. контрагент, который имеет задолженность. Значение указывается из справочника «Контрагенты». |
| pointOfSaleId | id | Идентификатор торговой точки, для которой оформлен документ, на основании которого возник долг. Значение указывается из справочника «Торговые точки». |
| contractId | id | Идентификатор договора. Значение указывается из справочника «Договоры». |
Табличная часть справочника «Долги» - items
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| date | Число | Дата/время создания документа, на основании которого возник долг, в формате UTC. Не указывается, если документ, на основании которого возник долг, является договором. |
| synonym | Строка | Наименование документа, на основании которого возник долг. |
| number | Строка | Номер документа, на основании которого возник долг. |
| type | Строка | Тип документа, на основании которого возник долг. В настоящий момент используются три типа: order - документ «Заказ», sales - документ «Реализация», contract - документ «Договор». Для других документов возможно значение null. |
| id | id | Идентификатор документа, на основании которого возник долг. |
| debtPaymentAmount | Строка | Сумма долга по указанному документу. |
| debtExpirationDate | Число | Дата/время истечения оплаты долга, в формате UTC. |
Сегменты клиентов
Справочник «Сегменты клиентов» предназначен для хранения информации о различных сегментах клиентов, в том числе по которым запрещена отгрузка товаров клиентам, нарушившим условия договора.
Название справочника — segments.
Список атрибутов справочника «Сегменты клиентов»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | Строка | Идентификатор сегмента. |
| name | Строка | Не используется. |
| description | Строка | Не используется. |
| isLocked | Булево | Значение true - отгрузка запрещена. Значение false - отгрузка разрешена. |
Таблица отношений клиентов и сегментов
Название таблицы — segmentsPointsOfSaleRelations.
Список атрибутов таблицы отношений клиентов и сегментов
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| pointOfSaleId | Строка | Идентификатор клиента (торговой точки). |
| segmentId | Строка | Идентификатор сегмента. |
План продаж
Справочник «План продаж» предназначен для хранения информации о планируемых продажах за определенный период.
Название справочника — planOfSale.
Список атрибутов справочника «План продаж»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| planName | Строка | Наименование плана. |
| planNumber | Строка | Номер плана. |
| dateFrom | Число | Начало периода плана. |
| dateTo | Число | Конец периода плана. |
| pointOfSaleId | Число | Идентификатор торговой точки. |
Табличная часть справочника «План продаж» — items.
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | Строка | Идентификатор номенклатуры, если план по номенклатуре. |
| productCategoryId | Строка | Идентификатор категории, если план по категориям. |
| amount | Строка | Запланированная сумма в валюте учета, на которую нужно продать. |
| quantity | Строка | Запланированное количество к продаже. |
Банковские счета
Справочник «Банковские счета» предназначен для хранения информации о банковских счетах и реквизитах.
Название справочника — bankAccounts
Список атрибутов справочника «Банковские счета»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | Строка | Идентификатор элемента банковского счета. |
| ourCompanyId | Строка | Идентификатор организации. |
| requisites | Строка | Набор реквизитов банковского счета. |
| accountNumber | Строка | Номер расчетного счета. |
| bankName | Строка | Наименование банка. |
| corrAccount | Строка | Номер корреспондентского счета. |
| BIC | Строка | БИК банка. |
Документы
Документы являются электронными аналогами бумажных документов.
Заказ
Название тэга — order.
Основные реквизиты документа «Заказ»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| officeStatus | Строка | Статус документа, например, сохранён, проведён, удалён. |
| documentNumber | Число | Номер документа. В учетной системе номер документа может измениться. |
| pointOfSaleId | id | Уникальный идентификатор торговой точки, для которой оформлен заказ. Значение указывается из справочника «Торговые точки». |
| warehouseId | id | Уникальный идентификатор склада. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| agreementId | id | Уникальный идентификатор основного договора по контрагенту. Значение указывается из справочника «Договоры». |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| deliveryMethodId | id | Уникальный идентификатор способа доставки. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| priceTypeId | id | Уникальный идентификатор типа цены для товара. Значение указывается из справочника «Типы цен». |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| comment | Строка | Комментарий. |
| editable | Число | Признак редактируемости документа. После получения подтверждения от учётной системы, документ нельзя редактировать. |
| total | Число | Общая сумма документа. |
| created | Число | Дата создания документа в МУ в формате UTC. |
| delivery | Число | Дата/время доставки товара в формате UTC. |
| updated | Число | Дата/время последнего изменения документа в МУ в формате UTC. |
| registrationStatus | Строка | Статус документа. |
Табличная часть документа «Заказ» — cartItems
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| quantity | Число | Количество товара. |
| price | Число | Цена товара. |
| sum | Число | Сумма товара без скидки. |
| unitId | id | Уникальный идентификатор единицы измерения. |
| coefficient | Число | Коэффициент. |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| priceIncludeVat | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС; true – учитывать НДС. |
Реализация
Название тэга — sale.
Основные реквизиты документа «Реализация»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки из соответствующего справочника в учетной системе. |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус документа. |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата/время создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа В МУ в формате UTC. |
| comment | Строка | Комментарий. |
Табличная часть документа «Реализация» — cartItems
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| quantity | Число | Количество товара. |
| price | Число | Цена товара. |
| sum | Число | Сумма товара без скидки. |
| manualPrice | Булево | Признак указания цены вручную. |
| unitId | id | Уникальный идентификатор единицы измерения. |
| coefficient | Число | Коэффициент. |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| priceIncludeVat | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС; true – учитывать НДС. |
| article | Строка | Артикул. |
| markingType | Строка | Тип маркировки товара. |
| scannedMarks | Табличная часть | Маркировка. |
| warehouseId | id | Уникальный идентификатор склада. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| agreementId | id | Уникальный идентификатор соглашения. Значение указывается из справочника «Соглашения». |
| contractId | id | Уникальный идентификатор договора. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
| deliveryMethodId | id | Уникальный идентификатор способа доставки. |
| delivery | Число | Дата/время доставки товара в формате UTC. |
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. (Например: «Заказ» - order) |
Табличная часть «Маркировка» документа «Реализация»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| code1C | Строка | Марка, выгруженная в формате для 1С. |
| fullCode | Строка | Полный код маркировки. |
Мерчендайзинг
Название тэга — merchandising.
Основные реквизиты документа «Мерчендайзинг»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| pointOfSaleId | id | Уникальный идентификатор торговой точки из соответствующего справочника в учетной системе. |
| created | Число | Дата/время создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа В МУ в формате UTC. |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус получения документа в учётной системе. Статус предотвращает повторную выгрузку документа «Мерчендайзинг» из МУ. |
| timeInMinutes | Число | Время работы с документом «Мерчендайзинг». |
| orderId | id | Уникальный идентификатор документа основания («Заказ»). |
Табличная часть документа «Мерчендайзинг» — remains
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| taskGroupId | id | Уникальный идентификатор справочника «Полочное пространство». |
| actPrice | Число | Цена, по которой реализуется товар в торговой точке. |
| chosenPriceTipe | Строка | Уникальный идентификатор цены из справочника «Виды цен для мерчендайзинга» |
| productsInDelivery | Число | Количество товарной позиции, которая находится в пути. |
| productsInOrder | Число | Количество товаров в документе «Заказ». |
| facesProducts | Число | Количество фейсов. |
| facesCategory | Число | Доля полки, закрепленная за товаром в торговой точке. |
| sheLfLife | Число | Срок годности товара в торговой точке. |
| remainsAct | Число | Остаток товара в торговой точке. |
| remainsVirt | Число | Виртуальный остаток товара в торговой точке. |
ПКО
Название тэга — cashIn.
Основные реквизиты документа «ПКО»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки, для которой оформлен ПКО. Значение указывается из справочника «Торговые точки». |
| registrationStatus | Строка | Статус документа. |
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. (Например: «Заказ» - order) |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа в МУ в формате UTC. |
| comment | Строка | Комментарий. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
| contractId | id | Уникальный идентификатор договора. |
| syncStatus | Строка | Статус отправки документа на сервер. |
РКО
Название тэга — cashOut.
Основные реквизиты документа «РКО»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки, для которой оформлен РКО. Значение указывается из справочника «Торговые точки». |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус документа. |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа в МУ в формате UTC. |
| comment | Строка | Комментарий. |
| contractId | id | Уникальный идентификатор договора. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
Табличная часть «Документы-основания» — relations
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. |
Возврат
Название тэга — return.
Основные реквизиты документа «Возврат»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки из соответствующего справочника в учетной системе. |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус документа. |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата/время создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа В МУ в формате UTC. |
| comment | Строка | Комментарий. |
Табличная часть документа «Возврат» — cartItems
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| quantity | Число | Количество товара. |
| price | Число | Цена товара. |
| sum | Число | Сумма товара без скидки. |
| manualPrice | Булево | Признак указания цены вручную. |
| unitId | id | Уникальный идентификатор единицы измерения. |
| coefficient | Число | Коэффициент. |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| priceIncludeVat | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС; true – учитывать НДС. |
| article | Строка | Артикул. |
| markingType | Строка | Тип маркировки товара. |
| scannedMarks | Табличная часть | Маркировка. |
| warehouseId | id | Уникальный идентификатор склада. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| agreementId | id | Уникальный идентификатор соглашения. Значение указывается из справочника «Соглашения». |
| contractId | id | Уникальный идентификатор договора. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. (Например: «Реализация» - sale) |
Табличная часть «Маркировка» документа «Возврат»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| code1C | Строка | Марка, выгруженная в формате для 1С. |
| fullCode | Строка | Полный код маркировки. |
Заявка на возврат
Название тэга — returnRequest.
Основные реквизиты документа «Заявка на возврат»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки из соответствующего справочника в учетной системе. |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус документа. |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата/время создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа В МУ в формате UTC. |
| comment | Строка | Комментарий. |
Табличная часть документа «Заявка на возврат» — cartItems
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| quantity | Число | Количество товара. |
| price | Число | Цена товара. |
| sum | Число | Сумма товара без скидки. |
| manualPrice | Булево | Признак указания цены вручную. |
| unitId | id | Уникальный идентификатор единицы измерения. |
| coefficient | Число | Коэффициент. |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| priceIncludeVat | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС; true – учитывать НДС. |
| article | Строка | Артикул. |
| markingType | Строка | Тип маркировки товара. |
| scannedMarks | Табличная часть | Маркировка. |
| warehouseId | id | Уникальный идентификатор склада. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| agreementId | id | Уникальный идентификатор соглашения. Значение указывается из справочника «Соглашения». |
| contractId | id | Уникальный идентификатор договора. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. (Например: «Реализация» - sale) |
| desiredAdmissionDate | Число | Желаемая дата поступления. |
Табличная часть «Маркировка» документа «Заявка на возврат»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| code1C | Строка | Марка, выгруженная в формате для 1С. |
| fullCode | Строка | Полный код маркировки. |
Поступление
Название тэга — arrival.
Основные реквизиты документа «Поступление»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| id | id | Уникальный идентификатор документа. |
| ourCompanyId | id | Уникальный идентификатор организации, от имени которой оформляется документ. Значение указывается из справочника «Организации». |
| pointOfSaleId | id | Уникальный идентификатор торговой точки из соответствующего справочника в учетной системе. |
| syncStatus | Строка | Статус отправки документа на сервер. |
| registrationStatus | Строка | Статус документа. |
| contractorId | id | Уникальный идентификатор контрагента. Значение указывается из справочника «Контрагенты». |
| created | Число | Дата/время создания документа в МУ в формате UTC. |
| updated | Число | Дата/время последнего изменения документа В МУ в формате UTC. |
| comment | Строка | Комментарий. |
Табличная часть документа «Поступление» — cartItems
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| productId | id | Уникальный идентификатор товара из справочника «Номенклатура». |
| quantity | Число | Количество товара. |
| price | Число | Цена товара. |
| sum | Число | Сумма товара без скидки. |
| manualPrice | Булево | Признак указания цены вручную. |
| unitId | id | Уникальный идентификатор единицы измерения. |
| coefficient | Число | Коэффициент. |
| priceChangeValue | Число | Значение скидки по заказу. Необязателен |
| priceChangeMode | id | Уникальный идентификатор вида скидки для товара. Значение указывается из перечисления «Виды цен и скидок». Данный реквизит используется для внутренних расчетов в приложении, из ЦБД передавать его необязательно. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| priceIncludeVat | Булево | Признак учета НДС. Возможные значения: false – не учитывать НДС; true – учитывать НДС. |
| article | Строка | Артикул. |
| markingType | Строка | Тип маркировки товара. |
| scannedMarks | Табличная часть | Маркировка. |
| warehouseId | id | Уникальный идентификатор склада. |
| priceTypeId | id | Уникальный идентификатор типа цены. |
| agreementId | id | Уникальный идентификатор соглашения. Значение указывается из справочника «Соглашения». |
| contractId | id | Уникальный идентификатор договора. |
| paymentTypeId | id | Уникальный идентификатор способа оплаты. |
| total | Число | Общая сумма документа. |
| relatedDocumentId | id | Уникальный идентификатор документа-основания. |
| relatedDocumentType | Строка | Тип документа-основания в строковом представлении. (Например: «Реализация» - sale) |
Табличная часть «Маркировка» документа «Поступление»
| Атрибут/Имя | Тип – длина | Описание |
|---|---|---|
| code1C | Строка | Марка, выгруженная в формате для 1С. |
| fullCode | Строка | Полный код маркировки. |