Содержание

Общая информация

Данная документация описывает условия и способы осуществления обмена информациоными сообщениями между КП ГИВЦ и Агентами и предназначена для технических специалистов-программистов в области интернет-технологий, понимающих то, о чём здесь говорится ;)

История изменений

2015-10-28
♦ Изменения в счетах за отопление и горячую воду с октября 2015г.
2015-04-05
♦ Добавлен интерфейс приёма оплат за Вивезення твердих побутових відходів ТОВ "Селтік" Seltik-1.0
♦ Добавлен интерфейс приёма оплат за технічне обслуговування домофона ТОВ "КС - Домофон" Domofon-1.0
2015-04-03
♦ Добавлен интерфейс приёма оплат за услуги кабельного телевидения ТОВ "Стар Телекомпани" StarTelecom-1.0
2015-01-26
♦ Исправлена ошибка на интерфейсе Rodplat-1.0 в запросе GetCBs [см.Получить справочник ЦБ]: при опускании параметра Period возвращались данные не за последний выставленный период, как было в описании к методу.
2014-12-14
♦ Если опустить атрибут Period в запросе GetBills [см.Получить все выставленные счета] то будут возвращены все последние выставленные счета. Отпадает необходимость использовать предварительно запрос получения последнего высталенного периода [см.Получить период последнего выставления счетов].
2014-12-04
♦ Добавлен тэг (PaymentFunction) назначения платежа в методе получения печатного реестра [см.Получить реест платежей под платёжное поручение].
♦ Начато ведение этой истории.

Назначение, целесообразность, преимущества

Безопасный, непрерывный, в режиме реального времени, он-лайн доступ к базе выставленных счетов.

Возможность получения развёрнутых данных по выставленному счёту, используя идентификационные данные плательщика (Период, ПИН/адрес), а также непосредственно из считанной последовательности штрих-кода (которую не придётся обрабатывать, а просто передать в запросе). Внедряя в Ваше существующее программное обеспечение возможность отправки он-лайн запросов Вы заметно ускорите и облегчите работу кассиров.

Возможность отправки данных о платеже сразу после его проведения что позволит клиентам видеть на сайте КП ГИВЦ состояние своего платежа ещё до его фактического зачисления на лицевой счёт. Отправлять данные о проведённых платежей можно также и в момент (до) отправки электронного реестра.

Генерация электронного реестра под платёжное поручение и отправка данных о проведённом платеже избавляют от необходимости генерации DBF-файлов экспорта для КП ГИВЦ.

Термины и определения

КП ГИВЦ
Юридическое лицо, осуществляющее расщепление денежных средств по оплате жилищно-коммунальных и других услуг г.Киева, поступающих на общегородской распределительный счёт на расчётные счета организаций – поставщиков коммунальных услуг согласно информации жилищно-эксплуатационных организаций г.Киева.
Агент
Юридическое лицо — банк или юридическое лицо, работающее по доверенности и от имени банка и осуществляющее приём платежей от жителей г.Киева за жилищно-коммунальные услуги на пользу поставщиков коммунальных услуг и направляет полученные денежные средства на общегородской распределительный расчётный счёт
Платёжная система
Набор программно-аппаратных средств на стороне Агента, позволяющих жителям г.Киева получать информацию о выставленных счетах за коммунальные услуги и осуществлять их оплату.
Интерфейс обмена информацией
Набор программно-аппаратных средств на стороне КП ГИВЦ, позволяющих Платёжной системе с помощью защищённого выделенного непрерывного электронного канала связи по запросу получать информацию о выставленных счетах на оплату жилищно-коммунальных услуг г.Киева, размещать электронные реестры о проведённых оплатах с мпогоуровневым контролем ошибок.
Договор
Договор между КП ГИВЦ и Агентом на приём платежей от жителей г.Киева за жилищно-коммунальные услуги на пользу поставщиков коммунальных услуг и использование Интерфейса.
Администратор
Администратор — физическое лицо, сотрудник КП ГИВЦ, ответственный за работоспособность Интерфейса.
Тел.: (044)238-80-43, (044)238-80-41. Email: support@xiface.gioc.kiev.ua
Идентификатор
Краткое уникальное идентификационное название Агента в Интерфейсе. Состоит из английских букв верхнего регистра, длиной не более 16 символов.

Установка соединения

Соединение с Интерфейсом происходит на 443-м порту (HTTPS), доступном из глобальной сети Интернет или с помощью электронной почты. Аутентификация и авторизация Агентов происходит с помощью клиентских SSL-сертификатов и по IP-адресу.

Для получения клиентского сертификата Агенту необходимо сгенерировать SSL-запрос с указанием в поле CN (Common Name) Идентификатора, согласованного с Администратором и передать его по электронной почте Администратору.

Во время передачи запроса на получение сертификата также следует указать перечень IP-адресов, с которых планируется соединение с Интерфейсом.

Получение клиентского SSL-сертификата

Будем считать, что Идентификатор с Администратором согласован и он есть VASYAPUPKIN. Генерация запроса на получение сертификата будет выглядеть:

openssl req -new -newkey rsa:1024 -nodes -keyout vasyapupkin.key -out vasyapupkin.csr -subj /CN=VASYAPUPKIN/OU=XIFACE

На выходе получаем: vasyapupkin.csr — файл с запросом, vasyapupkin.key — ваш закрытый ключ, никуда его не пересылайте, никому не показывайте, храните бережно.

Содержимое файла vasyapupkin.csr или сам файл пересылаете Администратору любым удобным для вас и для него способом. В ответ получаете vasyapupkin.crt — собственно ваш клиентский SSL-сертификат, ca.crt — наш корневой сертификат, который также можете скачать прямо здесь: ca.zip.

Далее файлы vasyapupkin.key, vasyapupkin.crt и ca.crt используете, что называется, по-назначению.

Генерация PKCS#12-файла для импорта в бравзер будет выглядеть следующим образом:

openssl pkcs12 -export -in vasyapupkin.crt -inkey vasyapupkin.key -certfile ca.crt -out vasyapupkin.p12 -passout pass:MYSTRONGPASSSS

На выходе получаем: vasyapupkin.p12 — этот файл смело импортируйте в любой вравзер. Не забудьте вместо MYSTRONGPASSSS указать любой удобрый для вас пароль. И не забывайте, что PKCS#12-файл соедржит внутри себя и ваш секретный ключ, поэтому храните его бережно.

Ограничения доступа

В случае выдачи Агенту временного тестового клиентского сертификата или в других случаях, оговоренных в Договоре доступ к Интерфейсу может и будет ограничен.

Ограничения на временный тестовый сертификат заключаются в том, что данные, возвращаемые запросами на получение счетов к оплате являются выдуманными, а суммы — нулевыми.

Доступ любого тестового сертификата к модулям интерфейса может быть ограничен в любой момент и без предупреждения, а также возвращаемые реальные данные могут быть заменены на выдуманные с постоянным статусом выполнения операции ОК.

Другие ограничения оговариваются отдельно в Договоре.

Тестовое подключение

Скачать готовый "тестовый набор" можно по этой ссылке: testagent.zip. Пароль на PKCS#12-файл "QWERTY" (большими буквами).

Не забудьте связаться с Администратором и сообщить IP, с которого будете работать...

Рабочее подключение

Рабочий (боевой) сертификат выдаётся Агенту только после двухстороннего подписания Договора.

Для этого необходимо укзазать: 1. Полное название организации на украинском языке; 2. IP-адреса, с которых будут приходить запросы; 3. Два (минимум) технических контактных лица с укзанием полного ФИО, телефона и адреса электронной почты.

Стоимость и оплата

Интерфейс обмена предоставляет Агенту всю необходимую информацию как о выставленных счетах на оплату услуг так и ряд сопроводительно-справочных данных, позволяющих построить максимально гибкую и удобную платёжную систему и/или рабочее место кассира, подтверждение проведённых платежей и отправка электронных реестров.

Работа с Интерфейсом является платной и Агенту выставляется счёт за использование Интерфейса от каждого подтверждённого и проведённого платежа в размере, установленного Договором, заключаемым между КП ГИВЦ и Агентом.

Условия конфиденциальности

Агент несёт ответственность за соблюдение конфиденциальности полученных от КП ГИВЦ данных о выставленных счетах за жилищно-коммунальные услуги г.Киева и обязан предоставлять их только владельцу лицевого счёта (квартиросъёмщику), если того требует/предусматривает Платёжная система, для осуществления платежа или использовать только в своих, внутренних целях.

Агент должен ограничивать и держать под контролем количество запрашиваемых данных о выставленных счетах по разным лицевым счетам квартиросъёмщиков г.Киева с одной клиентской учётной записи Платёжной системы с целью пресечения незаконного просмотра информации о выставленных счетах третьих лиц.

Требования к отображению и заполнению выставленных счетов

Рекомендованная схема взаимодействия с пользователем в процессе приёма коммунальных платежей на терминалах общего доступа

Полноразмерная схема: terminal_payments.pdf

Для всех счетов

Необходимо дать возможность клиенту указать конкретный период счёта, либо «последний выставленный».

При отображении любого счёта необходимо обязательно указывать период выставленного счёта и сумму «Всего начислено». Желательно (если это возможно) отображать расшифровку начислений по видам услуг.

Долг необходимо отображать, но информационно, не обязывая клиента его оплачивать. Переплата также может быть информационно отображена.Дополнительные оплаты и оплаты, заполняемые вручную могут быть произвольными, но только положительными либо нулевыми суммами.

Изменения в счетах за отопление и горячую воду с октября 2015г.

По требованию поставщиков услуг суммы начислений в счетах за отопление и горячую воду с октября 2015г. выставляются в разрезе сквозного сальдо. Это означает, что сумма долга/переплаты сразу учтена в общей сумме к оплате за услугу. Данные по суммам долгов/переплат на электронном Интерфейсе не предоставляются – они остаются только в бумажном счёте наравне со всеми иными детализированными данными, используемыми при начислении сумм за услугу.

Агентам в своих интерфейсах по приёму оплат по счетам следует убрать/отключить поля ввода данных по долгам/переплатам в указанных видах счетов, так как эта информация более не нужна поставщикам услуг. Для упрощения работы агентов допустимо в период до 1 декабря 2015г. передавать данные по подтверждению оплат на Интерфейс в старом формате: суммы долга и оплаты начислений будут объединяться.

Изменения касаются только отдельных счетов за горячую воду и отопление: BillTypeID = 539554ab-2884-4577-8218-928d4a6aa498 и be05964a-d77c-4d7c-b62d-4adbe186d64c соответственно. [см.Получить перечень типов счетов]

Описанные ранее требования для отражения использованной переплаты в подтверждении оплаты [см.Подтверждение оплаты] в счетах за горячую воду и отопление с указанного периода не действительны: отражать следует только суммы, оплачиваемые клиентом (положительные), а в случае, если переплата перекрывает общую сумму начислений и клиент не желает производить дополнительную оплату (к оплате сумма "ноль") -- такое подтверждение размещать не следует.

Коммунальные услуги (для счетов с октября 2014)

Не забывайте ставить фактическую дату оплаты клиентом, а не дату размещения подтверждения платежа [см.Подтверждение оплаты]!

Информация о счёте на этом Интерфейсе предоставляется лишь для возможности осуществления оплаты в пользу конкретных поставщиков и не содержит деталей начислений. Для получения клиентом детализированной информации по выставленныв счетам ему необходимо использовать бумажный счёт, который доставляется каждому квартиросъемщику в бумажном виде в почтовый ящик. Об этом следует сказать клиенту во время демонстрации данных к оплате по выставленному счёту.

Существует два способа получения выставленных счетов: все счета сразу по реквизитам плательщика (GetBills [см.Получить все выставленные счета]) либо отдельно каждый счёт по его типу (GetBill [см.Получить выставленный счёт определённого типа]).

Каждый счёт (Bill) содержит перечень поставщиков (ServiceProviders) и услуги (Services) каждого, которые оплачиваются в рамках выставленного счёта.

Средства от оплаты выставленного счёта следует перечислять на расчётные реквизиты, указанные в Biller. Составлять справочники из данных из Biller не следует, так как реквизиты могут меняться из периода в период.

Сумма задолженности или переплаты одна на каждого поставщика улуг (ServiceProvider). Переплата внутри одного поставщика не может быть использована в другом. В случае, если поставщик предоставляет несколько услуг и по его требованию учёт долгов должен быть разделён по каждой услуге (группе услуг) -- такой провайдер встретится несколько раз с разным перечнем услуг. Нельзя в случае получения нескольких одинаковых провайдеров объединять их услуги и размещять платёж как на одного провайдера.

Отрицательная сумма задолженности (DebtSumm) и есть переплата.

В случае отсутствия суммы начислений (AccruedSumm) строку о начислении отображать не нужно.

Указананием на необходимость отображения формы счётчика для ручного заполнения по услуге является наличие соответсвующего тэга (Counter). В случае его отсутствия отображать форму для ввода показаний и суммы по счётчику не нужно.

По каждой отдельно взятой улуге тэг счётчика Counter может быть только один. Передавать в подтверждении платежа [см.Подтверждение оплаты] следует также только один тэг счётчика Counter. Если у клиента в квартире установлено несколько счётчиков по одной услуге то в этом случае в подтверждении платежа [см.Подтверждение оплаты] следует передавать только один тэг Counter, опуская при этом атрибуты предыдущего и текущего показаний, а в атрибуте Consumed указывать суммарное количество потреблённых единиц по всем счётчикам данной услуги.

Если по услуге отсутствуют как начисления, так и счётчик, но услуга присутствует то она должна быть отображена в любом случае с возможностью заполнить дополнительную оплату (плату долга) по улуге.

Если по услуге отсутствуют начисления, а присутствует только счётчик то дополнительную оплату вводить НЕЛЬЗЯ -- по счётчикам ручного заполнения долгов/переплат НЕ БЫВАЕТ.

Предыдущие показания счётчика возвращаются информационно (либо могут вовсе отсутствовать) и должны быть редактируемы клиентом.

