api.sales.doc

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

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

api.sales.doc

Открытые члены
	create (outletId)
	Создать новый документ "Отгрузка". Подробнее...
	dataTextView (docId, key)
	Получить текстовое представление документа "Отгрузка". Подробнее...
	del (docId)
	Удалить документ "Отгрузка". Подробнее...
	edit (docId)
	Редактировать документ "Отгрузка". Подробнее...
	editHeader (obj)
	Изменить заголовочную часть документа "Отгрузка". Подробнее...
	header (docId)
	Получить заголовочную часть документа "Отгрузка". Подробнее...
	putRow (docId, object)
	Добавить/отредактировать строку документа "Отгрузка". Подробнее...
	removeRows (docId, skuList)
	Удалить строки документа "Отгрузка". Подробнее...
	row (docId, skuId)
	Получить строку документа "Отгрузка". Подробнее...
	rows (docId)
	Получить строчную часть документа "Отгрузка". Подробнее...
	skuIdList (docId)
	Получить список идентификаторов товаров документа "Отгрузка". Подробнее...
	validate (docId)
	Валидировать документ "Отгрузка". Подробнее...

Методы

create (outletId)

create

(

outletId

)

Создать новый документ "Отгрузка".

Аргументы

outletId

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

Возвращает

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

dataTextView (docId, key)

dataTextView	(	docId	,
		key
	)

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

Аргументы

docId	[ID] - Идентификатор документа
key	[String] - Ключ шаблона (stmobile://printform/<doc>/<ключ>)

Возвращает

Result - Результат выполнения операции.
В поле value - Текстовое представление документа "Отгрузка" (String)

del (docId)

del

(

docId

)

Удалить документ "Отгрузка".

Аргументы

docId

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

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

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

Возвращает

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

edit (docId)

edit

(

docId

)

Редактировать документ "Отгрузка".

Аргументы

docId

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

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

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

Возвращает

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

editHeader (obj)

editHeader

(

obj

)

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

Аргументы

obj	[SalesDocHeader] - Объект заголовочной части для существующего документа "Отгрузка"

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

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

В случае неправильно сформированного объекта obj вернется ошибка сохранения данных

Возвращает

Result - Признак успешного сохранения заголовочной части документа "Отгрузка"

header (docId)

header

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

putRow (docId, object)

putRow	(	docId	,
		object
	)

Добавить/отредактировать строку документа "Отгрузка".

Аргументы

docId	[ID] - Идентификатор существующего документа "Отгрузка"
object	[SalesDocRow] - Объект строки документа "Отгрузка" для сохранения

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

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

В случае неправильно сформированного объекта object вернется ошибка сохранения данных

Возвращает

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

removeRows (docId, skuList)

removeRows	(	docId	,
		skuList
	)

Удалить строки документа "Отгрузка".

Аргументы

docId	[ID] - Идентификатор существующего документа "Отгрузка"
skuList	[ID] - Список идентификаторов товаров для удаления

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

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

Возвращает

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

row (docId, skuId)

row	(	docId	,
		skuId
	)

Получить строку документа "Отгрузка".

Аргументы

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

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

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

В случае невалидного идентификатора skuId вернется пустая строка

Возвращает

Result - Результат выполнения операции.
В поле value - Строка документа "Отгрузка" (SalesDocRow)

rows (docId)

rows

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

skuIdList (docId)

skuIdList

(

docId

)

Получить список идентификаторов товаров документа "Отгрузка".

Аргументы

docId

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

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

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

Возвращает

Result - Результат выполнения операции.
В поле value - Список всех идентификаторов товаров, для которых есть строки в документе "Отгрузка" (ID[])

validate (docId)

validate

(

docId

)

Валидировать документ "Отгрузка".

Аргументы

docId

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

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

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

Возвращает

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