132 документа
← К списку

Приложение 12. Описание сущностей, предоставляемых через стандартный интерфейс OData

страница

Приложение 12. Описание сущностей, предоставляемых через стандартный интерфейс OData

Подробное описание представления данных см. здесь. При описании свойства описание представления дополнительно не приводится.

12.1. Константы

Имя сущности

Constant_<Имя>

Имя набора сущностей

Constant_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Value

Соответствует типу значения

Значение константы.

<Общие реквизиты>

Соответствует типу разделителя

Кроме общих реквизитов являющихся независимыми разделителями.

SurrogateKey

Edm.Int16

Суррогатный ключ в том случае, если отсутствуют разделители. Всегда равен 0.

Особенности поведения:

● Удаление не поддерживается (запрос DELETE);

● Создание поддерживается (запрос POST) с особенностями.

Если значение константы в информационной базе имеет значение Неопределено, то выполняется установка значения константы. Если значение константы в информационной базе имеет значение, отличное от Неопределено ‑ генерируется ошибка.

● Не поддерживается обращение «через точку».

12.2. Планы обмена

Имя сущности

ExchangePlan_<Имя>

Имя набора сущностей

ExchangePlan_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Code

Edm.String

Edm.Int32

Код.

Description

Edm.String

Наименование.

Ref

Ссылочный тип

Ссылка.

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

ReceivedNo

Edm.Int32

Номер последнего полученного сообщения.

SentNo

Edm.Int32

Номер последнего отправленного сообщения.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем ExchangePlan_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.2.1. Табличная часть плана обмена

Имя сущности

ExchangePlan_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

ExchangePlan_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.2.2. Строка табличной части

Имя составного типа: ExchangePlan_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части

<Реквизиты>

Соответствует типу реквизита

12.3. Справочники

Имя сущности

Catalog_<Имя>

Имя набора сущностей

Catalog_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Code

Edm.String,

Edm.Int32

При наличии у справочника кода.

Description

Edm.String

При наличии у справочника наименования.

IsFolder

Edm.Boolean

Для иерархического справочника.

Owner

Ссылочный или составной тип

Владелец для подчиненного справочника.

Parent

Ссылочный тип

Родитель для иерархического справочника.

Version

Edm.String

Версия данных.

Predefined

Edm.Boolean

Признак предопределенного элемента. Только для чтения.

PredefinedDataName

Edm.String

Имя предопределенного элемента.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем Catalog_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.3.1. Табличная часть справочника

Имя сущности

Catalog_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

Catalog_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.3.2. Строка табличной части

Имя составного типа: Catalog_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита

12.4. Документы

Имя сущности

Document_<Имя>

Имя набора сущностей

Document_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Number

Edm.String,

Edm.Int32

Номер документа, в зависимости от установленного типа номера.

Date

Edm.Date

Если включено.

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Posted

Edm.Boolean

Признак проведения документа.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем Document_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.4.1. Методы

Post

Описание:

Выполняет проведение документа.

Параметры:

PostingModeOperational­Edm.Boolean

Определяет необходимость проведения документа в оперативном режиме. При необходимости такого проведения значение свойства должно принимать значение true.

Значение по умолчанию: false.

Unpost

Описание:

Выполняет отмену проведения документа.

Параметры:

PostingModeOperational­Edm.Boolean

Определяет необходимость проведения документа в оперативном режиме. При необходимости такого проведения значение свойства должно принимать значение true.

Значение по умолчанию: false.

12.4.2. Табличная часть документа

Имя сущности

Document_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

Document_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.4.3. Строка табличной части

Имя составного типа: Document_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части

<Реквизиты>

Соответствует типу реквизита

12.5. Журналы документов

Имя сущности

DocumentJournal_<Имя>

Имя набора сущностей

DocumentJournal_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Number

Edm.String,

Edm.Int32

Номер документа, в зависимости от установленного типа номера.

Date

Edm.Date

Если включено.

DeletionMark

Edm.Boolean

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

Type

Edm.String

Представление типа документа.

Posted

Edm.Boolean

Признак проведения документа.

<Графы>

Соответствует типу графы

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

● Поддерживается только получение списка строк

● Не поддерживаются:

● Создание документа (запрос POST);

● Изменение документа (запрос PATCH);

● Удаление документа (запрос DELETE);

● Обращение «через точку».

12.6. Планы видов характеристик

Имя сущности

ChartOfCharacteristicTypes_<Имя>