Тариф по счётчику не включает в себя расчёты льгот и субсидий. Клиент должен самостоятельно расчитать общую сумму к оплате по услуге с учётом льгот и субсидий.

Клиент обязан оплатить начисления по услуге в полном объёме либо, при наличии переплаты, уменьшить её (вплоть до нуля), указывая значение используемой переплаты в поле «додаткова сплата» со знаком «минус». Выглядит это так: имеется переплата [100 грн], начисления при этом составляют [80 грн]; к оплате начислений при этом должна быть указана сумма в [80 грн] (полная сумма начислений), а в поле «додаткова сплата» будет указано [«минус»80 грн] При подтверждении платежа указывается AccruedSumm="80", DebtSumm="-80". Необходимо также контролировать и не позволять использовать переплаты более чем доступно (DebtSumm в полученном счёте). Клиент сам решает, какую сумму переплаты использовать.

В случае оплаты только по счётчикам клиент НЕ имеет право использовать доступную переплату. Начисления по счётчику должны быть оплачены в полном объёме (с учётом льгот и субсидий, разумеется) либо не оплачиватсья вовсе. Если по услуге присутствуют как начисления так и счётчик то переплата может быть использована только для погашения оплаты начислений.

ПЕРЕПЛАТНА ПО ОТДЕЛЬНОМУ ПРОВАЙДЕРУ МОЖЕТ БЫТЬ ИСПОЛЬЗОВАНА ТОЛЬКО ВНУТРИ ЭТОГО ПРОВАЙДРА И НЕ МОЖЕТ БЫТЬ ПЕРЕНЕСЕНА В ДРУГОГО ПРОВАЙДЕРА.

РАЗМЕЩЕНИЕ ЭЛЕКТРОННОГО РЕЕСТРА. Как и ранее главное требование -- один электронный реестр [см.Подтверждение оплаты] формируется под одно платёжное поручение. Средства от оплаты выставленного счёта следует перечислять (формировать платёжное поручение) на расчётные реквизиты, указанные в Biller [см.Получить выставленный счёт определённого типа]

Примеры отображения счетов:

Пояснения к примеру выше: 1) Пример счёта с несколькими поставщиками услуг; 2) Отображение название поставщика услуг; 3) Пример услуги, где нет счётчика, только начисления. 4) Пример услуги, где есть только счётчик, но нет начислений.
 

Пояснения к примеру выше: 5) Пример услуги где есть и счётчик и начисления.
 

Пояснения к примеру выше: 6) Пример услуги где нет ни счётчиков ни начислений, но услуга присутствует.
 

Все поля показаний счётчиков, сумм по счётчику и дополнительной оплаты должны быть редактируемы клиентом.

Коммунальные услуги (для счетов с августа 2014)

Информация о счёте на этом Интерфейсе предоставляется лишь для возможности осуществления оплаты в пользу конкретных поставщиков и не содержит деталей начислений. Для получения клиентом детализированной информации по выставленному счёту ему необходимо использовать бумажный счёт, который доставляется каждому квартиросъемщику в бумажном виде в почтовый ящик. Об этом следует сказать клиенту во время демонстрации данных к оплате по выставленному счёту.

Каждая услуга может содержать начисления Service.AccruedSumm, сумму долга Service.DebtSumm (переплаты) и счётчик ручного заполнения Counter.

Отрицательное значение долга Service.DebtSumm означает переплату.

Сумма начисления Service.AccruedSumm должна отображаться как "Нараховано до сплати".

В случае отсутствия суммы начислений Service.AccruedSumm строку о начислении отображать не нужно.

Указананием на необходимость отображения формы счётчика для ручного заполнения по услуге является наличие соответсвующего тэга Counter [см.Получить счёт]. В случае его отсутствия отображать форму для ввода показаний и суммы по счётчику не нужно.

По каждой отдельно взятой улуге тэг счётчика Counter может быть только один. Передавать в подтверждении платежа [см.Подтверждение оплат] следует также только один тэг счётчика Counter. Если у клиента в квартире установлено несколько счётчиков по одной услуге то в этом случае в подтверждении платежа [см.Подтверждение оплат] следует передавать только один тэг Counter, опуская при этом атрибуты предыдущего и текущего показаний, а в атрибуте Consumed указывать суммарное количество потреблённых единиц по всем счётчикам данной услуги.

Если по услуге отсутствуют как начисления, так и счётчик то она должна быть отображена в любом случае с возможностью заполнить дополнительную оплату (плату долга) по улуге.

Предыдущие показания счётчика возвращаются информационно и должны быть редактируемы клиентом.

Тариф по счётчику не включает в себя расчёты льгот и субсидий. Клиент должен самостоятельно расчитать общую сумму к оплате по услуге с учётом льгот и субсидий.

Счёт необходимо отображать следующим способом:

Клиент обязан оплатить начисления по услуге в полном объёме либо, при наличии переплаты, уменьшить её (вплоть до нуля), указывая значение используемой переплаты в поле «додаткова сплата» со знаком «минус». Выглядит это так: имеется переплата [100 грн], начисления при этом составляют [80 грн]; к оплате начислений при этом должна быть указана сумма в [80 грн] (полная сумма начислений), а в поле «додаткова сплата» будет указано [–80 грн] При подтверждении платежа указывается Service.AccruedSumm=80, Service.DebtSumm=–80. Необходимо также контролировать и не позволять использовать переплаты более чем доступно (поле Service.DebtSumm в полученном счёте). Клиент сам решает, какую сумму переплаты использовать.

В случае оплаты по счётчикам клиент также имеет право использовать доступную переплату по услуге. В этом случае поле суммы оплаты по счётчику заполняется в полном объёме, а значение используемой переплаты заполняется в поле «додаткова сплата» со знаком «минус».

Если у клиента имеются и начисления и счётчик и клиент желает использовать переплату, то суммы к оплате по начисленню и по счётчику заполняются в полном объёме, а сумма переплаты суммируется и указывется в поле «додаткова сплата» со знаком «минус». Выглядит это так: имеется переплата [100 грн]; начислено [25 грн]; по счётчику заполнена сумма на [35 грн]; чтобы использовать переплату нужно в поле «додаткова сплата» указать [–60 грн]

ПЕРЕПЛАТНА ПО ОТДЕЛЬНОЙ УСЛУГЕ МОЖЕТ БЫТЬ ИСПОЛЬЗОВАНА ТОЛЬКО ВНУТРИ ЭТОЙ УСТУГИ И НЕ МОЖЕТ БЫТЬ ПЕРЕНЕСЕНА В ИНУЮ.

При запросе на получение бумажного рееста платежей под платёжное поручение (pdf) [см.Получить реест платежей под платёжное поручение] необходимо обязательно указывать номер счёта, куда зачисляются средства в теге Sheet.Recipient.BankAccount, так как при его отсутствии будет подставлен старый транзитный счёт КП ГИВЦ.

Коммунальные услуги (для счетов до июля 2014 включительно)

Обязательной и минимальной к оплате является сумма PaymentInfo.MinSumToBePaid [см.], она уже учитывает переплату (если она есть, тоесть PaymentInfo.Debt<0).

Для начала расшифровываем начисления по видам услуг. PaymentInfo.ExtraFeeList и PaymentInfo.XFCounterList [см.]. В случае счётчиков по начислению (PaymentInfo.XFCounterList [см.]) отображаем так же показания XFCounter.CurrentValue, XFCounter.PreviousValue, XFCounter.UsedValue [см.].

В строке «Всего начислено» всегда отображаем сумму PaymentInfo.Summ [см.], это фактическое начисление по счёту.

В случае если есть переплата (PaymentInfo.Debt<0) необходимо дать возможность человеку решить использовать её или нет: отображаем сумму переплаты и изменяемое поле «Используемая переплата».

Если есть долг (PaymentInfo.Debt>0) то сообщаем об этом, отображая сумму PaymentInfo.Debt [см.] и даём возможность заполнить поле с суммой долга, которую он желает оплатить.

В строке «Всего к оплате» первоначально отображаем общую сумму, без учёта переплат PaymentInfo.Summ [см.] и модифицируем её по мере заполнения человеком оплачиваемого долга или переплаты.

При наличии заполняемых счётчиков PaymentInfo.CounterList [см.] нужно акцентировать внимание клиента на необходимости их заполнения, а при отсутствии расхода по счётчику обязать клиента заполнить нулевую сумму к оплате и нулевую разницу потреблённых единиц, тем самым убедившись, что клиент осознанно не желает платить по счётчику. Вводим показания счётчиков: а) текущие и предыдущие, разницу считаем автоматом; б) текущие и предыдущие – пусто (нет показаний, счётчик по договору), вводим только разницу; в) все поля – пусто (не было потребления). Значения поля предыдущих показаний может быть нулевым – то есть счётчик только установили. Это необходимо делать по каждому заполняемому счётчику.

При наличии у клиента нескольких счётчиков по одной услуге заполнять необходимо только суммарное значение израсходованных единиц и общую сумму к оплате по всем счётчикам данной услуги.

В показаниях счётчиков количество знаков после запятой может колебаться в разных услугах от 0 до 4. Точное количество знаков после запятой, которые необходимо дать возможность вводить возвращаются в атрибуте DecimalPrecision [см.].

При получении данных по счёту в счётчиках возможно появление атрибута с предыдущими показаниями в случае, если платёж клиента ранее проводился данным Интерфейсом и заполнялись текущие показания счётчика.

После заполнения клиентом показаний разницу и сумму к оплате можно вычислить и отобразить, дав при этом возможность исправить сумму к оплате, так как в случае наличия льготы и субсидии клиент должен расчитывать сумму сам.

Отображение счёта:

Алгоритм расчёта подтверждения коммунального платежа

Имеем сумму к оплате, которую всегда берём из PaymentInfo.MinSumToBePaid назовём её НАЧИСЛЕНО.

Даём ввести «Дополнительную оплату». Это либо оплата долга либо просто оплата «наперёд». Сумма только положительная. Это будет у нас первая введённая сумма, назовём её ДОПОЛНИТЕЛЬНО.

Сумму по счётчикам назовём СУММАСЧЁТЧИКА.

Итого к оплате у нас получается ИТОГО = НАЧИСЛЕНО + ДОПОЛНИТЕЛЬНО + СУММАСЧЁТЧИКА, человек вносит сумму СУММА.

1-й случай. СУММА >= ИТОГО: Payment.Summ = СУММА; Payment.Municipal.NachSumm = НАЧИСЛЕНО; Payment.Municipal.DebtSumm = ДОПОЛНИТЕЛЬНО + (СУММА - ИТОГО); Payment.Counter.Summ = СУММАСЧЁТЧИКА

2-й случай. СУММА >= НАЧИСЛЕНО < ИТОГО: Payment.Summ = СУММА; Payment.Municipal.NachSumm = НАЧИСЛЕНО; Payment.Municipal.DebtSumm = СУММА - НАЧИСЛЕНО

3-й случай. СУММА < НАЧИСЛЕНО: Payment.Summ = СУММА; Payment.Municipal.NachSumm = СУММА

ЗАМЕЧАНИЯ. Дать возможность клиенту вообще не заполнять какие-либо счётчики и не платить по ним. Ввод отрицательных сумм невозможно по-определению. В случае если человек заполнял счётчики и суммы по ним но не ввёл достаточно денег (2-й, 3-й случаи) то просто игнорируем его ввод и не передаём нам ничего по счётчикам.

Кабельное телефидение (Информационноые технологии, Киевтелесервис)

Обязательной и минимальной к оплате является сумма «всего начислено».

В данных счетах присутствуют как начисления по видам услуг ExtraFeeList так и так называемые «поля ручного заполнения» ManualFeeList. Необходимо отображать все полученные в счёте поля, даже если получена нулевая сумма. В полях ручного заполнения суммы необходимо отображать информационно, давая клиенту заполнять желаемую сумму к дополнительной оплате самостоятельно.

Приблизительное отображение счёта с расшифровкой по видам услуг:

Приблизительное отображение счёта без расшифровки по видам услуг:

НПО Информационноые технологии

В случае, если клиент пришёл платить с бумажным счётом, а мы отвечаем на GetBill что счёт не найден, но период счёта имеется в выставленных — это означает что счёт выпущен в "межрасчётный" период и отсутствует в централизованной базе выставленных счетов. Чтобы «протолкнуть» такой платёж, указывайте в запросе PutPayment атрибут Payment.Number равным нулю.

Пользоваться этой «уловкой» следует только в том случае, если точно известно что период есть в выставленных счетах, точно указан GetBill.Number. ОБРАТИТЕ ВНИМАНИЕ, что таким образом средства попадают на счёт абонента, но не совсем корректно и с некоторым запозданием, поэтому не следует этим пользоваться «просто так».

Отчётные документы

Квитанция об оплате услуг

На данный момент все платёжные системы не имеют единой формы квитанции для подтверждения факта оплаты клиентом коммунальных услуг. Чеки, выписки и прочая индивидуальная в каждой системе документация не явяется документом при предъявлении в ЖЭКах, судах и прочих инстанциях.

Для урегулирования этого вопроса КП ГИВЦ берёт на себя функцию и ответственность по генерации квитанций об оплате на основе полученных данных от Банковских организаций по оплате выставленных сумм по счетам. Банковской организации для этого необходимо лишь по требованию клиента сгенерировать запрос [см.Получить квитанцию об оплате клиентом] и получить готовый для печати документ, заверить его подписью ответственных лиц, мокрой печатью и выдать клиенту:

Текстовая выписка о подтверждённом платеже

При приёме оплаты с терминала самообслуживания, банкомата или POS-терминала, где предусматривается печать чека необходимо в обязательном порядке впечатывать текстовую выписку о принятом платеже с расшифровкой всех введённых клиентом сумм, показаний счётчиков по видам услуг, периоде оплаты и назначении платежа.

