Подсистема обмен УНПФ: различия между версиями

Материал из OrticonWiki
Перейти к навигации Перейти к поиску
Нет описания правки
Нет описания правки
Строка 41: Строка 41:
*[[#6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам|<span style="color:#000000"><small>6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам</small></span>]]
*[[#6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам|<span style="color:#000000"><small>6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам</small></span>]]
*[[#6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)|<span style="color:#000000"><small>6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)</small></span>]]
*[[#6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)|<span style="color:#000000"><small>6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)</small></span>]]
*[[#6.4.1 Описание объектов, которые подлежат учёту изменений по ПС и ПД в учете НПО и используются при обмене данными|<span style="color:#000000"><small>6.4.1 Описание объектов, которые подлежат учёту изменений по ПС и ПД в учете НПО и используются при обмене данными</small></span>]]
</div>
</div>
|style="vertical-align:top;|
|style="vertical-align:top;|
Строка 1368: Строка 1369:
<h2>'''6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)'''</h2>
<h2>'''6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)'''</h2>


Регистрация изменений ведется по всем ПС и ПД (НПО).
<h2>'''6.4.1 Описание объектов, которые подлежат учёту изменений по ПС и ПД в учете НПО и используются при обмене данными'''</h2>
[[Категория:УНПФ| ]]
[[Категория:УНПФ| ]]

Версия от 13:08, 22 июля 2025

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

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

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

Версия документа

  • 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) Обмен изменениями по Клиентам

Учет регистрации изменений ведется во всем контрагентам ФЛ с флагом «хранить данные перс. учета» и по всем ЮЛ. В рамках данного сервиса передаются персональные данные по ЮЛ/ФЛ без отбора по НПО/ПДС/ОПС и т.п.

Наличие ПС по НПО/ПДС/ОПС проверяется по Справочнику уп_ПенсионныеСчета, пдс_ПенсионныеСчета, уп_ДоговорыОПС соответственно.

6.3.1 Описание параметров, которые подлежат регистрации по ФЛ/ЮЛ и используются при обмене данными

Объекты для учета регистрации изменений и последующей передаче через сервис

Регистрация ФЛ проводится только тех, у кого стоит флаг «Хранить данные перс.учета»

1. Объекты контроля для регистрации изменений:

1.1. Справочник. Контрагенты

1.2. Справочник.ФизЛица

1.3. РС. ФИОФизическихЛиц

1.4. РС. ФизическиеЛицаДокументов

2. Извлекаемые данные из объектов контроля для передачи через сервис:

2.1. ФЛ:

2.1.1. ТипКонтрагента (1-ФЛ, 2-ЮЛ, 0 — это ошибка в базе)

2.1.2. ГУИД контрагента /guidClient

2.1.3. Дата последнего изменения персональных данных клиента, в Формате ДатаВремя

2.1.4. КодКонтрагента / npoCode /

2.1.5. Контрагент-ПометкаНаУдаление

2.1.6. СНИЛС/ snils

2.1.7. ИНН/ inn

2.1.8. ФИО:

2.1.8.1. Фамилия/ surname

2.1.8.2. Имя/ name

2.1.8.3. Отчество/ patronymic

2.1.9. ФИО при рождении / birthPersonal

2.1.9.1. Фамилия/ surname

2.1.9.2. Имя/ name

2.1.9.3. Отчество/ patronymic

2.1.10. Пол/ sex

2.1.11. ДатаРождения/ birthDate

2.1.12. МестоРождения/ birthPlace

2.1.13. ДатаСмерти/ deathDate

2.2. Сведения о наличии правопреемников:

2.2.1. Есть назначенные ПП в НПО (Проверка через заявления ЗаявлениеОНаличииПравопреемниковНПО) – Тип Булево

2.2.2. Есть назначенные ПП в ПДС(Проверка через заявления ЗаявлениеОНаличииПравопреемниковПДС) – Тип Булево

2.2.3. Есть назначенные ПП в ОПС(Проверка через заявления ЗаявлениеОНаличииПравопреемниковОПС) – Тип Булево

2.3. Контактная информация (коллекция телефонов, адресов, email):

2.3.1. Номер по порядку

2.3.2. ТипКонтактнойИнформации – см. Табл.1 «Типы и виды контактной информации ФЛ»

2.3.3. ВидКонтактнойИнформации - – см. Табл.1 «Типы и виды контактной информации ФЛ»

2.3.4. Значение (Представление)/ singleString

2.3.4.1. Структура Адреса: (заполняется только, если ТипКонтактнойИнформации= Адрес). Поля структуры адреса могут быть скорректированы.

2.3.4.2. Адрес в формате JSON.

2.3.4.3. Страна/country

2.3.4.4. Регион представление/ regionName

2.3.4.5. Город/ town

2.4. Документ, удостоверяющий личность (паспорт) – коллекция документов:

2.4.1. Код (код документа)/ code – виды кодов представлены в табл.2 «Коды документов»

2.4.2. Серия/ seria

2.4.3. Номер/ number

2.4.4. Дата (дата выдачи)/ date

2.4.5. Кем выдан/ org

2.4.6. Код кем выдан/ orgCode – только для паспорта РФ

2.5. ЮЛ:

2.5.1. ТипКонтрагента=Булево (1-ФЛ, 2-ЮЛ, 0 — это косяк в базе)

2.5.2. ГУИД контрагента / guidClient

2.5.3. Дата последнего изменения персональных данных клиента, в Формате ДатаВремя

2.5.4. КодКонтрагента /npoCode/

2.5.5. ИНН/ inn

2.5.6. КПП

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

2.5.8. Полное наименование

2.5.9. Контрагент-ПометкаНаУдаление

2.6. Сведения о наличии ПС:

2.6.1. Есть НПО- Истина, если является участником/вкладчиком НПО, иначе Ложь

2.6.2. Есть ПДС- Истина, если является участником/вкладчиком ПДС, иначе Ложь

2.6.3. Есть ОПС - Истина, если является участником ОПС, иначе Ложь

Табл.1 «Типы и виды контактной информации ФЛ»

ТипКонтактнойИнформации ВидКонтактнойИнформации Код
Телефон Мобильный телефон
Телефон Рабочий телефон
Телефон Домашний телефон
Адрес Адрес по прописке (регистрации) AddressReg
Адрес Адрес места проживания AddressFact
Адрес Адрес за пределами РФ AddressFrgn
Адрес Адрес для информирования AddressInfo
Адрес для адресов, для которых указан произвольный вид unknown
Адрес Email

Указаны предопределенные типы и виды контактной информации, но они могут быть расширены в рамках пользовательских настроек системы.

Табл.2 «Коды документов»

Код Наименование
01 Паспорт гражданина СССР
02 Загранпаспорт гражданина СССР
03 Свидетельство о рождении
04 Удостоверение личности офицера
05 Справка об освобождении
06 Паспорт Минморфлота
07 Военный билет солдата (матроса, сержанта, старшины)
08 Временное удостоверение, выданное взамен военного билета
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
09 Дипломатический паспорт гражданина РФ
10 Иностранный паспорт
11 Свидетельство о регистрации ходатайства иммигранта о признании его беженцем
12 Вид на жительство
13 Удостоверение беженца
14 Временное удостоверение личности гражданина РФ
15 Разрешение на временное проживание в Российской Федерации
18 Свидетельство о предоставлении временного убежища на территории Российской Федерации
21 Паспорт гражданина РФ
22 Загранпаспорт гражданина РФ
23 Свидетельство о рождении, выданное уполномоченным органом иностранного государства
24 Удостоверение личности военнослужащего Российской Федерации
26 Паспорт моряка
27 Военный билет офицера запаса
91 Иные документы, выдаваемые органами МВД

6.3.2 Описание Запроса и ответа на Обмен изменениями по Клиентам

Параметры: ID узла обмена / ключ

Путь к сервису: [host]/…/ClientsChg_Request

Описание JSON запрос:

Элемент Описание Тип данных
ИмяМетода ClientsChg_Request
Без параметров

Описание JSON ответа:

Структура объекта «package» - содержит GUID узла, зарегистрировавшего изменения и номер пакета сообщения

Элемент Описание Тип данных
RefKey ГУИД узла изменений GUID
Msg Номер пакета сообщения Число

Структура массива объектов «clients» - информация о контрагентах

Элемент Описание Тип данных
RefKey ГУИД контрагента GUID
Exist Признак найденного контрагента по ГУИД Boolean
client Объект с подробной информацией о контрагенте ЮЛ Объект

Структура объекта «client» для Юридических лиц

Элемент Описание Тип данных
Type Тип контрагента 2 – Юридическое лицо Число
Code Код контрагента Строка
DeletionMark Признак пометки на удаление Boolean
DateChg Дата последнего изменения персональных данных клиента ДатаВремя
Inn ИНН контрагента Строка
Kpp КПП контрагента Строка
Name Наименование контрагента Строка
FullName Полное наименование контрагента Строка

Структура объекта «client» для Физических лиц

Элемент Описание Тип данных
Type Тип контрагента 1 – Физическое лицо Число
Code Код контрагента Строка
DeletionMark Признак пометки на удаление Boolean
Inn ИНН контрагента Строка
Inn ИНН контрагента Строка
Snils СНИЛС контрагента Строка
Sex Пол контрагента: «М» - мужской, «Ж» - женский Строка[1]
BirthDate Дата рождения Дата
BirthPlace Место рождения Строка
DeathDate Дата смерти Дата
Personal ФИО контрагента Объект
BirthPersonal ФИО при рождении Строка
Snils СНИЛС контрагента Строка
Documents Документы удостоверяющие личность контрагента Массив объектов
Phones Телефоны контрагента Массив объектов
Emails Электронные адреса контрагента Массив объектов
Addresses Адреса контрагента Массив объектов
statements Участие контрагента в программах фонда Объект

Таблица. Значения статусов контрагента по пенсионным счетам НПО

Значения статуса
Выплатной период
Начисления приостановлены
Накопительный период
Подготовка к закрытию
Закрыт
Ожидание взносов
Без определенного состояния

Структура объекта «Personal»

Элемент Описание Тип данных
Surname Имя Строка
Name Фамилия Строка
Patronymic Отчество Строка

Структура объекта «Documents» - документы, удостоверяющие личность (ДУЛ) последние на дату (возможны разные виды документов, действующих на дату выгрузки)

Элемент Описание Тип данных
Code Код документа, соответствует справочнику кодов ДУЛ в табл.2 «Коды документов» Число
Seria Серия ДУЛ Строка
Number Номер ДУЛ Строка
Date Дата выдачи документа Дата
Org Орган, выдавший ДУЛ Строка
OrgCode Код подразделения Строка

Структура объекта «Phones» - телефоны контрагента

Элемент Описание Тип данных
Type Тип телефона (мобильный/домашний…) Строка
Value Номер телефона (формат: +Ц (ЦЦЦ) ЦЦЦЦЦЦЦ) Строка

Структура объекта «Emails» - электронные адреса контрагента

Элемент Описание Тип данных
Type Тип электронного адреса Строка
Value Электронный адрес Строка

Структура объекта «Addresses» - адреса контрагента

Элемент Описание Тип данных
Type Тип адреса (по прописке, регистрации….) Строка
TypeCode Код типа адреса Строка
Value Представление адреса Строка
AddressJSON Адрес по элементам Объект
Country Страна Строка
Region Регион Строка
Town Населенный пункт Строка

Таблица. Значения Кодов типов адреса

Код Описание
AddressReg Адрес регистрации
AddressFact Адрес проживания
AddressInfo Адрес для информирования
AddressFrgn Адрес за пределами РФ
unknown неопределено (для адресов, для которых указан произвольный вид)

Структура объекта «AddressJSON» - элементы адреса контрагента

(Внимание: Состав полей в структуре не является фиксированным и может отличаться в зависимости от типа адреса.)
Элемент Описание Тип данных
version Версия структуры адреса Число
value Представление адреса Строка
comment Комментарий к адресу Строка
type Тип контактной информации Строка
addressType Тип заполнения структуры адреса - Административно-территориальное деление/Муниципальное деление/Адрес в свободной форме Строка
id Уникальный идентификатор адреса Строка
country Страна Строка
countryCode Код страны Строка
ZIPcode Почтовый индекс Строка
areaCode Код региона Строка
area Наименование региона Строка
areaType Тип региона Строка
areaValue Представление региона Строка
areaCode Код региона Строка
areaId Идентификатор региона Строка
city Наименование города Строка
cityType Тип города Строка
cityId Идентификатор города Строка
district Наименование района Строка
districtType Тип района Строка
districtId Идентификатор района Строка
munDistrict Наименование муниципального района Строка
munDistrictType Тип муниципального района Строка
munDistrictId Идентификатор муниципального района Строка
cityDistrict Внутригородской район Строка
cityDistrictType Тип внутригородского района Строка
locality Наименование населенного пункта Строка
localityType Тип населенного пункта Строка
localityId Идентификатор населенного пункта Строка
territory Наименование территории Строка
territoryType Тип территории Строка
territoryId Идентификатор территории Строка
settlement Наименование поселения Строка
settlementType Тип поселения Строка
settlementId Идентификатор поселения Строка
street Наименование улицы Строка
streetType Тип улицы Строка
streetId Идентификатор улицы Строка
stead Номер земельного участка Строка
steadId Идентификатор земельного участка Строка
houseNumber Номер здания Строка
houseType Тип здания Строка
houseId Идентификатор здания Строка
buildings Массив с информацией о строениях, корпусах. Элементы массива – структура с полями «type», «number». Массив объектов
apartments Массив с информацией о квартирах, помещениях. Элементы массива – структура с полями «type», «number». Массив объектов
codeKLADR Код адреса по КЛАДР Строка
oktmoBudget ОКТМО бюджетополучателя Строка
oktmo ОКТМО адреса Строка
okato ОКАТО адреса Строка
ifnsFLCode Код ИФНС для физических лиц Строка
ifnsULCode Код ИФНС для юридических лиц Строка
ifnsFLAreaCode Код ИФНС региона для физических лиц Строка
ifnsULAreaCode Код ИФНС региона для юридических лиц Строка
munLevels Массив уровней адреса в формате «Муниципальный» Массив объектов
admLevels Массив уровней адреса в формате «Административно-территориальный») Массив объектов

Структура объекта «buildings»

Элемент Описание Тип данных
type Тип здания (строение, корпус….) Строка
number Номер здания Строка

Структура объекта «apartments»

Элемент Описание Тип данных
type Тип помещения (квартира….) Строка
number Номер помещения Строка

Структура объекта «statements»

Элемент Описание Тип данных
OPS Наличие договора/счета ОПС Boolean
NPO Наличие договора/счета НПО Boolean
PDS Наличие договора/счета ПДС Boolean

6.4 Сервисы по НПО. (NPO_PSChg_Request) Обмен изменениями по ПС и ПД (НПО)

Регистрация изменений ведется по всем ПС и ПД (НПО).

6.4.1 Описание объектов, которые подлежат учёту изменений по ПС и ПД в учете НПО и используются при обмене данными