Интерфейсы взаимодействия БРО клиент сервер

НачалоПериода

Описание, пример вызова

// Возвращает начало периода даты.
//
// Параметры:
//   Периодичность - Перечисление.Периодичность - периодичность.
//   Дата - Дата - дата.
//
// Возвращаемое значение:
//   Дата - начало периода даты.
//
Функция НачалоПериода(Периодичность, Дата) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.НачалоПериода(Периодичность, Дата)

КонецПериода

Описание, пример вызова

// Возвращает конец периода.
//
Функция КонецПериода(Периодичность, Дата) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КонецПериода(Периодичность, Дата)

ДобавитьПериод

Описание, пример вызова

// Добавляет период.
//
Функция ДобавитьПериод(Знач Дата, Периодичность, Знач КоличествоПериодов = 1) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ДобавитьПериод(Дата, Периодичность, КоличествоПериодов);

ОперацииСРегламентированнымОтчетом

Описание, пример вызова

// Возвращает операции регламентированного отчета с признаками их доступности.
//
// Параметры:
//   ИмяОтчета - Строка - имя регламентированного отчета, например, "РегламентированныйОтчет4ФСС".
//   ИмяФормы - Строка - имя формы регламентированного отчета, например, "ФормаОтчета2017Кв1".
//
// Возвращаемое значение:
//   ФиксированнаяСтруктура - операции с регламентированным отчетом.
//     * АвтоФормированиеНаСервере - Булево - признак автоматического формирования отчета в тихом режиме на сервере.
//     * ВыгрузкаНаСервере - Булево - признак выгрузки отчета в тихом режиме на сервере.
//     * ПечатьСоШтрихкодомPDF417НаСервере - Булево - признак печати отчета со штрихкодом PDF417 в тихом режиме
//                            на сервере.
//     * ПечатьБезШтрихкодаPDF417НаСервере - Булево - признак печати отчета без штрихкода PDF417 в тихом режиме
//                            на сервере.
//
Функция ОперацииСРегламентированнымОтчетом(ИмяОтчета, ИмяФормы) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ОперацииСРегламентированнымОтчетом(ИмяОтчета, ИмяФормы)

ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ

Описание, пример вызова

// Определяет, можно ли использовать функцинал формирования пакета для ФНС для внесения изменений в ЕГРЮЛ
//
// Возвращаемое значение:
//  Булево - Истина, если можно использовать.
//
Функция ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПоддерживаетсяФормированиеПакетаДляВнесенияИзмененийВЕГРЮЛ()

КлассификаторОшибокПакетаПоЕГРЮЛ

Описание, пример вызова

// Содержит реестр ошибок возникающие во время формирования пакет для для внесения изменений в ЕГРЮЛ.
// Используется в поле "ТипОшибки" в возвращаемом значении функции ПараметрыМетодаСформироватьПакетПоЕГРЮЛ.
//
// Возвращаемое значение:
//  ФиксированнаяСтруктура
//
Функция КлассификаторОшибокПакетаПоЕГРЮЛ() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КлассификаторОшибокПакетаПоЕГРЮЛ()

СтатусСданоСтрокой

Описание, пример вызова

////////////////////////////////////////////////////////////////////////////////
// Процедуры и функции интерфейса взаимодействия с сервисом "Список задач
// бухгалтера".

// Определяет строковой статус объекта регламентированной отчетности,
// предназначенный для интерактивного изменения пользователем,
// соответствующий финальному статусу.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса, предназначенное для программной обработки.
//
Функция СтатусСданоСтрокой() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусСданоСтрокой()

СтатусВРаботеСтрокой

Описание, пример вызова

// Определяет строковой статус объекта регламентированной отчетности,
// предназначенный для интерактивного изменения пользователем,
// соответствующий статусу отчета, находящегося в процессе подготовки.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса, предназначенное для программной обработки.
//
Функция СтатусВРаботеСтрокой() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусВРаботеСтрокой()

СтатусПодготовленоСтрокой

Описание, пример вызова

// Определяет строковый статус объекта регламентированной отчетности,
// предназначенный для интерактивного изменения пользователем,
// соответствующий статусу подготовленной отчетности.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса, предназначенное для программной обработки.
//
Функция СтатусПодготовленоСтрокой() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.СтатусПодготовленоСтрокой()

ПредставлениеСтатусаНеОтправлено

Описание, пример вызова

// Пользовательское представление статуса объекта регламентированной отчетности,
// соответствующего статусу по умолчанию.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса пользователю.
//
Функция ПредставлениеСтатусаНеОтправлено() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаНеОтправлено()