Интерфейс предусматривает готовое решение по формированию такой выписки [см.Получить текстовую выписку об оплате для печати на чеке]. Агенту необходимо после осуществления успешного подтверждения платежа [см.] следом посылать запрос на получение такой выписки и полученную информацию отражать на чеке.

В текстовой выписке применяется простая маркировка для изменения начертания шрифтов. В случае, если используемый принтер не поддерживает все или некоторе варианты изменения шрифтов ненужные или все тэги маркировки необходимо "выкусить".

Применяемая маркировка: <b /> - жирный, <u /> - подчёркнутый, <big /> - увеличенный шрифт (+1).

Реестр принятых платежей

В начале месяца, Агент должен предоставить КП ГИВЦ бемажные реестры принятых платежей проведённых за предыдущий месяц под каждое платёжное поручение.

Нет необходимости генерировать реестр самостоятельно, а достаточно лишь воспользоваться функцией генерации реестра [см.Получить реест платежей под платёжное поручение]. Распечатать подписать, заверить мокрой печатью Банковской организации и отправить на КП ГИВЦ.

Примеры платёжных документов (счетов)

Счёт на оплату коммунальных услуг (с октября 2014г.).

Пример счёта: один и другой (будут).

Счёт на оплату коммунальных услуг (с августа 2014г.).

Пример счёта: один и другой.

Счёт на оплату коммунальных услуг (до июля 2014г. включительно).

Расположение ключевых реквизитов: номер ЖЭО, номер лицевого счёта, период счёта, ключ активации.

Полноразмерный пример счёта для печати и тестов здесь: bill_MUNICIPAL.tif.

Счёт на оплату услуг НПО "Информационные технологии".

Расположение ключевых реквизитов: номер оператора, номер счёта, ПИН, период счёта.

Полноразмерный пример счёта для печати и тестов здесь: bill_NPOIT.tif.

Счёт на оплату услуг СКП "Киевтелесервис".

Расположение ключевых реквизитов: ПИН, период счёта.

Полноразмерный пример счёта для печати и тестов здесь: bill_KTS.tif.

Счёт на оплату Родительской платы.

Расположение ключевых реквизитов: период счёта, контрольная сумма, ПИН.

Полноразмерный пример счёта для печати и тестов здесь: bill_RODPLAT.tif.

Взаимодействие с системой

Интерфейс поддерживает два режима посылки запросов и получения ответов. Первый режим — режим реального времени (Он-Лайн). Второй — режим обмера сообщениями с помощью электронной почты (Офф-Лайн).

Обмен пакетами в он-Лайн режиме

Пакеты Платёжной системой формируются и отправляются GET/POST-запросом на адрес xiface.gioc.kiev.ua/xiface с указанием одного параметра xmlstr, содержащего текст XML-запроса.

https://xiface.gioc.kiev.ua/xiface?xmlstr=<DataExchangeModule Interface="MunicipalBilling-">
<Head Type="Query" Query="GetLastBillPeriod"/><Data><QueryParams/></Data></DataExchangeModule> -или- https://xiface.gioc.kiev.ua/xiface?xmlstr=%3CDataExchangeModule%20Interface=%22MunicipalBilling-%22
%3E%3CHead%20Type=%22Query%22%20Query=%22GetLastBillPeriod%22%20/%3E%3CData%3E%3CQueryParams/%3E%3C/Data%3E%3C/DataExchangeModule%3E

В случае запросов большого объёма, PutPaySheet [см.Разместить электронный реестр] например, возможно разумнее использовать POST.

В ответ, не разрывая соединения, сервер отправляет XML-ответ с результатом обработки запроса.

ЗАПРОС

<DataExchangeModule Interface="MunicipalBilling-"> <Head Type="Query" Query="QueryCommand" CompressResult="True" SequenceId="571AF7E8BC5B5"/> <Data /> </DataExchangeModule>
1.    Interface – Название интерфейса обмена.
2.    Query – Команда запроса
3.    CompressResult – Устанавливать компрессию для результата *)
4.    SequenceId – Идентификатор последовательности запрос-ответ *)
5. <DATA/> – Тэг, содержащий атрибуты, конкретизирующие конкретный запрос (параметры запроса)

ОТВЕТ

<DataExchangeModule Interface="MunicipalBilling-"> <Head Type="Reply" Query="QueryCommand" Result="ResultCode" Reason="ReasonText" SequenceId="571AF7E8BC5B5"/> <Data /> </DataExchangeModule>
1.    Interface – Название интерфейса обмена.
2.    Query – Команда запроса, на которую предоставлен ответ
3.    Result – Код обработки запроса
4.    Reason – Описание причины неудачного выполнения запроса или дополнительное описание результата обработки
5.    SequenceId – Идентификатор последовательности запрос-ответ *)
6. <Data/> – Блок данных cодержит данные ответа на запрос

Тестовая страница

Для отладки запросов всех интерфейсов существует тестровая страница по адресу xiface.gioc.kiev.ua/xifacedoc.php.

Используйте тестовую страницу для отладки запросов и визуального понимания принципа функционирования Интерфейса.

Кодировки и форматы данных

Все текстовые данные, передаваемые и принимаемые кодируются в UTF-8.

Дата
Даты форматируются следующим образом: ГГГГММДД (например 20070422). Где ГГГГ - год (например 2007), ММ - месяц с лидирующим нулём, если меньше 10 (например 04), ДД - день месяца с лидирующим нулём, если меньше 10 (например 22).
Период
Период форматируется следующим образом: ГГГГММ (например 200705). Где ГГГГ - год (например 2007), ММ - месяц с лидирующим нулём, если меньше 10 (например 05).
Суммы, показания счётчиков
Для указания значений в суммах и показаниях счётчиков после запятой необходимо использовать "точку" (.), а не "запятую" (,). Например: 2.31 - верно, а 2,31 - не верно.

Коды результатов обработки запросов (сообщения об ошибках)

Существуют как общие коды обработки запросов для всех интерфейсов так и присущие только для конкретного интерфейса. Для получения перечня результирующих кодов в каждом интерфейсе (расшифровке кода результата) следует использовать соотвествующий запрос GetResultCodes.

Во всех случаях коды в диапазоне 200-299 сообщают об успешной обработке запроса. В диапазоне 300-399 являются предупреждающими. В диапазоне 500-599 сообщают о происхождении какой-либо фатальной ошибке.

Каждый ответ содержит общий результат обработки и может содержать результаты обработки подзапросов, если в запросе таковые были.

Размещение электронного реестра, подтверждение оплат

Для платёжных систем, отправляемых на ГИВЦ реестр платежей важно знать и указывать номер и дату проводки платёжного документа, которым банк отправляет денежные средства на распределительный расчётный счёт по этому реестру. Номер следует уточнять у банка так, чтобы он совпадал с номером в банковской выписке, получаемой ГИВЦ и номером, переданным в электронном реестре.

Во время подтверждения платежа (что фактически представляет собой передачу всех идентификационных реквизитов (ЖЭК/лицевой/период), дополнительных сумм и показаний счётчиков) каждый платёж валидируется с базой выставленных счетов. Если валидация успешна и выславленный счёт обнаружен то каждому платежу присваивается уникальный идентификационный код и передаётся вместе с ответом платёжной системе. Эти коды платежей необходимо включать в электронный реестр, формируемого под платёжное поручение и передаваемого на ГИВЦ.

Передача на ГИВЦ реестра платежей под платёжное поручение фактически является подтверждением осуществления платежа и зачисления денежных средств на транзитный расчётный счёт КП ГИВЦ.

Также см.схему: schema.pdf

Выяснение идентификационных данных плательщика

Возможна ситуация, когда оплаченный клиентом счёт за коммунальные или другие услуги не удаётся подтвердить методом PutPayment и получить идентификатор для дальнейшего включения его в электронный реестр PutPaySheet. Причиной невозможности размещения могут быть ошибочные или недостаточные идентификационные данные лицевого счёта, требуемые для выполнения метода PutPayment.

Предоставляется возможность получить точные идентификационные данные, отправив скан-копию извещения на КП ГИВЦ:

1) Следует убедиться что счёт оплачивается в пользу КП ГИВЦ для зачисления на одну из услуг, счета за которую выпускает и обрабатывает КП ГИВЦ.

2) Приять платёж от клиента. Отсканировать лицевую и оборотную сторону извещения так, чтобы содержание и качество скан-копии было достаточным для полноценной идентификации плательщика на стороне КП ГИВЦ, а также был виден и разборчив оттиск кассового аппарата и любые иные отметки банка и ЖЭО.

3) Сформировать два изображения в формате TIFF (300dpi, B/W, G4FAX).

4) Отправить полученные скан-копии на КП ГИВЦ с помощью метода PutAdviceScan и получить в ответ ID скан-копии.

5) С промежутком в 10 минут проверять состояние обработки отправленной скан-копии с помощью метода GetAdviceScanIdent.

В случае успешного распознавания присланного извещения будут выданы идентификационные реквизиты для размещения платежа.

Схема взаимодействия

Приведённая схема наглядно иллюстрирует процесс обмена пакетами в описываемой системе, их последовательность и взаимодействие: schema.pdf

Описание Интерфейсов

Интерфейс MunicipalBilling, версия 1.4

Интерфейс предоставляет доступ к базе данных выставленных счетов (до июля 2014г включительно) оплаты коммунальных услуг и справочникам коммунального хозяйства г.Киева

CheckAuthkey

Проверка корректности ключа активации

Выполняется проверка корректности ключа активации для данного лицевого счёта.

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="CheckAuthkey" CompressResult="True"/>
  <Data>
    <QueryParams JEK="2401" PACC="650540" Authkey="RR5E4BRECA4F" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Authkey – Ключ активации *)

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="CheckAuthkey" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
  </Data>
</DataExchangeModule>

GetAccounts

Получить список лицевых

Получить список лицевых в уазанном ЖЭКе

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetAccounts" CompressResult="True"/>
  <Data>
    <QueryParams JEK="505" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    JEK – Код ЖЭКа [см.Получить список ЖЭКов]

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetAccounts" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <AccountsList JEK="505">
      <Account ID="94" HouseID="1" Flat="9"/>
      <Account ID="108" HouseID="1" Flat="10"/>
      <Account ID="116" HouseID="1" Flat="11"/>
      <Account ID="124" HouseID="1" Flat="12"/>
      <Account ID="10537" HouseID="4" Flat="88"/>
      <Account ID="18295" HouseID="7" Flat="161"/>
    </AccountsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    JEK – Код ЖЭКа [см.Получить список ЖЭКов]
2.    ID – Номер лицевого счёта *)
3.    HouseID – Код дома [см.Получить список домов]
4.    Flat – Номер квартиры

GetBill

Получить счёт

Получить развёрнутые данные по выставленному счёту за коммунальные услуги за период по указанным ЖЭКу и лицевому счёту

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams JEK="505" PACC="17981" Period="200708" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период счета
4.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData JEK="505" PACC="17981" Period="200708" Result="OK(200)">
      <AccountInfo StreetAddress="МАЛИНОВСЬКОГО МАРШАЛА ВУ,б.13А" Flat="188" AccountOwner="" HouseDolg="FALSE" />
      <PaymentInfo Debt="0" DebtByContract="0" MinSumToBePaid="67.61" IncludedDiscount="0.00">
        <ExtraFeeList Summ="67.61">
          <ExtraFee Code="1" Subcode="1" ExtraFee="26.07" Grant="0.00" Compensation="0.00" HelpNeedy="0.00" Payable="26.07" />
          <ExtraFee Code="4" Subcode="0" ExtraFee="38.16" ReCalc="0.00" Grant="0.00" Compensation="0.00" HelpNeedy="0.00" Payable="38.16" />
          <ExtraFee Code="6" Subcode="1" ExtraFee="3.38" ReCalc="0.00" Grant="0.00" Compensation="0.00" HelpNeedy="0.00" Payable="3.38" />
        </ExtraFeeList>
        <XFCounterList Summ="0.00"/>
        <CounterList>
          <Counter Code="2" Subcode="1" Tariff="1.48" DecimalPrecision="1"/>
          <Counter Code="5" Subcode="2" Tariff="7.38" PreviousValue="430.34" DecimalPrecision="1"/>
          <Counter Code="7" Subcode="1" Tariff="0.1560" PreviousValue="453" DecimalPrecision="0"/>
        </CounterList>
        <ElectricalCounter Type="1" AccountNo="15000818820" UsedValue="75" ExtraFee="9.14" Debt="0.00"
                                    PrivilegeHowMuch="Пiльга 50% на 2 особ. 75 кВтг" PrivilegeName="Ветеран вiйськ. служби" Tariff="0.2436"/>
      </PaymentInfo>
    </BillData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <BillData/> – Контейнер данных счёта