Имя набора сущностей

ChartOfCharacteristicTypes_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Code

Edm.String,

Edm.Int32

При наличии у плана видов характеристик кода.

Description

Edm.String

При наличии у плана видов характеристик наименования.

IsFolder

Edm.Boolean

Для иерархического плана видов характеристик.

Owner

Ссылочный или составной тип

Владелец (для подчиненного плана видов характеристик).

Parent

Ссылочный тип

Родитель (для иерархических планов видов характеристик).

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Predefined

Edm.Boolean

Признак предопределенного элемента. Только для чтения.

PredefinedDataName

Edm.String

Имя предопределенного элемента.

ValueType

EnterpriseV8.TypeDescription

Тип значения характеристики.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем ChartOfCharacteristicTypes_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.6.1. Табличная часть плана видов характеристик

Имя сущности

ChartOfCharacteristicTypes_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

ChartOfCharacteristicTypes_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.6.2. Строка табличной части

Имя составного типа: ChartOfCharacteristicTypes_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита

12.7. Планы счетов

Имя сущности

ChartOfAccounts_<Имя>

Имя набора сущностей

ChartOfAccounts _<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Code

Edm.String,

Edm.Int32

При наличии у плана счетов кода.

Description

Edm.String

При наличии у плана счетов наименования.

OffBalance

Edm.Boolean

Признак забалансового счета.

Order

Edm.String

Порядок сортировки.

Type

Edm.String

Тип счета: активный, пассивный, активно/пассивный.

Parent

Ссылочный тип

Родитель (для иерархического плана счетов).

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Predefined

Edm.Boolean

Признак предопределенного элемента. Только для чтения.

PredefinedDataName

Edm.String

Имя предопределенного элемента.

<ПризнакиУчета>

Edm.Boolean

Признаки учета.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем ChartOfAccounts_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

ExtDimensionTypes

Collection(СоставнойТип)

Стандартная табличная часть «Виды субконто».

12.7.1. Табличная часть плана счетов

Имя сущности

ChartOfAccounts_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

ChartOfAccounts_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.7.2. Строка табличной части

Имя составного типа: ChartOfAccounts_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита

12.7.3. Строка стандартной табличной части «Виды субконто»

Имя составного типа: ChartOfAccounts_<Имя объекта>_``ExtDimensions.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части

ExtDimensionType_Key

Edm.Guid

Идентификатор типа плана видов характеристик, хранящий виды субконто

Predefined

Edm.Boolean

Признак предопределенного вида субконто

<Реквизиты>

Соответствует типу реквизита

<ПризнакиУчета>

Edm.Boolean

Признаки учета.

12.8. Планы видов расчета

Имя сущности

ChartOfCalculationTypes_<Имя>

Имя набора сущностей

ChartOfCalculationTypes_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Code

Edm.String,

Edm.Int32

При наличии у плана видов расчета кода.

Description

Edm.String

При наличии у плана видов расчета наименования.

ActionPeriodIsBasic

Edm.Boolean

Признак того, что базовым периодом является период действия (только для планов видов расчета c поддержкой периода действия).

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Predefined

Edm.Boolean

Признак предопределенного элемента. Только для чтения.

PredefinedDataName

Edm.String

Имя предопределенного элемента.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем ChartOfCalculationTypes_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

LeadingCalculationTypes

Collection(СоставнойТип)

Стандартная табличная часть «Ведущие виды расчета».

DisplacingCalculationTypes

Collection(СоставнойТип)

Стандартная табличная часть «Вытесняющие виды расчета» (только для планов видов расчета с поддержкой периода действия).

BaseCalculationTypes

Collection(СоставнойТип)

Стандартная табличная часть «Базовые виды расчета» (только для плана видов расчета с поддержкой базового периода действия).

12.8.1. Табличная часть плана расчетов

Имя сущности

ChartOfCalculationTypes_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

ChartOfCalculationTypes_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.8.2. Строка табличной части

Имя составного типа: ChartOfCalculationTypes_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита

12.8.3. Строка стандартной табличной части «Ведущие виды расчета»

Имя составного типа: ChartOfCalculationTypes_<Имя объекта>_``LeadingCalculationTypes.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

CalculationType

Edm.Guid

Идентификатор типа плана видов расчета, хранящий виды расчета.

Predefined

Edm.Boolean

Признак предопределенного вида субконто.

12.8.4. Строка стандартной табличной части «Вытесняющие виды расчета»

