Получение из ГИС ГМП информации, необходимой для уплаты денежных средств
Во всех запросах необходимо передавать следующие заголовки:
| Название | Тип | Обязательно | Описание |
|---|---|---|---|
X-Api-Key |
string | Да | Уникальный идентификатор магазина |
X-Signature |
string | Да | Подпись запроса |
При формировании подписи используется secret_key - секретный ключ, который находится в настройках магазина мерчанта.
Запрос
Метод: POST
- Production:
https://api.baas.kvell.group/v1/smev3/gisgmp/export-charges - Stage:
https://api.baas.stage.kvell.group/v1/smev3/gisgmp/export-charges
Параметры запроса (JSON)
| Название поля | Тип данных | Обязательность | Описание |
|---|---|---|---|
sender_id |
string | Да | УРН участника-отправителя запроса |
sender_role |
string | Нет (по умолчанию 11) |
Полномочие участника-отправителя сообщения, с которым происходит, обращение к ГИС ГМП |
page_number |
int >=1 |
Нет | Номер страницы предоставления информации |
page_length |
int 1..100 |
Нет | Количество элементов на странице |
conditions |
dict | Да | Условия для предоставления необходимой для уплаты информации |
external |
str | Нет | Признак предоставляемой информации: 0 - предоставление информации, необходимой для уплаты денежных средств в бюджетную систему РФ, за исключением начислений, администрируемых налоговыми органами РФ |
Описание поля conditions:
| Название поля | Тип поля | Обязательность | Описание |
|---|---|---|---|
kind |
string | Да | Тип запроса на предоставление информации. Допустимые значения:
|
conditions |
dict | Да | Условия для получения информации |
Указать один из следующих трёх вариантов вложенного поля conditions:
1. Условия для получения информации по УИН с указанием дополнительных параметров (при необходимости):
| Название поля | Тип поля | Обязательность | Описание |
|---|---|---|---|
typ |
string (всегда charges) |
Да | — |
start_dtime |
string (формат dateTime) | Нет | Начальная дата временного интервала запроса |
end_dtime |
string (формат dateTime) | Нет | Конечная дата временного интервала запроса |
uin_list |
list of strings (не более 100 элементов) |
Да | Список УИНов |
payment_method |
string | Нет | Признак оплаты начисления через СБП |
2. Условия для получения информации по идентификатору плательщика с указанием дополнительных параметров (при необходимости):
| Название поля | Тип поля | Обязательность | Описание |
|---|---|---|---|
typ |
string (всегда payers) |
Да | — |
inn_list |
list of strings (не более 100 элементов) |
Условно | Список ИНН ЮЛ |
payer_id_list |
list of strings (не более 100 элементов) |
Условно | Список идентификаторов плательщиков (ФЛ, ЮЛ, ИП и других) |
kbk_list |
list of strings (не более 10 элементов) |
Нет | Перечень КБК |
beneficiary |
list of elements (не более 10 элементов) |
Нет | Список для идентификации получателя средств |
Обязательно указывается либо inn_list, либо payer_id_list.
3. Условия для получения извещений о начислениях за временной интервал с указанием дополнительных параметров (при необходимости):
| Название поля | Тип поля | Обязательность | Описание |
|---|---|---|---|
typ |
string (всегда time) |
Да | — |
start_dtime |
string (формат dateTime) | Да | Начальная дата временного интервала запроса |
end_dtime |
string (формат dateTime) | Да | Конечная дата временного интервала запроса |
kbk_list |
list of strings (не более 10 элементов) |
Нет | Перечень КБК |
beneficiary |
list of elements (не более 10 элементов) |
Нет | Список для идентификации получателя средств |
Формат элемента списка для идентификации получателя средств beneficiary:
| Название поля | Тип поля | Обязательность | Описание |
|---|---|---|---|
inn |
string | Да | ИНН получателя средств |
kpp |
string | Нет | КПП получателя средств |
Пример запроса
{
"sender_id": "3eacb7",
"conditions":
{
"kind": "chargestatus",
"conditions":
{
"typ": "charges",
"uin_list": ["32117072411021588933"]
}
},
"page_length": 100,
"page_number": 1
}
Формирование подписи
Подпись X-Signature формируется конкатенацией X-Api-Key, json <тело запроса> и secret_key. Формируется sha256 от
полученной строки:
Ответ запроса
request_id— идентификатор запроса (используется далее для получения результата).
Получение результата
Метод: GET
- Production:
https://api.baas.kvell.group/v1/smev3/gisgmp/export-charges/{request_id} - Stage:
https://api.baas.stage.kvell.group/v1/smev3/gisgmp/export-charges/{request_id}
Параметры запроса в URL
| Название | Тип данных | Обязательно | Описание |
|---|---|---|---|
request_id |
string | Да | Идентификатор запроса |
Формирование подписи
Подпись X-Signature формируется конкатенацией X-Api-Key, request_id и secret_key. Формируется sha256 от
полученной строки:
Пример ответа
{
"id": "I_66a12db2-8953-2155-1664-dd95394aadb4",
"request_id": "G_cfe0c895-b33d-33bc-28d8-697f21d9e561",
"recipient_id": "3eacb7",
"timestamp": "2021-07-01T18:13:51.0",
"has_more": false,
"charges":
[
{
"uin": "32117072411021588933",
"amount_to_pay": 0,
"ack_status": "1",
"offence": false,
"bill_date": "2020-09-30T14:06:30.313+03:00",
"total_amount": 500000,
"purpose": "Плата за предоставление сведений из Единого государственного реестра недвижимости (ТЕСТОВЫЕ ДАННЫЕ!)",
"kbk": "32111301031016000130",
"oktmo": "45348000",
"payee":
{
"acc_num": "03100643000000019500",
"bank":
{
"bik": "024501901",
"corr_acc_num": "40102810045370000002"
},
"name": "ФГБУ «ФКП Росреестра» по г Москва",
"inn": "7705401341",
"kpp": "770542151"
},
"payer":
{
"id": "1010000000008751379232",
"name": "Тестовый плательщик"
},
"budget_index":
{
"status": "01",
"payt_reason": "0",
"tax_period": "0",
"tax_docnum": "0",
"tax_docdate": "0"
},
"change_status":
{
"meaning": "1"
}
}
]
}
Описание полей ответа
(о) — обязательно, (н) — необязательно; в скобках после названия поля опционально указан его тип.
- (о)
id: идентификатор ответа (возвращает РосКазна) - (о)
request_id: идентификатор запроса - (о)
recipient_id: УРН участника получателя - (о)
timestamp: дата и время формирования ответа - (о)
has_more(bool): признак конца выборки: false — достигнут конец выборки; true — после последнего предоставленного элемента в выборке имеются другие. - (н)
repeat_request(bool): признак необходимости направления повторного запроса. Присутствует в ответе, если для предоставления ответа на запроос потребовалось зайдействовать внешнюю систему и ответ от нее не был получен (внешняя система недоступна либо получено сообщение об ошибке) - (н)
charges: список извещений о начислениях; описание элемента списка:- (о)
uin: УИН - (о)
amount_to_pay(int): остаток суммы подлежащей оплате, указанной в начислении (в копейках). При переплате начисления принимает отрицательное значение; при полной оплате — значение «0». - (н)
ack_status: статус присвоенный начислению при создании квитанции - (н)
req_checkcode: КПР или код и описание ошибки - (н)
notice_term(int): поле номер 1011: количество дней от даты начисления, подлежащей уплате плательщиком, по истечении которых необходимо повторно предоставлять уведомление о начислении по подписке в случае, если оно не оплачено или сумма платежей меньше суммы к оплате, указанной в начислении - (н)
okved: код по ОКВЭД - (о)
offence(bool): признак административного правонарушения, зафиксированного специальными техническими средствами, работающими в автоматическом режиме - (о)
bill_date(YYYY-MM-DD): поле номер 4: дата, а также сведения о периоде времени, в который осуществлено начисление, либо время начисления суммы денежных средств, подлежащих уплате - (н)
valid_until(YYYY-MM-DD): поле номер 1001: дата, вплоть до которой актуально выставленное начисление - (о)
total_amount(int): поле номер 7: сумма начисления (в копейках) - (н)
purpose: поле номер 24: назначение платежа - (о)
kbk: поле номер 104: КБК - (о)
oktmo: поле номер 105: код по ОКТМО, указываемый АН или ГАН в соответствии с НПА - (н)
delivery_date(YYYY-MM-DD): поле номер 37: дата отсылки (вручения) плательщику документа с начислением в случае, если этот документ был отослан (вручен) получателем средств плательщику - (н)
legal_act: поле номер 1010: информация о нормативном правовом (правовом) акте, являющемся основанием для исчисления суммы денежных средств, подлежащих уплате - (н)
payment_term(YYYY-MM-DD): поле номер 19: срок оплаты начисления в соответствии с нормативным правовым актом - (н)
origin: поле номер 1002: признак предварительного начисления (PRIOR или TERM) - (н)
details(dict): расширенная информация о подлежащей к уплате сумме средств:- (о)
balance(int): сумма, отражающая остаток денежных средств налогоплательщика на ЕНС - (н)
debt(int): общая подлежащая к уплате сумма средств с наступившим сроком уплаты (задолженность) - (н)
upcoming(int): общая подлежащая к уплате сумма средств с ненаступившим сроком уплаты (предстоящие платежи) - (н)
info(list): описание каждого элемента списка:- (о)
typ: тип - (о)
name: наименование налога, сбора, недоимки и пени к налогу, сбору или страховому взносу - (н)
amount(int): сумма, подлежащая уплате - (н)
due_date: срок уплаты (формат YYYY-MM-DD)
- (о)
- (о)
- (н)
exclude_payments(list): сведения о платежах, исключенных из процедуры автоматического квитирования с начислением (список УПНО) - (н)
discount(dict): дополнительные условия оплаты:- (н)
value: значение - (н)
expiry: срок действия скидки, возможные значения: 1) дата окончания скидки в формате «ГГГГ-ММ-ДД»; 2) при отсутствии срока действия указывается значение «0»
- (н)
- (н)
add_data(list): поле номер 202: дополнительные поля начисления; поля каждого элемента списка:- (н)
name: наименование поля - (н)
value: значение поля
- (н)
- (н)
linked_uins(list): поле номер 1003: идентификаторы начислений, на основании которых выставлено, данное начисление - (н)
payee(dict): данные организации, являющейся получателем средств:- (о)
name: поле номер 16: наименование организации - (о)
inn: поле номер 61: ИНН организации - (о)
kpp: поле номер 103: КПП организации - (н)
ogrn: поле номер 200: ОГРН организации - (н)
acc_num: поле номер 17: номер казначейского счета или номер счета получателя средств в банке получателя - (о)
bank:- (о)
bik: поле номер 14 для получателя средств. Поле номер 11 для организации, принявшей платеж. БИК ТОФК, структурного подразделения кредитной организации или подразделения Банка России, в котором открыт счет - (н)
name: поле номер 13 для получателя средств. Поле номер 10 для организации, принявшей платеж. Наименование ТОФК, структурного подразделения кредитной организации или подразделения Банка России, в котором открыт счет - (o)
corr_acc_num: Поле номер 15 для получателя средств. Поле номер 12 для организации, принявшей платеж. Номер единого казначейского счета или корреспондентского счета кредитной организации, открытый в подразделении Банка России.
- (о)
- (о)
- (н)
payer(dict): сведения о плательщике:- (н)
name: поле номер 8: плательщик - (о)
id: поле номер 201: идентификатор плательщика - (н)
add_id: поле номер 1201: дополнительный идентификатор плательщика
- (н)
- (н)
budget_index(dict): дополнительные реквизиты платежа, предусмотренные приказом Минфина России от 12 ноября 2013 г. №107н:- (о)
status: поле номер 101: статус плательщика — реквизит 101 распоряжения - (о)
payt_reason: поле номер 106: показатель основания платежа — реквизит 106 Распоряжения - (о)
tax_period: поле номер 107: показатель налогового периода или код таможенного органа, осуществляющего в соответствии с законодательством РФ функции по выработке государственной политики и нормативному регулированию, контролю и надзору в области таможенного дела — реквизит 107 Распоряжения - (о)
tax_docnum: поле номер 108: показатель номера документа — реквизит 108 Распоряжения - (о)
tax_docdate: поле номер 109: показатель даты документа — реквизит 109 Распоряжения
- (о)
- (н)
exec_proc_info(dict): дополнительная информация, необходимая для осуществления исполнительного производства - (н)
additional_offence(dict): блок дополнительной информации об административном правонарушении:- (о)
date: дата и время нарушения (YYYY-MM-DD) - (о)
place: место нарушения - (о)
legal_act: статья нарушения - (о)
link: ссылка на фото (видео) материалов нарушения - (о)
department_name: данные о подразделении, вынесшем постановление
- (о)
- (н)
change_status(dict): сведения о статусе начисления и основаниях его изменения:- (о)
meaning(str, enum): статус, отражающий изменение данных: 1 — новый, 2 — уточнение, 3 — аннулирование, 4 — деаннулирование - (н)
reason: основание изменения - (н)
date: дата и время уточнения информации
- (о)
- (н)
reconcile_no_payments(list): сведения о фактах погашения начисления без платежа; описание элемента списка:- (о)
id: номер операции принудительного квитирования начисления с отсутствующим в ГИС ГМП платежом - (о)
amount(int): сумма операции принудительного квитирования начисления с отсутствующим в ГИС ГМП платежом
- (о)
- (о)
- (н)
offences(list): дополнительная информация административного правонарушения, зафиксированного специальными техническими средствами, работающими в автоматическом режиме; описание элемента списка (dict):- (о)
uin: УИН - (о)
date: дата и время нарушения (YYYY-MM-DD) - (о)
place: место нарушения - (о)
legal_act: статья нарушения - (о)
link: ссылка на фото (видео) материалов нарушения - (о)
department_name: данные о подразделении, вынесшем постановление
- (о)