2.    JEK – Номер ЖЭКа [см.Получить список ЖЭКов]
3.    PACC – Лицевой счёт
4.    Period – Период счета
5. <AccountInfo/> – Общие данные по счёту
6.    StreetAddress – Адрес. Улица, номер дома.
7.    Flat – Номер квартиры
8.    AccountOwner – Хозяин лицевого (Фамилия И.О.) *)
9.    HouseDolg – Признак долгового дома
10. <PaymentInfo/> – Контейнер данных по начислениям
11.    Debt – Сумма долга по коммунальным
12.    DebtByContract – Сумма оплаты реструктурированного долга по договору *)
13.    Summ – Начислено по выставленному счёту.
14.    MinSumToBePaid – Обязательная сумма, которая должна быть оплачена по выставленному счёту. *)
15.    IncludedDiscount – Учтённая скидка *)
16. <ExtraFeeList/> – Перечень начислений
17.    Summ – Сумма начислений *)
18. <ExtraFee/> – Начисление
19.    Code – Код названия начислення [см.Получить кодификатор названий начислений] *)
20.    Subcode – Субкод названия начислення [см.Получить кодификатор названий начислений] *)
21.    ExtraFee – Сумма "начислено"
22.    ReCalc – Сумма "перерасчёт" *)
23.    Grant – Сумма "субсидия"
24.    Compensation – Сумма "компенсация"
25.    HelpNeedy – Сумма "Адресна допомога"
26.    Payable – Сумма "к оплате"
27.    PayableBound – Сумма обязательного платежа *)
28.    PayableNorm – Сумма по Норме потребления *)
29. <XFCounterList/> – Перечень счетчиков по начислениям *)
30.    Summ – Сумма начислено счетчиков по начислениям *)
31. <XFCounter/> – Счётчик "по начислению"
32.    Code – Код названия начислення [см.Получить кодификатор названий начислений] *)
33.    Subcode – Субкод названия начислення [см.Получить кодификатор названий начислений] *)
34.    Tariff – Тариф (БЕЗ УЧЁТА ЛЬГОТ И СУБСИДИЙ) *)
35.    Grant – Сумма "субсидия"
36.    Compensation – Сумма "компенсация"
37.    HelpNeedy – Сумма "Адресна допомога"
38.    Payable – Сумма "к оплате"
39.    CurrentValue – Текущие показания счётчика
40.    PreviousValue – Предыдущие показания счётчика
41.    UsedValue – Потреблено единиц
42. <CounterList/> – Перечень счётчиков для ручного заполнения *)
43. <Counter/> – Счётчик для ручного заполнения
44.    Code – Код названия начислення [см.Получить кодификатор названий начислений] *)
45.    Subcode – Субкод названия начислення [см.Получить кодификатор названий начислений] *)
46.    Tariff – Тариф *)
47.    PreviousValue – Предыдущие показания *)
48.    DecimalPrecision – Требуемая точность при вводе десятичных значений *)
49. <ElectricalCounter/> – Контейнер данных по счётчику электроэнергии *)
50.    Type – Тип счётчика
51.    AccountNo – Лицевой счёт Киевэнерго
52.    UsedValue – Потреблено единиц
53.    ExtraFee – Начислено к оплате
54.    Debt – Долг по электроэнегии
55.    PrivilegeHowMuch – Процентная ставка льготы
56.    PrivilegeName – Название льготы
57.    Tariff – Тариф *)

GetHouses

Получить список домов

Получить список домов в разрезе ЖЭКов, которые находятся на обслуживании КП ГИВЦ

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetHouses" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetHouses" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <HousesList>
      <House ID="1" JEKID="106" StreetID="3748" Number="112"/>
      <House ID="21" JEKID="106" StreetID="1120" Number="49 К3"/>
      <House ID="111" JEKID="9667" StreetID="686" Number="44/50"/>
      <House ID="138" JEKID="9660" StreetID="7733" Number="53"/>
    </HousesList>
				
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    ID – Код дома *)
2.    JEKID – Код ЖЭКа [см.Получить список ЖЭКов]
3.    StreetID – Код улицы [см.Получить список улиц]
4.    Number – Номер дома

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="28070805050179810277006761" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData JEK="505" PACC="17981" Period="200708"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период счета

GetJEKs

Получить список ЖЭКов

Получить список ЖЭКов, находящихся на обслуживании КП ГИВЦ

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetJEKs" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetJEKs" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <JEKsList>
      <JEK ID="101" RegionID="1" Name="ЖЕК 101"/>
      <JEK ID="201" RegionID="2" Name="КП УЖХ Дарницького р-ну м.Києва"/>
      <JEK ID="601" RegionID="6" Name="ЖЕО-601 КП УЖГ &quot;Печерськжитло&quot;"/>
      <JEK ID="9667" RegionID="8" Name="ЖБК &quot;Академiчний-18&quot;"/>
      <JEK ID="9672" RegionID="2" Name="ОСББ &quot;Вишнякiвська-9&quot;"/>
    </JEKsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    JEK – Код ЖЭКа *)
2.    RegionID – Код района [см.Получить список районов]
3.    Name – Название ЖЭКа

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data>
    
    <QueryParams />
					
  </Data>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="200708"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetPaymentNames

Получить кодификатор названий начислений

Получить кодификатор названий начислений

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetPaymentNames" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetPaymentNames" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment Code="2" SubCode="1" LeftName="Холодне водопостачання та водовідведення" RightName="ХВ та водовідв."/>
      <Payment Code="5" SubCode="1" LeftName="Гаряче водопостачання"/>
      <Payment Code="10" SubCode="26" LeftName="Експлуатаційні витрати"/>
      <Payment Code="13" SubCode="4" LeftName="Вахта"/>
      <Payment Code="13" SubCode="10" LeftName="Консьєрж"/>
      <Payment Code="20" SubCode="1" LeftName="= ВСЬОГО НАРАХОВАНО ="/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код начисления
2.    SubCode – Субкод начисления
3.    LeftName – Полное название в левой части счёта

GetRegions

Получить список районов

Получить список районов г.Киева

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetRegions" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetRegions" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <RegionsList>
      <Region ID="1" Name="Голосіївський">від Кільцевої дороги по північно-західній межі гаража ... </Region>
      <Region ID="5" Name="Оболонський">вул. Заводська; вул. Новокостянтинівська; просп. Червоних козаків; ... </Region>
    </RegionsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Region/> – Данные по району, текстовое описание его границ
2.    ID – Код района
3.    Name – Название района

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
      <Result Code="553" Description="Запрошенный период не найден в базе выставленных счетов."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

GetStreets

Получить список улиц

Получить список-кодификатор улиц г.Киева

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="GetStreets" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="GetStreets" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <StreetsList>
      <Street ID="3748" Name="ГОЛОСІЇВСЬКИЙ" Type="ПР-Т" NameOld="40-РІЧЧЯ ЖОВТНЯ ПР-Т" Locality="" LocalityType="" CodeEDARP="1495"/>
      <Street ID="1889" Name="ІНГУЛЬСЬКИЙ" Type="ПРОВ." NameOld="" Locality="" LocalityType="" CodeEDARP="685"/>
      <Street ID="4589" Name="ЗАПОРОЖЦЯ ПЕТРА" Type="ВУЛ." NameOld="" Locality="ТРОЄЩИНА" LocalityType="С" CodeEDARP="0"/>
      <Street ID="610" Name="1-ША ЛІНІЯ" Type="ВУЛ." NameOld="" Locality="ВИШГОРОД" LocalityType="М" CodeEDARP="0"/>
    </StreetsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    ID – Код улицы *)
2.    Name – Название улицы
3.    NameOld – Старое название улицы
4.    Type – Тип улицы *)
5.    Locality – Населённый пункт
6.    LocalityType – Тип населеного пункта *)
7.    CodeEDARP – Код улицы по классификатору ЕДАРП *)

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment JEK="3061" PACC="335101" Period="200709" PayDate="20071015" Summ="578.14" ReturnCheque="False">
        <Municipal NachSumm="269.94" DebtSumm="158.4"/>
        <CountersList>
          <Counter Code="2" CurrentValue="525" PreviousValue="505" UsedValue="20" Summ="29.6"/>
          <Counter Code="5" CurrentValue="259" PreviousValue="251" UsedValue="8" Summ="59.04"/>
          <Counter Code="6" NachSumm="3.95"/>
          <Counter Code="7" CurrentValue="8320" PreviousValue="8020" UsedValue="300" Summ="56.16" DebtSumm="1.05"/>
        </CountersList>
      </Payment>
      <Payment JEK="4011" PACC="90374" Period="200709" PayDate="20071015" Summ="672.59">
        <Municipal NachSumm="185.39"/>
        <CountersList>
          <Counter Code="7" CurrentValue="8000" PreviousValue="6000" UsedValue="2000" Summ="487.2"/>
        </CountersList>
        <SupplyData>UAIVC2A9F60223CF70BD6D28774C4</SupplyData>
      </Payment>
      <Payment JEK="505" PACC="17981" Period="200709" PayDate="20071015" Summ="100.00">
        <Municipal NachSumm="99.99"/>
      </Payment>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Контейнер подтверждения оплат
2. <Payment/> – Подтверждение оплаты
3.    PayDate – Дата платежа клиентом
4.    Summ – Общая сумма оплаты по счёту
5.    JEK – Номер ЖЭКа
6.    PACC – Лицевой счёт
7.    Period – Период счета за который производится оплата
8.    ReturnCheque – В ответе сразу вернуть текст чека *)
9. <Municipal/> – Данные по коммунальным услугам
10.    NachSumm – Оплата начислений
11.    DebtSumm – Оплата долга или дополнительно
12. <CountersList/> – Контейнер данных по счётчикам *)
13. <Counter/> – Данные по одному счётчику
14.    Code – Код услуги [см.Получить кодификатор названий начислений] *)
15.    CurrentValue – Текущие показания
16.    PreviousValue – Предыдущие показания
17.    UsedValue – Использовано *)
18.    Summ – Сумма оплаты по показаниям счётчика
19.    DebtSumm – Сумма оплаты долга или дополнительно по данному счётчику
20.    NachSumm – Оплата начислений по данному счётчику
21. <SupplyData/> – Сопроводительная информация *)

« Ответ

<DataExchangeModule Interface="MunicipalBilling-1.4">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment ID="32015" Result="OK(200)"/>
      <Payment ID="0" Result="ERROR(555)"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Common, версия 1.0

Интерфейс предоставляет доступ к модулям обмена информацией общего назначения.

DelPaySheet

Удалить электронный реестр

Удалить (отозвать) размещённый ранее электронный реестр.

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="DelPaySheet" CompressResult="True"/>
  <Data>
    
    <QueryParams SheetID="99" />
					
  </Data>
</DataExchangeModule>

Параметры запроса

1.    SheetID – Идентификатор электронного реестра *)

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="DelPaySheet" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
					
  </Data>
</DataExchangeModule>

GetEPayAcception

Получить состояния обработки оплаты

Проверить был ли платёж подтверждён электронным реестром и были ли средства распределены между поставщиками коммунальных и других услуг и готовы к отправке и зачислению на лицевой счёт (произведено ли расщепление оплаты).

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetEPayAcception" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment ID="465084"/>
      <Payment ID="468446"/>
    </PaySheetList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Список подтверждённых платежей
2. <Payment/> – Контейнер плетежа
3.    ID – Уникальный код подтверждённого платежа

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetEPayAcception" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment EPayID="465084" Result="OK(200)"/>
        <Accept Sheet="TRUE" RSB="TRUE"/>
      </Payment/>
      <Payment EPayID="468446" Result="OK(200)"/>
        <Accept Sheet="TRUE" RSB="TRUE"/>
      </Payment/>
    </PaySheetList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер результатов обработки плетежей
2. <Payment/> – Контейнер результатов обработки плетежа
3.    ID – Уникальный код подьверждённого платежа
4.    Result – Результат обработки запроса
5. <Accept/> – Контейнер результатоа обработки плетежа
6.    Sheet – Подтверждён ли платёж электронным реестром *)
7.    RSB – Произведено ли расщепление платежа *)

GetLastInterfaceVersion

Последняя версия интерфейса

Получить последнюю версию указанного интерфейса.

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetLastInterfaceVersion" CompressResult="True"/>
  <Data>
    <QueryParams Interface="MunicipalBilling" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Interface – Название интерфейса

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetLastInterfaceVersion" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Interface LastVersion="1.4"/>
					
  </Data>
</DataExchangeModule>

GetParsedBarcodeData

Расшифровать штрих-код

Получить расшифровку данных штрих-кода, а также название интерфейса, обслуживающего данный вид счёта.

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetParsedBarcodeData" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="28080596380000900021023209" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetParsedBarcodeData" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData Period="200805" JEK="9638" PACC="000090" Interface="MunicipalBilling" LastInterfaceVersion="1.4" />
					
  </Data>
</DataExchangeModule>

GetPaymentCheque

Получить текстовую выписку об оплате для печати на чеке

Получить текстовую выписку об оплате для печати на чеке терминала самообслуживания, банкомата или POST-терминала. Подробнее описание [см.Текстовая выписка о подтверждённом платеже]

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetPaymentCheque" CompressResult="True"/>
  <Data>
    <QueryParams PaymentID="123333" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PaymentID – Уникальный идентификатор платежа *)

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetPaymentCheque" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ChequeData PaymentID="123333" Result="OK(200)"><![CDATA[
----------
<b>КВИТАНЦІЯ ПРО СПЛАТУ ЗА ВЕРЕСЕНЬ 2008</b>
<big>* КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ *</big>
КП "Житлорембудсервiс"
ЗАКРЕВСЬКОГО М. ВУЛ.,б.13А,кв.57
ЖОЛДАК О.О.
<b>ЖЕО 0307 / Особов.рахунок 017479 / ID 123333</b>
+ Комунальні та інші послуги
  нарахування: 95.68 грн.
+ Холодне водопостачання та водовідведення
  лічильник: 14.80 грн.
  поточн.321.0 попер.311.0 різн.10.0 
+ Гаряче водопостачання та водовiдведення
  лічильник: 29.52 грн.
  поточн.158.0 попер.154.0 різн.4.0 
+ Електроенергія (о/р 12008005707)
  лічильник: 45.49 грн.
  поточн.2090 попер.1847 різн.243 
  борг або додатково: 100.00 грн.
<b>= ВСЬОГО СПЛАЧЕНО: 285.49 грн.</b>
----------
]]></ChequeData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <ChequeData/> – Контейнер данных чека *)

GetPaymentReceipt

Получить квитанцию об оплате клиентом

Сгенерировать и получить ссылку на PDF-версию квитанции об оплате

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetPaymentReceipt" CompressResult="True"/>
  <Data>
    
    <Payment ID="331">
      <Bank>
        <Name>ВАТ КБ 'БАНК'</Name>
      </Bank>
      <PersonList>
        <Person>
          <Title>Гол.бухгалтер</Title>
          <Name>Иванов Иван Иванович</Name>
        </Person>
        <Person>
          <Title>Директор</Title>
          <Name>Сидоров Сидор Сидорович</Name>
        </Person>
      </PersonList>
    </Payment>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Payment/> – Контейнер данных запроса квитанции об оплате
