Выгрузка информации, необходимой для внесения платы за ЖКУ через кредитные организации
Атрибут | Значение |
---|---|
Название | zhkh-export-document |
Тип | Адаптер для вида сведений |
Наименование | Выгрузка информации, необходимой для внесения платы за ЖКУ через кредитные организации |
Область применения | Межведомственное взаимодействие |
Версия | 2.0.0 |
Версия МР | 3.0 |
Версия СМЭВ | СМЭВ3 |
Переменные окружения
Название | Описание |
---|---|
CA_CERT | сертификат центра сертификации для подключения к rabbitmq |
CLIENT_CERT | сертификат, используемый для подключения к rabbitmq |
CLIENT_KEY | ключ, используемый для подключения к rabbitmq |
MQ_HOST | хост rabbitmq |
MQ_PORT | порт rabbitmq |
SMEV_SERVICE | название смэв сервиса, на который будут отправляться запросы |
Переменные для конфигурирования подключения к БД:
DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.
Переменные для конфигурирования отправки метрик в Elasticsearch:
ELASTIC_HOST, ELASTIC_PORT, ELASTIC_METRIC_PREFIX
Принимаемые параметры
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
system_id | Идентификатор информационной системы. Предоставляется в личном кабинете ГИС ЖКХ руководителя организации. | + | 3f8678e0-c69c-4bc0-998a-3be17a0ac8ad |
organization_id | Идентификатор зарегистрированной организации. Для проверки прав доступа в соответствии с п.123 Приказа. | + | f82e8882-72c1-4ba1-96be-516637c1adb7 |
payment_document_id | Идентификатор платежного документа. Строка длиной 18 символов | -1 | 40АА006173-07-9112 |
month | Месяц. Число от 1 до 12 | -2 | 11 |
year | Год. Число от 1920 до 2050 | -2 | 2019 |
unified_account_number | Единый лицевой счет. Длина 10 символов. | -1 | 40АА006173 |
service_id | Идентификатор жилищно-коммунальной услуги. Длина 13 символов. | -1 | 40АА006173-07 |
premise_address | Адрес помещения | -3 | Составной элемент PremiseAddress |
payment_document_number | Номер платежного документа, по которому внесена плата, присвоенный такому документу исполнителем в целях осуществления расчетов по внесению платы. | -1 | 123 |
account_number | Номер лицевого счета/Иной идентификатор потребителя | -1 | 0603_1211_1303_19 |
amount_required | Сведения о потребителе, необходимые для получения информации о сумме начислений/задолженности | Необязателен, если запрос не должен вернуть сумму к оплате и задолженности в соотв. с п.125 Приказа | Составной элемент AmountRequired |
1 - обязательно должен присутствовать только один из элементов
2 - не используется при наличии payment_document_id
3 - требуется при указании payment_document_number или account_number
Структура элемента PremiseAddress
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
fias_house_guid | Глобальный уникальный идентификатор дома по ФИАС | + | fd6e171f-7c3f-457a-946c-c20d9210b8e0 |
residential_premise | Номер жилого помещения | -1 | |
residential_premise_room | Номер комнаты жилого помещения | - Указывается только при наличии residential_premise |
|
residential_block | Номер жилого блока | -1 | |
residential_block_room | Номер комнаты жилого блока | - Указывается при наличии residential_block |
|
non_residential_apartment | Номер нежилого помещения | -1 | |
non_residential_block | Номер нежилого блока | -1 |
1 - требуется наличие только одного элемента
Структура элемента AmountRequired
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
fio | Потребитель-физическое лицо, в том числе индивидуальный предприниматель | -1 | Составной элемент FIO |
legal | Юридическое лицо | -1 | Составной элемент Legal |
1 - должен присутствовать только один элемент
Структура элемента FIO
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
name | Имя | + | Иван |
surname | Фамилия | + | Иванов |
partonymic | Отчество | - | Иванович |
Структура элемента Legal
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
inn | ИНН | + | 133968666975 |
kpp | КПП | + | 310082589 |
Параметры ответа
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
payment_documents | Платежные документы | -1 | Последовательность элементов типа PaymentDocument |
services | Сведения об ИЖКУ (при отсутствии начислений по лицевому счету) | -1 | Последовательнось элементов типа Service |
error | Ошибка контроля или бизнес-процесса | -1 | Составной элемент Error |
1 - должно присутствовать только одно из полей
Структура элемента PaymentDocument
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
payment_document_id | Идентификатор платежного документа | + | 40АА006173-07-9112 |
payment_document_guid | GUID платежного документа | + | 154f08b0-6b78-4f10-a7d5-4c559df5a527 |
payment_document_number | Номер платежного документа, по которому внесена плата, присвоенный такому документу исполнителем в целях осуществления расчетов по внесению платы | + | 123 |
service_id | Идентификатор жилищно-коммунальной услуги | + | 40АА006173-07 |
service_id_guid | GUID идентификатора жилищно-коммунальной услуги | + | 204f6163-06d5-4542-a0ab-31c37f9dbd7b |
account_number | Номер лицевого счета/иной идентификатор потребителя | + | 0603_1211_1303_19 |
unified_account_number | Единый лицевой счет | + | 40АА006173 |
payment_document_details | Сведения, содержащиеся в платежном документе | + | Структура элемента PaymentDocumentDetails |
month | Месяц | - | 11 |
year | Год | - | 2019 |
Структура элемента Service
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
unified_account_number | Единый лицевой счет | + | 00АА008969 |
account_number | Номер лицевого счета/иной идентификатор потребителя | - | 0603_1211_1304_19 |
service_id | Идентификатор жилищно-коммунальной услуги | + | 00АА008969-01 |
service_id_guid | GUID идентификатор жилищно-коммунальной услуги | + | 664adf41-14e5-452d-bc8c-974bc4087347 |
executor_information | Сведения об исполнителе | + | Составной элемент ServiceExecutorInformation |
purpose | Назначение платежа | - | |
service_name | Наименование услуги (работы), оказываемой (выполняемой) исполнителем, штрафной санкции | - |
Структура элемента Error
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
error_code | Код ошибки | + | INT002012 |
description | Описание ошибки | + | Нет объектов для экспорта |
stacktrace | StackTrace в случае возникновения исключения | - |
Структура элемента PaymentDocumentDetails
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
consumer_information | Сведения о потребителе | - | Составной элемент ConsumerInformation |
executor_information | Сведения об исполнителе | + | Составной элемент ExecutorInformation |
reminder | Сумма к оплате (в копейках) | + | 3880 |
error | Ошибка контроля или бизнес-процесса | -1 | Составной элемент Error |
debt | Задолженность (в копейках) | -1 | 1000 |
total_with_debt_and_advance | -1 | 10000 | |
purpose | Назначение платежа | - | 0603_1211_1303_19.Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1 |
service_name | Наименование услуги (работы), оказываемой (выполняемой) исполнителем, штрафной санкции | - |
1 - отсутствие элемента error допускает возможность наличия debt и total_with_debt_and_advance
Структура элемента ConsumerInformation
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
individual_entrepreneur | Потребитель - индивидуальный предприниматель | -1 | Составной элемент IndividualEntrepreneur |
legal | Потребитель - юридическое лицо | -1 | Составной элемент Legal |
addresses | Адреса помещений | + | Последовательность элементов Address |
1 - должен присутствовать только один из элементов
Структура элемента IndividualEntrepreneur
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
inn | ИНН | + | 960313856307 |
Структура элемента Legal
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
name | Наименование | + | Тест |
inn | ИНН | + | 8770260323 |
kpp | КПП | + | 660023578 |
Структура элемента ExecutorInformation
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
inn | ИНН | + | 6208337627 |
individual_entrepreneur | Исполнитель ИП | -1 | Составной элемент ExecutorIndividualEntrepreneur |
legal | Исполнитель ЮЛ | -1 | Составной элемент ExecutorLegal |
payment_informations | Сведения о платежных реквизитах организации | + | Последовательность элементов PaymentInformation |
mailing_address | Почтовый адрес | + | Ивановская обл, г. Иваново, ул. Красной Армии |
1 - должен присутствовать только один из элементов
Структура элемента ServiceExecutorInformation
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
individual_entrepreneur | Исполнитель ИП | -1 | Составной элемент IndividualEntrepreneur |
legal | Исполнитель ЮЛ | -1 | Составной элемент ExecutorLegal |
payment_informations | Сведения о платежных реквизитах организации | + | Последовательность элементов ServicePaymentInformation |
mailing_address | Почтовый адрес | + | Ивановская обл, г. Иваново, ул. Красной Армии |
1 - должен присутствовать один из элементов
Структура элемента ExecutorIndividualEntrepreneur
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
fio | Фамилия Имя Отчество | + | Составной элемент ExecutorFIO |
Структура элемента ExecutorLegal
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
name | Наименование | + | Тест |
kpp | КПП | - | 660023578 |
Структура элемента ExecutorFIO
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
name | Имя | + | Иван |
surname | Фамилия | + | Иванов |
partonymic | Отчество | - | Иванович |
Структура элемента PaymentInformation
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
payment_information_guid | GUID платежных реквизитов в платежном документе | + | 82eb1632-a48b-4421-ac23-d965a2f0aadd |
amount | Сумма к оплате за расчетный период по получателю платежа (в копейках) | + | 3880 |
account_number | Номер лицевого счета/Иной идентификатор потребителя | - | |
service_id | Идентификатор жилищно-коммунальной услуги | - | |
error | Ошибка контроля или бизнес-процесса | -1 | Составной элемент Error |
debt_or_advance | Задолженность за предыдущие периоды/Аванс на начало расчетного периода (учтены платежи, поступившие до 25 числа включительно) по получателю платежа (в копейках) | -1 | |
total_with_debt_and_advance | Итого к оплате c учетом задолженности/переплаты по получателю платежа (в копейках) | -1 | |
recipient_inn | ИНН получателя платежа | + | 1233540515 |
recipient_kpp | КПП получателя платежа | + | 623061546 |
bank_name | Наименование банка-получателя платежа | + | БАЙКОНУРСКИЙ ФИЛИАЛ АО "ФОНДСЕРВИСБАНК" |
payment_recipient | Наименование получателя | + | АДМИНИСТРАЦИЯ ЗАКРЫТОГО АДМИНИСТРАТИВНО-ТЕРРИТОРИАЛЬНОГО ОБРАЗОВАНИЯ ГОРОДА ЗАОЗЕРСКА МУРМАНСКОЙ ОБЛАСТИ |
bik | БИК банка получателя | + | 040037470 |
operating_account_number | Номер расчетного счета | + | 40702810602051004207 |
correspondent_account_number | Корр. счет банка получателя | + | 30101810300000000470 |
kbk | Код из Классификатора доходов в бюджет | - | |
oktmo | Код из Общероссийского классификатора территорий муниципальных образований | - | |
number_budgetary_account | Номер лицевого счета, открытый в органах Федерального казначейства (финансовых органах) | - | |
is_capital_repair | Платежные реквизиты для платежей капитального ремонта | - |
1 - элементы не обязательные, но error и пара debt_or_advance и total_with_debt_and_advance взаимоисключающие
Структура элемента ServicePaymentInformation
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
payment_information_guid | GUID платежных реквизитов в платежном документе | + | 82eb1632-a48b-4421-ac23-d965a2f0aadd |
recipient_inn | ИНН получателя платежа | + | 1233540515 |
recipient_kpp | КПП получателя платежа | + | 623061546 |
bank_name | Наименование банка получателя платежа | + | БАЙКОНУРСКИЙ ФИЛИАЛ АО "ФОНДСЕРВИСБАНК" |
payment_recipient | Наименование получателя | + | АДМИНИСТРАЦИЯ ЗАКРЫТОГО АДМИНИСТРАТИВНО-ТЕРРИТОРИАЛЬНОГО ОБРАЗОВАНИЯ ГОРОДА ЗАОЗЕРСКА МУРМАНСКОЙ ОБЛАСТИ |
bik | БИК банка получателя | + | 040037470 |
operating_account_number | Номер расчетного счета | + | 40702810602051004207 |
correspondent_account_number | Корр. счет банка получателя | + | 30101810300000000470 |
kbk | Код из Классификатора доходов в бюджет | - | |
oktmo | Код из Общероссийского классификатора территорий муниципальных образований | - | |
number_budgetary_account | Номер лицевого счета, открытый в органах Федерального казначейства (финансовых органах) | - | |
is_capital_repair | Платежные реквизиты для платежей капитального ремонта | - |
Структура элемента Address
Параметр | Описание | Обязательное | Пример |
---|---|---|---|
fias_house_guid | Глобальный уникальный идентификатор дома по ФИАС | + | 0ea2c85e-9fdd-4fdf-86bd-32a4108033aa |
region | Субъект РФ | + | Ивановская |
area | Район | - | |
city | Город | - | Иваново |
settlement | Населенный пункт | - | Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1 |
street | Улица | - | Болотная |
house_number | Номер дома | - | 1А |
building_number | Номер корпуса | - | |
struct_number | Номер строения | - | |
residential_premise | Номер жилого помещения | - | 1 |
residential_premise_room | Номер комнаты жилого помещения | - | |
residential_block | Номер жилого блока | - | |
residential_block_room | Номер комнаты жилого блока | - | |
non_residential_apartment | Номер нежилого помещения | - | |
non_residential_block | Номер нежилого блока | - | |
address_string | Неформализованное описание адреса | + | Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1 |
Примеры
Запрос сведений о начислениях по адресу жилого помещения, номеру лицевого счета, присвоенного исполнителем услуги, и периоду, на который имеется размещенный платежный документ, по которому остаток к оплате больше нуля:
{
"system_id": "3f8678e0-c69c-4bc0-998a-3be17a0ac8ad",
"organization_id": "f82e8882-72c1-4ba1-96be-516637c1adb7",
"premise_address": {
"fias_house_guid": "fd6e171f-7c3f-457a-946c-c20d9210b8e0",
"residential_premise": 1
},
"account_number": "0603_1211_1303_19"
}
Ответ:
{
"payment_documents": [
{
"payment_document_id": "40АА006173-07-9112",
"payment_document_guid": "154f08b0-6b78-4f10-a7d5-4c559df5a527",
"payment_document_number": "123",
"service_id": "40АА006173-07",
"service_id_guid": "204f6163-06d5-4542-a0ab-31c37f9dbd7b",
"account_number": "0603_1211_1303_19",
"unified_account_number": "40АА006173",
"payment_document_details": {
"consumer_information": {
"addresses": [
{
"fias_house_guid": "0ea2c85e-9fdd-4fdf-86bd-32a4108033aa",
"region": "Ивановская",
"city": "Иваново",
"settlement": "Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1",
"street": "Болотная",
"house_number": "1А",
"residential_premise": "1",
"address_string": "Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1"
}
]
},
"executor_information": {
"inn": "6208337627",
"legal": {
"name": "Общество с ограниченной ответственностью \"ИвТБС\"",
"kpp": "623061546"
},
"payment_information": {
"recipient_inn": "1233540515",
"recipient_kpp": "623061546",
"bank_name": "БАЙКОНУРСКИЙ ФИЛИАЛ АО \"ФОНДСЕРВИСБАНК\"",
"payment_recipient": "АДМИНИСТРАЦИЯ ЗАКРЫТОГО АДМИНИСТРАТИВНО-ТЕРРИТОРИАЛЬНОГО ОБРАЗОВАНИЯ ГОРОДА ЗАОЗЕРСКА МУРМАНСКОЙ ОБЛАСТИ",
"bik": "040037470",
"operating_account_number": "40702810602051004207",
"correspondent_account_number": "30101810300000000470",
"payment_information_guid": "82eb1632-a48b-4421-ac23-d965a2f0aadd",
"amount": "3880"
},
"mailing_address": "Ивановская обл, г. Иваново, ул. Красной Армии",
"payment_informations": [
{
"recipient_inn": "1233540515",
"recipient_kpp": "623061546",
"bank_name": "БАЙКОНУРСКИЙ ФИЛИАЛ АО \"ФОНДСЕРВИСБАНК\"",
"payment_recipient": "АДМИНИСТРАЦИЯ ЗАКРЫТОГО АДМИНИСТРАТИВНО-ТЕРРИТОРИАЛЬНОГО ОБРАЗОВАНИЯ ГОРОДА ЗАОЗЕРСКА МУРМАНСКОЙ ОБЛАСТИ",
"bik": "040037470",
"operating_account_number": "40702810602051004207",
"correspondent_account_number": "30101810300000000470",
"payment_information_guid": "82eb1632-a48b-4421-ac23-d965a2f0aadd",
"amount": "3880"
}
]
},
"reminder": "3880",
"purpose": "0603_1211_1303_19.Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1"
},
"month": "11",
"year": "2019"
},
{
"payment_document_id": "40АА006173-07-9111",
"payment_document_guid": "caaeb579-6d9a-4822-9cb1-bb249df54917",
"payment_document_number": "124",
"service_id": "40АА006173-07",
"service_id_guid": "204f6163-06d5-4542-a0ab-31c37f9dbd7b",
"account_number": "0603_1211_1303_19",
"unified_account_number": "40АА006173",
"payment_document_details": {
"consumer_information": {
"addresses": [
{
"fias_house_guid": "0ea2c85e-9fdd-4fdf-86bd-32a4108033aa",
"region": "Ивановская",
"city": "Иваново",
"settlement": "Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1",
"street": "Болотная",
"house_number": "1А",
"residential_premise": "1",
"address_string": "Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1"
}
]
},
"executor_information": {
"inn": "6208337627",
"legal": {
"name": "Общество с ограниченной ответственностью \"ИвТБС\"",
"kpp": "623061546"
},
"payment_information": {
"recipient_inn": "2224132840",
"recipient_kpp": "623061546",
"bank_name": "УФК по Вологодской области",
"payment_recipient": "Общество с ограниченной ответственностью \"ИвТБС\"",
"bik": "001908152",
"operating_account_number": "40705810825000000266",
"payment_information_guid": "7174eb4e-4cce-4b5f-a249-041a2699f8b5",
"amount": "3880"
},
"mailing_address": "Ивановская обл, г. Иваново, ул. Красной Армии",
"payment_informations": [
{
"recipient_inn": "2224132840",
"recipient_kpp": "623061546",
"bank_name": "УФК по Вологодской области",
"payment_recipient": "Общество с ограниченной ответственностью \"ИвТБС\"",
"bik": "001908152",
"operating_account_number": "40705810825000000266",
"payment_information_guid": "7174eb4e-4cce-4b5f-a249-041a2699f8b5",
"amount": "3880"
}
]
},
"reminder": "3880",
"purpose": "0603_1211_1303_19.Ивановская обл, г. Иваново, ул. Болотная, д. 1А, кв. 1"
},
"month": "11",
"year": "2019"
}
]
}
Запрос по адресу жилого помещения, номеру лицевого счета, присвоенного исполнителем услуги, и периоду, на который не были размещены платежные документы:
{
"system_id": "3f8678e0-c69c-4bc0-998a-3be17a0ac8ad",
"organization_id": "f82e8882-72c1-4ba1-96be-516637c1adb7",
"premise_address": {
"fias_house_guid": "0ea2c85e-9fdd-4fdf-86bd-32a4108033aa",
"residential_premise": 1
},
"account_number": "0603_1211_1304_19"
}
Ответ:
{
"services": [
{
"unified_account_number": "00АА008969",
"account_number": "0603_1211_1304_19",
"service_id": "00АА008969-01",
"service_id_guid": "664adf41-14e5-452d-bc8c-974bc4087347",
"executor_information": {
"inn": "6208337627",
"individual_entrepreneur": {
"fio": {
"firstname": "Кирилл",
"lastname": "Владимирцев",
"middlename": "Григорьевич"
}
},
"mailing_address": "Ивановская обл, г. Иваново, ул. Красной Армии",
"payment_informations": [
{
"recipient_inn": "3653562836",
"recipient_kpp": "623061546",
"bank_name": "БАЙКОНУРСКИЙ ФИЛИАЛ АБ \"РОССИЯ\"",
"payment_recipient": "Общество с ограниченной ответственностью \"ИвТБС\"",
"bik": "040037471",
"operating_account_number": "40702810164000050006",
"correspondent_account_number": "30101810000370000471",
"payment_information_guid": "6534a320-ae8e-447c-946c-956204d8c520"
},
{
"recipient_inn": "1233540515",
"recipient_kpp": "623061546",
"bank_name": "БАЙКОНУРСКИЙ ФИЛИАЛ АО \"ФОНДСЕРВИСБАНК\"",
"payment_recipient": "АДМИНИСТРАЦИЯ ЗАКРЫТОГО АДМИНИСТРАТИВНО-ТЕРРИТОРИАЛЬНОГО ОБРАЗОВАНИЯ ГОРОДА ЗАОЗЕРСКА МУРМАНСКОЙ ОБЛАСТИ",
"bik": "040037470",
"operating_account_number": "40702810602051004207",
"correspondent_account_number": "30101810300000000470",
"payment_information_guid": "82eb1632-a48b-4421-ac23-d965a2f0aadd"
}
]
}
}
]
}
Запрос по несуществующему адресу жилого помещения и номеру лицевого счета, присвоенного исполнителем услуги
{
"system_id": "3f8678e0-c69c-4bc0-998a-3be17a0ac8ad",
"organization_id": "f82e8882-72c1-4ba1-96be-516637c1adb7",
"premise_address": {
"fias_house_guid": "0ea2c85e-9fdd-4fdf-86bd-32a4108033aa",
"residential_premise": 1
},
"account_number": "10АА091447"
}
Ответ:
{
"error": {
"error_code": "INT002012",
"description": "Нет объектов для экспорта"
}
}