Список версий МТ

Главная

api.data

Кэшируемые данные документа

Properties:
Name Type Description
additDocInfo Object Дополнительная информация о документе из БД.
Properties
Name Type Description
agreementId ID Идентификатор договора
currencyId ID Идентификатор валюты
currencySymbol String Символ валюты (документа или из глобального контекста)
deliveryDate Date Дата доставки
discountPromoRate Number Процент бонус-скидки (наценки)
discountRate Number Процент скидки (наценки)
firmId ID Идентификатор фирмы продавца
isRetail Boolean Признак оплаты в розницу
payTypeId ID Идентификатор типа оплаты
priceTypeId ID Идентификатор типа цены
storeId ID Идентификатор склада
storeReceiverId ID Идентификатор склада-получателя
storeSenderId ID Идентификатор склада-отправителя
_aggregation Object Информация об агрегированных колонках
aggregation function Функция агрегирования значений колонок документа
basicInfo Object Базовая информация о документе
Properties
Name Type Description
creationDate String Дата создания документа в формате dd.MM.yyyy
documentName String Короткое имя документа
isDraft Boolean Признак того, что документ является черновиком
printNumber String Печатный номер документа (PrintDocNum)
documentFullAmount Number Полная сумма документа
documentId ID Идентификатор текущего документа
documentInfo Object Информация о документе (api.document.info)
documentType "merch" | "movement" | "order" | "request" | "return" | "sale" Тип документа
documentVATAmount Number Сумма НДС всего документа
extraRowAttributes Object Дополнительные атрибуты строчной части
Properties
Name Type Description
meta Array.<String> Информация о дополнительных атрибутах (id, name)
values Object Значения дополнительных атрибутов. Ключами выступают идентификаторы строк, значениями - массивы значений в строке
fieldOrStub function Возвращает имя поля или заглушку, если в соответствующей таблице такого поля нет
flags Object Флаги состояния документа
Properties
Name Type Description
haveBaseDocuments Boolean Флаг наличия документов-оснований строчной части
haveDiscounts Boolean Флаг наличия скидок строчной части
haveGoodsWithWeight Boolean Флаг наличия товаров с ненулевым весом
haveOverdueGoods Boolean Флаг наличия просроченных товаров
havePromoDiscounts Boolean Флаг наличия промо-скидок строчной части
groupInfo function Информация о группе товаров документа
outletInfo Object Информация о торговой точке документа (api.outlets.outlet)
relatedDocs Array.<ID> Список идентификаторов документов, связанных с текущим
relatedSale Object | Null Связанный документ отгрузки. Ключами выступают идентификаторы товаров, значениями - объекты с полями "price" (цена) и "quantity" (отгруженное количество)
reset function Сброс данных документа
rows Array.<Row> Строки документа
rowsMatch function Сопоставление строк различных уровней
skuInfo function Вернуть информацию о товаре (api.skus.sku)
skuType "COD" | "CO" | "D" Тип товаров, отображаемых во вьювере. "CO" - документ в товарах Центрального офиса, "D" - документ в товарах дистрибьютора, "COD" - документ а товарах обоих типов (строки дистрибьютора отображаются вторым уровнем)

Methods

api.data.aggregation(groupIndex, mainRowIndex, columnIndex, rawValue, format) → AggregatedColumns
api.data.coInfo(groupIndex, mainRowId) → Number
api.data.fieldOrStub(fieldName) → String
api.data.groupInfo(groupId) → GroupInfo
api.data.reset()
api.data.skuInfo(idGoods) → SkuInfo

Methods description

aggregation(groupIndex, mainRowIndex, columnIndex, rawValue, format) → AggregatedColumns

Вернуть значения агрегированных колонок или обновить и сохранить их.

Parameters:
Name Type Description
groupIndex Number Индекс группы товаров
mainRowIndex Number Индекс основной строки в группе
columnIndex Number Индекс колонки
rawValue Number Агрегируемое значение
format function Указатель на функцию форматирования значения
Return:
AggregatedColumns - - Структура, содержая агрегированные значения для колонок документа. В случае, когда на вход подаются необходимые аргументы, происходит обновление структуры.

coInfo(groupIndex, mainRowId) → Number

Вернуть индекс строки верхнего уровня по индексу группы и по идентификатору строки

Parameters:
Name Type Description
groupIndex Number Индекс группы товаров
mainRowId ID Идентификатор строки
Return:
Number - Индекс строки в группе

fieldOrStub(fieldName) → String

Возвращает имя поля или заглушку, если в соответствующей таблице такого поля нет.

