Облачные кассы

НастройкаПодключенияДоступна

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

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

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

Результат = ОблачныеКассы.НастройкаПодключенияДоступна()

ЧтениеНастроекПодключенияДоступно

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

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

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

Результат = ОблачныеКассы.ЧтениеНастроекПодключенияДоступно()

ПробитиеЧековДоступно

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

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

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

Результат = ОблачныеКассы.ПробитиеЧековДоступно()

СостояниеКассы

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

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

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

Результат = ОблачныеКассы.СостояниеКассы(Касса)

ПробитьЧек

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

// Выполняет отправку запроса на пробитие чека в Облачной кассе.
//
// Параметры:
//  ДокументОперации - ОпределяемыйТип.ДокументОперацииОблачнойКассы - ссылка на документ инициирующий пробитие чека.
//  Касса - ОпределяемыйТип.ОблачнаяКасса - ссылка на элемент справочника для которого настроена интеграция с Облачной
//    кассой.
//  ДанныеЧека - Структура - запрос операции в формате Структура.
//
// Возвращаемое значение:
//  Структура:
//    * КодОшибки - Строка - строковый код возникшей ошибки, который может быть обработан вызывающим методом.
//        Список ошибок:
//          "ОтсутствуютНастройкиПодключения" - не выполнена настройка подключения Облачной кассы.
//          "НеверныйФорматЗапроса" - передан некорректный запрос или ошибка сериализации данных чека в формат JSON.
//          "ОшибкаАутентификации" - неверный логин или пароль Интернет-поддержки или к системе Облачной кассе.
//          "ТребуетсяОплата" - требуется оплата сервиса.
//          "ОтсутствуетДоступКСервису" - у пользователя нет доступа к сервису.
//          "ПревышеноКоличествоПопыток" - превышено количество попыток обращения к сервису с некорректным логином и
//            паролем.
//          "СервисВременноНеДоступен" - на сервере ведутся регламентные работы.
//          "ОшибкаСервиса" - внутренняя ошибка сервиса.
//          "ОшибкаПодключения" - ошибка при подключении к сервису.
//          "НеизвестнаяОшибка" - при получении информации возникла неизвестная (не обрабатываемая) ошибка.
//          "ОшибкаСохраненияПараметровПодключения" - ошибка обновления данных аутентификации к сервису Облачной кассы.
//          "ПрочаяОшибка" - ошибка получения идентификатора операции.
//    * СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя.
//    * ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора.
//    * ДанныеОперации - Структура - данные выполнения операции:
//        * ИдентификаторОперации - Строка - идентификатор операции в информационной базе.
//        * СтатусОперации - Строка - результат выполнения операции Облачной кассы.
//            Список статусов:
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииВыполнена - успешное завершение операции.
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииОтменена - операция отмена.
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииВыполняется - операция выполняется. Для обновления статуса
//                следует вызвать метод см. ОблачныеКассы.СтатусПробитияЧека.
//        * ИдентификаторЧека - Строка - идентификатор операции в системе Облачной кассы.
//        * ОписаниеСтатусаОперации - Строка - описание статуса выполнения операции, полученное из Облачной кассы.
//    * Результат - Неопределено - ошибка отправки запроса на обработку операции Облачной кассы.
//                - Структура - данные ответа Облачный кассы.
//
Функция ПробитьЧек(ДокументОперации, Касса, ДанныеЧека) Экспорт

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

Результат = ОблачныеКассы.ПробитьЧек(ДокументОперации, Касса, ДанныеЧека)

СтатусПробитияЧека

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

// Выполняет получение статуса пробития чека в Облачной кассе.
//
// Параметры:
//  ДокументОперации - ОпределяемыйТип.ДокументОперацииОблачнойКассы - ссылка на документ инициирующий пробитие чека.
//  ВремяОжидания - Число - время ожидания терминального статуса в секундах.
//    Если параметр заполнен, то получение статуса будет выполняться в цикле с небольшими задержками между запросами.
//    Значение по умолчанию: 0 (один запрос).
//
// Возвращаемое значение:
//  Структура:
//    * КодОшибки - Строка - строковый код возникшей ошибки, который может быть обработан вызывающим методом.
//        Список ошибок:
//          "НеверныйФорматЗапроса" - передан некорректный запрос или ошибка сериализации данных чека в формат JSON.
//          "ОшибкаАутентификации" - неверный логин или пароль Интернет-поддержки или к системе Облачной кассе.
//          "ТребуетсяОплата" - требуется оплата сервиса.
//          "ОтсутствуетДоступКСервису" - у пользователя нет доступа к сервису.
//          "ПревышеноКоличествоПопыток" - превышено количество попыток обращения к сервису с некорректным логином и
//            паролем.
//          "СервисВременноНеДоступен" - на сервере ведутся регламентные работы.
//          "ОшибкаСервиса" - внутренняя ошибка сервиса.
//          "ОшибкаПодключения" - ошибка при подключении к сервису.
//          "НеизвестнаяОшибка" - при получении информации возникла неизвестная (не обрабатываемая) ошибка.
//          "ОшибкаСохраненияПараметровПодключения" - ошибка обновления данных аутентификации к сервису Облачной кассы.
//          "ПрочаяОшибка" - ошибка получения идентификатора операции.
//    * СообщениеОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для пользователя.
//    * ИнформацияОбОшибке - Строка, ФорматированнаяСтрока - сообщение об ошибке для администратора.
//    * ДанныеОперации - Структура - данные выполнения операции:
//        * ИдентификаторОперации - Строка - идентификатор операции в информационной базе.
//        * СтатусОперации - Строка - результат выполнения операции Облачной кассы.
//            Список статусов:
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииВыполнена - успешное завершение операции.
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииОтменена - операция отмена.
//              см. ОблачныеКассыКлиентСервер.СтатусОперацииВыполняется - операция выполняется. Для обновления статуса
//                следует вызвать метод см. ОблачныеКассы.СтатусПробитияЧека.
//        * ИдентификаторЧека - Строка - идентификатор операции в системе Облачной кассы.
//        * ОписаниеСтатусаОперации - Строка - описание статуса выполнения операции, полученное из Облачной кассы.
//    * Результат - Неопределено - ошибка отправки запроса на обработку операции Облачной кассы.
//                - Структура - данные ответа Облачный кассы.
//
Функция СтатусПробитияЧека(ДокументОперации, ВремяОжидания = 0) Экспорт

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

Результат = ОблачныеКассы.СтатусПробитияЧека(ДокументОперации, ВремяОжидания);

СтатусыОпераций

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

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

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

Результат = ОблачныеКассы.СтатусыОпераций()

УстановитьОтложенноеПолучениеСтатуса

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

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

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

Результат = ОблачныеКассы.УстановитьОтложенноеПолучениеСтатуса(ДокументОперации, Значение)