Имя составного типа: ChartOfCalculationTypes_<Имя объекта>_``BaseCalculationTypes.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

CalculationType

Edm.Guid

Идентификатор типа плана видов расчета, хранящий виды расчета.

Predefined

Edm.Boolean

Признак предопределенного вида субконто.

12.8.5. Строка стандартной табличной части «Базовые виды расчета»

Имя составного типа: ChartOfCalculationType``s_<Имя объекта>_``DisplacingCalculationType``s.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

CalculationType_Key

Edm.Guid

Идентификатор типа плана видов расчета, хранящий виды расчета.

Predefined

Edm.Boolean

Признак предопределенного вида субконто.

12.9. Регистры сведений

12.9.1. Независимый

Имя сущности

InformationRegister_<Имя>

Имя набора сущностей

InformationRegister_<Имя>

 Состав свойств:

Имя

Тип

Комментарий

Period

Edm.Date

Период записи.

Только для периодического регистра сведений.

SurrogateKey

Edm.Int16

Суррогатный ключ в том случае, если отсутствуют измерения и разделители. Всегда равен 0.

<Измерения>

Соответствует типу измерения

Измерения включаются в ключ сущности.

<Ресурсы>

Соответствует типу ресурса

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет генерироваться исключение с HTTP-статусом 404. Рекомендуется в таком случае вначале удалять существующую запись, а затем добавлять новую.

12.9.1.1. Функции

SliceLast

Описание:

Набор сущностей ‑ срез последних периодического регистра сведений.

Параметры:

Period­Edm.Date

Период получения среза.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

SliceFirst

Описание:

Набор сущностей ‑ срез первых периодического регистра сведений.

Параметры:

Period­Edm.Date

Период получения среза.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

12.9.2. Подчиненный регистратору

Имя сущности

InformationRegister_<RegisterName>

Имя набора сущностей

InformationRegister_<RegisterName>

Состав свойств:

Имя

Тип

Комментарий

Recorder

Edm.String

Регистратор.

Recorder_Type

Edm.String

Ссылка на регистратор.

RecordSet

Collection(СоставнойТип)

Набор записей.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет генерироваться исключение с HTTP-статусом 404. Рекомендуется в таком случае вначале удалять существующую запись, а затем добавлять новую.

12.9.2.1. Функции

SliceLast

Описание:

Набор сущностей ‑ срез последних периодического регистра сведений.

Параметры:

Period­Edm.Date

Период получения среза.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

SliceFirst

Описание:

Набор сущностей ‑ срез первых периодического регистра сведений.

Параметры:

Period­Edm.Date

Период получения среза.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

12.9.2.2. Набор записей регистра

Имя составного типа: InformationRegister_<Имя``>_RowType

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей

Active

Edm.Boolean

Признак активности строки

SurrogateKey

Edm.Int16

Суррогатный ключ в том случае, если отсутствуют измерения, разделители и период регистрации отличен от Регистратор. Всегда равен 0.

<Измерения>

Соответствует типу измерения

<Ресурсы>

Соответствует типу ресурса

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.9.2.3. Строка набора записей регистра сведений

Имя сущности

InformationRegister_<Имя>_RecordType

Имя набора сущностей

InformationRegister_<Имя>_RecordType

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

SurrogateKey

Edm.Int16

Суррогатный ключ в том случае, если отсутствуют измерения, разделители и период регистрации отличен от Регистратор. Всегда равен 0.

<Измерения>

Соответствует типу измерения

<Ресурсы>

Соответствует типу ресурса

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Сущность доступна только на чтение (запрос GET).

12.10. Регистр накопления

Имя сущности

AccumulationRegister_<RegisterName>

Имя набора сущностей

AccumulationRegister_<RegisterName>

Состав свойств:

Имя

Тип

Комментарий

Recorder

Edm.String

Регистратор.

Recorder_Type

Edm.String

Ссылка на регистратор.

RecordSet

Collection(СоставнойТип)

Набор записей.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет генерироваться исключение с HTTP-статусом 404. Рекомендуется в таком случае вначале удалять существующую запись, а затем добавлять новую.

12.10.1. Функции

Balance

Описание:

Обеспечивает доступ к виртуальной таблице остатков регистра накопления.

Параметры:

Period­Edm.Date

Дата, на которую необходимо получить остатки регистра накопления.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

Dimensions­Edm.String

Список измерений через запятую.

Turnovers

Описание:

