Экспорт сущностей из ИС УНП Общий формат запроса
В сообщении запроса в теге RequestMessage должен передаваться тег ExportRequest, структура которого приведена в файле MessageData.xsd (см. раздел 7. «XML-схемы сущностей ИС УНП»). Описание параметров представлено в таблице 25.
Таблица . «Структура запроса на экспорт»
Наименование
|
Кол-во тегов, обязательность тега или атрибута
|
Тип данных
|
Комментарий
|
ExportRequest
|
1, обязательно
|
DataRequest
|
Корневой тег запроса.
|
Id (атрибут)
|
0..1, необязателен
|
ID
|
Необходим для наложения ЭП в формате XadES. Должен иметь структуру <буква [A-Z]>_<GUID>. Обязателен при наложении ЭП под запросом или для обращения к БД УНП.
|
kind (атрибут)
|
1, обязательно
|
String
|
Атрибут, устанавливающий тип запроса. Допустимые значения описаны в п.п. 5.4.2 – 5.4.8.
|
originatorID (атрибут)
|
0..1, необязательно
|
URNType (см. описание в п. 2.5.7.10)
|
УРН участника косвенного взаимодействия, полученный при регистрации в ГИС ГМП.
|
EsiaUserInfo
|
0..1, необязательно
|
Контейнер
|
Информация, подтверждающая аутентификацию плательщика (пользователя) в ЕСИА.
Данный блок заполняется при запросе на экспорт по идентификатору плательщика извещений о начислениях, администрируемых налоговыми органами Российской Федерации.
Обязательность заполнения данного блока определяется внутренними настройками ГИС ГМП.
|
userId (атрибут)
|
1, обязательно
|
Integer
|
Уникальный идентификатор учетной записи плательщика (пользователя) в системе ЕСИА.
Соответствует числовому идентификатору учетной записи пользователя, полученному поставщиком услуг (Участником ГИС ГМП) из ЕСИА.
|
sessionIndex (атрибут)
|
0..1, необязательно
|
String
|
Уникальный идентификатор сессии плательщика (пользователя) в системе ЕСИА
|
sessionDate (атрибут)
|
0..1, необязательно
|
DateTime
|
Дата и время аутентификации пользователя в системе ЕСИА.
Соответствует дате начала действия сессии (sessionIndex) пользователя, предоставленной системой ЕСИА, на запрос поставщика услуг (Участника ГИС ГМП).
|
Filter
|
1, обязательно
|
Контейнер
|
Фильтр для получения сущностей из ИС УНП. (или из ГИС ГМП)
|
Conditions
|
1, обязательно
|
Контейнер
|
Условие для получения сущностей из ИС УНП.
|
AllDateCatalog (атрибут)
|
0..1, необязательно
|
boolean
|
Признак выгрузки каталога услуг (используется только для запроса экспорта каталога услуг из ИС УНП).
True - выгрузка полного каталога (при передаче признака полной выгрузки, тег Timeslot не должен быть указан в запросе).
False - выгрузка изменений каталога (при передаче признака для выгрузки изменений, в запросе должен присутствовать тег Timeslot со значениями временного интервала, за который запрашиваются изменения услуг).
|
ChargesIdentifiers
|
0..1, необязательно
|
Контейнер
|
Список УИН, по которым запрашиваются сущности.
Наличие этого тега исключает тег Payers.
|
SupplierBillID
|
1..100, обязательно
|
Token
|
УИН.
При запросе данных начислений соответствует атрибуту supplierBillID начисления.
При запросе данных платежей соответствует тегу SupplierBillID платежа.
При запросе данных квитанций соответствует УИН начисления (указан в атрибуте supplierBillID), на которое ссылается квитанция.
Запрос выполняется или в ИС УНП или в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При выполнении в одной из указанных систем запрос может быть множественным, при этом итоговая выгрузка будет являться объединением результатов запроса по каждому из указанных УИН.
|
Payers
|
1, обязательно
|
Контейнер
|
Список идентификаторов плательщиков, по которым запрашиваются сущности.
Запрос выполняется или только в ИС УНП или только в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При выполнении в одной из указанных систем запрос может быть множественным, при этом итоговая выгрузка будет являться объединением результатов запроса по каждому из указанных идентификаторов плательщиков
Наличие этого тега исключает тег ChargesIdentifiers.
|
PayerIdentifier
|
1..100, обязательно
|
Token
|
Идентификатор плательщика.
При запросе начислений соответствует значению тега UnifiedPayerIdentifier или AltPayerIdentifier.
При запросе платежей соответствует значению тега PayerIdentifier.
При запросе платежей по связанным начислениям игнорируется.
При запросе квитанций соответствует значению тега UnifiedPayerIdentifier или AltPayerIdentifier, указанного в начислении, на которое ссылаются квитанции.
Наличие этого тега исключает тег PayerIdentification.
|
PaymentsIdentifiers
|
1, обязательно
|
Контейнер
|
Список УИП, по которым запрашиваются сущности (только в запросах на экспорт платежей или квитанций)
Допускается указывать до 100 УИП
|
SystemIdentifier
|
1..100, обязательно
|
String
|
УИП, по которому запрашиваются сущности (использовать только при запросах на экспорт платежей и квитанций).
При запросе платежей соответствует тегу SystemIdentifier платежа.
При запросе квитанций соответствует УИП платежа, на который ссылаются квитанции (указан в атрибуте SystemIdentifier). УИП платежа при запросе квитанций может быть использован только когда kind запроса ExportRequest принимает значение «ALLQUITTANCE».
Может быть множественным, в этом случае итоговая выгрузка будет являться объединением выгрузок по каждому из указанных УИП.
|
PayerIdentification
|
1..n, обязательно
|
com:PayerIdentification_Type
|
Идентификация данных начисления/ платежа по каталогу услуг.
Наличие этого тега исключает тег PayerIdentifier.
Запрос по каталогу услуг выполняется только в ИС УНП (в ГИС ГМП не обрабатывается)
|
ServiceCode
|
1, необязательно
|
Xsd:String
|
Идентификатор услуги Поставщика
|
SimpleParameter
|
1..n, обязательно
|
com:SimpleParameterType
|
Простой параметр
Для поиска могут использоваться соответствующие параметры, описанные в DescriptionSimpleParameter Каталога услуг Поставщика с признаком, что они являются идентификатором плательщика (@isId=1) и предназначены для поиска (значение @forSearch равно true).
Наличие этого тега исключает тег ComplexParameter.
|
name
(атрибут)
|
1, обязательно
|
Xsd:string
|
Наименование параметра.
Наименование должно соответствовать одному из наименований параметра, описанного в DescriptionSimpleParameter Каталога услуг поставщика с признаком, что этот параметр является идентификатором плательщика (@isId =1) и предназначен для поиска (значение @forSearch равно true).
|
supplierSrvCode
(атрибут)
|
0..1, необязательно
|
Xsd:string
|
Код услуги в каталоге Поставщика
(Не используется)
|
supplierID
(атрибут)
|
0..1, необязательно
|
com:UUID
|
Id Поставщика из каталога которого взята услуга
(Не используется).
|
isId
(атрибут)
|
0..1, необязательно
|
Xsd:integer
|
Указывает что данный параметр является идентификатором плательщика
1 - параметр является уникальным идентификатором плательщика, если присутствует несколько параметров с таким значением isID, то для идентификации может использоваться любой параметр.
(Не используется)
|
Value
|
1..n, обязательно
|
com:ParamValue_Type
|
Значение параметра
|
label
(атрибут)
|
0..1, необязательно
|
Xsd:string
|
Наименование значения
|
isSelected
(атрибут)
|
0..1, необязательно
|
Xsd:boolean
|
Указывает, что данное значение выбрано в качестве текущего значения параметра в случае если присутствует список значений
|
data
(атрибут)
|
1, обязательно
|
Xsd:string
|
Значение параметра.
Если наименованием параметра будет указано UnifiedPayerIdentifier/ AltPayerIdentifier/PayerIdentifier то поиск указанного значения параметра будет проводиться по соответствующему значению тега UnifiedPayerIdentifier/AltPayerIdentifier /PayerIdentifier начисления/платежа.
Если наименование отлично от UnifiedPayerIdentifier/ AltPayerIdentifier/PayerIdentifier, то поиск указанного значения параметра будет проводиться среди значений AdditionalData/Value начисления или платежа.
|
ComplexParameter
|
1..n, обязательно
|
Контейнер
|
Сложный параметр
Для поиска могут использоваться соответствующие параметры, описанные в DescriptionComplexParameter Каталога услуг Поставщика с признаком, что они являются идентификатором плательщика (@isId=1) и предназначены для поиска (значение @forSearch равно true).
Наличие этого тега исключает тег SimpleParameter.
|
name
(атрибут)
|
1, обязательно
|
Xsd:string
|
Наименование параметра
|
supplierSrvCode
(атрибут)
|
0..1, необязательно
|
Xsd:string
|
Код услуги в каталоге поставщика
(Не используется).
|
supplierID
(атрибут)
|
0..1, необязательно
|
com:UUID
|
Id поставщика из каталога которого взята услуга
|
isId
(атрибут)
|
0..1, необязательно
|
Xsd:integer
|
Указывает что данный параметр является идентификатором плательщика
1 - параметр является уникальным, идентификатором плательщика, если присутствует несколько параметров с таким значением isID, то для идентификации может использоваться любой параметр.
(Не используется).
|
label
(атрибут)
|
0..1, необязательно
|
Xsd:string
|
Наименование значения
|
Field
|
1..n, обязательно
|
com:Field_Type
|
Поле сложного параметра
|
name
(атрибут)
|
1, обязательно
|
Xsd:string
|
Наименование поля параметра.
|
Value
|
1..n, обязательно
|
com:ParamValue_Type
|
Значение
|
label
(атрибут)
|
0..1, необязательно
|
Xsd:string
|
Наименование значения
|
isSelected
(атрибут)
|
0..1, необязательно
|
Xsd:boolean
|
Указывает, что данное значение выбрано в качестве текущего значения параметра в случае если присутствует список значений
|
data
(атрибут)
|
1, обязательно
|
Xsd:string
|
Значение параметра.
Поиск указанного значения параметра будет проводиться среди значений AdditionalData/Value начисления/платежа.
|
Timeslot
|
0..1, необязательно
|
Контейнер
|
Временной интервал, за который запрашиваются сущности.
Если тег Timeslot не указан в запросе, то возвращаются удовлетворяющие остальным параметрам запроса сущности, импортированные или созданные за весь период функционирования системы.
Для запроса изменений каталога услуг, из УНП рекомендуется указывать период не более месяца.
Для запроса полного каталога услуг из УНП временной интервал не должен быть заполнен.
|
startDate (атрибут)
|
1, обязательно
|
DateTime
|
Наименьшая дата и время, когда была зарегистрирована сущность в системе, создана квитанции или зарегистрировано последнее изменение услуги
|
endDate (атрибут)
|
1, обязательно
|
DateTime
|
Наибольшая дата и время, когда была зарегистрирована сущность в системе, создана квитанция или зарегистрировано последнее изменение услуги
|
AdditionRestrictions
|
0..1, необязательно
|
Контейнер
|
Дополнительные ограничения.
|
SubordinateIdList
|
0..1, необязательно
|
Контейнер
|
Список идентификаторов участников косвенного взаимодействия.
|
TaxpayerIdentification
|
1..100, обязательно
|
Контейнер
|
Идентификация получателя средств. Наличие данного/данных тега/тегов исключает наличие тега/тегов PayeeID.
|
inn (атрибут)
|
1, обязательно
|
INNType (см. описание в п.2.5.7.2)
|
ИНН получателя средств, указанный в возвращаемой сущности.
При запросе квитанций соответствует ИНН получателя, указанному в начислении, на которое ссылается квитанция.
Запрос выполняется или только в ИС УНП или только в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При выполнении в одной из указанных систем запрос может быть множественным: если указано несколько тегов TaxpayerIdentification, то итоговая выгрузка будет являться объединением результатов запроса по всем получателям средств - участникам косвенного взаимодействия, каждый из которых определяется отдельным тегом TaxpayerIdentification.
|
kpp (атрибут)
|
0..1, необязательно
|
KPPType (см. описание в п. 2.5.7.3)
|
КПП получателя средств, указанный в возвращаемой сущности.
При запросе квитанций соответствует КПП получателя, указанному в начислении, на которое ссылается квитанция.
|
PayeeID
|
1..100, обязательно
|
String
|
УРН участника, сформировавшего сущность, полученный при регистрации в ИС УНП.
При запросе квитанций соответствует УРН участника, сформировавшего начисление, на которое ссылается квитанция.
При запросе каталога услуг соответствует УРН участника, передавшего каталог в ИС УНП
Запрос выполняется или только в ИС УНП или только в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При выполнении в одной из указанных систем запрос может быть множественным: если указано несколько тегов PayeeID, то итоговая выгрузка будет являться объединением результатов запроса по всем участникам косвенного взаимодействия, каждый из которых определяется отдельным тегом PayeeID.
Наличие данного/данных тега/тегов исключает наличие тега/тегов TaxpayerIdentification.
|
KBKClassifier
|
0..1, необязательно
|
Контейнер
|
Перечень КБК.
|
KBK
|
1..100, обязательно
|
KBKType (см. описание в п. 2.5.7.5)
|
КБК, указанный в сущности.
При запросе начислений соответствует КБК, указанному в начислении.
При запросе платежей соответствует КБК, указанному в платеже.
При запросе платежей по связанным начислениям игнорируется.
При запросе квитанций соответствует КБК, указанному в начислении, на которое ссылаются квитанции.
Запрос выполняется или только в ИС УНП или только в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При указании нескольких КБК итоговая выгрузка будет являться объединением результатов запроса по каждому из указанных КБК.
|
OKTMOClassifier
|
0..1, необязательно
|
Контейнер
|
Коды ОКТМО.
|
OKTMO
|
1..100, обязательно
|
OKTMOType (см. описание в п. 2.5.7.4)
|
Код ОКТМО.
При запросе начислений соответствует коду ОКТМО, указанному в начислении.
При запросе платежей соответствует коду ОКТМО, указанному в платеже.
При запросе платежей по связанным начислениям игнорируется.
При запросе квитанций соответствует коду ОКТМО, указанному в начислении, на которое ссылаются квитанции.
Запрос выполняется или только в ИС УНП или только в ГИС ГМП в зависимости от значения первого символа в поле RequestMessage/Id: «U» - означает обработку запроса в УНП.
При указании нескольких кодов ОКТМО итоговая выгрузка будет являться объединением результатов запроса по каждому из указанных ОКТМО.
|
Exclude
|
0..1, необязательно
|
String
|
Признак, означающий ненулевые УИН (допустимое значение – ZERO-UIN).
При запросе платежей должна возвращаться информация о платежах, в которых указан УИН, отличный от нуля.
|
Paging
|
0..1, необязательно
|
Контейнер
|
Параметры постраничной выдачи (при больших объемах экспортируемых данных).
Если параметр не указан, то по умолчанию в ответе вернутся первые 100 элементов и признак конца выборки (true или false).
|
pageLength (атрибут)
|
1, обязательно
|
Int (≥1)
|
Количество элементов на странице выдачи (количество сущностей в ответе).
|
pageNumber (атрибут)
|
1, обязательно
|
Int (≥1)
|
Номер страницы выдачи. Вся полученная в результате выполнения запроса выборка разбивается на блоки размером pageLength, начиная с первого элемента. Последний блок может быть меньше, чем pageLength. Возвращается только блок, номер которого равен pageNumber.
|
Signature
|
0..1, необязательно
|
SignatureType
|
Подпись участника взаимодействия, сформировавшего запрос. В теге содержатся реквизиты ЭП, соответствующие стандарту XML Advanced Electronic Signatures with Time-Stamp (описание стандарта находится в сети Интернет по адресу http://www.w3.org/TR/XAdES/).
| |
