api.movement.doc

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

Работа с документом Перемещение

api.movement.doc

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

Методы

create (distributorId)

create

(

distributorId

)

Создать новый документ Перемещение

Аргументы

distributorId

[ID] - Идентификатор дистрибьютора

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

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

Возвращает

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	[MovementDocHeader] - Новые параметры для существующей заголовочной части документа Перемещение

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

В случае отсутствия параметра id в объекте obj вернется ошибка

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

Возвращает

Result - Признак успешного сохранения заголовочной части документа Перемещение (если не успешно, то результат содержит текст ошибки)

header (docId)

* header

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

putRow (docId, obj)

putRow	(	docId	,
		obj
	)

Добавить/отредактировать строку документа Перемещение

Аргументы

docId	[ID] - Идентификатор существующего документа Перемещение
obj	[MovementDocRow] - Новая строка документа Перемещение или новые параметры существующей строки документа Перемещение

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

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

В случае отсутствия параметра skuId в объекте obj вернется ошибка

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

Возвращает

Result - Признак успешного сохранения строки документа Перемещение (если не успешно, то результат содержит текст ошибки)

removeRow (docId, skuId)

removeRow	(	docId	,
		skuId
	)

Удалить строку документа Перемещение

Аргументы

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

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

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

Возвращает

Result - Признак успешного удаления строки в документе Перемещение (если не успешно, то результат содержит текст ошибки)

removeRows (docId, skuIdList)

removeRows	(	docId	,
		skuIdList
	)

Удалить список строк документа Перемещение

Аргументы

docId	[ID] - Идентификатор существующего документа Перемещение
skuIdList	[IDList] - Список идентификаторов существующих товаров

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

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

Возвращает

Result - Признак успешного удаления строки в документе Перемещение (если не успешно, то результат содержит текст ошибки)

row (docId, skuId)

* row	(	docId	,
		skuId
	)

Получить строку документа Перемещение

Аргументы

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

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

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

Возвращает

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

rows (docId)

rows

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

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

skuIdList (docId)

skuIdList

(

docId

)

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

Аргументы

docId

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

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

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

Возвращает

Result - Результат выполнения операции.
В поле value - Список всех идентификаторов товаров, для которых есть строки в документе Перемещение (IDList)

validate (docId)

validate

(

docId

)

Валидировать документ Перемещение

Аргументы

docId

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

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

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

Возвращает

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