Обеспечивает доступ к виртуальной таблице оборотов регистра накопления. Разворот итогов по периодам не поддерживается.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

BalanceAndTurnovers

Описание:

Обеспечивает доступ к виртуальной таблице остатков и оборотов регистра накопления. Разворот итогов по периодам не поддерживается.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

12.10.2. Набор записей регистра

Имя составного типа: AccumulationRegiste``r_<RegisterName>_RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

<Измерения>

Соответствует типу измерения

<Ресурсы>

Соответствует типу ресурса

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет выдаваться исключение, код HTTP 404. Правильный способ ‑ удалить запись и создать новую.

12.10.3. Строка набора записей регистра накопления

Имя сущности

AccumulationRegister_<Имя>_RecordType

Имя набора сущностей

AccumulationRegister_<Имя>_RecordType

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

<Измерения>

Соответствует типу измерения

<Ресурсы>

Соответствует типу ресурса

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Сущность доступна только на чтение (запрос GET).

12.11. Регистры бухгалтерии

Имя сущности

AccountingRegister_<RegisterName>

Имя набора сущностей

AccountingRegister_<RegisterName>

Состав свойств:

Имя

Тип

Комментарий

Recorder

Edm.String

Регистратор.

Recorder_Type

Edm.String

Ссылка на регистратор.

RecordSet

Collection(СоставнойТип)

Набор записей.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет генерироваться исключение с HTTP-статусом 404. Рекомендуется в таком случае вначале удалять существующую запись, а затем добавлять новую.

12.11.1. Функции

Balance

Описание:

Обеспечивает доступ к виртуальной таблице остатков регистра бухгалтерии.

Параметры:

Period­Edm.Date

Дата, на которую необходимо получить остатки регистра бухгалтерии.

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. стр. 1652.

Dimensions­Edm.String

Список измерений через запятую.

AccountCondition­Edm.String

Условие отбора по счетам в формате OData. Подробнее см. здесь.

ExtraDimensions­Edm.String

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

Turnovers

Описание:

Обеспечивает доступ к виртуальной таблице оборотов регистра бухгалтерии. Разворот итогов по периодам не поддерживается.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

AccountCondition­Edm.String

Условие отбора по счетам в формате OData. Подробнее см. стр. 1652.

BalancedAccountCondition­Edm.String

Условие отбора по корреспондирующим счетам в формате OData. Подробнее см. стр. 1652.

Dimensions­Edm.String

Список измерений через запятую.

ExtraDimensions­Edm.String

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

BalancedExtraDimensions­Edm.String

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

BalanceAndTurnovers

Описание:

Обеспечивает доступ к виртуальной таблице остатков и оборотов регистра бухгалтерии. Разворот итогов по периодам не поддерживается.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

ExtDimensions

Описание:

Обеспечивает доступ к виртуальной таблице субконто регистра бухгалтерии.

RecordsWithExtDimensions

Описание:

Обеспечивает доступ к виртуальной таблице движений с субконто регистра бухгалтерии.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

Top­Edm.Int32

Ограничение максимального количества записей.

OrderBy­Edm.String

Строка, содержащая имена колонок (через запятую), по которым будет выполняться сортировка проводок.

DrCrTurnover

Описание:

Обеспечивает доступ к виртуальной таблице получать обороты по регистру бухгалтерии за произвольный период с определенной агрегацией. Разворот итогов по периодам не поддерживается.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

EndPeriod­Edm.Date

Конец периода, за который требуется получить обороты.

StartPeriod­Edm.Date

Начало периода, за который требуется получить обороты.

AccountCondition­Edm.String

Условие отбора по счетам в формате OData. Подробнее см. здесь.

BalancedAccountCondition­Edm.String

Условие отбора по корреспондирующим счетам в формате OData. Подробнее см. здесь.

Dimensions­Edm.String

Список измерений через запятую.

ExtraDimensions­Edm.String

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

BalancedExtraDimensions­Edm.String

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

12.11.2. Набор записей регистра

Имя составного типа: AccountingRegiste``r_<RegisterName>_RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

Period

Edm.Date

Момент времени, в который выполнена запись.

RecordType

Edm.String

Вид движения записи регистра бухгалтерии: Debit или Credit.

AccountDr_Key

Edm.Guid

Счет дебета (только для регистра с корреспонденцией).

AccountCr_Key

Edm.Guid

Счет кредита (только для регистра с корреспонденцией).

Account_Key

Edm.Guid

Счет (только для регистра без корреспонденции).

