api.document

Подробное описание

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

api.document

Открытые члены
	create (type, outletId, distributorId)
	Создать черновик документа. Если черновик уже существует, то вернется существующий. Подробнее...
	createCopy (docId)
	Создание копии документа в новом черновике. Возвращаемое значение - это шапка документа с полями уникальными для каждого типа документа. Подробнее...
	defaultData (type, outletId, distributorId)
	Сформировать документ, заполненный по умолчанию. Подробнее...
	defaultRow (type)
	Возвращает заполненную по умолчанию строчную часть для документа определенного типа Подробнее...
	documentIdList (type, outletId, dateOrPeriod, status)
	Получить идентификаторы документов Подробнее...
	draftId (type, outletId, distributorId)
	Возвращает идентификатор черновика документа Подробнее...
	info (docId)
	Получить информацию о документе Подробнее...
	isNotSent ()
	Получить признак наличия неотправленных документов Подробнее...
	isSent (docId)
	Получить признак того, что документ был отправлен в УС Подробнее...
	lastValidatedId (type, outletId, distributorId, routeId)
	ID последнего валидного документа Подробнее...
	previousId (docId)
	ID предыдущей версии документа Подробнее...
	previousIdList (docIdList)
	Список ID предыдущих версий документов переданных на вход Подробнее...
	printNumber (printFormName, idDoc, firmFieldName, numFieldName)
	Функция, возвращающая печатный номер документа Подробнее...
	storno (docId, check)
	Пометить документ на удаление Подробнее...
	submit (document)
	Сохранение шапки документа Подробнее...
	submitRow (docId, row)
	Сохранение строки в документа Подробнее...
	validatedIdList (condition)
	Получить список идентификаторов валидированных документах Подробнее...
	validateDoc (idDoc)
	Валидация документа Подробнее...

Методы

create (type, outletId, distributorId)

create	(	type	,
		outletId	,
		distributorId
	)

Создать черновик документа. Если черновик уже существует, то вернется существующий.

Аргументы

type	[DocType] - Тип документа
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

Document - Документ с полями уникальными для каждого типа документа

createCopy (docId)

createCopy

(

docId

)

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

Уст.:

(2020-05-08) Метод не реализован

Аргументы

docId

[ID] - Идентификатор документа

defaultData (type, outletId, distributorId)

defaultData	(	type	,
		outletId	,
		distributorId
	)

Сформировать документ, заполненный по умолчанию.

Заметки

Без сохранения

Аргументы

type	[DocType] - Тип документа
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

Document - Документ с полями уникальными для каждого типа документа

defaultRow (type)

struct DocumentRow * defaultRow

(

type

)

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

Аргументы

type	[DocType] - Тип документа

Возвращает

DocumentRow

documentIdList (type, outletId, dateOrPeriod, status)

struct DocStatus * documentIdList	(	type	,
		outletId	,
		dateOrPeriod	,
		status
	)

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

Аргументы

type	[DocType] - Тип документа
outletId	[ID] - Идентификатор ТТ
dateOrPeriod	[Date or Period] optional - Дата или период, если не задано то текущая дата
status	[DocStatus] optional - Статус документа. По умолчанию StatusUnknown

Возвращает

IDList

draftId (type, outletId, distributorId)

draftId	(	type	,
		outletId	,
		distributorId
	)

Возвращает идентификатор черновика документа

Аргументы

type	[DocType] - Тип документа
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора

Возвращает

ID

info (docId)

* info

(

docId

)

Получить информацию о документе

Аргументы

docId

[ID] - Идентификатор документа

Возвращает

DocumentInfo

isNotSent ()

isNotSent

(

)

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

Возвращает

Boolean

isSent (docId)

isSent

(

docId

)

Получить признак того, что документ был отправлен в УС

Аргументы

docId

[ID] - Идентификатор документа

Возвращает

Boolean

lastValidatedId (type, outletId, distributorId, routeId)

lastValidatedId	(	type	,
		outletId	,
		distributorId	,
		routeId
	)

ID последнего валидного документа

Аргументы

type	[DocType] - Тип документа
outletId	[ID] - Идентификатор торговой точки
distributorId	[ID] - Идентификатор дистрибьютора
routeId	[ID] - Идентификатор маршрута

Возвращает

ID

previousId (docId)

previousId

(

docId

)

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

Аргументы

docId

[ID] - Идентификатор документа

Возвращает

ID

previousIdList (docIdList)

previousIdList

(

docIdList

)

Список ID предыдущих версий документов переданных на вход

Аргументы

docIdList

[IDList] - Список ID документов

Возвращает

IDList

printNumber (printFormName, idDoc, firmFieldName, numFieldName)

struct DocType * printNumber	(	printFormName	,
		idDoc	,
		firmFieldName	,
		numFieldName
	)

Функция, возвращающая печатный номер документа

Аргументы

printFormName	[String] - Наименование формы
idDoc	[ID] - Идентификатор документа
firmFieldName	[String] optional - Наименование поля фирмы. По умолчанию 'idFirm'
numFieldName	[String] optional - Наименование поля номера

Возвращает

String

storno (docId, check)

storno	(	docId	,
		check
	)

Пометить документ на удаление

Уст.:

(2020-05-08) Метод не реализован

Аргументы

docId	[ID] - идентификатор документа
check	[Boolean] - флаг, делать проверки перед сохранением, при этом могут быть заданы вопросы или показаны сообщения пользователю

Возвращает

Boolean

submit (document)

submit

(

document

)

Сохранение шапки документа

Аргументы

document

[Document] - Структура шапки документа для сохранения

Возвращает

Boolean - Результат сохранения документа

submitRow (docId, row)

submitRow	(	docId	,
		row
	)

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

Аргументы

docId	[ID] - Идентификатор документа
row	[DocumentRow] - Строка документа, уникальная для каждого документа

Возвращает

Boolean - Результат сохранения

validatedIdList (condition)

* validatedIdList

(

condition

)

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

Аргументы

condition

[DocumentCondition] - Условия для отбора документа. Статус документа принудительно будет заменен на валидный

Возвращает

IDList

validateDoc (idDoc)

validateDoc

(

idDoc

)

Валидация документа

Аргументы

idDoc

[ID] - Идентификатор документа

Возвращает

Boolean - Возвращает результат процедуры