2.    ID – Уникальный идентификатор платежа *)
3. <Bank/Name/> – Название Банковской организации *)
4. <PersonList/> – Контейнер перечня ответственных лиц, подписывающих квитанцию *)
5. <Person/Title/> – Должность ответственного лица, подписывающего квитанцию
6. <Person/Name/> – Фамилия, Имя, Отчество ответственного лица, подписывающего квитанцию

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetPaymentReceipt" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Receipt>/docs/receipts/331-628b45.pdf</Receipt>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Receipt/> – URI файла сгенерированной квитанции в PDF-формате *)

GetPaymentsDetails

Получить информацию по подтверждённым платежам

Модуль предназначен для получения подробной информации по подтверждённому платежу. Используется в основном для сверки сумм при невозможности разметстить реестр.

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetPaymentsDetails" CompressResult="True"/>
  <Data>
    
    <PaymentList>
      <Payment ID="159"/>
      <Payment ID="160"/>
    </PaymentList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1.    ID – Уникальный код подтверждённого платежа

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetPaymentsDetails" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentList>
      <Payment ID="159" TransactionDateTime="2010-08-17 15:22:08" PIN="0505/017981" PayDate="2007-09-25" Period="200708" Summ="1.99" Result="OK(200)"/>
      <Payment ID="160" TransactionDateTime="2010-08-17 15:22:10" PIN="0307/017479" PayDate="2007-09-25" Period="200708" Summ="9.11" Result="OK(200)"/>
    </PaymentList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    TransactionDateTime – Дата и время подтверждения агентом оплаты
2.    PIN – ПИН *)
3.    PayDate – Дата оплаты клиентом
4.    Period – Оплата за период
5.    Summ – Общая сумма по подтверждённой оплате

GetPaymentsRegister

Получить реест платежей под платёжное поручение

Сгенерировать и получить ссылку на PDF-версию реестра платежей под платёжное поручение

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetPaymentsRegister" CompressResult="True"/>
  <Data>
    
    <Sheet ID="3039">
      <Recipient>
          <PaymentFunction>житлово-комунальні послуги та перерахованих на розподільчий</PaymentFunction>
          <BankAccount>2603000018106</BankAccount>
          <BankName>ВАТ КБ "Хрещатик"2</BankName>
          <BankCode>300670</BankCode>
          <Code>04013755</Code>
      </Recipient>
      <Bank>
        <Name>ВАТ КБ 'БАНК'</Name>
        <MFO>332211</MFO>
      </Bank>
      <PersonList>
        <Person>
          <Title>Гол.бухгалтер</Title>
          <Name>Иванов Иван Иванович</Name>
        </Person>
        <Person>
          <Title>Директор</Title>
          <Name>Сидоров Сидор Сидорович</Name>
        </Person>
      </PersonList>
    </Sheet>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Sheet/> – Контейнер данных запроса реестра платежей
2.    ID – Уникальный идентификатор платёжного поручения *)
3. <Recipient/> – Данные получателя платежа *)
4.    PaymentFunction – Назначение платежа *)
5.    BankAccount – Номер расчётного счёта
6.    BankName – Название банка
7.    BankCode – Код банка (МФО)
8.    Code – Код организации, на которую открыт счёт (ЄДРПОУ), без лидирующих нулей
9. <Bank/> – Данные банка *)
10.    Name – Название банка или название финансовой компании, которая перечисляет средства
11.    MFO – МФО банка
12. <Company/> – Данные финансовой компании *)
13.    Name – Название банка или название финансовой компании
14. <PersonList/> – Контейнер перечня ответственных лиц, подписывающих квитанцию *)
15. <Person/Title/> – Должность ответственного лица, подписывающего квитанцию
16. <Person/Name/> – Фамилия, Имя, Отчество ответственного лица, подписывающего квитанцию

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetPaymentsRegister" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Receipt>/docs/registers/3039-628b45.pdf</Receipt>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Receipt/> – URI файла сгенерированного реестра в PDF-формате *)

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

PutPaySheet

Разместить электронный реестр

Разместить электронный реестр подтверждённых оплат. Один электронный реестр описывает одно банковское платёжное поручение.

» Запрос

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Query" Query="PutPaySheet" CompressResult="True"/>
  <Data>
    
    <PaySheetList>
      <PaySheet Date="20071016" Number="12/2875" BankID="9999" Summ="1250.73" Test="True" EachPaymentResult="False">
        <Payment ID="159"/>
        <Payment ID="160"/>
      </PaySheet>
    </PaySheetList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaySheetList/> – Контейнер реестров подтверждённых платежей
2. <PaySheet/> – Реестр подтверждённых платежей
3.    Date – Дата платёжного поручения
4.    Number – Номер платёжного поручения. Такой-же как мы увидим, когда средства поступят на расчётный счёт.
5.    BankID – Код банка *)
6.    Summ – Общая сумма по платёжному поручению *)
7.    Test – Признак тестового платёжного реестра *)
8.    EachPaymentResult – Возвращать результат обработки каждого платежа *)
9. <Payment/> – Подтверждённый платёж
10.    ID – Уникальный код подтверждённого платежа

« Ответ

<DataExchangeModule Interface="Common-1.0">
  <Head Type="Reply" Query="PutPaySheet" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaySheetList>
      <PaySheet ID="9" Result="OK(200)"/>
    </PaySheetList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PaySheetList – Контейнер результатов обработки реестров
2.    PaySheet – Результат обработки реестра
3.    ID – Уникальный код сохранённого реестра *)
4.    Result – Результат обработки реестра

Интерфейс NPOIT, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов оператора кабельного телевидения НПО "Информационные технологии"

GetBill

Получить счёт

Получить развёрнутый счёт за оказанные услуги кабельного телевидения и интернет

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="1230120" Period="200710" Number="1" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт
2.    Period – Период счета
3.    Number – Номер счёта *)
4.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1170460" Period="200710" Number="1" Result="OK(200)">
      <Abonent Address="МИРУ ПР-Т, буд.8, кв.46" FIO=""/>
      <ExtraFeeList Summ="35.00">
        <ExtraFee Code="1" Summ="15.00"/>
        <ExtraFee Code="6" Summ="20.00"/>
      </ExtraFeeList>
      <ManualFeeList>
        <ManualFee Code="90" Summ="13.00"/>
        <ManualFee Code="91" Summ="-20.00"/>
        <ManualFee Code="92" Summ="0.00"/>
      </ManualFeeList>
    </BillData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Abonent/> – Контейнер персональных данных абонента
2.    Address – Почтовый адрес
3.    FIO – Фамилия, Имя, Отчество *)
4. <ExtraFeeList/> – Контейнер начислений по услугам
5.    Summ – Общая сумма начислений *)
6. <ExtraFee/> – Начисление по услуге *)
7.    Code – Код услуги [см.Получить кодификатор названий начислений]
8.    Summ – Сумма начисления
9. <ManualFeeList/> – Контейнер ручного заполнения *)
10. <ManualFee/> – Ручное заполнение
11.    Code – Код услуги [см.Получить кодификатор названий начислений]
12.    Summ – Сумма *)

GetBillNumber

Получить номер первого выставленного счёта в указанном периоде

Получить номер первого выставленного счёта в указанном периоде

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetBillNumber" CompressResult="True"/>
  <Data>
    <QueryParams PIN="1230120" Period="200710" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт
2.    Period – Период счета

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetBillNumber" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1170460" Period="200710" Number="1" Result="OK(200)"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Number – Порядковый номер счёта, присвоенный в процессе формирования счетов.

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="3707100004601030010105002100" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="4601030" Number="1" Period="200710"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – Номер ЖЭКа
2.    Number – Номер счёта
3.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="200710"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetPaymentNames

Получить кодификатор названий начислений

Получить кодификатор названий начислений

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetPaymentNames" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetPaymentNames" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment Code="1" Title="За доступ до телемережі"/>
      <Payment Code="6" Title="За доступ до пакету закодованих телеканалів"/>
      <Payment Code="8" Title="За доступ до цифрового телебачення"/>
      <Payment Code="9" Title="Аренда цифрового декодера"/>
      <Payment Code="10" Title="Выкуп цифрового декодера"/>
      <Payment Code="90" Title="Борг"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код начисления
2.    Title – Название

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

PutBill

Разместить счёт

Разместить счёт

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="PutBill" CompressResult="True"/>
  <Data>
    
    <BillsList>
      <Bill PIN="99999999" Period="201010" Number="1">
        <Abonent Street="КОНЕЧНА ВУЛ." House="99е" Flat="11" FIO="ПУПКИН И.А."/>
        <FeeList>
          <Fee Code="1" Summ="35.00"/>
          <Fee Code="50" Summ="35.00"/>
          <Fee Code="90" Summ="0.00"/>
        </FeeList>
      </Bill>
      <Bill PIN="88888888" Period="201010" Number="2">
        <Abonent Street="НАКОНЕЧНА ВУЛ." House="11ф" Flat="99" FIO="ШАПКИН У.А."/>
        <FeeList>
          <Fee Code="1" Summ="75.00"/>
          <Fee Code="50" Summ="75.00"/>
          <Fee Code="90" Summ="-120.00"/>
        </FeeList>
      </Bill>
    </BillsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <BillsList/> – Контейнер, содержащий перечень размещаемых счетов
2. <Bill/> – Контейнер, содержащий один размещаемый счёт
3.    PIN – ПИН абонента
4.    Period – Период, за который выставляется счёт *)
5.    Number – Уникальный номер счёта по данному ПИНу и периоду в баазе НПО
6. <Abonent/> – Контейнер, содержащий данные абонента
7.    Street – Название улицы, на которой проживает абонент
8.    House – Номер дома абонента
9.    Flat – Номер квартиры абонента
10.    FIO – ФИО абонента
11. <FeeList/> – Контейнер, содержащий перечень начислений абонента
12. <Fee/> – Контейнер, содержащий данные по одному начислению
13.    Code – Код начисления согласно справочника [см.Получить кодификатор названий начислений] *)
14.    Summ – Сумма начисления

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="PutBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillsList>
      <Bill ID="100873" Result="OK(200)"/>
      <Bill ID="100874" Result="OK(200)"/>
    </BillsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <BillsList/> – Контейнер, содержащий перечень размещаемых счетов
2. <Bill/> – Контейнер, содержащий один размещаемый счёт
3.    ID – Присвоенный уникальный идентификатор *)
4.    Result – Результат размещения счёта

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment PIN="1170460" Number="1" Period="200710" PayDate="20071018" Summ="65.00">
        <ExtraFeeList Summ="35.00"/>
        <ManualFeeList>
          <ManualFee Code="90" Summ="10.00"/>
          <ManualFee Code="91" Summ="20.00"/>
        </ManualFeeList>
      <SupplyData/>
      </Payment>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Контейнер подтверждения оплат
2. <Payment/> – Подтверждение оплаты
3.    PayDate – Дата платежа клиентом
4.    Summ – Общая сумма оплаты по счёту
5.    PIN – ПИН абонента
6.    Number – Номер счёта *)
7.    Period – Период счета за который производится оплата
8. <ExtraFeeList/> – Контейнер данных оплат начислений по услугам
9.    Summ – Общая сумма оплаты начислений
10. <ManualFeeList/> – Контейнер оплат ручного заполнения
11. <ManualFee/> – Данные по одному ручнму заполнению
12.    Code – Код услуги [см.Получить кодификатор названий начислений]
13.    Summ – Сумма
14. <SupplyData/> – Сопроводительная информация *)

« Ответ

<DataExchangeModule Interface="NPOIT-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment ID="32015" Result="OK(200)"/>
      <Payment ID="32016" Result="OK(200)"/>
      <Payment ID="0" Result="ERROR(555)"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс KTS, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов оператора кабельного телевидения СКП "Киевтелесервис"

GetBill

Получить счёт

Получить развёрнутый счёт за оказанные услуги кабельного телевидения и интернет

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="1230120" Period="200710" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт (ПИН абонента)
2.    Period – Период счета
3.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1019501790" Period="200711" Result="OK(200)">
      <Abonent Address="ГЛУШКОВА АКАДЕМIКА ПР-Т, буд.22, кв.179" FIO=""/>
      <ExtraFeeList Summ="18.00">
        <ExtraFee Code="1" Summ="18.00"/>
      </ExtraFeeList>
      <ManualFeeList>
        <ManualFee Code="90" Summ="18.00"/>
      </ManualFeeList>
    </BillData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Abonent/> – Контейнер персональных данных абонента
2.    Address – Почтовый адрес
3.    FIO – Фамилия, Имя, Отчество *)
4. <ExtraFeeList/> – Контейнер начислений по услугам
5.    Summ – Общая сумма начислений *)
6. <ExtraFee/> – Начисление по услуге *)
7.    Code – Код услуги [см.Получить кодификатор названий начислений]
8.    Summ – Сумма начисления
9. <ManualFeeList/> – Контейнер ручного заполнения *)
10. <ManualFee/> – Ручное заполнение
11.    Code – Код услуги [см.Получить кодификатор названий начислений]
12.    Summ – Сумма *)

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="44071110195017900180000000" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1019501790" Period="200711"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – ПИН абонента
2.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="200711"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetPaymentNames

Получить кодификатор названий начислений

Получить кодификатор названий начислений

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="GetPaymentNames" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="GetPaymentNames" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment Code="1" Title="Системи колективного прийому телебачення"/>
      <Payment Code="2" Title="Підключення до СКПТ"/>
      <Payment Code="90" Title="Борг"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код начисления
2.    Title – Название

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment PIN="1170460" Period="200710" PayDate="20071018" Summ="36.00">
        <ExtraFeeList Summ="18.00"/>
        <ManualFeeList>
          <ManualFee Code="90" Summ="18.00"/>
        </ManualFeeList>
      <SupplyData/>
      </Payment>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Контейнер подтверждения оплат