<Измерения>

Соответствует типу измерения

Для небалансовых измерений два свойства:

● <ИмяИзмерения>Dr

● <ИмяИзмерения>Cr.

<Ресурсы>

Соответствует типу ресурса

Для небалансовых измерений два свойства:

● <ИмяРесурса>Dr

● <ИмяРесурса>Cr.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.11.3. Строка набора записей регистра сведений

Имя сущности

AccountingRegister_<Имя>_RecordType

Имя набора сущностей

AccountingRegister_<Имя>_RecordType

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

Period

Edm.Date

Момент времени, в который выполнена запись.

RecordType

Edm.String

Вид движения записи регистра бухгалтерии: Debit или Credit.

AccountDr_Key

Edm.Guid

Счет дебета (только для регистра с корреспонденцией).

AccountCr_Key

Edm.Guid

Счет кредита (только для регистра с корреспонденцией).

Account_Key

Edm.Guid

Счет (только для регистра без корреспонденции).

<Измерения>

Соответствует типу измерения

Для небалансовых измерений два свойства:

● <ИмяИзмерения>Dr

● <ИмяИзмерения>Cr.

<Ресурсы>

Соответствует типу ресурса

Для небалансовых измерений два свойства:

● <ИмяРесурса>Dr

● <ИмяРесурса>Cr.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Сущность доступна только на чтение (запрос GET).

12.12. Регистры расчета

Имя сущности

CalculationRegister_<RegisterName>

Имя набора сущностей

CalculationRegister_<RegisterName>

Состав свойств:

Имя

Тип

Комментарий

Recorder

Edm.String

Регистратор.

Recorder_Type

Edm.String

Ссылка на регистратор.

RecordSet

Collection(СоставнойТип)

Набор записей.

Особенности поведения:

Измерения регистра сведений образуют ключ записи. При попытке изменить ключ записи будет генерироваться исключение с HTTP-статусом 404. Рекомендуется в таком случае вначале удалять существующую запись, а затем добавлять новую.

12.12.1. Функции

ScheduledData

Описание:

Обеспечивает доступ к виртуальной таблице данных графика регистра расчета. Только для регистра расчета с заданным графиком.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

ActualActionPeriod

Описание:

Обеспечивает доступ к виртуальной таблице фактического периода действия. Только для регистра с поддержкой периода действия.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

<ИмяПерерасчета>

Описание:

Обеспечивает доступ к виртуальной таблице записей перерасчета.

Base<ИмяБазовогоРегистраРасчета>

Описание:

Обеспечивает доступ к виртуальной таблице базовых данных регистра расчета.

Параметры:

Condition­Edm.String

Отбор записей в формате OData. Подробнее см. здесь.

MainRegisterDimensions­Edm.String

Имена измерений основного регистра расчета, по которому строится таблица базовых данных, через запятую.

BaseRegisterDimensions­Edm.String

Имена измерений базового регистра расчета, по которому строится таблица базовых данных, через запятую.

ViewPoints­Edm.String

Имена полей базового регистра расчета, по которым производится суммирование базовых данных, через запятую

12.12.2. Набор записей регистра

Имя составного типа: CalculationRegister_<RegisterName>_RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

Period

Edm.Date

Момент времени, в который выполнена запись.

BegOfBasePeriod

Edm.Date

Дата начала базового периода учетной записи. Только для регистров с базовым периодом.

EndOfBasePeriod

Edm.Date

Дата окончания базового периода учетной записи. Только для регистров расчета с базовым периодом.

BegOfActionPeriod

Edm.Date

Дата начала периода действия. Только для регистров расчета с периодом действия.

EndOfAcrionPeriod

Edm.Date

Дата окончания периода действия. Только для регистров расчета с периодом действия.

CalculationType_Key

Edm.Guid

Ссылка на вид расчета учетной записи.

ReversingEntry

Edm.Boolean

Признак сторно-записи.

<Измерения>

Соответствует типу измерения

Для небалансовых измерений два свойства:

● <ИмяИзмерения>Dr

● <ИмяИзмерения>Cr.

<Ресурсы>

Соответствует типу ресурса

Для небалансовых измерений два свойства:

● <ИмяРесурса>Dr

● <ИмяРесурса>Cr.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.12.3. Строка набора записей регистра сведений

Имя сущности

CalculationRegister_<Имя>_RecordType

Имя набора сущностей

CalculationRegister_<Имя>_RecordType

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки в наборе записей.

