api.tma.doc

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

Общие функции работы с документом "Бонус".

api.tma.doc

Открытые члены
	create (outletId, distributorId, mechanicsId)
	Создать новый документ "Бонус". Подробнее...
	del (docId)
	Удалить документ "Бонус". Подробнее...
	edit (docId)
	Отредактировать документ "Бонус". Подробнее...
	header (docId)
	Получить заголовочную часть документа "Бонус". Подробнее...
	lastDocId (outletId, distributorId, mechanicsId)
	Идентификатор последнего документа "Бонус" в ТТ Подробнее...
	rowList (docId)
	Получить строчную часть документа "Бонус". Подробнее...
	validate (docId)
	Валидировать документ "Бонус". Подробнее...

Методы

create (outletId, distributorId, mechanicsId)

create	(	outletId	,
		distributorId	,
		mechanicsId
	)

Создать новый документ "Бонус".

Аргументы

outletId	[ID] - Идентификатор ТТ
distributorId	[ID] - Идентификатор дистрибьютора
mechanicsId	[ID] - Идентификатор механики

Возвращает

Result - результат выполнения операции.
В поле value - Идентификатор созданного документа "Бонус" (ID)

del (docId)

del

(

docId

)

Удалить документ "Бонус".

Аргументы

docId

[ID] - Идентификатор существующего документа "Бонус"

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Признак успешного удаления документа "Бонус"

edit (docId)

edit

(

docId

)

Отредактировать документ "Бонус".

Аргументы

docId

[ID] - Идентификатор существующего документа "Бонус"

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - результат выполнения операции.
В поле value - Идентификатор текущего документа, если документ является черновиком, или идентификатор новой версии текущего документа (ID)

header (docId)

header

(

docId

)

Получить заголовочную часть документа "Бонус".

Аргументы

docId

[ID] - Идентификатор существующего документа "Бонус"

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - результат выполнения операции.
В поле value - Заголовочная часть документа "Бонус" (BonusDocHeader)

lastDocId (outletId, distributorId, mechanicsId)

lastDocId	(	outletId	,
		distributorId	,
		mechanicsId
	)

Идентификатор последнего документа "Бонус" в ТТ

Аргументы

outletId	[ID] - Идентификатор ТТ
distributorId	[ID] - Идентификатор дистрибьютора
mechanicsId	[ID] - Идентификатор механики

Возвращает

Result - результат выполнения операции.
В поле value - Последний документ, доступный для редактирования (ID)

rowList (docId)

rowList

(

docId

)

Получить строчную часть документа "Бонус".

Аргументы

docId

[ID] - Идентификатор существующего документа "Бонус"

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - результат выполнения операции.
В поле value - Строчная часть документа "Бонус" (BonusDocRow[])

validate (docId)

validate

(

docId

)

Валидировать документ "Бонус".

Аргументы

docId

[ID] - Идентификатор существующего документа "Бонус"

Предупреждения

В случае невалидного идентификатора docId вернется ошибка

Возвращает

Result - Признак успешного завершения валидации документа "Бонус"