2. <Payment/> – Подтверждение оплаты
3.    PayDate – Дата платежа клиентом
4.    Summ – Общая сумма оплаты по счёту
5.    PIN – ПИН абонента
6.    Period – Период счета за который производится оплата
7. <ExtraFeeList/> – Контейнер данных оплат начислений по услугам
8.    Summ – Общая сумма оплаты начислений
9. <ManualFeeList/> – Контейнер оплат ручного заполнения
10. <ManualFee/> – Данные по одному ручнму заполнению
11.    Code – Код услуги [см.Получить кодификатор названий начислений]
12.    Summ – Сумма
13. <SupplyData/> – Сопроводительная информация *)

« Ответ

<DataExchangeModule Interface="KTS-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment ID="32015" Result="OK(200)"/>
      <Payment ID="32016" Result="OK(200)"/>
      <Payment ID="0" Result="ERROR(555)"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Rodplat, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов родительской платы

GetBill

Получить счёт

Получить счёт за питание ребёночка в детском садике

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="21381813926" Check="42" Period="201212" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Персональный идентификационный номер (ПИН) ребёночка *)
2.    Check – Контрольное число *)
3.    Period – Период счета *)
4.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="21381813926" Period="201212" Result="OK(200)">
      <ChildsGardenName>Сонечко</ChildsGardenName>
      <ChildName></ChildName>
      <ExtraFee>218.40</ExtraFee>
    </BillData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Period – Период счета
2. <ChildsGardenName/> – Название садика (детского учереждения)
3. <ChildName/> – Имя ребёночка *)
4. <ExtraFee/> – Сумма начислений

GetCBs

Получить справочник ЦБ

Получить справочник центральных бухгалтерий (ЦБ) и из реквизитов

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="GetCBs" CompressResult="True"/>
  <Data>
    <QueryParams Period="201212" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Period – Период *)

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="GetCBs" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <CBsList Period="201212">
      <CB Code="4" EDRPOU="12345690" MFO="123456" Account="12345678905513" KFK="12345">
        <Name>СОЛОМ'ЯНСЬКЕ УО</Name>
        <BankName>Банк ГУДКУ м.КИЄВА</BankName>
      </CB>
      <CB Code="212" EDRPOU="43215690" MFO="553456" Account="42377678905513">
        <Name>ШЕВЧЕНКIВСЬКОЇ РДА</Name>
        <BankName>Банк УДК м.КИЄВА</BankName>
      </CB>
    </CBsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Period – Период актуальности справочника
2.    Code – Код ЦБ
3.    EDRPOU – ЄДРПОУ
4.    MFO – МФО
5.    Account – Расчётный счёт
6.    KFK – Код функціональної классифікації видатків *)
7. <Name/> – Название ЦБ
8. <BankName/> – Название банка

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="4121381813926000004732" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="21381813926" />
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – Персональный идентификатор ребёночка *)

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="200710"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment PIN="21381813926" Period="201212" PayDate="20130107" Summ="47.32" />
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Контейнер подтверждения оплат
2. <Payment/> – Подтверждение оплаты
3.    PayDate – Дата платежа клиентом
4.    Summ – Общая сумма оплаты по счёту
5.    PIN – ПИН ребёнка
6.    Period – Период счета за который производится оплата

« Ответ

<DataExchangeModule Interface="Rodplat-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment ID="32015" Result="OK(200)"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Municipal, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов (с августа 2014г включительно) оплаты коммунальных и других услуг в разрезе поставщиков коммунальных г.Киева

GetBill

Получить счёт

Получить развёрнутые данные по выставленному счёту за коммунальные услуги за период по указанным ЖЭКу и лицевому счёту

» Запрос

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams JEK="310" PACC="91519" Period="201408" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период счета

« Ответ

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData JEK="310" PACC="91519" Period="201407" ID="6d38d371-93c7-c55e-5393-4345f281e906" Result="OK(200)">
      <AccountInfo StreetAddress="МАЯКОВСЬКОГО В. ПР-Т,Б.3А" Flat="1"/>
      <Services>
        <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e" Title="ЖИТЛОВО-КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ" OrganizationTitle="ЖЕК - 310" DebtSumm="0.00" AccruedSumm="134.67"/>
        <Service ID="a156ca58-b91f-9071-fd0c-3cc52c44cd3c" Title="ЕЛЕКТРОЕНЕРГIЯ" OrganizationTitle="ЖЕК - 310" DebtSumm="0.00" AccruedSumm="0.00">
          <Counter Precision="0" Tariff="0.1234" TariffPrecision="4" Previous="0" MeasureName="кВтг"/>
        </Service>
        <Service Id="70b2c9a3-2912-2094-4703-efa310951183" Title="ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ХОЛОДНОЇ ВОДИ ТА ВОДОВІДВЕДЕННЯ" OrganizationTitle="ПАТ "АК"КИЇВВОДОКАНАЛ"" DebtSumm="0.00" AccruedSumm="0.00">
          <Counter Precision="1" Tariff="7.464" TariffPrecision="3" Previous="0.0" MeasureName="м³"/>
        </Service>
        <Service Id="4d68a3e3-a954-98fb-ed68-7f24bb333193" Title="ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ" OrganizationTitle="ПАТ "КИЇВЕНЕРГО"" DebtSumm="0.00" AccruedSumm="0.00">
          <Counter Precision="1" Tariff="25.10" TariffPrecision="2" Previous="0.0" MeasureName="м³"/>
        </Service>
        <Service Id="b981ff54-947e-8b4c-310d-5f4f9ad62115" Title="ЦЕНТРАЛІЗОВАНЕ ВОДОВІДВЕДЕННЯ ГАРЯЧОЇ ВОДИ" OrganizationTitle="ПАТ "АК"КИЇВВОДОКАНАЛ"" DebtSumm="0.00" AccruedSumm="0.00">
          <Counter Precision="1" Tariff="3.576" TariffPrecision="3" Previous="0.0" MeasureName="м³"/>
        </Service>
        <Service Id="a77fac3b-9a21-0917-b266-7f28adf4787e" Title="ЦЕНТРАЛІЗОВАНЕ ОПАЛЕННЯ" OrganizationTitle="ПАТ "КИЇВЕНЕРГО"" DebtSumm="0.00">
          <Counter Precision="5" Tariff="3.10" TariffPrecision="2" Previous="0.00000" MeasureName="Гкал"/>
        </Service>
      </Services>
    </BillData>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <BillData/> – Контейнер данных счёта
2.    JEK – Шифр ЖЭ0
3.    PACC – Лицевой счёт
4.    Period – Период счета
5.    ID – Уникальный идентификатор выставленного счёта *)
6. <AccountInfo/> – Общие данные по счёту
7.    StreetAddress – Адрес. Улица, номер дома.
8.    Flat – Номер квартиры
9. <Services/> – Контейнер услуг
10. <Service/> – Контейнер услуги
11.    ID – Идентификатор услуги *)
12.    Title – Название услуги
13.    OrganizationTitle – Название организации, предоставляющей услугу
14.    DebtSumm – Сумма долга/переплаты *)
15.    AccruedSumm – Сумма, начисленная к оплате *)
16. <Counter/> – Контейнет счётчика ручного заполнения *)
17.    Precision – Точность показаний счёчика *)
18.    Tariff – Тариф по услуге для оплаты по счётчику
19.    TariffPrecision – Точность тарифа *)
20.    Previous – Предыдущие показания счётчика *)
21.    MeasureName – Название единицы измерения по счётчику

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="111408020105050179810015320000" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData JEK="505" PACC="17981" Period="201408"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data>
    
    <QueryParams />
					
  </Data>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="200708"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
      <Result Code="553" Description="Запрошенный период не найден в базе выставленных счетов."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <PaymentsList>
      <Payment BillDataID="ca2c555d-3f0b-86c0-dad4-59ebd3cf8e00" Date="20140916" Summ="859.89">
        <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e" AccruedSumm="799.89" DebtSumm="0"/>
        <Service ID="a156ca58-b91f-9071-fd0c-3cc52c44cd3c">
          <Counter Current="10" Previous="8" Consumed="2" Summ="10.00"/>
        </Service>
        <Service ID="70b2c9a3-2912-2094-4703-efa310951183" AccruedSumm="0" DebtSumm="20.00">
          <Counter Consumed="12" Summ="30.00"/>
        </Service>
      </Payment>
      <Payment BillDataID="ca2c555d-3f0b-86c0-dad4-59ebd3cf8e00" Date="20140917" Summ="102.01">
        <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e" AccruedSumm="100.01" DebtSumm="1.99"/>
      </Payment>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <PaymentsList/> – Контейнер подтверждения оплат
2. <Payment/> – Подтверждение оплаты
3.    BillDataID – Уникальный идентификатор выставленного счёта *)
4.    Date – Фактическая дата платежа клиентом
5.    Summ – Общая сумма оплаты по счёту
6. <Service/> – Данные по оплачиваемой услуге
7.    ID – Уникальный идентификатор услуги *)
8.    AccruedSumm – Оплата начислений
9.    DebtSumm – Оплата долга или дополнительно
10. <Counter/> – Контейнер данных по счётчику
11.    Current – Текущие показания
12.    Previous – Предыдущие показания
13.    Consumed – Использовано
14.    Summ – Сумма оплаты по показаниям счётчика

« Ответ

<DataExchangeModule Interface="Municipal-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <PaymentsList>
      <Payment ID="32015" Result="OK(200)"/>
      <Payment ID="0" Result="ERROR(555)"/>
    </PaymentsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <PaymentsList/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Municipal, версия 2.0

Интерфейс предоставляет доступ к базе данных выставленных счетов (с октября 2014г включительно) оплаты коммунальных и других услуг в разрезе поставщиков коммунальных г.Киева

CheckAuthkey

Проверка корректности ключа активации

Выполняется проверка корректности ключа активации для данного лицевого счёта.

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="CheckAuthkey" CompressResult="True"/>
  <Data>
    <QueryParams JEK="2221" PACC="621411" Period="201506" Authkey="9NRSPY7GEKWF" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период, за которы выставлен счёт
4.    Authkey – Ключ активации *)

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="CheckAuthkey" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
  </Data>
</DataExchangeModule>

GetBill

Получить выставленный счёт определённого типа

Получить выставленный счёт за указанный период по лицевому счёту определённого типа. Рекомендуется использовать получение всех выставленных счетов [см.Получить все выставленные счета]

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    
    <QueryParams JEK="505" PACC="17981" Period="201410" BillTypeID="226100e6-847f-48bd-a765-2e1a1567a425" />
    <QueryParams JEK="505" PACC="17981" Period="201410" BillTypeID="539554ab-2884-4577-8218-928d4a6aa498" />
    <QueryParams JEK="115" PACC="333444" Period="201410" BillTypeID="226100e6-847f-48bd-a765-2e1a1567a425" />
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <QueryParams/> – Контейнер, содержащий данные по одному счёту
2.    JEK – Номер ЖЭО
3.    PACC – Номер лицевого счёта
4.    Period – Период, за которы выставлен счёт
5.    BillTypeID – Уникальный идентификатор типа счёта *)

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Bills>
      <Bill JEK="505" PACC="17981" ID="a110db6f-8db9-1674-a12a-65a036a25ab9" TypeID="226100e6-847f-48bd-a765-2e1a1567a425" LayoutID="afd1682f-fe09-95ef-0021-a76e4debfa2c" Result="OK(200)">
        <Title>ЖИТЛОВО-КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ</Title>
        <Period>201410</Period>
        <PayerInfo>
          <JEK>505</JEK>
          <PACC>17981</PACC>
          <StreetAddress>МАЛИНОВСЬКОГО МАРШАЛА ВУ,Б.13А</StreetAddress>
          <Flat>188</Flat>
        </PayerInfo>
        <Biller ID="c2eff163-7961-4ae0-ab89-5255dc80c6fe" ShortCode="2">
          <Title>КП ГЫОЦ</Title>
          <Code>4013755</Code>
          <Bank>
            <Title>ПАК КБ "Хрещатик"</Title>
            <Code>300670</Code>
            <Account>2603400038106</Account>
          </Bank>
    	</Biller>
        <ServiceProviders>
          <ServiceProvider ID="a1e39d77-0adc-d598-dcab-46a63de13e97">
            <Title>ЖЕК - 505</Title>
            <AccruedSumm>97.50</AccruedSumm>
            <DebtSumm>9.99</DebtSumm>
            <Services>
              <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e">
                <Title>ЖИТЛОВО-КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ</Title>
                <AccruedSumm>87.50</AccruedSumm>
              </Service>
              <Service ID="06c97df8-db74-ea14-9b27-28ed5e2c8df4">
                <Title>Газ</Title>
                <AccruedSumm>10.00</AccruedSumm>
              </Service>
            </Services>  
          </ServiceProvider>
          <ServiceProvider ID="05710df3-5d12-fd48-73b8-703a9fac9715">
            <Title>ПАТ "АК"КИЇВВОДОКАНАЛ"</Title>
            <AccruedSumm>25.33</AccruedSumm>
            <DebtSumm>-9.99</DebtSumm>
            <Services>
              <Service ID="70b2c9a3-2912-2094-4703-efa310951183">
                <Title>ПОСТАЧАННЯ ХОЛОДНОЇ ВОДИ ТА ВОДОВІДВЕДЕННЯ</Title>
                <AccruedSumm>25.33</AccruedSumm>
                <Counter>
                  <Precision>1</Precision>
                  <Tariff>7.464</Tariff>
                  <TariffPrecision>3</TariffPrecision>
                  <MeasureName>м³</MeasureName>
                </Counter>
              </Service>
            </Services>  
          </ServiceProvider>
          <ServiceProvider ID="05710df3-5d12-fd48-73b8-703a9fac9715">
            <Title>ПАТ "АК"КИЇВВОДОКАНАЛ"</Title>
            <AccruedSumm>17.50</AccruedSumm>
            <Services>
              <Service ID="b981ff54-947e-8b4c-310d-5f4f9ad62115">
                <Title>ВОДОВІДВЕДЕННЯ ГАРЯЧОЇ ВОДИ</Title>
                <AccruedSumm>17.50</AccruedSumm>
              </Service>
            </Services>  
          </ServiceProvider>
        </ServiceProviders>
      </Bill>
      <Bill JEK="505" PACC="17981" Period="201410" ID="8fd1bde9-8755-4b52-b9cd-c6337fd8f18f" TypeID="539554ab-2884-4577-8218-928d4a6aa498" Result="OK(200)">
        <Title>ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ</Title>
        <Period>201410</Period>
        <PayerInfo>
          <JEK>505</JEK>
          <PACC>17981</PACC>
          <StreetAddress>МАЛИНОВСЬКОГО МАРШАЛА ВУ,Б.13А</StreetAddress>
          <Flat>188</Flat>
        </PayerInfo>
        <Biller ID="f29d42bf-79f3-f9b7-fc14-cf89f4d7459a" ShortCode="33">
          <Title>ПАТ "КИЇВЕНЕРГО"</Title>
          <Code>221602</Code>
          <Bank>
            <Title>АТ "Ощадбанк" ГУ по м.Києву та областi</Title>
            <Code>322669</Code>
            <Account>260323000201</Account>
          </Bank>
    	  </Biller>
        <ServiceProviders>
          <ServiceProvider ID="f29d42bf-79f3-f9b7-fc14-cf89f4d7459a">
            <Title>ПАТ "КИЇВЕНЕРГО"</Title>
            <DebtSumm>91.99</DebtSumm>
            <Services>
              <Service ID="4d68a3e3-a954-98fb-ed68-7f24bb333193">
                <Title>ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ</Title>
                <Counter>
                  <Previous>215</Previous>
                  <Precision>1</Precision>
                  <Tariff>25.10</Tariff>
                  <TariffPrecision>2</TariffPrecision>
                  <MeasureName>м³</MeasureName>
                </Counter>
              </Service>
            </Services>  
          </ServiceProvider>
        </ServiceProviders>
      </Bill>
      <Bill JEK="115" PACC="333444" Period="201410" Result="ERROR(552)" />
    </Bills>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Bills/> – Контейнер данных списка запрошенных выставленных счетов *)