Parameters:
Name Type Description
fieldName String Имя поля, для которого необходимо вернуть соответствие
Return:
String - Имя поля или "NULL" в качестве заглушки
Example
[          ПОЛЕ          | Мерчандайзинг | Перемещение | Заказ | Заявка на дозагрузку | Возврат | Отгрузка ]
|         Amount         |       —       |      —      |   +   |          —           |    +    |    +     |
|     AmountWithoutCO    |       —       |      —      |   +   |          —           |    -    |    +     |
|      DeliveryDate      |       —       |      —      |   +   |          —           |    —    |    —     |
|     DiscountAmount     |       —       |      —      |   +   |          —           |    —    |    +     |
|     DiscountManual     |       —       |      —      |   +   |          —           |    —    |    —     |
|   DiscountPromoRate    |       —       |      —      |   +   |          —           |    —    |    —     |
|  docDiscountPromoRate  |       —       |      —      |   +   |          —           |    —    |    —     |
|    docDiscountRate     |       —       |      —      |   +   |          —           |    —    |    +     |
|      DiscountRate      |       —       |      —      |   +   |          —           |    —    |    +     |
|         Facing         |       +       |      —      |   —   |          —           |    —    |    —     |
|           id           |       +       |      +      |   +   |          +           |    +    |    +     |
|      idAgreement       |       —       |      —      |   +   |          —           |    +    |    +     |
|       idCurrency       |       —       |      —      |   +   |          —           |    +    |    +     |
|         idFirm         |       —       |      —      |   +   |          —           |    +    |    +     |
|        idGoods         |       +       |      +      |   +   |          +           |    +    |    +     |
|       idItemType       |       +       |      +      |   +   |          +           |    +    |    +     |
|  idMerchParticipation  |       +       |      —      |   —   |          —           |    —    |    —     |
|       idPayType        |       —       |      —      |   +   |          —           |    +    |    +     |
|      idPriceType       |       —       |      —      |   +   |          —           |    —    |    +     |
|        isRetail        |       —       |      —      |   +   |          —           |    —    |    +     |
|       idSaleDoc        |       —       |      —      |   —   |          —           |    +    |    —     |
|        idStore         |       —       |      —      |   +   |          +           |    +    |    +     |
|    idStoreReceiver     |       —       |      +      |   —   |          —           |    —    |    —     |
|     idStoreSender      |       —       |      +      |   —   |          —           |    —    |    —     |
|        Overdue         |       —       |      —      |   —   |          —           |    +    |    —     |
|         Price          |       +       |      —      |   +   |          —           |    +    |    +     |
|        Quantity        |       +       |      +      |   +   |          +           |    +    |    +     |
|       UnitFactor       |       —       |      +      |   +   |          +           |    +    |    +     |
|         idUnit         |       +       |      +      |   +   |          +           |    +    |    +     |
|       VATAmount        |       —       |      —      |   +   |          —           |    +    |    +     |
|     VATAmountFact      |       —       |      —      |   +   |          —           |    —    |    +     |
|        VATRate         |       —       |      —      |   +   |          —           |    —    |    +     |

Приставка "doc" говорит о том, что поле выбирается из заголовочной таблицы

groupInfo(groupId) → GroupInfo

Вернуть кэшируемую информацию о группе товаров по идентифкатору.

Parameters:
Name Type Description
groupId ID Идентификатор группы товаров
Return:
GroupInfo - Информация о группе товаров

reset()

Обнулить кэши для текущего документа.

skuInfo(idGoods) → SkuInfo

Вернуть кэшируемую информацию о товаре.

Parameters:
Name Type Description
idGoods ID Идентификатор товара
Return:
SkuInfo - Информация о товаре

Type Definitions

AggregatedColumns

Агрегированные значения колонок для товаров ЦО.
Properties:
Name Type Description
totals Object Агрегация итогов всего документа. Ключи - индексы колонок
groupValues Object Агрегация по группам. Ключи - индексы групп
Properties
Name Type Description
columnValues Object Значения агрегации по колонкам. Ключи - индексы колонок
totals Object Значения агрегации итогов группы. Ключи - индексы колонок

GroupInfo

Информация о группе товаров.
Properties:
Name Type Description
index Number Индекс группы в массиве строк
name String Наименование группы товаров

Row

Строка документа
Properties:
Name Type Description
amount Number Сумма
amountWithoutCO Number Сумма без учета ЦО
baseDocId ID Идентификатор документа-основания
discount Number Сумма скидки
discountPromoRate Number Процент бонус-скидки
discountRate Number Процент скидки
facing Number Фейсинг
itemTypeId ID Тип товара
manualDiscount Number Сумма ручной скидки
overdue Boolean Просрочка (true - непригодный, false - годный)
price Number Цена товара
quantity Number Количество
quantityType Number Тип количества для мерчандайзинга
rowId ID Идентификатор строки документа
skuId ID Идентификатор товара
unitFactor Number Коэффициент пересчета единицы измерения
unitId ID Идентификатор единицы измерения товара
VAT Number Ставка НДС
VATAmount Number Сумма НДС
VATAmountWithHeadDiscount Number Инкрементиреумая с каждой строкой сумма НДС с учетом скидки, указанной в шапке документа

rowsMatch

Информация о сопоставлении строк различных уровней. Ключами выступают индексы групп, ключами вложенных объектов выступают идентификаторы строк верхнего уровня. Значения по обоим ключам - индекс строки в группе.

SkuInfo

Информация о товаре, содержащая объект, возвращаемый api.skus.sku, и дополнительный метод unitTitles
Properties:
Name Type Description
unitTitles function Метод получения строкового представления единицы измерения товара