Active

Edm.Boolean

Признак активности строки.

Period

Edm.Date

Момент времени, в который выполнена запись.

BegOfBasePeriod

Edm.Date

Дата начала базового периода учетной записи. Только для регистров с базовым периодом.

EndOfBasePeriod

Edm.Date

Дата окончания базового периода учетной записи. Только для регистров расчета с базовым периодом.

BegOfActionPeriod

Edm.Date

Дата начала периода действия. Только для регистров расчета с периодом действия.

EndOfAcrionPeriod

Edm.Date

Дата окончания периода действия. Только для регистров расчета с периодом действия.

CalculationType_Key

Edm.Guid

Ссылка на вид расчета учетной записи.

ReversingEntry

Edm.Boolean

Признак сторно-записи.

<Измерения>

Соответствует типу измерения

Для небалансовых измерений два свойства:

● <ИмяИзмерения>Dr

● <ИмяИзмерения>Cr.

<Ресурсы>

Соответствует типу ресурса

Для небалансовых измерений два свойства:

● <ИмяРесурса>Dr

● <ИмяРесурса>Cr.

<Реквизиты>

Соответствует типу реквизита

●

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

Особенности поведения:

Сущность доступна только на чтение (запрос GET).

12.13. Бизнес-процессы

Имя сущности

BusinessProcess_<Имя>

Имя набора сущностей

BusinessProcess_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Code

Edm.String,

Edm.Int32

При наличии у бизнес-процесса кода.

Description

Edm.String

При наличии у бизнес-процесса наименования.

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Started

Edm.Boolean

Бизнес-процесс стартован.

Competed

Edm.Boolean

Бизнес-процесс завершен.

HeadTask

Два поля:

● <Имя реквизита> ‑ содержит значение ссылки в виде строки;

● <Имя реквизита>_Type ‑ ссылка на задачу, обслуживающую данный бизнес-процесс.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем BusinessProcess_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.13.1. Функции

Start

Описание:

Стартует бизнес-процесс.

Параметры:

RoutePoint

Имя точки маршрута, с которой стартует бизнес-процесс. Необязательный параметр.

12.13.2. Табличная часть бизнес-процесса

Имя сущности

BusinessProcess_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

BusinessProcess_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.13.3. Строка табличной части

Имя составного типа: BusinessProcess_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита

12.14. Задачи

Имя сущности

Task_<Имя>

Имя набора сущностей

Task_<Имя>

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

Ссылка.

Number

Edm.String,

Edm.Int32

При наличии у задачи номера.

Description

Edm.String

При наличии у задачи наименования.

DeletionMark

Edm.Boolean

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

Version

Edm.String

Версия данных.

Executed

Edm.Boolean

Задача выполнена.

BusinessProcess

Описывает составной тип, если задача связана с несколькими бизнес-процессами:

● <Имя реквизита> ‑ содержит значение ссылки в виде строки;

● <Имя реквизита>_Type ‑ ссылка на задачу, обслуживающую данный бизнес-процесс.

Если задача связана с одним бизнес-процессом, то реквизит описывается двумя свойствами:

● Навигационная ссылка;

● BusinessProcess_Key ‑ значение ссылки.

RoutePoint

Edm.String

Имя точки маршрута, для исполнения которой создана задача. Только для задачи, привязанной к бизнес-процессу.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

<Табличные части>

Collection(СоставнойТип)

Каждая табличная часть выступает в виде отдельной сущности с именем Task_<ИмяОбъекта>_<ИмяТабличнойЧасти>.

12.14.1. Функции

ExecuteTask

Описание:

Выполняет задачу.

12.14.2. Табличная часть бизнес-процесса

Имя сущности

Task_<Имя объекта>_<Имя табличной части>_ RecordType

Имя набора сущностей

Task_<Имя объекта>_<Имя табличной части>_RecordType

Состав свойств:

Имя

Тип

Комментарий

Ref

Ссылочный тип

LineNumber

Edm.Int64

Номер строки.

<Реквизиты>

Соответствует типу реквизита

<Общие реквизиты>

Соответствует типу реквизита

Кроме общих реквизитов являющихся независимыми разделителями.

12.14.3. Строка табличной части

Имя составного типа: Task_<Имя объекта>_<Имя табличной части>_``RowType.

Состав свойств:

Имя

Тип

Комментарий

LineNumber

Edm.Int64

Номер строки табличной части.

<Реквизиты>

Соответствует типу реквизита