2. <Bill/> – Контенер данных выставленного счёта
3.    JEK – Шифр ЖЭО *)
4.    PACC – Лицевой счёт *)
5.    Period – Период выставленного счёта *)
6.    ID – Уникальный идентификатор выставленного счёта *)
7.    TypeID – Уникальный идентификатор типа счёта *)
8.    LayoutID – Служебная информация *)
9. <Title/> – Название выставленного счёта *)
10. <Period/> – Период выставленного счёта
11. <PayerInfo/> – Контейнер данных о плательщике
12. <JEK/> – Шифр ЖЭО
13. <PACC/> – Лицевой счёт
14. <StreetAddress/> – Название улицы + номер дома
15. <Flat/> – Квартира
16. <Biller/> – Контейнер данных о выставителе счёта *)
17.    ID – Идентификатор организации *)
18.    ShortCode – Короткий идентификатор организации *)
19. <Title/> – Название организации
20. <Code/> – Код в госреестре *)
21. <Bank/> – Контейнер данных банка *)
22. <Title/> – Название банка
23. <Code/> – Код банка *)
24. <Account/> – Расчётный счёт
25. <ServiceProviders/> – Контейнер поставщиков, услуги которых будут оплачены в данном счёте
26. <ServiceProvider/> – Контейнер поставщика услуг
27.    ID – Уникальный идентификатор *)
28. <Title/> – Название поставщика
29. <AccruedSumm/> – Общая сумма начислений по поставщику услуг
30. <DebtSumm/> – Сумма задолженности/переплаты по данному поставщику
31. <Services/> – Контейнер услуг, предоставляемых данным поставщиком
32. <Service/> – Контейнер данных по услуге
33.    ID – Уникальный идентификатор *)
34. <Title/> – Название услуги
35. <AccruedSumm/> – Начисленная суииа по услуге *)
36. <Counter/> – Контейнер данных по счётчику *)
37. <Previous/> – Предыдущие показания *)
38. <Precision/> – Точность показаний *)
39. <Tariff/> – Тариф *)
40. <TariffPrecision/> – Точность тарифа *)
41. <MeasureName/> – Название единицы измерения

GetBillTypes

Получить перечень типов счетов

Получить перечень доступных на данном интерфейсе типов счетов

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetBillTypes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetBillTypes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillTypes>
      <BillType ID="226100e6-847f-48bd-a765-2e1a1567a425">
        <Title>ЖИТЛОВО-КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ</Title>
      </BillType>
      <BillType ID="539554ab-2884-4577-8218-928d4a6aa498">
        <Title>ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ</Title>
      </BillType>
      <BillType ID="be05964a-d77c-4d7c-b62d-4adbe186d64c">
        <Title>ЦЕНТРАЛІЗОВАНЕ ОПАЛЕННЯ</Title>
      </BillType>
    </BillTypes>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <BillType/> – Контейнер данных о типе счёта
2.    ID – Уникальный идентификатор типа счёта *)
3. <Title/> – Обобщённое название типа счёта *)

GetBills

Получить все выставленные счета

Получить все выставленные счета за указанный период по лицевому счёту.

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetBills" CompressResult="True"/>
  <Data>
    
    <QueryParams JEK="505" PACC="17981" Period="201410" />
    <QueryParams JEK="310" PACC="92825" />
    <QueryParams JEK="150" PACC="8234" Period="201410" />
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <QueryParams/> – Контейнер, содержащий данные по одному счёту
2.    JEK – Номер ЖЭО
3.    PACC – Номер лицевого счёта
4.    Period – Период, за который выставлен счёт *)

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetBills" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Bills JEK="505" PACC="17981" Period="201410" Result="OK(200)">
      <Bill ID="a110db6f-8db9-1674-a12a-65a036a25ab9" TypeID="226100e6-847f-48bd-a765-2e1a1567a425">
        <Title>ЖИТЛОВО-КОМУНАЛЬНІ ТА ІНШІ ПОСЛУГИ</Title>
        [...]
      </Bill>
      <Bill ID="8fd1bde9-8755-4b52-b9cd-c6337fd8f18f" TypeID="539554ab-2884-4577-8218-928d4a6aa498" Result="OK(200)">
        <Title>ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ</Title>
        [...]
      </Bill>
      <Bill ID="979fad4c-423d-4790-b005-fff73923ef7e" TypeID="be05964a-d77c-4d7c-b62d-4adbe186d64c" Result="OK(200)">
        <Title>ЦЕНТРАЛІЗОВАНЕ ОПАЛЕННЯ</Title>
        [...]
      </Bill>
    </Bills>
    <Bills JEK="310" PACC="92825" Result="OK(200)">
        [...]
    </Bills>
    <Bills JEK="150" PACC="8234" Period="201410" Result="ERROR(558)" />
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Bills/> – Контейнер данных списка запрошенных выставленных счетов *)
2.    JEK – Шифр ЖЭО *)
3.    PACC – Лицевой счёт *)
4.    Period – Период выставленного счёта *)
5. <Bill/> – Контейнер выставленного счёта *)

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="151410000266010840201100015762" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData JEK="6601" PACC="84020" Period="201410" BillTypeID="226100e6-847f-48bd-a765-2e1a1567a425" BillerShortCode="2" />
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    JEK – Номер ЖЭКа
2.    PACC – Лицевой счёт
3.    Period – Период счета
4.    BillTypeID – Уникальный идентификатор типа счёта *)
5.    BillerShortCode – Короткий идентификатор организации *)

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data>
    
    <QueryParams />
					
  </Data>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="201410"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
      <Result Code="553" Description="Запрошенный период не найден в базе выставленных счетов."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

GetServices

Получить справочнить базовых услуг

Справочник услуг на данном этапе предоставляет список фиксированно присвоенных идентификаторов услугам.

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="GetServices" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="GetServices" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Services>
      <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e">
        <Title>УТРИМАННЯ БУДИНКУ ТА ПРИБУДИНКОВОI ТЕРIТОРII</Title>
      </Service>
      <Service ID="06c97df8-db74-ea14-9b27-28ed5e2c8df4">
        <Title>ГАЗ</Title>
      </Service>
      <Service ID="a156ca58-b91f-9071-fd0c-3cc52c44cd3c">
        <Title>ЕЛЕКТРОЭНЕРГIЯ</Title>
      </Service>
      <Service ID="7e7f2f47-97a8-1be2-1149-8ff43987a6c3">
        <Title>IНШI ПОСЛУГИ</Title>
      </Service>
      <Service ID="c1ff601c-806b-9ce7-ca8a-0061384dfba7">
        <Title>КРЕДИТИВУННЯ ЛIЧИЛЬНИКIВ</Title>
      </Service>
      <Service ID="70b2c9a3-2912-2094-4703-efa310951183">
        <Title>ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ХОЛОДНОЇ ВОДИ ТА ВОДОВІДВЕДЕННЯ ХВ</Title>
      </Service>
      <Service ID="4d68a3e3-a954-98fb-ed68-7f24bb333193">
        <Title>ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ</Title>
      </Service>
      <Service ID="b981ff54-947e-8b4c-310d-5f4f9ad62115">
        <Title>ЦЕНТРАЛІЗОВАНЕ ВОДОВІДВЕДЕННЯ ГАРЯЧОЇ ВОДИ</Title>
      </Service>
      <Service ID="a77fac3b-9a21-0917-b266-7f28adf4787e">
        <Title>ЦЕНТРАЛІЗОВАНЕ ОПАЛЕННЯ</Title>
      </Service>
    </Services>
    
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Services/> – Контейнер списка услуг
2. <Service/> – Контейнер данных по услуге
3.    ID – Уникальный идентификатор услуги *)
4. <Title/> – Название услуги *)

PutPayment

Подтверждение оплаты

В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании электронного реестра платежей [см.Разместить электронный реестр]. В случае неудачной обработки код ошибки указывает на причину неудачи. При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <Payments>
      <Payment BillID="ca2c555d-3f0b-86c0-dad4-59ebd3cf8e00">
        <Date>20141116</Date>
        <TotalSumm>1127.49</TotalSumm>
        <ServiceProviders>
          <ServiceProvider ID="a1e39d77-0adc-d598-dcab-46a63de13e97">
            <AccruedSumm>769.89</AccruedSumm>
            <DebtSumm>10.01</DebtSumm>
            <Services>
              <Service ID="35b25213-d4a7-dd21-746e-534de0cfb46e">
                <AccruedSumm>769.89</AccruedSumm>
              </Service>
            </Services>
          </ServiceProvider>
          <ServiceProvider ID="05710df3-5d12-fd48-73b8-703a9fac9715">
            <AccruedSumm>182.07</AccruedSumm>
            <DebtSumm>-9.99</DebtSumm>
            <Services>
              <Service ID="70b2c9a3-2912-2094-4703-efa310951183">
                <AccruedSumm>25.33</AccruedSumm>
                <Counter>
                  <Current>101</Current>
                  <Previous>80</Previous>
                  <Consumed>21</Consumed>
                  <Summ>156.74</Summ>
                </Counter>
              </Service>
            </Services>
          </ServiceProvider>
          <ServiceProvider ID="05710df3-5d12-fd48-73b8-703a9fac9715">
            <AccruedSumm>170.50</AccruedSumm>
            <DebtSumm>5.01</DebtSumm>
            <Services>
              <Service ID="b981ff54-947e-8b4c-310d-5f4f9ad62115">
                <AccruedSumm>170.50</AccruedSumm>
              </Service>
            </Services>
          </ServiceProvider>
        </ServiceProviders>
      </Payment>
    
      <Payment BillID="0030c9f2-0cc3-3319-ebc5-dc0e03389f2e">
        <Date>20141116</Date>
        <TotalSumm>100.6</TotalSumm>
        <ServiceProviders>
          <ServiceProvider ID="f29d42bf-79f3-f9b7-fc14-cf89f4d7459a">
            <AccruedSumm>150.6</AccruedSumm>
            <DebtSumm>-50</DebtSumm>
            <Services>
              <Service ID="4d68a3e3-a954-98fb-ed68-7f24bb333193">
                <AccruedSumm>150.6</AccruedSumm>
              </Service>
            </Services>
          </ServiceProvider>
        </ServiceProviders>
      </Payment>    

      <Payment BillID="304527f9-4233-692e-7c87-96af522df2fc">
        <Date>20141116</Date>
        <TotalSumm>123.6</TotalSumm>
        <ServiceProviders>
          <ServiceProvider ID="40d33ce4-45a6-cb01-26ce-346a5351aa30">
            <AccruedSumm>123.6</AccruedSumm>
            <Services>
              <Service ID="a77fac3b-9a21-0917-b266-7f28adf4787e">
                <Counter>
                  <Current>1.54384</Current>
                  <Previous>1.21451</Previous>
                  <Consumed>0.32933</Consumed>
                  <Summ>123.6</Summ>
                </Counter>
              </Service>
            </Services>
          </ServiceProvider>
        </ServiceProviders>
      </Payment>    
    </Payments>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Payments/> – Контейнер подтверждений оплат
2. <Payment/> – Контейнер данных об одной оплате
3.    BillID – Идентифкатор счёта *)
4. <Date/> – Фактическая дата оплаты клиентом
5. <TotalSumm/> – Общая сумма оплаты по счёту *)
6. <ServiceProviders/> – Контейнер данных по оплате услуг провайдеров
7. <ServiceProvider/> – Контейнер данных по сервис-провайдеру
8.    ID – Идентификатор сервис-провайдера *)
9. <AccruedSumm/> – Общая сумма оплачиваемых начислений по данному провайдеру *)
10. <DebtSumm/> – Оплачичаемая сумма задолженности или дополнительная сумма *)
11. <Services/> – Контейнер услуг
12. <Service/> – Название услуги
13.    ID – Идентификатор услуги *)
14. <AccruedSumm/> – Оплачиваемая сумма начислений по услуге *)
15. <Counter/> – Контейнер данных по счётчику *)
16. <Current/> – Текущие показания счётчика *)
17. <Previous/> – Предыдущие показания счётчика *)
18. <Consumed/> – Использовано единиц *)
19. <Summ/> – Сумма оплаты по счётчику

