Модуль: Docs

Модуль Dosc служит для задач, связанных с документами

Khorn - Модуль Docs

Methods

inner api.Docs.getCashOrderDocuments(saleDoc, distributorId) → Array.<subOperationDocument>
inner api.Docs.getReturnDocuments(saleDoc, distributorId) → Array.<subOperationDocument>
inner api.Docs.getSaleOperationDocuments(document, distributorId) → Array.<operationDocument>
inner api.Docs.getShortName(param) → String

Methods description

inner getCashOrderDocuments(saleDoc, distributorId) → Array.<subOperationDocument>

Вернуть массив документов-ПКО по документу отгрузки

Parameters:
Name Type Description
saleDoc saleDocument Документ отгрузки
distributorId String | Number Идентификатор дистрибьютора
Return:
Array.<subOperationDocument> - Массив строк в виде объектов
Since:
  • build 10
Author:
  • Пряхина Анастасия <a.priakhina@systtech.ru>

inner getReturnDocuments(saleDoc, distributorId) → Array.<subOperationDocument>

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

Parameters:
Name Type Description
saleDoc saleDocument Документ отгрузки
distributorId String | Number Идентификатор дистрибьютора
Return:
Array.<subOperationDocument> - Массив строк в виде объектов
Since:
  • build 10
Author:
  • Пряхина Анастасия <a.priakhina@systtech.ru>

inner getSaleOperationDocuments(document, distributorId) → Array.<operationDocument>

Вернуть массив документов-операций отгрузки

Parameters:
Name Type Description
document saleDocument Документ отгрузки
distributorId String | Number Идентификатор дистрибьютора
Return:
Array.<operationDocument> - Массив строк в виде объектов
Since:
  • build 10
Author:
  • Пряхина Анастасия <a.priakhina@systtech.ru>

inner getShortName(param) → String

Получить короткое наименование типа документа

Parameters:
Name Type Description
param String | Number Идентификатор или ключ документа
Return:
String - Короткое наименование
Since:
  • build 10
Author:
  • Пряхина Анастасия <a.priakhina@systtech.ru>

Type Definitions

operationDocument

Документ-операция относящаяся к отгрузке
Properties:
Name Type Description
amount Number Сумма по документу
totalAmount Number Долг по документу отгрузки
name String Название документа
date Date дата Совершения операции
currencyId String Индетификатор валюты
docId String Идентификатор документа отгрузки
debtDays Number Количество дней просчрочки
type String Тип документа
hasLink Boolean Признак наличия ссылки на документ

saleDocument

Неоплаченная отгрузка
Properties:
Name Type Description
buyerId String Идентификатор владельца
period Number Количество дней лимита
outletId String Идентификатор ТТ
docId String Идентификатор отгрузки
date Date Дата создания отгрузки
agreementId String Идентификатор договора, на который сделана отгрузка
amount Number Сумма долга по документу
name String Название документа
currencyId String Индетификатор валюты
operationId String Индетификатор операции
type String Тип документа

subOperationDocument

Документ-операция относящаяся к отгрузке
Properties:
Name Type Description
eNumber Number Номер документа
currencyId String Индетификатор валюты
amount Number Сумма по документу
name String Название документа
date Date Дата совершения операции
docId String Идентификатор документа отгрузки
debtDays Number Количество дней просрочки
type String Тип документа
hasLink Boolean Признак наличия ссылки на документ