Общие функции работы с документом "Бонус"
Methods
- api.tmaꓸdoc.create(outletId, distributorId, mechanicsId) → Result
- api.tmaꓸdoc.del(docId) → Result
- api.tmaꓸdoc.edit(docId) → Result
- api.tmaꓸdoc.header(docId) → Result
- api.tmaꓸdoc.lastDocId(outletId, distributorId, mechanicsId) → Result
- api.tmaꓸdoc.rowList(docId) → Result
- api.tmaꓸdoc.validate(docId) → Result
Methods description
-
create(outletId, distributorId, mechanicsId) → Result
-
Создать новый документ "Бонус"
Parameters:
Name Type Description outletId ID Идентификатор ТТ
distributorId ID Идентификатор дистрибьютора
mechanicsId ID Идентификатор механики
Return:
Result -Результат выполнения операции.
В поле value - идентификатор созданного документа "Бонус" (type ID) -
del(docId) → Result
-
Удалить документ "Бонус"
Parameters:
Name Type Description docId ID Идентификатор существующего документа "Бонус"
Return:
Throws:
В случае невалидного идентификатора docId вернётся ошибка
-
edit(docId) → Result
-
Отредактировать документ "Бонус"
Parameters:
Name Type Description docId ID Идентификатор существующего документа "Бонус"
Return:
Result -Результат выполнения операции.
В поле value - Идентификатор текущего документа "Бонус", если документ является черновиком,
или идентификатор новой версии текущего документа (type ID)Throws:
В случае невалидного идентификатора docId вернётся ошибка
-
header(docId) → Result
-
Получить заголовочную часть документа "Бонус"
Parameters:
Name Type Description docId ID Идентификатор существующего документа "Бонус"
Return:
Result -Результат выполнения операции.
В поле value - заголовочная часть документа "Бонус" (type DocumentHeader)Throws:
В случае невалидного идентификатора docId вернётся ошибка
-
lastDocId(outletId, distributorId, mechanicsId) → Result
-
Получить идентификатор последнего созданного в ТТ документа "Бонус"
Parameters:
Name Type Description outletId ID Идентификатор ТТ
distributorId ID Идентификатор дистрибьютора
mechanicsId ID Идентификатор механики
Return:
Result -Результат выполнения операции.
В поле value - идентификатор последнего документа доступного для редактирования,
либо черновик, либо валидный документ (type ID) -
rowList(docId) → Result
-
Получить строчную часть документа "Бонус"
Parameters:
Name Type Description docId ID Идентификатор существующего документа "Бонус"
Return:
Result -Результат выполнения операции.
В поле value - Строчная часть документа "Бонус" (type DocumentRow)Throws:
В случае невалидного идентификатора docId вернётся ошибка
-
validate(docId) → Result
-
Валидировать документ "Бонус"
Parameters:
Name Type Description docId ID Идентификатор существующего документа "Бонус"
Return:
Throws:
В случае невалидного идентификатора docId вернётся ошибка