ПредставлениеСтатусаСдано

Описание, пример вызова

// Пользовательское представление строкового статуса объекта регламентированной отчетности,
// предназначенного для интерактивного изменения пользователем,
// соответствующего финальному статусу.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса пользователю.
//
Функция ПредставлениеСтатусаСдано() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаСдано()

ПредставлениеСтатусаВРаботе

Описание, пример вызова

// Пользовательское представление строкового статуса объекта регламентированной отчетности,
// предназначенного для интерактивного изменения пользователем,
// соответствующего статусу отчета, находящегося в процессе подготовки.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса пользователю.
//
Функция ПредставлениеСтатусаВРаботе() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаВРаботе()

ПредставлениеСтатусаПодготовлено

Описание, пример вызова

// Пользовательское представление строкового статуса объекта регламентированной отчетности,
// предназначенного для интерактивного изменения пользователем,
// соответствующего статусу подготовленной отчетности.
//
// Возвращаемое значение:
//  Строка - строковое представление статуса пользователю.
//
Функция ПредставлениеСтатусаПодготовлено() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеСтатусаПодготовлено()

НовыйСостояниеДокумента

Описание, пример вызова

// Конструктор коллекции со сведениями о состоянии передачи в учреждение отчета или иного документа
// - при передаче в электронном виде - состояние отправки;
// - при передаче иным способом - статус, установленный пользователем.
//
// Возвращаемое значение:
//  Структура
//    * Представление - Строка - представление состояния передачи в учреждение.
//    * Статус        - Строка - строковый статус объекта регламентированной отчетности.
//    * Сдано         - Булево - Истина, если отчет сдан любым способом.
//    * Отправлено    - Булево - Истина, если отчет отправлен в учреждение в электронном виде.
//    * ВРаботе       - Булево - Истина, если отчет редактируется и еще не отправлен в учреждение.
//
Функция НовыйСостояниеДокумента() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.НовыйСостояниеДокумента()

ВозможнаОтправкаЭлектронногоДокумента

Описание, пример вызова

// Определяет, возможна ли отправка отчета в учреждение в виде электронного документа.
//
// Параметры:
//  ИмяОтчета - Строка - Имя отчета (элемента метаданных).
//
// Возвращаемое значение:
//  Булево - Истина, если отчет может быть отправлен в электронном виде.
//
Функция ВозможнаОтправкаЭлектронногоДокумента(ИмяОтчета) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ВозможнаОтправкаЭлектронногоДокумента(ИмяОтчета)

ОтчетыОтправкаОграничена

Описание, пример вызова

// Определяет перечень отчетов, отправка которых в учреждение невозможна в виде электронного документа.
//
// В список включены отчеты, из форм которых не вызывается
// ОнлайнСервисыРегламентированнойОтчетностиКлиент.ПередОтправкойРегламентированногоОтчета()
//
// Внимание!
// При изменении содержимого этого перечня регламентированных отчетов в конфигурации-потребителе
// БРО при обновлении но новую версию необходимо выполнить специальный обработчик обновления,
// который должен выполняться каждый раз при изменени содержимого этого перечня.
//
// Возвращаемое значение:
//  ФиксированныйМассив - имена отчетов (элементов метаданных).
//
Функция ОтчетыОтправкаОграничена() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ОтчетыОтправкаОграничена()

ПредставлениеПолучателяБумажногоДокумента

Описание, пример вызова

// Определяет краткое наименование государственного органа - получателя документа, который невозможно отправить ему в электронном виде.
// Следует использовать для отчетов, для которых ВозможнаОтправкаЭлектронногоДокумента() = Ложь.
//
// Параметры:
//  ИмяОтчета - Строка - Имя отчета (элемента метаданных).
//
// Возвращаемое значение:
//  Строка - представление гос. органа; пустая строка, если неизвестно.
//
Функция ПредставлениеПолучателяБумажногоДокумента(ИмяОтчета) Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.ПредставлениеПолучателяБумажногоДокумента(ИмяОтчета)

КраткоеПредставлениеОграниченияОтправкиОтчета

Описание, пример вызова

// Определяет текст для пользователя, кратко, в несколько слов описывающий суть ограничения отправки отчета.
// Такой текст выводится в дополнение к названию отчета и т.п.
//
// Возвращаемое значение:
//  Строка - краткое представление ограничения отправки отчета для пользователя.
//
Функция КраткоеПредставлениеОграниченияОтправкиОтчета() Экспорт

Пример вызова

Результат = ИнтерфейсыВзаимодействияБРОКлиентСервер.КраткоеПредставлениеОграниченияОтправкиОтчета()