« Ответ

<DataExchangeModule Interface="Municipal-2.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Payments>
      <Payment ID="112233" BillID="ca2c555d-3f0b-86c0-dad4-59ebd3cf8e00" Result="OK(200)" />
      <Payment ID="112234" BillID="0030c9f2-0cc3-3319-ebc5-dc0e03389f2e" Result="OK(200)" />
      <Payment BillID="304527f9-4233-692e-7c87-96af522df2fc" Result="ERROR(555)" />
    </Payments>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Payments/> – Контейнер списка подтверждаемых оплат *)
2. <Payment/> – Контейнер подтверждённой оплаты
3.    ID – Уникальный идентификатор подтверждённой оплаты *)
4.    BillID – Идентифкатор счёта *)
5.    Result – Результат выполнения

Интерфейс StarTelecom, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов оператора кабельного телевидения ТОВ "Стар Телекомпани"

GetBill

Получить счёт

Получить счёт за оказанные услуги

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="1230120" Period="200710" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт (ПИН абонента)
2.    Period – Период счета
3.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Bills>
      <Bill Period="201411" PIN="1007001310" Result="OK(200)">
        <Title>Доступ до телекомунікаційних мереж</Title>
        <Period>201411</Period>
        <PIN>1007001310</PIN>
        <Address>КНЯЖИЙ 3АТОН ВУЛ., Б.2/30, КВ.131</Address>
        <AccruedSumm>19.50</AccruedSumm>
        <DebtSumm>0.00</DebtSumm>
        <Services>
          <Service ID="d63ac77c-698f-7f71-d049-f730f12fa90d">
            <Title>Доступ до телекомунікаційних мереж</Title>
            <AccruedSumm>19.50</AccruedSumm>
          </Service>
        </Services>
      </Bill>
    </Bills>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Bills/> – Контейнер данных запрошенных счетов
2. <Bill/> – Контейнер данных счёта
3.    Period – Периода выставленного счёта
4.    PIN – ПИН (персональный идентификационный номер) абонента
5. <Title/> – Название (заголовок) счёта
6. <Period/> – Периода выставленного счёта
7. <PIN/> – ПИН (персональный идентификационный номер) абонента
8. <Address/> – Адрес абонента, по которому выставлен счёт
9. <AccruedSumm/> – Общая сумма начислений по счёту *)
10. <DebtSumm/> – Сумма долга/переплаты *)
11. <Services/> – Контейнер данных по расшифровке предоставленных услуг
12. <Service/> – Контейнер данных предоставленной услуги
13.    ID – Идентификатор услуги *)
14. <Title/> – Название услуги
15. <AccruedSumm/> – Начисленная сумма по данной услуге

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="421411100700131000195000000000" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1007001310" Period="201411"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – ПИН абонента
2.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="201505"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

GetServices

Получить справочник услуг

Получить справочник услуг

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="GetServices" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="GetServices" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Services>
      <Service ID="d63ac77c-698f-7f71-d049-f730f12fa90d">
        <Title>Доступ до телекомунікаційних мереж</Title>
      </Service>
    </Services>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Services/> – Контейнер списка услуг
2. <Service/> – Контейнер данных по услуге
3.    ID – Уникальный идентификатор услуги
4. <Title/> – Название услуги

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <Payments>
      <Payment PIN="1007001310" Period="201505">
        <Date>20150402</Date>
        <AccruedSumm>24.50</AccruedSumm>
        <DebtSumm>11.01</DebtSumm>
      </Payment>
    </Payments>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Payments/> – Контейнер оплат
2. <Payment/> – Контейнер данных подтверждаемой оплаты
3.    PIN – ПИН (персональный идентификационный номер) абонента
4.    Period – Периода оплачиваемого счёта
5. <Date/> – Дата фактической оплаты счёта клиентом
6. <AccruedSumm/> – Общая сумма оплаты начислений по счёту *)
7. <DebtSumm/> – Сумма оплаты долга или дополнительная оплата

« Ответ

<DataExchangeModule Interface="StarTelecom-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Payments>
      <Payment ID="11889321" PIN="1007001310" Period="201505" Result="OK(200)"/>
    </Payments>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Payments/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Domofon, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов за технічне обслуговування домофона ТОВ "КС - Домофон"

GetBill

Получить счёт

Получить счёт за оказанные услуги

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="01046383" Period="201502" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт (ПИН абонента)
2.    Period – Период счета
3.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Bills>
      <Bill Period="201502" PIN="1046383" Result="OK(200)">
        <Title>Технічне обслуговування домофона</Title>
        <Period>201502</Period>
        <PIN>1046383</PIN>
        <Address>ПР-Т ГРИГОРЕНКА ПЕТРА, Б.3В, КВ.888</Address>
        <AccruedSumm>10.00</AccruedSumm>
        <DebtSumm>37.00</DebtSumm>
        <Services>
          <Service ID="03e53883-0164-42c4-b1cb-efbc2ca994d4">
            <Title>Домофон Т/О</Title>
            <AccruedSumm>10.00</AccruedSumm>
          </Service>
        </Services>
      </Bill>
    </Bills>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Bills/> – Контейнер данных запрошенных счетов
2. <Bill/> – Контейнер данных счёта
3.    Period – Периода выставленного счёта
4.    PIN – ПИН (персональный идентификационный номер) абонента
5. <Title/> – Название (заголовок) счёта
6. <Period/> – Периода выставленного счёта
7. <PIN/> – ПИН (персональный идентификационный номер) абонента
8. <Address/> – Адрес абонента, по которому выставлен счёт
9. <AccruedSumm/> – Общая сумма начислений по счёту *)
10. <DebtSumm/> – Сумма долга/переплаты *)
11. <Services/> – Контейнер данных по расшифровке предоставленных услуг
12. <Service/> – Контейнер данных предоставленной услуги
13.    ID – Идентификатор услуги *)
14. <Title/> – Название услуги
15. <AccruedSumm/> – Начисленная сумма по данной услуге

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="45140660104975800700" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1049758" Period="201406"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – ПИН абонента
2.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="201503"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

GetServices

Получить справочник услуг

Получить справочник услуг

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="GetServices" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="GetServices" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Services>
      <Service ID="03e53883-0164-42c4-b1cb-efbc2ca994d4">
        <Title>Домофон Т/О</Title>
      </Service>
    </Services>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Services/> – Контейнер списка услуг
2. <Service/> – Контейнер данных по услуге
3.    ID – Уникальный идентификатор услуги
4. <Title/> – Название услуги

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <Payments>
      <Payment PIN="01046383" Period="201503">
        <Date>20150405</Date>
        <AccruedSumm>10.00</AccruedSumm>
        <DebtSumm>37.10</DebtSumm>
      </Payment>
    </Payments>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Payments/> – Контейнер оплат
2. <Payment/> – Контейнер данных подтверждаемой оплаты
3.    PIN – ПИН (персональный идентификационный номер) абонента
4.    Period – Периода оплачиваемого счёта
5. <Date/> – Дата фактической оплаты счёта клиентом
6. <AccruedSumm/> – Общая сумма оплаты начислений по счёту *)
7. <DebtSumm/> – Сумма оплаты долга или дополнительная оплата

« Ответ

<DataExchangeModule Interface="Domofon-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Payments>
      <Payment ID="11889321" PIN="01046383" Period="201503" Result="OK(200)"/>
    </Payments>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Payments/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)

Интерфейс Seltik, версия 1.0

Интерфейс предоставляет доступ к базе данных выставленных счетов за ивезення твердих побутових відходів ТОВ "Селтік"

GetBill

Получить счёт

Получить счёт за оказанные услуги

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="GetBill" CompressResult="True"/>
  <Data>
    <QueryParams PIN="1161" Period="201503" Barcode="" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    PIN – Лицевой счёт (ПИН абонента)
2.    Period – Период счета
3.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="GetBill" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Bills>
      <Bill Period="201503" PIN="1161" Result="OK(200)">
        <Title>Вивезення твердих побутових відходів (ТПВ)</Title>
        <Period>201503</Period>
        <PIN>1161</PIN>
        <Address>ВУЛ. ЗОЛОТА, Б.9, КВ.12</Address>
        <AccruedSumm>22.38</AccruedSumm>
        <DebtSumm>22.38</DebtSumm>
        <Registered>5</Registered>
        <Exemption>50</Exemption>
        <Services>
          <Service ID="b0243921-8db9-4eee-9ed6-c8bc8b50c4fa">
            <Title>Вивезення ТПВ</Title>
            <Norma>0.21</Norma>
            <Amount>1.05</Amount>
            <Tariff>42.63</Tariff>
            <AccruedSumm>22.38</AccruedSumm>
          </Service>
        </Services>
      </Bill>
    </Bills>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Bills/> – Контейнер данных запрошенных счетов
2. <Bill/> – Контейнер данных счёта
3.    Period – Периода выставленного счёта
4.    PIN – ПИН (персональный идентификационный номер) абонента
5. <Title/> – Название (заголовок) счёта
6. <Period/> – Периода выставленного счёта
7. <PIN/> – ПИН (персональный идентификационный номер) абонента
8. <Address/> – Адрес абонента, по которому выставлен счёт
9. <AccruedSumm/> – Общая сумма начислений по счёту *)
10. <DebtSumm/> – Сумма долга/переплаты *)
11. <Registered/> – К-ть зареєстрованих
12. <Exemption/> – Пільга, %
13. <Services/> – Контейнер данных по расшифровке предоставленных услуг
14. <Service/> – Контейнер данных предоставленной услуги
15.    ID – Идентификатор услуги *)
16. <Title/> – Название услуги
17. <Norma/> – Норма накопичення на 1 особу, м3 в місяць
18. <Tariff/> – Тариф за м3
19. <Amount/> – Кількість, м3
20. <AccruedSumm/> – Начисленная сумма по данной услуге

GetIdentificationByBarcode

Получить идентификационные данные из последовательности штрих-кода

Получить идентификационные данные из последовательности штрих-кода

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="GetIdentificationByBarcode" CompressResult="True"/>
  <Data>
    <QueryParams Barcode="45140670000116203581" />
  </Data>
</DataExchangeModule>

Параметры запроса

1.    Barcode – Последовательность данных штрих-кода *)

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="GetIdentificationByBarcode" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData PIN="1162" Period="201406"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    PIN – ПИН абонента
2.    Period – Период счета

GetLastBillPeriod

Получить период последнего выставления счетов

Период, за который было произведено выставление счетов в последний раз.

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="GetLastBillPeriod" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="GetLastBillPeriod" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <BillData LastPeriod="201503"/>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    LastPeriod – Период последнего выставления счетов

GetResultCodes

Получить кодификатор результатов обработки запросов

Получить кодификатор результатов обработки запросов

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="GetResultCodes" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="GetResultCodes" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <ResultsList>
      <Result Code="200" Description="Запрос успешно обработан."/>
      <Result Code="300" Description="Пакетный запрос обработан частично. Смотрите результаты обработки каждого подзапроса."/>
      <Result Code="500" Description="Ошибка в структуре XML-документа."/>
      <Result Code="501" Description="Ошибка в структуре XML-запроса."/>
    </ResultsList>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1.    Code – Код результата
2.    Description – Описание результата

GetServices

Получить справочник услуг

Получить справочник услуг

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="GetServices" CompressResult="True"/>
  <Data/>
</DataExchangeModule>

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="GetServices" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Services>
      <Service ID="b0243921-8db9-4eee-9ed6-c8bc8b50c4fa">
        <Title>Вивезення ТПВ</Title>
      </Service>
    </Services>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Services/> – Контейнер списка услуг
2. <Service/> – Контейнер данных по услуге
3.    ID – Уникальный идентификатор услуги
4. <Title/> – Название услуги

PutPayment

Подтверждение оплат

Подтверждение оплат, проведённых Платёжной системой. В результате обработки запроса каждому обработанному подтверждению оплаты присваивается уникальный идентификационный номер, который следует сохранить для дальнейшего использования при формировании реестра платежей. В случае неудачной обработки код равен "нулю" и код ошибки указывает на причину неудачи.
При подаче пакетного запроса (с несколькими подтверждениями) коды присваиваются и возвращаются в том-же порядке, в котором следуют подтверждения оплат. Если пакетный запрос успешно обработан лишь частично, то повторять следует только ошибочные, опуская успешные с присвоенными уже кодами.

» Запрос

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Query" Query="PutPayment" CompressResult="True"/>
  <Data>
    
    <Payments>
      <Payment PIN="553" Period="201503">
        <Date>20150405</Date>
        <AccruedSumm>35.81</AccruedSumm>
        <DebtSumm>75.20</DebtSumm>
      </Payment>
    </Payments>
					
  </Data>
</DataExchangeModule>

Параметры запроса

1. <Payments/> – Контейнер оплат
2. <Payment/> – Контейнер данных подтверждаемой оплаты
3.    PIN – ПИН (персональный идентификационный номер) абонента
4.    Period – Периода оплачиваемого счёта
5. <Date/> – Дата фактической оплаты счёта клиентом
6. <AccruedSumm/> – Общая сумма оплаты начислений по счёту *)
7. <DebtSumm/> – Сумма оплаты долга или дополнительная оплата

« Ответ

<DataExchangeModule Interface="Seltik-1.0">
  <Head Type="Reply" Query="PutPayment" Result="OK(200)" Reason="Запрос успешно обработан."/>
  <Data>
    
    <Payments>
      <Payment ID="11893103" PIN="553" Period="201503" Result="OK(200)"/>
    </Payments>
					
  </Data>
</DataExchangeModule>

Назначение и описание результирующих данных

1. <Payments/> – Контейнер списка результатов обработки подтверждения оплат
2. <Payment/> – Результат обработки подтверждения оплаты
3.    ID – Присвоенный уникальный номер подтверждённой оплаты *)
4.    Result – Результат подтверждения оплаты *)