Подсистема обмен УНПФ

Модуль обмена данными НПФ

Возврат к заглавной странице

Модуль обмена данными НПФ Версия документа 1 Назначение модуля 2 Цели 3 Принятые сокращения и общие параметры 4 Настройка сервиса обмена 1С: УНПФ 5 Виды сервисов 5.1 Описание группы сервисов, в рамках которых ведется учет регистрации изменения передаваемых данных по НПО/ПДС/ОПС 5.2 Описание группы сервисов, в рамках которых не ведется учет регистрации изменения передаваемых данных 6 Описание сервисов НПО/ПДС/ОПС 6.1 Авторизация 6.2 Общие сервисы. (StatusExchange) Подтверждение успешного обмена (НПО/ПДС/ОПС) [[#6.3 Общие сервисы. (ClientsChg_Request) Обмен изменениями по Клиентам|6.3 Общие сервисы. (ClientsChg_Request) Обмен изменениями по Клиентам]] ПРИЛОЖЕНИЕ 2. Сведения, включаемые в анкету (досье) клиента

Версия документа 1.1 – 09.04.2024 Добавлено в: п 5.5.2, 5.11.2 – описание структуры реквизита OutPay (информация о решениях выплаты выкупной суммы правопреемникам) 1.2 – 09.04.2024 Удалены лишние данные, скорректировано описание поля vidOp 1.3 – 02.05.2024 Добавлен раздел Назначение модуля и скорректировано описание цели 1.4 – 18.10.2024 Добавлено в: п 6.3.2, 6.9.2 – описание структуры реквизита AddressJSON (информация о структуре адреса в формате JSON) 1.5 – 18.10.2024 Добавлены разделы для сервисов по Договорам ОПС (изменены: п.4, 5.1, 5.2. Добавлены: п.6.6, 6.9, 6.14, 6.17) Обновлены картинка с параметрами настройки 1.6 – 06.11.2024 Обновлены описания таблиц «Типы резервов» и «Типы Сумм» для НПО, ПДС,ОПС. Добавлены поля «TypeResId» и «TypeSumId» в структуры данных по остаткам и движениям денежных средств для НПО,ПДС,ОПС 1.7 – 21.02.2025 Обновлены описания полей структуры договора ПДС. 1 Назначение модуля Модуль предназначен для предоставления необходимой информации для внешних систем (Например: СРМ, ЛК и т.п.) из подсистемы пенсионного учета УНПФ8 по НПО,ПДС и ОПС. Модуль работе в виде http-сервиса. Формат сообщений = json. Модуль доступен после покупки и активации соответствующей лицензии на сервере СЛК. Наименование модуля в УНПФ8 и в СЛК = «Обмен УНПФ». 2 Цели Сервиса реализован в 1С (конфигурация УНПФ8) для предоставления данных внешним системам. На стороне 1С ведется регистрация изменений данных по клиентам (ФЛ) и данных по пенсионным счетам и договорам, а также операций (документов) с ними связанных Для каждой внешний системы в 1С создается «узел обмена», в рамках которого производится учет регистрация изменений и обмен данными. Обмен данными производится в виде «сообщений», в рамках которых регистрируется успешная или неуспешная передача данных. Предусмотрены отдельные сервисы для получения полных данных выборочно по конкретным клиентам вне рамок подсистемы регистрации изменений. Настройка реализована для вида учета по НПО, ПДС и ОПС. В рамках сервиса предусмотрена только предоставление данных по запросу. Загрузка информации в 1С (УНПФ8) не предусмотрена, т.е. загрузка новых договоров, участников и т.п. в рамках данного сервиса не предусмотрена. 3 Принятые сокращения и общие параметры Квитирование - подтверждение приёма-передачи структурной единицы информации URL Пространства имен - Требуется для идентификации веб-сервиса, по сочетанию его имени и пространству имен. Значение присваиваем: ______ Пакеты XDTO (XML Data Transfer Objects) — это механизм, разработанный фирмой “1С” для обмена данными с другими программными системами посредством XML, позволяющий на уровне языка 1С оперировать не узлами XML, а прикладными понятиями “Сотрудник”, “Счет” и привычными встроенными типами (“ТаблицаЗначений”, “СправочникСсылка” и т.п.) Узел обмена – внешняя система ФЛ- физическое лицо ЮЛ- Юридическое лицо ПС- пенсионный счет ПД – пенсионный договор НПО- учет по договорам негосударственное пенсионное обеспечение ПДС- учет по договорам долгосрочных сбережений (ПДС = Программа долгосрочных сбережений) ОПС – учет по договорам обязательного пенсионного страхования Спр – Справочник РС – Регистр сведений РН – Регистр накоплений Док – Документ БД – база данных ДУЛ – документ удостоверения личности ИД – инвестиционный доход ИПД – индивидуальный пенсионный договор ПР – пенсионные резервы Р/С – расчетный счет СПС – Солидарный пенсионный счет СР – страховой резерв 4 Настройка сервиса обмена 1С: УНПФ Для предоставления данных внешним системам необходимо осуществить настройку сервисов обмена на форме «Настройки сервиса обмена УНПФ», которая доступна в разделе «Общие настройки УНПФ»/«Сервис доступа к данным УНПФ8» Данная настройка выполняется индивидуально для каждой внешней системы. Настройка доступна только пользователю с полными правами. Параметр «Пользователь» определяет от имени какого пользователя будет производится подключение к 1с со стороны внешней системы. Такой пользователь и его пароль задается администратором системы 1с. У пользователя должны быть доступна роль «Доступ к сервису УНПФ». Параметр «Организация» - используется для отбора данных, которые передаются через сервис. Параметр «Имя модуля» - если не задан, то используется модуль поставщика с предопределенным именем «уп_ИнтеграцияСВнешнимиСистемами». Либо указывается имя общего модуля, который настроен под требования организации. В модуле прописывается порядок сбора информации и формирование ответа json. Установка флага «Действует» предоставляет внешнему пользователю возможность получать данные из системы УНПФ. При подключении внешнего пользователя производится сверка есть ли для него данная настройка обмена и действует ли она. В рамках группы сервисов по регистрации изменений проверяется включена ли регистрация таких изменений (задан ли узел обмена и включен ли флаг «регистрировать изменения»). Если регистрация изменений не включена или не настроена, то будет ответ с кодом ошибки и с описанием ошибки (404,"Не указан в настройках источник данных"). Значение «Макс количество идентификаторов…» для GET-запросов по умолчанию равно 40, для POST-запросов 100 000. На закладке «Планы обмена» настраиваются узлы обмена для каждого пользователя (внешняя система). В узлах обмена производится регистрация и накопление изменений с момента последнего успешного обмена. Рекомендуется имя для узлов задавать по следующей маске: «Имя внеш. системы (пользователь)»-«Вид регистрируемых данных». Предусмотрены следующие виды регистрируемых данных (изменений): Контрагенты, ПС НПО, ПС ПДС, Договоры ОПС, Резервы НПО, Резервы ПДС, Резервы ОПС. Флаг «Регистрировать изменений» - если флаг установлен, то производится регистрация изменений в заданном узле обмена. Флаг устанавливается/снимается по кнопке «Вкл»/ «Откл». Параметр «№ Сообщения» - последний номер сообщения, который был передан в результате обмена. 5 Виды сервисов 1. В рамках проекта предусматривается разработка две группы сервисов для вида учета НПО/ПДС/ОПС: Группа сервисов, в рамках которых ведется учет регистрации изменения передаваемых данных. Регистрационный учет ведется в рамках каждого узла обмена (внешняя система). Группа сервисов, в рамках которой не ведется учет регистрации изменения передаваемых данных. Данные по такой группе передаются в полном объеме, но только по запрошенным guid клиентам/договорам. Предусмотрена возможность получения полного списка клиентов. 2. Аутентификация сервисов в базе данных 1С производится: по логину и паролю 1С. 3. Каждому узлу обмена (внешнему клиенту) присваивается идентификатор (по умолчанию планируется использовать логин и пароль). При обмене данный параметр является обязательным. 4. В имени каждой функции сервиса и у каждого плана обмена 1с8 устанавливается префикс, который характеризуем систему обмена в рамках вида учета NPO(НПО), OPS(ОПС), PDS(ПДС). 5.1 Описание группы сервисов, в рамках которых ведется учет регистрации изменения передаваемых данных по НПО/ПДС/ОПС Имена сервисов в документе содержат в имени дефис, для удобства визуального восприятия. По мере завершения работы над документом дефис будет замен на символ подчёркивания. Все сообщения обмена через это набор сервисов производится в разрезе номеров сообщений в рамках каждого узла обмена (клиент). По результатам успешного обмена узел обмена обязан передать сообщение об успешном прохождении обмена по номеру сообщения (квитирование). Данный учет необходим для реализации учета какой набор изменённых данных требуется передать узлу обмена с момента последнего обмена. И как следствие регистрация учета изменений ведется в рамках каждого узла отдельно (что позволит реализовать независимый учета обмена измененными данными между разными системами. Например, таким как ЛК и Синтакси). Предусмотрены следующий набор сервисов (структура обмена будет описана в подразделах): 1. Общие сервисы (без привязки к НПО/ОПС/ПДС) 1.1. («StatusExchange») Информирование об успешном прохождении сообщений Узел обмена должен будет присылать информацию/подтверждение об успешном обмене по сообщению (успешный прием сообщения) Параметры входящего запроса: Коллекция с указанием идентификатора узла обмена , номера сообщения (НомерСообщения) и имя сервиса Ответа не предусмотрено (либо стандартные коды ответов). 1.2. («ClientsChg_Request») Обмен изменениями по Клиентам: Учет регистрации изменений ведется по всем контрагентам (ФЛ/ЮЛ). Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Ответ: передается коллекция данных по ФЛ/ЮЛ, по которым зафиксированы изменения с момента последнего подтвержденного обмена. Сведения не привязаны к виду учета НПО/ОПС и т.п. 2. Сервисы по НПО: 2.1. («NPO_PSChg_Request») Обмен изменениями по ПС и ПД (НПО) Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Ответ: передается коллекция характеристик по ПС и ПД, по которым зафиксированы изменения с момента последнего подтвержденного обмена 2.2. («NPO_OperationsChg_Request») Обмен изменениями по движениям (выписка по ПС) (НПО) -в рамках движений денежных средств по ПС: Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Движений денежных средств привязаны к регистратору (документ). В случае отмены проведения или пометки удаления документа – движения в узле обмена придется чистить по регистратору. В рамках обмена будет передавать идентификатор регистратора, по которому требуется очистить движения. Ответ: передается коллекция документов и движений по ним, по которым зафиксированы изменения с момента последнего подтвержденного обмена 3. Сервисы по ПДС: 3.1. («PDS_PSChg_Request») Обмен изменениями по ПС и ПД (ПДС) Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Ответ: передается коллекция характеристик по ПС и ПД, по которым зафиксированы изменения с момента последнего подтвержденного обмена 3.2. («PDS_OperationsChg_Request») Обмен изменениями по движениям (выписка по ПС) (ПДС) -в рамках движений денежных средств по ПС: Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Движений денежных средств привязаны к регистратору (документ). В случае отмены проведения или пометки удаления документа – движения в узле обмена придется чистить по регистратору. В рамках обмена будет передавать идентификатор регистратора, по которому требуется очистить движения. Ответ: передается коллекция документов и движений по ним, по которым зафиксированы изменения с момента последнего подтвержденного обмена 4. Сервисы по ОПС: 4.1. («OPS_PSChg_Request») Обмен изменениями по Договорам (ОПС) Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Ответ: передается коллекция характеристик по Договорам ОПС, по которым зафиксированы изменения с момента последнего подтвержденного обмена 4.2. («OPS_OperationsChg_Request») Обмен изменениями по движениям (выписка по Договору) (ОПС) -в рамках движений денежных средств по Договору: Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: да Движений денежных средств привязаны к регистратору (документ). В случае отмены проведения или пометки удаления документа – движения в узле обмена придется чистить по регистратору. В рамках обмена будет передавать идентификатор регистратора, по которому требуется очистить движения. Ответ: передается коллекция документов и движений по ним, по которым зафиксированы изменения с момента последнего подтвержденного обмена 5.2 Описание группы сервисов, в рамках которых не ведется учет регистрации изменения передаваемых данных В рамках данной группы сервисов не предусмотрен контроль подтверждения успешного прохождения сообщений. Вызывать сервис можно через как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). Пример структуры JSON: { " uids": [ "7a2e005a-8efd-11e3-be8c-74d02bc3313d", "87e21ffa-cb82-11e3-be9d-74d02bc3313d", "87e21fff-cb82-11e3-be9d-74d02bc3313d" ] } Обращаем внимание, что через GET запрос используется параметр uid, а POST запросе используется параметр uids. 1. Общие сервисы (без привязки к НПО/ПДС): 1.1. (Функция «ClientsID_Request») Список идентификаторов клиентов: Параметры входящего запроса: отсутствуют Обмена в рамках номеров сообщений: нет Ответ: возвращает идентификаторы (guid контрагента) всех клиентов (контрагентов ЮЛ/ФЛ), в т.ч. предусмотрен признак о наличии ПС в учете НПО/ПДС/ОПС. 1.2. (Функция «ClientsInfo_Request») Получение информации по клиентам: Параметры входящего запроса: Коллекция «Идентификаторов Клиента» (guid контрагента). Количество идентификаторов клиентов в одном запросе ограничено. – параметр планируется вывести в настройки обмена. Обмена в рамках номеров сообщений: нет Ответ: возвращает информацию по клиенту (карточка контрагента ЮЛ/ФЛ), в т.ч. предусмотрен признак о наличии ПС в учете НПО/ПДС/ОПС. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 2. Сервисы по НПО: 2.1. (Функция «NPO_PS_Request») Получить данные по ПС клиентов НПО: Параметры входящего запроса: Коллекция «Идентификаторов Клиента» (guid контрагента). Количество идентификаторов клиентов в одном запросе ограничено. – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: возвращает данные по пенсионным счетам клиента (ФЛ и ЮЛ) в учете НПО и характеристики пенсионного договора, текущий остаток на ПС. 2.2. (Функция «NPO_Operations_Request») Получить полную выписку по счетам НПО: Передаем полные данные по ФЛ/ЮЛ и полные данные по движениям + тек. остатки Параметры входящего запроса: Коллекция «Идентификатор ПС» (ГУИД ПС (guidPS)). Количество идентификаторов в одном запросе будет ограничено – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: передается история всех движений по запрошенным ПС в разрезе регистраторов (документов) в учете НПО. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 3. Сервисы по ПДС: 3.1. (Функция «PDS_PS_Request») Получить данные по ПС клиентов ПДС: Параметры входящего запроса: Коллекция «Идентификаторов Клиента» (guid контрагента). Количество идентификаторов клиентов в одном запросе ограничено. – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: возвращает данных по пенсионным счетам клиента в учете ПДС (ФЛ) и характеристики договора такого клиента, текущие остатки на ПС. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 3.2. (Функция «PDS_Operations_Request») Получить полную выписку по счетам ПДС: Передаем полные данные по ФЛ и полные данные по движениям + тек. остатки Параметры входящего запроса: Коллекция «Идентификаторов Клиента» (код контрагента). Количество идентификаторов клиентов в одном запросе будет ограничено. – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: передается история всех движений по запрошенным ПС в разрезе регистраторов (документов) в учете ПДС. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 4. Сервисы по ОПС: 4.1. (Функция «OPS_PS_Request») Получить данные по Договорам клиентов ОПС: Параметры входящего запроса: Коллекция «Идентификаторов Клиента» (guid контрагента). Количество идентификаторов клиентов в одном запросе ограничено. – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: возвращает данных по Договорам клиента в учете ОПС (ФЛ) и характеристики договора такого клиента, текущие остатки на Договоре. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 4.2. (Функция «OPS_Operations_Request») Получить полную выписку по Договорам ОПС: Передаем полные данные по ФЛ и полные данные по движениям + тек. остатки Параметры входящего запроса: Коллекция «Идентификаторов Договоров» (ГУИД договора). Количество идентификаторов в одном запросе будет ограничено. – параметр планируется вывести в настройки обмена Обмена в рамках номеров сообщений: нет Ответ: передается история всех движений по запрошенным Договорам в разрезе регистраторов (документов) в учете ОПС. Можно вызывать как через GET, так и через POST. При вызове через POST в тело запроса передается JSON с массивом UID клиентов или счетов (в зависимости от сервиса). 6 Описание сервисов НПО/ПДС/ОПС Имена сервисов в документе содержат в имени дефис, для удобства визуального восприятия. По мере завершения работы над документом дефис будет замен на символ подчёркивания. 6.1 Авторизация Механизм авторизации в БД реализован посредством проверки логина и пароля 1С. Возможно, потребуется реализация отдельных прав для такого пользователя. http://[host]/hs/unpfAPI/v1/test - тест доступности сервиса 6.2 Общие сервисы. (StatusExchange) Подтверждение успешного обмена (НПО/ПДС/ОПС) Номера сообщений используются в механизмах обмена данными для контроля доставки переданной информации. Т.к. история изменений будет передаваться с момента последнего успешного номера сообщения в рамках конкретного узла обмена. Параметры этого обмена будут скорректированы по мере необходимости или по мере реализации. 6.2.1 Описание параметров, которые следует учесть в сообщении при обмене Для подтверждения успешного прохождения обмена требуется передать информацию: ГУИД узла обмена в 1с для данной внешней системы номер последнего принятого сообщения. 6.2.2 Описание запроса и ответа для подтверждения успешного принятия сообщения из сервиса Входящие параметры: 1. ГУИД узла обмена в 1с для данной внешней системы 2. Номер сообщения (в рамках сервиса обмена) Путь к сервису: [host]/hs/unpfAPI/v1/StatusExchange/ Описание JSON запрос: Элемент Описание Тип данных ИмяМетода StatusExchange: refkey ГУИД узла обмена "refkey": "3d0e8117-cfbc-11ee-9d25-184f325a1be6" GUID msg Номер сообщения "msg": 1 Число Описание HTTP ответа: Cтрока ответа HTTP, содержит следующую информацию: Код ответа; Тело ответа. Код ответа Тело ответа Описание 200 Сервис отработал без ошибок. 401 Для пользователя не указаны настройки обмена Для пользователя не заданы настройки интеграции. 400 Не указан REFKEY узла обмена В переданных параметрах запроса отсутствует идентификатор узла REFKEY 400 Не указан MSG узла обмена В переданных параметрах запроса отсутствует номер пакета обмена 404 Не найден узел обмена по RefKey= По переданному параметру запроса не найден узел обмена 500 ОписаниеОшибки() Описание возникшей на сервере ошибки 6.3 Общие сервисы. (ClientsChg_Request) Обмен изменениями по Клиентам Примечание: Коды видов операций, выделенные жирным (1000, 3000, 4000, 5000, 6000, 7000, 8000), являются подзаголовками и в качестве кода вида операции не применяются. ПРИЛОЖЕНИЕ 2. Сведения, включаемые в анкету (досье) клиента Сведения, включаемые в анкету (досье) клиента для НКО регламентируются Приложением 3 к Положению Банка России от 12 декабря 2014 года N 444-П (с изменениями на 18 августа 2016 года) – см. ниже. Приложение 3 к Положению Банка России от 12 декабря 2014 года N 444-П "Об идентификации некредитными финансовыми организациями клиентов, представителей клиента, выгодоприобретателей, бенефициарных владельцев в целях противодействия легализации (отмыванию) доходов, полученных преступным путем, и финансированию терроризма" Сведения, включаемые в анкету (досье) клиента (с изменениями на 18 августа 2016 года) 1. Сведения, полученные в результате идентификации клиента, выгодоприобретателя, представителя клиента, бенефициарного владельца, указанные в приложениях 1 и 2 к настоящему Положению. 2. Сведения о степени (уровне) риска клиента, включая обоснование отнесения клиента к определенной степени (определенному уровню) риска клиента в соответствии с Положением Банка России N 445-П. (Пункт в редакции, введенной в действие с 15 октября 2016 года указанием Банка России от 18 августа 2016 года N 4105-У. 3. Дата начала отношений с клиентом, дата прекращения отношений с клиентом. (Пункт в редакции, введенной в действие с 15 октября 2016 года указанием Банка России от 18 августа 2016 года N 4105-У. 4. Дата оформления анкеты, даты обновлений анкеты (досье) клиента. (Пункт в редакции, введенной в действие с 15 октября 2016 года указанием Банка России от 18 августа 2016 года N 4105-У. 5. Фамилия, имя, отчество (при наличии последнего), должность сотрудника некредитной финансовой организации, принявшего решение о приеме клиента на обслуживание, а также сотрудника, заполнившего (обновившего) анкету (досье) клиента. (Пункт в редакции, введенной в действие с 15 октября 2016 года указанием Банка России от 18 августа 2016 года N 4105-У. 6. Сведения о результатах каждой проверки наличия (отсутствия) в отношении клиента информации о его причастности к экстремистской деятельности или терроризму: дата проверки, результаты проверки, при наличии информации о причастности клиента к экстремистской деятельности или терроризму указываются также номер и дата перечня организаций и физических лиц, в отношении которых имеются сведения об их причастности к экстремистской деятельности или терроризму, содержащего сведения о клиенте, или номер и дата решения межведомственного координационного органа, осуществляющего функции по противодействию финансированию терроризма, о замораживании (блокировании) денежных средств или иного имущества клиента. (Пункт в редакции, введенной в действие с 15 октября 2016 года указанием Банка России от 18 августа 2016 года N 4105-У. 7. Иные сведения по усмотрению некредитной финансовой организации.