Datapool-Сервис обмена данными¶
Содержание
- Datapool-Сервис обмена данными
- Термины и сокращения
- Общие положения
- Создание и настройка GPG ключницы
- Настройка ключницы
- Datapool API
- Методы формирования наборов данных
- Запрос информации о доступных агентах
- Запрос информации об услугах агентов
- Запрос информации об группах услуг агентов
- Запрос информации об организациях
- Запрос информации о лицевых счетах агента
- Запрос информации о начислении
- Запрос информации о начислении (дома)
- Запрос информации о состоянии ЛС по принципалу
- Запрос информации о платежах
- Запрос информации о состоянии лицевого счета
- Запрос информации о перерасчетах
- Запрос информации о сторно платежей
- Запрос информации об ПУ-начислениях
- Запрос информации о тарифах
- Запрос информации об актах
- Запрос информации об актах корректировки перерасчетов
- Запрос информации о жильцах
- Запрос информации о ИПУ-шкалы
- Запрос информации о ИПУ-показания
- Запрос информации о ИПУ-поверки
- Запрос информации о КПУ-шкалы
- Запрос информации о КПУ-показания
- Запрос информации о КПУ-поверки
- Запрос информации о ГПУ-гр.помещений-шкалы
- Запрос информации о ГПУ-гр.помещений-показания
- Запрос информации о ГПУ-гр.помещений-поверки
- Запрос информации о ГПУ-дома-шкалы
- Запрос информации о ГПУ-дома-показания
- Запрос информации о ГПУ-домов-поверки
- Запрос информации о ГПУ-гр.домов-шкалы
- Запрос информации о ГПУ-гр.домов-показания
- Запрос информации о ГПУ-гр.домов-поверки
- Запрос информации о журналах
- Запрос информации по справочнику принципалов
- Запрос информации о группе услуг агента
- Запрос информации о начислении (группа услуг)
- Запрос на формирование информации о ед. измерения
- Запрос на формирование информации о коммунальных ресурсах
- Запрос на формирование информации о маршрутных листах
- Запрос на формирование информации об объектах маршрутного листа
- Запрос на формирование информации об учетных ресурсах
- Запрос на формирование информации о типах приборов учета
- Запрос на формирование информации о местах установки ПУ
- Запрос информации о доме
- Запрос информации по субсчету
- Запрос информации по группе домов
- Запрос информации по группе помещений
- Запрос информации о просуженной задолженности
- Методы получения наборов данных
Термины и сокращения¶
XML - (eXtensible Markup Language) расширяемый язык разметки.
XML-RPC - (eXtensible Markup Language Remote Procedure Call) XML-вызов удалённых процедур
RSA - (аббревиатура от фамилий Rivest, Shamir и Adleman) криптографический алгоритм с открытым ключом
DSA - (Digital Signature Algorithm) алгоритм с использованием открытого ключа для создания электронной подписи, но не для шифрования
PGP - (Pretty Good Privacy) также библиотека функций, позволяющая выполнять операции шифрования и цифровой подписи информации
API - (application programming interface) набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах.
Общие положения¶
- Сервис Datapool предназначен для предоставления информации пользователям системы с использованием стандарта XML-RPC и PGP-шифрования.
- Кодировка XML-запросов и ответов — UTF-8.
- Передача зашифрованных XML-запросов осуществляется по стандарту HTTP POST.
- Перед началом работы стороны должны обменяться публичными PGP-ключами (RSA + RSA, 2048 или 4096 байт). После формирования XML запроса клиент производит шифрование полученного текста публичным ключом сервера и осуществляет подпись своим приватным ключом. Сервер соответственно шифрует и подписывает ответ клиенту. При ответе происходит проверка соответствия PGP-ключа и доступных ему агентов.
- Пользователи сервиса самостоятельно разрабатывают клиентскую часть. При этом:
- клиентская часть должна обращаться к серверу по технологии XML-RPC, используя защищенный транспорт GPG.
- при направлении запроса на сервер в конец URI должен добавляться отпечаток клиентского публичного ключа (например: „/v1/HU234234JJH7876G22“, где „HU234234JJH7876G22“ - отпечаток ключа)
- При формировании ответа сервис использует соответствующие запросу базисы
- Доступ к сервису предоставляется по Заявке.
Публичный ключ сервиса Datapool: Datapool_key
Создание и настройка GPG ключницы¶
Описанный ниже алгоритм позволяет пользователям MS Windows сгенерировать пару GPG-ключей, инициализировать ключницу и импортировать в нее созданные ключи.
Генерация ключа
Загрузите прилагаемый архив (
Datapool_key
) содержит приложение GPG и файл настройки для генерации ключаРаспакуйте содержимое архива в корень диска
"С:"
(в результате у Вас должен появиться на диске «С:» каталог «gpg» с исполняемым файлом и библиотеками, а также файлом конфигурации «generator.cfg».Отредактируйте файл «generator.cfg» следующим образом (примечание: редактор должен работать с кодировкой UTF-8. Рекомендуемые редакторы: Notepad++, FAR-manager):
- у параметра Name-Real измените значение NAME на свое реальное имя (наименование организации)
- у параметра Name-Comment измените значение COMMENT на комментарий к создаваемому ключу
- у параметра Name-Email измените значение MAIL@FOO.BAR на свой реальный адрес электронной почты
- у параметра Passphrase измените значение PASSWORD на пароль, которым будет защищен Ваш приватный ключ
Сохраните изменения в файле
Запустите оболочку командной строки (меню Пуск - Выполнить - cmd)
Измените текущий каталог на созданный командой: cd c:gpg
Выполните команду: gpg.exe –batch –gen-key -a generator.cfg. В результате выполнения команды в Вашем каталоге появятся два новых файла: key.pub и key.sec, которые соответствуют Вашим открытому и закрытому ключу соответственно.
Закройте окно командной оболочки
Настройка ключницы¶
После того, как Вы сгенерировали ключи, приватный ключ необходимо импортировать в ключницу, которую необходимо предварительно инициализировать. Для этого:
- На диске «С:» создайте каталог с именем «keyring»
- Запустите оболочку командной строки (меню Пуск - Выполнить - cmd)
- Измените текущий каталог на созданный командой: cd c:keyring
- Инициализируйте ключницу и импортируйте в нее Ваш приватный ключ командой: c:gpggpg.exe –homedir=. –import < c:gpgkey.sec
- Убедитесь, что Ваш ключ импортировался командой: c:gpggpg.exe –homedir=. –list-keys (на экран должна быть выведена информация об импортированном ключе)
На этом этапе Ваша ключница готова к работе.
Публичный ключ необходимо отправить по электронной почте в ООО «Биллинг Онлайн Решения» для его регистрации и дальнейшего предоставления доступа.
После успешного проведения всех действий удалите файлы key.pub и key.sec.
Datapool API¶
Версия используемого клиентом API указывается в URI сервера:
для API версии 2: http://datapool.rc-online.ru/v2/
API v2
Поддерживает вызовы методов:
- формирования наборов данных (пространство имен export) - в качестве результата возвращается текстовый идентификатор серверного курсора (наименование), при помощи которого в дальнейшем может быть осуществлен непосредственный доступ к сформированным данным;
- получения наборов данных (пространство имен cursor).
Комментарии к API v2.
При вызове какого-либо метода формирования наборов данных клиенту возвращается наименование серверного курсора (см. выше). При этом сама задача формирования набора данных помещается сервисом в очередь выполнения.
Задачи в очереди выполняются последовательно. По полученному идентификатору возможно запросить статус задачи, кол-во строк в результирующем наборе данных или непосредственно получить сформированные данные.
Сформированные курсоры доступны на сервере в течение 6 часов с момента формирования результирующего набора данных. Также курсоры становятся недоступными, если с момента постановки задачи в очередь исполнения прошло 6 часа.
Пример порядка работы
- осуществить вызов метода export.accounts (123456)
- результатом будет идентификатор курсора: „ct_123FFFJ2L“
- посредством вызова метода cursor.status („ct_123FFFJ2L“) установить, что задача успешно выполнена (получен код 0)
- определить количество строк в сформированном курсоре: cursor.rowcount („ct_123FFFJ2L“), пусть результат = 600
- получить данные из курсора: cursor.fetch („ct_123FFFJ2L“, offset, limit)
- закрыть курсор: cursor.close („ct_123FFFJ2L“)
Примечание
Рекомендуется между запросами делать паузу в 0.5-1 секунду
Методы формирования наборов данных¶
export.agents — запрос на формирование информации о доступных агентах
export.services — запрос на формирование информации об услугах агентов
export.servgroups — запрос на формирование информации об группах услуг агентов
export.orgs — запрос на формирование информации об организациях
export.accounts — запрос на формирование информации о лицевых счетах агента
export.calculations — запрос на формирование информации о начислении
export.housecalculations — запрос информации о начислении (дома)
export.accresellers — запрос информации о состоянии ЛС по принципалу
export.payments — запрос на формирование информации о платежах
export.recalcs — запрос на формирование информации о состоянии лицевого счета
export.dbtstorn — запрос на формирование информации о перерасчетах
export.paymentstorn — запрос на формирование информации о сторно платежей
export.pucalcs — запрос на формирование информации о ПУ-начислениях
export.tarifs — запрос на формирование информации о тарифах (связка с id начислений)
export.akts — запрос на формирование информации об актах
export.correct_debt_akts — запрос на формирование информации об актах корректировки перерасчетов
export.persons — запрос на формирование информации о жильцах
export.ipucplug — запрос на формирование информации о ИПУ-шкалы
export.ipucval — запрос на формирование информации о ИПУ-показания
export.ipucpcheck — запрос на формирование информации о ИПУ-поверки
export.kpucplug — запрос на формирование информации о КПУ-шкалы
export.kpucval — запрос на формирование информации о КПУ-показания
export.kpucpcheck — запрос на формирование информации о КПУ-поверки
export.gpufgrpcplug — запрос на формирование информации о ГПУ-гр.помещений-шкалы
export.gpufgrpcval — запрос на формирование информации о ГПУ-гр.помещений-показания
export.gpufgrpcpcheck — запрос на формирование информации о ГПУ-гр.помещений-поверки
export.gpuhousecplug — запрос на формирование информации о ГПУ-дома-шкалы
export.gpuhousecval — запрос на формирование информации о ГПУ-дома-показания
export.gpuhousecpcheck — запрос на формирование информации о ГПУ-дома-поверки
export.gpuhgrpcplug — запрос на формирование информации о ГПУ-гр.домов-шкалы
export.gpuhgrpcval — запрос на формирование информации о ГПУ-гр.домов-показания
export.gpuhgrpcpcheck — запрос на формирование информации о ГПУ-гр.домов-поверки
export.jornalobjtypes — запрос на формирование информации о журналах
export.resellers — запрос на формирование информации по справочнику принципалов
export.sgrp — запрос информации о группе услуг агента
export.servgroupcalculations — запрос информации о начислении (группа услуг)
export.phisvals — запрос на формирование информации о ед. измерения
export.gpureses — запрос на формирование информации о коммунальных ресурсах
export.bypasslist — запрос на формирование информации о маршрутных листах
export.bypasslist_objects — запрос на формирование информации об объектах маршрутного листа
export.resources — запрос на формирование информации об учетных ресурсах
export.countypes — запрос на формирование информации о типах приборов учета
export.locations — запрос на формирование информации о местах установки ПУ
export.houses — запрос информации о доме
export.resid — запрос информации по субсчету
export.housegroup — запрос информации по группе домов
export.flatgroup — запрос информации по группе помещений
export.debtreq — запрос информации о просуженной задолженности
Запрос информации о доступных агентах¶
export.agents¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт»(обязательный параметр)
year* int — год (необязательный параметр)
month* int — год (необязательный параметр)
структура ответа:
AGENT_ID | Идентификатор агента | int |
ORG_ID | ID организации | int |
CITY_ID | Идентификатор населенного пункта | int |
AGENT_NAME | Наименование агента | string |
FIXEDPERIOD_PERIOD | Последний закрытый период агента | dateTime.iso8601 |
EXTID_AGENT_GIS | ИД агента ГИС ЖКХ | string |
EXTID_AGENT_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
ACCTYPE_NAME | Тип абонента | string |
OBJBANKDETAIL_FMAIN | Признак основного банковского реквизита | bool |
BANK_NAME | Наименование банка | string |
BANKDETAIL_CODE | Код банковского реквизита | string |
BANKDETAIL_RS | Расчетный счет | string |
BANK_KS | Корр. счет | string |
BANK_BIK | БИК | string |
Запрос информации об услугах агентов¶
export.services¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (НЕобязательный параметр)
month* int — месяц (НЕобязательный параметр)
структура ответа:
SERVICE_ID | Идентификатор услуги | int |
SERVICE_ABBR | Наименование услуги | string |
SERVGROUP_NAME | Наименование группы услуг | string |
INTAKETYPE | Тип услуги (0 - Индивидуальное потребление, 1 - ОДН) | int |
AGENT_ID | Идентификатор агента | int |
CITY_ID | Идентификатор населенного пункта | int |
GPURES_NAME | Наименование коммунального ресурса | string |
SERVICE_TITLE | Наименование услуги в квитанции | string |
PHISVAL_NAME | Единица измерения услуги | string |
EXTID_SERVICE_GIS | Наименование услуги ГИС ЖКХ | string |
EXTID_SERVICE_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
SERVCAT_ID | Идентификатор категории услуги | int |
SERVCAT_ABBR | Категория услуги | string |
SERVCLASS_ID | Идентификатор льготной категории услуги | int |
SERVCLASS_ABBR | Льготная категория услуги | string |
SALG_ID | Алгоритм начисления | int |
SALG_ABBR | Алгоритм начисления | string |
XC_ALG_ID | Алгоритм внешнего начисления | int |
XC_ALG_ABBR | Алгоритм внешнего начисления | string |
SERVICE_COMINV_TITLE | Название в счет-фактуру | string |
SERVICE_NAME | Название услуги | string |
GPHISVAL_ID | Код Ед. изм. коммунального ресурса | int |
GPHISVAL_NAME | Наименование Ед. изм. коммунального ресурса | string |
VPHISVAL_ID | Код Ед. изм. базы для начисления | int |
VPHISVAL_NAME | Наименование Ед. изм. базы для начисления | string |
NPHISVAL_I | Код Ед. изм. норматива потребления | int |
NPHISVAL_NAME | Наименование Ед. изм. норматива потребления | string |
RESOURCE_ID | Учетный ресурс | int |
RESOURCE_ABBR | Учетный ресурс | string |
SERVICE_LGR | Взятие льготного норматива | bool |
SERVICE_FNOLGTVOL | Признак неприменения объема по услуге к расчету льгот | bool |
SERVICE_PRIORITY | Порядковый номер услуги (сортировка) | int |
SERVICE_CODE | Код услуги ФЛ | string |
SERVICE_UCODE | Код услуги ЮЛ | string |
SERVICE_SNRM | Признак взятия норматива для составной услуги | bool |
SERVICE_PENI | Признак начисления пени по услуге | bool |
TARINF_ID | int | |
TARINF_ABBR | string | |
PAR_ID | Параметр для определения базы начисления по услуге | int |
SERVICE_ISEXT | Флаг загрузки начислений по услуге из внешней системы | bool |
SERVICE_EXTID | Идентификатор услуги из внешней системы | string |
VATGROUP_ID | Код ИД группы ставок НДС | int |
VATGROUP_ABBR | Наименование группы ставок НДС | string |
SERVICE_FNDS | Флаг НДС: 0 - без НДС, 1 - НДС внутри, 2 - НДС снаружи | bool |
SERVICE_F_SGODP | Признак коммунальной услуги на общедомовые нужды на содержание жилья | bool |
SERVICE_ACTIVE | Активность услуги (для исключения из интерфейса) | bool |
SERVICE_COMPONENT | Многокомпонентная услуга (код группы услуг) | int |
Запрос информации об группах услуг агентов¶
export.servgroups¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
servgroup_id* int — идентификатор группы услуг
структура ответа:
SERVGROUP_ID | ID группы услуг | string |
ACCTYPE_ID | Тип абонента (0-физическое лицо, 1-юридическое лицо, NULL - все) | int |
SERVGROUP_ABBR | Наименование группы услуг | string |
SERVGROUP_NAME | Наименование группы услуг | string |
SERVICE_ID | Идентификатор услуги | int |
SERVICE_ABBR | Наименование услуги | string |
SERVICE_NAME | Наименование услуги | string |
AGENT_ID | Идентификатор агента | int |
GRPTYPE_ID | ID типа группы услуг (1-Для квитанций/счетов-фактур,2-Прочие,3-Для поуслужной оплаты,4-ПИР,5-Для выгрузки,6-Для расчета структуры задолженности по ЛС ) | int |
SERVGROUP_FDOC | Платежные документы: NULL - любые, 1 - квитанции, 2 - счет-фактуры | int |
Запрос информации об организациях¶
export.orgs¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
org_id* int — id организации (обязательный параметр)
структура ответа:
ORG_ID | Идентификатор организации | int |
ORG_ABBR | Аббревиатура организации | string |
ORG_NAME | Наименование организации | string |
ORGTYPE_ID | Тип организации (ID) | int |
ORGTYPE_NAME | Тип организации наименование | string |
ORG_INN | ИНН | string |
ORG_OGRN | ОГРН | string |
ODESC_NAME | Наименование из описания | string |
ODESC_KPP | КПП | string |
Запрос информации о лицевых счетах агента¶
export.accounts¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
acctype int — тип лицевого счета (0- физ. лицо, 1 - юр.лицо; необязательный параметр)
базисы:
Лицевой счет RSP_ACC Базис ЛС (RSP_ACC)
и
Состояние лицевого счета по принципалу RSP_AP (ITOG_bit = 1) Базис состояния лицевого счета по принципалу (RSP_AP)
структура ответа:
AGENT_ID | Идентификатор агента | int |
ACCOUNT_ID | Идентификатор ЛС | int |
ACCOUNT_NO | Номер ЛС | int |
ACCTYPE_ID | Тип абонента (0-физическое лицо, 1-юридическое лицо) | int |
ACCOUNT_FROMPERIOD | Дата регистрации ЛС в ОП „Биллинг Эксперт“ | dateTime.iso8601 |
ACCOUNT_TOPERIOD | Дата закрытия ЛС в ОП „Биллинг Эксперт“ | dateTime.iso8601 |
ACCOUNT_OLDNO | „Старый“ номер ЛС (номер ЛС абонента из внешней системы биллинга) | string |
EMPLOYER | Наниматель (да/нет) | string |
ORG_ABBR | Аббревиатура организации | string |
ORG_NAME | Название организации | string |
ORG_INN | ИНН организации | string |
ORG_KPP | КПП организации | string |
ORG_OGRN | ОГРН организации | string |
ORGTYPE_NAME | Тип организации | string |
ORGTYPE_CODE | Код типа организации | string |
ORG_SELF_LNAME | Фамилия (Самозанятые граждане) | string |
ORG_SELF_FNAME | Имя (Самозанятые граждане) | string |
ORG_SELF_MNAME | Отчество (Самозанятые граждане) | string |
HTYPE_ABBR | Тип дома | string |
GISGKH_ACCOUNT_ID | ID ЛС ГИСЖКХ | int |
GISGKH_FLAT_ID | ID помещения ГИСЖКХ | int |
GISGKH_FLOOR_ID | ID комнаты ГИСЖКХ | int |
GISGKH_HOUSE_ID | ID дома ГИСЖКХ | int |
DOCUMENT_NO | Номер договора на оказания услуг | string |
DOCUMENT_INDATE | Дата регистрации договора | dateTime.iso8601 |
DOCUMENT_FROMDATE | Дата начала действия договора | dateTime.iso8601 |
DOCUMENT_TODATE | Дата окончания действия договора | dateTime.iso8601 |
DOCUMENT_CLOSEDATE | Дата закрытия договора | dateTime.iso8601 |
DOCUMENT_PERIOD | Период начала действия договора | dateTime.iso8601 |
DOCUMENT_REGDATE | Дата создания договора | dateTime.iso8601 |
RESELLER_ID | ID принципала | int |
AP_INRES | Входящее сальдо | double |
PERSON_ID | Уникальный код жильца | int |
SPERSON | ФИО потребителя | string |
PERSON_LNAME | Фамилия | string |
PERSON_FNAME | Имя | string |
PERSON_MNAME | Отчество | string |
PERSON_PHONE1 | Телефон потребителя №1 | string |
PERSON_PHONE2 | Телефон потребителя №2 | string |
PERSON_EMAIL | Электронная почта потребителя | string |
OKTMO | ОКТМО | string |
CITY_ID | ID населенного пункта | int |
CITY_NAME | Название населенного пункта | string |
CITY_PFX | Префикс города | string |
OBLAST_PFX | Область. Префикс | string |
OBLAST_NAME | Область. Наименование | string |
REGION_PFX | Муниципальный район. Префикс | string |
REGION_NAME | Муниципальный район. Наименование | string |
CDIST_PFX | Префикс городского района | string |
CDIST_NAME | Наименование городского района | string |
STREET_PFX | Аббревиатура типа улицы (улица, переулок, …) | string |
STREET_NAME | Название улицы | string |
HOUSE_ID | Уникальный код дома | string |
HOUSE_NO | Номер дома | int |
HOUSE_BULDNO | Номер строения | int |
ACCUM_ID | Уникальный код с/с | int |
HOUSE_LITER | Литера дома | string |
PREFLAT_ABBR | Аббревиатура места проживания (комната, квартира …) | string |
FLAT_ID | Уникальный код квартиры | int |
FLAT_NO | Номер квартиры | int |
FLAT_LITER | Литера квартиры | string |
ACCOUNT_DESC | Примечание | string |
ACCPERSCNT_FACTCOUNT | Количество проживающих | int |
ACCPERSCNT_PERSCOUNT | Количество прописанных | int |
ADESC_S0 | Общая площадь | double |
ADESC_SL | Жилая площадь | double |
ADESC_SH | Отапливаемая площадь | string |
CA_PHONE | Телефон в кабинете абонента | string |
CA_ACTIVE | Доступ в кабинет абонента | int |
CA_EMAIL | e-mail, указанный абонентом при регистрации в Кабинете Абонента | string |
PERSON_BIRTHDAY | Дата рождения абонента | string |
HACCSERV_FROMPERIOD | Дата регистрации услуги на ЛС в ОП „Биллинг Эксперт“ | dateTime.iso8601 |
HCAT_ABBR | Дом: Категория | string |
HBLAG_LIFT | Дом: Благоустройства : Наличие лифта | string |
HBLAG_GARB | Дом: Благоустройства : Наличие мусоропровода | string |
HBLAG_CGZS | Дом: Благоустройства : Наличие газа | string |
HBLAG_CHVS | Дом: Благоустройства : Наличие ХВС | string |
HEATYPE_ID | Дом: Благоустройства : Уникальный идентификатор типа отопления | int |
VOTYPE_ID | Дом: Благоустройства : Уникальный идентификатор типа водоотведения | int |
GVSTYPE_ID | Дом: Благоустройства : Уникальный идентификатор типа ГВС | int |
HEATYPE_ABBR | Дом: Благоустройства : Тип отопления | string |
VOTYPE_ABBR | Дом: Благоустройства : Тип водоотведения | string |
GVSTYPE_ABBR | Дом: Благоустройства : Тип ГВС | string |
HOUSE_BDATE | Дом: Год постройки | string |
HOUSE_ENTRCNT | Дом: Кол.Подъездов | string |
FLOOR_ABBR | Квартира: Этажность | string |
FLAT_FLOOR | Квартира: Этаж | string |
FTYPE_ABBR | Квартира: Тип помещения | string |
FLAT_ENTRANCE | Квартира: Подъезд | int |
FDESC_S0 | Квартира: Площадь общая | double |
FDESC_SL | Квартира: Площадь жилая | string |
FCAT_ABBR | Категория помещения (форма пользования) | string |
FDESC_KOR | Квартира: Коридорная | boolean |
FDESC_ROOMCNT | Квартира: Кол. комнат | int |
FLAT_MOP | Общее имущество МКД | int |
ACAT_ABBR | ЛС: Форма пользования | string |
ADESC_PRIV | ЛС: Приватизация | boolean |
ADESC_TSG | ЛС: ТСЖ | string |
CVSTYPE_NAME | ЛС: Тип ЦВС | string |
GCOLTYPE_NAME | ЛС: Тип водон. | string |
COOKERTYPE_ABBR | Доп.Параметры: Тип плиты | string |
WT_BLAGTYPE_CODE_ABBR | Доп.Параметры: Степень благоустройства по водоснабжению | string |
EL_BLAGTYPE_CODE_ABBR | Доп.Параметры: Степень благоустройства по электроэнергии | string |
ADESC_ROOMCNT | Доп.Параметры: Комнат в пользовании | int |
ADESC_ROOMNOS | Доп.Параметры: Номер(а) комнат(ы) | string |
ODESC_NAME | Доп.Параметры: Организация | string |
CONSIST_SQ | Состав площадей ЛС: Номер помещения; Этажность;Площадь общая;Площадь жилая; Описание;Начало;Окончание |
String |
ACCPERSCNT_TEMPCOUNT | Регистрация: Временно зарегистрированных | int |
ACCPERSCNT_OUTCOUNT | Регистрация: Временно выбывших | int |
NOTPERSCOUNT | Регистрация: Без регистрации (расчетное) | int |
ACCPERSCNT_FAMCOUNT | Регистрация: Количество членов семьи | int |
LGHOUSEHOLD_ABBR | Регистрация: Льготная группа домохозяйства | string |
ACCPERSCNT_FROMPERIOD | Регистрация: Дата начала | dateTime.iso8601 |
ACCPERSCNT_TOPERIOD | Регистрация: Дата окончания | dateTime.iso8601 |
ACCPERSCNT_REGDATE | Регистрация: Дата внесения (изменения) | dateTime.iso8601 |
ACCPERSCNT_DESK | Регистрация: Примечание | string |
CALCQ_OUTDT | Последний расчет дома | dateTime.iso8601 |
EXTID_HOUSE_FIAS | Внешний ID дома ФИАС | string |
EXTID_HOUSE_GIS | ИД принципала ГИС ЖКХ | string |
EXTID_HOUSE_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
EXTID_FLAT_GIS | ИД квартиры ГИС ЖКХ | string |
EXTID_FLAT_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
EXTID_ACCOUNT_GIS | ИД лс ГИС ЖКХ | string |
EXTID_ACCOUNT_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
EXTID_ACCOUNT_GIS_TKO | Сторона по договору ИКУ-РСО | string |
FLAT_LITERONLY | Флаг литеры | boolean |
ORG_ID | ИД организации | int |
Запрос информации о начислении¶
export.calculations¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис:
Базис начислений (RSP_ACCDBT)
RSP_ACCDBT (ITOG_bit=0, TARIF_bit=1, NNULL_bit=0)
структура ответа:
ACCDBT_ID | ID начисления | int |
SERVICE_ID | ID услуги | int |
ACCOUNT_ID | ID лицевого счета | int |
ACCOUNT_NO | Номер ЛС | int |
PERIOD | Период начисления | dateTime.iso8601 |
RESELLER_ABBR | Принципал | string |
RESELLER_ID | Код принципала | int |
PROVIDER_ABBR | Поставщик | string |
PROVIDER_ID | Код поставщика | int |
S_INRES | Вх. сальдо | double |
S_OUTRES | Исх. сальдо | double |
S_PBASE | Сумма базового начисления | double |
S_DPPRT | Частичное предоставление услуги | double |
S_DPVRCL | Корректировка начисления по актам корректировки объема | double |
S_DPPRCL | Корректировка суммы начисления по актам корректировки начислений | double |
S_DPKPU | Корректировка объема по дельте КПУ | double |
S_DPGPU | Корректировка объема по дельте ГПУ | double |
S_DPMF | Корректировка начисления по актам ненадлежащего качества | double |
DBT_DPMI | Корректировка начисления по ППМИ | double |
S_LGOT | Сумма монетизированных льгот (МСП) | double |
S_NLGOT | Сумма немонетизированных льгот (МСП) | double |
S_DPNDS | НДС | double |
S_PNDS | Начислено без НДС | double |
S_ITOG | Начислено за период с учетом корректировок | double |
S_MITOG | „Начислено за период“ + „Перерасчет на с/с“ + „Акты корректировки перерасчетов“ | double |
S_ASTORN | Акты корректировки перерасчетов | double |
S_STORN | „Состояние“.“Движение по услугам“.“Перерасчет по услуге“ (Перерасчет по услуге) | double |
S_RESTORN | Перерасчет на с/с | double |
S_DBT_VOL | Объем услуги, на который произведено начисление | double |
S_LAMBDA | „состояние“.“Движение по услугам“.“зачтено остатков с/с“ | double |
S_ELAMBDA | „состояние“.“Движение по услугам“.“зачтено остатков с/с“ (в конце периода) | double |
S_DELTA | „состояние“.“Движение по услугам“.“зачтено поступлений“ | double |
S_STORNOKRD | „состояние“.“Движение по услугам“.“зачтено сторно поступлений“ | double |
ACCUM_ID | ID субсчета | int |
DBT_NVAL | Норматив потребления | double |
NPHISVAL_NAME» | Услуги: [норма]» | string |
VOLSTATUS_NORM | Признак по нормативу — 1 / объем — 0 | int |
VOLSTATUS_ABBR | Статус получения объема | string |
DBT_TAR | Тариф, по которому произведено начисление | double |
TPHISVAL_NAME | Услуги: [тариф] | string |
TARTYPE | Тип тарифа | string |
TAC | Факт учета в тарифе НДС (1 — да / 0 — нет) | int |
PCNT | Количество точек | int |
HACCSERV_PCNT | Количество ПУ | int |
HACCSERV_PART | % начисления | double |
HACCSERV_FROMPERIOD | Услуги: начало | dateTime.iso8601 |
HACCSERV_TOPERIOD | Услуги: окончание | dateTime.iso8601 |
EXTID_RESELLER_ACCTYPE_GIS | Тип ЛС ГИС ЖКХ | string |
EXTID_PROVIDER_GIS | ИД поставщика ГИС ЖКХ | string |
EXTID_PROVIDER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
DBT_ID | ID начисления | int |
CSBALANCE_ID | ID начисления | int |
DBT_CRAIS | Значение Кпов | double |
DBT_DPRAIS | Сумма начислений по Кпов | int |
S_ABRESID | Акты вх. сальдо | int |
S_AERESID | Акты исх. сальдо | int |
EXT_ACCOUNT_GIS_GUID | ГИС. Код Account_GUID | string |
Запрос информации о начислении (дома)¶
export.housecalculations¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис:
Базис начислений (RSP_ACCDBT)
RSP_ACCDBT
структура ответа:
AGENT_ID | Код агента | int |
S_DBT_VOL | Итоговый объем с учетом корректировок | double |
S_ITOG | Начислено за период | double |
HOUSE_ID | Код дома | int |
EXTID_HOUSE_GIS2 | Код договора ГИС ЖКХ | string |
EXTID_HOUSE_FIAS | Код МКД по ФИАС | string |
GPURES_ID | Код коммунального ресурса | int |
GPURES_ABBR | Аббревиатура коммунального ресурса | string |
RESELLER_ID | Код принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | Код поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
Запрос информации о состоянии ЛС по принципалу¶
export.accresellers¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис: Базис состояния лицевого счета по принципалу (RSP_AP) RSP_AP (ITOG_bit=0)
структура ответа:
AGENT_ID | Код агента | int |
ACCOUNT_ID | Код ЛС | int |
RESELLER_ID | Код Принципала | int |
RESELLER_ABBR | Наименование принципала | string |
AP_PERIOD | Период | dateTime.iso8601 |
AP_IS_PRE | Наличие записи В БД в предыдущем месяце (10) | int |
AP_IS_CUR | Наличие записи В БД в текущем месяце (10) | int |
AP_INRES | Вх. сальдо | double |
AP_ABRESID | Акты вх. сальдо | double |
AP_INC | Поступления | double |
AP_STORNOKRD | зачтенные сторно поступлений | double |
AP_INC_WOUTPENI | поступления без пени | double |
IN_PENI_RESID | входящее сальдо пени | double |
AP_INC_ONLYPENI | поступления на пени | double |
PENIRES_SUM | начислено пени | double |
OUT_PENI_RESID | исх сальдо пени | double |
AP_STORN | Перерасчет | double |
AP_ITOG | Начислено | double |
AP_AERESID | Акты исх. сальдо | double |
AP_OUTRES | Исходящее сальдо | double |
AP_FSHOW | Флаг отображения строки (есть ненулевые операции 10) | int |
AP_INC_WOUTPENI | Поступления без пени | double |
IN_PENI_RESID | Входящее сальдо пени | double |
AP_INC_ONLYPENI | Поступления на пени | double |
PENIRES_XSTORN | Перерасчеты предыдущих периодов пени | double |
PENI_ASTORN | Акты сальдо пени | double |
PENI_STORN | Перерасчет пени | double |
PENIRES_SUM | Начислено пени | double |
OUT_PENI_RESID | Исх. сальдо пени | double |
EXT_ACCOUNT_GIS_GUID | ГИС. Код Account_GUID | string |
Запрос информации о платежах¶
export.payments¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис: Базис платежей (RSP_PAYMENT) RSP_PAYMENT (i_PAYMODE=2,i_STORNMODE=0) + RSP_PAYMENT (i_PAYMODE=0,i_STORNMODE=1)
структура ответа:
ACCKRD_ID | ID платежа | int |
ACCKRDDIST_ID | ID части платежа | int |
ACCOUNT_ID | ID Лицевого счета | int |
ACCOUNT_NO | Номер ЛС | int |
SERVICE_ID | ID услуги, за которую произведена данная часть платежа | int |
ACCKRD_EXECNO | Номер исполнительного листа, если платеж производился по таковому | string |
ACCKRD_DESC | Прмечание | string |
ACCKRDTYPE_ABBR | Тип платежа (для исполнительного листа) | string |
EXTID_ACCKRDTYPE_GIS_ABLE | Обмен с ГИС ЖКХ (тип платежа) | boolean |
ACCKRD_OPNO | Номер операции | string |
ACCKRD_PAYDATE | Дата платежа | dateTime.iso8601 |
ACCKRD_INDATE | Дата учета платежа | dateTime.iso8601 |
ACCKRD_CALCPERIOD | Период, за который произведен платеж | dateTime.iso8601 |
ACCKRDDIST_SUM | Сумма части платежа | int |
KRD_ITOG | Сумма платежа | int |
AKDINTYPE_ID | Тип ввода платежа (1-ручной,2-импорт файла,3-касса онлайн,4-эквайринг,5-API) | int |
PAYMETHOD_ID | Способ оплаты (1-наличные,2-банковская карта) | int |
ACCKRD_PERIOD | Оплата за период | dateTime.iso8601 |
RESELLER_ID | Принципал | int |
ACCKRD_PAYPLACE | Место приема платежа | string |
ACCKRDDIST_FIX | Признак фиксированного распределения | int |
ACCRESLQUIT_RECORD_ID | Код записи ИПД ГИС ЖКХ | int |
EXTID_ACCRESLQUIT_IPD | ИПД ГИС ЖКХ | int |
DA_RECORD_ID | ||
PAYACCEPTOR_ID | Организация по приему платежей | int |
EXTID_PAYACCEPTOR_GIS_ABLE | Обмен с ГИС ЖКХ (орг. по приему) | boolean |
EXTID_ACCOUNT_GIS | ЕЛС ГИС ЖКХ | string |
EXTID_ACCOUNT_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
EXTID_ACCRESL_GIS | ИЖКУ ГИС ЖКХ | string |
EXTID_DP_DOC_GIS2 | ИД оплаты ГИС ЖКХ | string |
EXTID_DP_DOC_GIS | ||
ACCKRDDIST_TYPE | Тип операции | int |
Запрос информации о состоянии лицевого счета¶
export.recalcs¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис накопительного счета (RSP_ACCUM) RSP_ACCUM
структура ответа:
ACCUM_ID | ID перерасчета | int |
ACCOUNT_ID | ID Лицевого счета | int |
ACCOUNT_NO | Номер ЛС | int |
ACCUM_PERIOD | Дата учета сальдового перерасчета | dateTime.iso8601 |
ACCUM_STORN | Перерасчет | int |
ACCUM_PMNT | Погашено задолженности | int |
ACCUM_ASTORN | Сумма сальдового перерасчета | int |
ACCUM_DEC | Списано с остатка | int |
ACCUM_EDEC | Списано с остатка (в конце периода) | int |
Запрос информации о перерасчетах¶
export.dbtstorn¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт»
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис накопительного счета (RSP_ACCUM) RSP_DBTSTORN
структура ответа:
DBTSTORN_ID | ID перерасчета в предыдущем периоде | string |
ACCOUNT_ID | ID лицевого счета | int |
ACCOUNT_NO | Номер ЛС | int |
SERVICE_ID | ID услуги | int |
CPERIOD | Дата проведения перерасчета | dateTime.iso8601 |
SPERIOD | Дата, к которой относится перерасчет | dateTime.iso8601 |
PERIOD | Период расчета | dateTime.iso8601 |
SOURCE_STORN_ITOG | Сумма перерасчета в предыдущем периоде | int |
PR_DBT_VOL | Корректируемый объем (старое значение) | int |
DBT_VOL | Корректирующий объем (новое значение) | int |
PR_DBT_TAR | Корректируемый тариф (старое значение) | int |
DBT_TAR | Корректирующий тариф (новое значение) | int |
PR_DBT_PNDS | Сумма без НДС пр. | int |
DBT_PNDS | Сумма без НДС нов. | int |
PR_DBT_DPNDST | НДС пр. | int |
DBT_DPNDS | НДС нов. | int |
PR_DBT_SPNDS | Сумма без НДС пр. + НДС пр. | int |
DBT_SPNDS | Сумма без НДС нов. + НДС нов. | int |
DBT_AUTOCORR_FL | Флаг наличия основания „АВТО-корр.“ (1-есть даное основание, 0-нет) | int |
Запрос информации о сторно платежей¶
export.paymentstorn¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис платежей (RSP_PAYMENT) RSP_PAYMENT
структура ответа:
ACCKRD_ID | Уникальный код платежа | int |
STORNOKRD_ID | Уникальный код сторно платежа | int |
SERVICE_ID | Уникальный код услуги | int |
DISTR_SUM | Сумма распределения | int |
DOCUMENT_ID | Уникальный код акта-сторно платежа | int |
STORNOKRD_PAYDATE | Дата сторно платежа | dateTime.iso8601 |
ACCOUNT_ID | ID лицевого счета | int |
ACCOUNT_NO | Номер ЛС | int |
ACCKRD_OPNO | Операция | string |
ACCKRD_PAYDATE | Дата платежа | dateTime.iso8601 |
ACCKRD_INDATE | Дата ввода | dateTime.iso8601 |
ACCKRD_CALCPERIOD | Период учета платежа | dateTime.iso8601 |
DOCUMENT_PERIOD | Период учета акта сторно | dateTime.iso8601 |
DOCUMENT_REGDATE | Дата и время создания акта сторно | dateTime.iso8601 |
DOCUMENT_INDATE | Дата создания акта сторно | dateTime.iso8601 |
KRD_ITOG | Сумма платежа | int |
STORNOKRD_SUM | Сумма сторно | int |
Запрос информации об ПУ-начислениях¶
export.pucalcs¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
структура ответа:
COUNTER_ID | ID счетчика | int |
ACCDBT_ID | ID начисления | int |
PU_TYPE | Вид ПУ (0-ИПУ, 1-КПУ, 2-ГПУ) | int |
COUNTER_NO | Номер ПУ | string |
OBJECT_NAME | Имя объекта | string |
COUNTYPE_ABBR | Тип | string |
CPLUGTYPE_ABBR | Схема подключения | string |
GPUTYPE_ABBR | Тип ГПУ (для групповых) | string |
CTPAR_ABBR | Параметр | string |
GPURES_ABBR | Коммунальный ресурс | string |
PHISVAL_ABBR | Ед.изм. | string |
RESELLER_ABBR | Принципал (для коммунальных и групповых) | string |
PROVIDER_ABBR | Поставщик (для коммунальных и групповых) | string |
SERVICE_ABBR | Услуга (для индивидуальных) | string |
CPLUG_TRANS | Коэффициент (x1000000) | int |
Запрос информации о тарифах¶
export.tarifs¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
структура ответа:
ACCDBT_ID | Уникальный код начисления (export.calculations) | int |
TPHISVAL_NAME | Ед. измерения | string |
TARIFF_TYPE | Тип тарифа (1 - с НДС, 2 - без НДС) | int |
GTARIFF_VALUE | ТарифАгент | int |
RTARIFF_VALUE | ТарифПринципал | int |
PTARIFF_VALUE | ТарифПоставщик | int |
HTARIFF_VALUE | ТарифГрДомов | int |
HGTARIFF_VALUE | ТарифДом | int |
STARIFF_VALUE | ТарифГр.счетов | int |
ATARIFF_VALUE | ТарифСчет | int |
Запрос информации об актах¶
export.akts¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
структура ответа:
DOCUMENT_ID | Уникальный код акта | int |
ACCOUNT_NO | Уникальный код ЛС | int |
DOCUMENT_NO | Номер акта | string |
DOCUMENT_INDATE | Дата | dateTime.iso8601 |
DOCUMENT_PERIOD | Период акта | dateTime.iso8601 |
DOCTYPE_ABBR | Тип акта | string |
DOCUMENT_NAME | Название | string |
STORNREAS_ABBR | Основание перерасчета | string |
DOCUMENT_REGDATE | Время создания акта | dateTime.iso8601 |
Запрос информации об актах корректировки перерасчетов¶
export.correct_debt_akts¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
document_id int — id документа
структура ответа:
DOCUMENT_ID | Уникальный код акта | int |
ACCOUNT_NO | Уникальный код ЛС | int |
DOCUMENT_NO | Номер акта | string |
ACCSERV_ID | id ЛС-услуги | int |
SERVICE_ID | id услуги | int |
SERVICE_ABBR | Наименование услуги | string |
RESELLER_ID | id принципала | int |
RESELLER_ABBR | Наименование принципала | string |
PROVIDER_ID | id поставщика | int |
PROVIDER_ABBR | Наименование поставщика | string |
DOCACCSERV_SUM | Сумма | int |
DOCACCSERV_VOL | Объем | double |
DOCACCSERV_TAR | Тариф | double |
DOCACCSERV_SPERIOD | Период | dateTime.iso8601 |
Запрос информации о жильцах¶
export.persons¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
структура ответа:
PERSON_ID | Уникальный код жильца | int |
ACCOUNT_NO | Уникальный код ЛС | int |
PERSON_FNAME | Имя | string |
PERSON_MNAME | Отчество | string |
PERSON_LNAME | Фамилия | string |
PERSON_INN | ИНН | string |
PERSON_STRAHNO | Страховое свидетельство - СНИЛС | string |
PERSACC_FROMPERIOD | Дата начала | dateTime.iso8601 |
PERSACC_TOPERIOD | Дата окончания | dateTime.iso8601 |
REGTYPE_ABBR | Вид регистрации | string |
PTYPE | Статус | string |
PERSACC_FAMCOUT | Количество членов семьи | int |
LGOT_NAME | Льгота (только для льготников) | string |
LGOT_OBLREG | Код обл. (только для льготников) | string |
DOCUMENT | Документ (только для льготников) | string |
PERSACC_DEPENDENT | Количество иждивенцев (только для льготников) | int |
Запрос информации о ИПУ-шкалы¶
export.ipucplug¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ИПУ (RSP_IPU) RSP_IPU
структура ответа:
AGENT_ID | Код агента | int |
ACCOUNT_ID | Код ЛС | int |
ACCSERV_ID | Код ЛС-услуги | int |
RESPROV_ID | ID таблицы принципал-поставщик | int |
SERVICE_ID | ID услуги | int |
SERVICE_ABBR | Аббревиатура услуги | string |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
PLUG_TRANS | Коэффициент трансформации | double |
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
CPARTYPE_ID | ID таблицы типа шкалы | int |
CPARTYPE_ABBR | Тип шкалы (аббр.) | string |
CPARTYPE_NAME | Тип шкалы (наименование) | string |
CPARTYPE_DESC | Тип шкалы (описание) | string |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_ABBR | Параметры шкалы (аббр.) | string |
CTPAR_NAME | Параметры шкалы (наименование) | string |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
CTPAR_CODE | Код | string |
GPURES_ID | ID таблицы Коммунального ресурса | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
RESGRP_ID | ID таблицы группа ресурсов | int |
RESGRP_ABBR | Группа ресурсов (аббр.) | string |
RESGRP_NAME | Группа ресурсов (наименование) | string |
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
COUNTER_ID | ID таблицы ПУ | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
COUNTER_NO | No ПУ | string |
COUNTER_MAKEDATE | Дата выпуска | dateTime.iso8601 |
COUNTER_DESC | Примечание | string |
COUNTER_SEALING | Опломбирование | string |
LOCATION_ID | ID таблицы места установки | int |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
CPSTATUS_ID» | ID таблицы состояний шкалы (виды)» | int |
CPSTATUS_ABBR | Аббревиатура состояния | string |
CPSTATUS_NAME | Наименование состояния | string |
CPSTATUS_FIT | Признак работоспособной шкалы | int |
EXTID_COUNTER_GIS | Идентификатор GIS | int |
EXTID_COUNTER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о ИПУ-показания¶
export.ipucval¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ИПУ (RSP_IPU) RSP_IPU
структура ответа:
AGENT_ID | Код агента | int |
ACCOUNT_ID | Код ЛС | int |
ACCSERV_ID | Код ЛС-услуги | int |
RESPROV_ID | ID таблицы принципал-поставщик | int |
SERVICE_ID | ID услуги | int |
SERVICE_ABBR | Аббревиатура услуги | string |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTVAL_ID | ID таблицы показаний | int |
COUNTVAL_NVAL | Текущие показания | double |
COUNTVAL_AVAL | Показание, взятое в расчет в предыдущем периоде | double |
COUNTVAL_DVAL | Показание, взятое в расчет в текущем периоде | double |
COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
COUNTVAL_CROSS | Переход через 0 шкалы | int |
COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
CVALCALC_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
COUNTVAL_DESC | Комментарий | string |
COUNTVAL_DEL | Отмена показания | int |
START_COUNTVAL_ID» | ID таблицы показаний» | int |
START_COUNTVAL_NVAL» | Начальное показание» | double |
START_COUNTVAL_AVAL | double | |
START_COUNTVAL_DVAL | double | |
START_COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
START_COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
START_COUNTVAL_CROSS | Переход через 0 шкалы | int |
START_COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
START_COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
START_COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
START_COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
START_COUNTVAL_DESC | Комментарий | string |
START_COUNTVAL_DEL | Отмена показания | int |
CVALTYPE_ID | ID таблицы типов показаний | int |
CVALTYPE_ABBR | Аббревиатура типа показания | string |
CVALTYPE_NAME | Наименование типа показания | string |
CVALTYPE_PRIORITY | Приоритет показания | int |
CVALTYPE_FNOCALC | Признак неучета показания в расчете | int |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
Запрос информации о ИПУ-поверки¶
export.ipucpcheck¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр) |
year* int — год (обязательный параметр) |
month* int — месяц (обязательный параметр) |
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт» |
базис Базис ИПУ (RSP_IPU) RSP_IPU
структура ответа:
COUNTER_ID | ID прибора учета | int |
CPLUG_ID | ID шкалы прибора учета | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
CPCHECK_FROMDATE | Дата начала поверки | dateTime.iso8601 |
CPCHECK_TODATE | Дата окончания поверки | dateTime.iso8601 |
CPCHECK_CSEALINSTALLDATE | Дата опломбирования ПУ после поверки | dateTime.iso8601 |
CPCHECK_TOCVAL | Показание на начало поверки | double |
CPCHECK_FROMCVAL | Показание на окончание поверки | double |
Запрос информации о КПУ-шкалы¶
export.kpucplug¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис КПУ (RSP_KPU) RSP_KPU
структура ответа:
AGENT_ID | Код агента | int |
FLAT_ID | ID помещения | int |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
CPARTYPE_ID | ID таблицы типа шкалы | int |
CPARTYPE_ABBR | Тип шкалы (аббр.) | string |
CPARTYPE_NAME | Тип шкалы (наименование) | string |
CPARTYPE_DESC | Тип шкалы (описание) | string |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_ABBR | Параметры шкалы (аббр.) | string |
CTPAR_NAME | Параметры шкалы (наименование) | string |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
CTPAR_CODE | Код | string |
GPURES_ID | ID таблицы Коммунального ресурса | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
RESGRP_ID | ID таблицы группа ресурсов | int |
RESGRP_ABBR | Группа ресурсов (аббр.) | string |
RESGRP_NAME | Группа ресурсов (наименование) | string |
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
COUNTER_ID | ID таблицы ПУ | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
COUNTER_NO | No ПУ | string |
COUNTER_MAKEDATE | Дата выпуска | dateTime.iso8601 |
COUNTER_DESC | Примечание | string |
COUNTER_SEALING | Опломбирование | string |
LOCATION_ID | ID таблицы места установки | int |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
CPSTATUS_ID | ID таблицы состояний шкалы (виды) | int |
CPSTATUS_ABBR | Аббревиатура состояния | string |
CPSTATUS_NAME | Наименование состояния | string |
CPSTATUS_FIT | Признак работоспособной шкалы | int |
EXTID_COUNTER_GIS | Идентификатор GIS | int |
EXTID_COUNTER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о КПУ-показания¶
export.kpucval¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис КПУ (RSP_KPU) RSP_KPU
структура ответа:
AGENT_ID | Код агента | int |
FLAT_ID | ID помещения | int |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTVAL_ID | ID таблицы показаний | int |
COUNTVAL_NVAL | Текущие показания | double |
COUNTVAL_AVAL | Показание, взятое в расчет в предыдущем периоде | double |
COUNTVAL_DVAL | Показание, взятое в расчет в текущем периоде | double |
COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
COUNTVAL_CROSS | Переход через 0 шкалы | int |
COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
CVALCALC_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
COUNTVAL_DESC | Комментарий | string |
COUNTVAL_DEL | Отмена показания | int |
START_COUNTVAL_ID | ID таблицы показаний | int |
START_COUNTVAL_NVAL | Начальное показание | double |
START_COUNTVAL_AVAL | double | |
START_COUNTVAL_DVAL | double | |
START_COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
START_COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
START_COUNTVAL_CROSS | Переход через 0 шкалы | int |
START_COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
START_COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
START_COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
START_COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
START_COUNTVAL_DESC | Комментарий | string |
START_COUNTVAL_DEL | Отмена показания | int |
CVALTYPE_ID | ID таблицы типов показаний | int |
CVALTYPE_ABBR | Аббревиатура типа показания | string |
CVALTYPE_NAME | Наименование типа показания | string |
CVALTYPE_PRIORITY | Приоритет показания | int |
CVALTYPE_FNOCALC | Признак неучета показания в расчете | int |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
Запрос информации о КПУ-поверки¶
export.kpucpcheck¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис КПУ (RSP_KPU) RSP_KPU
структура ответа:
COUNTER_ID | ID прибора учета | int |
CPLUG_ID | ID шкалы прибора учета | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
CPCHECK_FROMDATE | Дата начала поверки | dateTime.iso8601 |
CPCHECK_TODATE | Дата окончания поверки | dateTime.iso8601 |
CPCHECK_CSEALINSTALLDATE | Дата опломбирования ПУ после поверки | dateTime.iso8601 |
CPCHECK_TOCVAL | Показание на начало поверки | double |
CPCHECK_FROMCVAL | Показание на окончание поверки | double |
Запрос информации о ГПУ-гр.помещений-шкалы¶
export.gpufgrpcplug¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр) year* int — год (обязательный параметр) month* int — месяц (обязательный параметр) accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Поступления RSP_GPU_FGRP
структура ответа:
AGENT_ID | Код агента | int |
FLATGROUP_ID | ID группы помещения | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
CPARTYPE_ID | ID таблицы типа шкалы | int |
CPARTYPE_ABBR | Тип шкалы (аббр.) | string |
CPARTYPE_NAME | Тип шкалы (наименование) | string |
CPARTYPE_DESC | Тип шкалы (описание) | string |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_ABBR | Параметры шкалы (аббр.) | string |
CTPAR_NAME | Параметры шкалы (наименование) | string |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
CTPAR_CODE | Код | string |
GPURES_ID | ID таблицы Коммунального ресурса | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
RESGRP_ID | ID таблицы группа ресурсов | int |
RESGRP_ABBR | Группа ресурсов (аббр.) | string |
RESGRP_NAME | Группа ресурсов (наименование) | string |
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
COUNTER_ID | ID таблицы ПУ | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
COUNTER_NO | No ПУ | string |
COUNTER_MAKEDATE | Дата выпуска | dateTime.iso8601 |
COUNTER_DESC | Примечание | string |
COUNTER_SEALING | Опломбирование | string |
LOCATION_ID | ID таблицы места установки | int |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
CPSTATUS_ID | ID таблицы состояний шкалы (виды) | int |
CPSTATUS_ABBR | Аббревиатура состояния | string |
CPSTATUS_NAME | Наименование состояния | string |
CPSTATUS_FIT | Признак работоспособной шкалы | int |
EXTID_COUNTER_GIS | Идентификатор GIS | int |
EXTID_COUNTER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о ГПУ-гр.помещений-показания¶
export.gpufgrpcval¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Гр. ПОМЕЩЕНИЙ (RSP_GPU_FGRP) RSP_GPU_FGRP
структура ответа:
AGENT_ID | Код агента | int |
FLATGROUP_ID | ID группы помещения | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTVAL_ID | ID таблицы показаний | int |
COUNTVAL_NVAL | Текущие показания | double |
COUNTVAL_AVAL | Показание, взятое в расчет в предыдущем периоде | double |
COUNTVAL_DVAL | Показание, взятое в расчет в текущем периоде | double |
COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
COUNTVAL_CROSS | Переход через 0 шкалы | int |
COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
CVALCALC_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
COUNTVAL_DESC | Комментарий | int |
COUNTVAL_DEL | Отмена показания | int |
START_COUNTVAL_ID | ID таблицы показаний | int |
START_COUNTVAL_NVAL | Начальное показание | double |
START_COUNTVAL_AVAL | double | |
START_COUNTVAL_DVAL | double | |
START_COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
START_COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
START_COUNTVAL_CROSS | Переход через 0 шкалы | int |
START_COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
START_COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
START_COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
START_COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
START_COUNTVAL_DESC | Комментарий | string |
CVALTYPE_ID | ID таблицы типов показаний | int |
CVALTYPE_ABBR | Аббревиатура типа показания | string |
CVALTYPE_NAME | Наименование типа показания | string |
CVALTYPE_PRIORITY | Приоритет показания | int |
CVALTYPE_FNOCALC | Признак неучета показания в расчете | int |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
Запрос информации о ГПУ-гр.помещений-поверки¶
export.gpufgrpcpcheck¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Гр. ПОМЕЩЕНИЙ (RSP_GPU_FGRP) RSP_GPU_FGRP
структура ответа:
COUNTER_ID | ID прибора учета | int |
CPLUG_ID | ID шкалы прибора учета | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
CPCHECK_FROMDATE | Дата начала поверки | dateTime.iso8601 |
CPCHECK_TODATE | Дата окончания поверки | dateTime.iso8601 |
CPCHECK_CSEALINSTALLDATE | Дата опломбирования ПУ после поверки | dateTime.iso8601 |
CPCHECK_TOCVAL | Показание на начало поверки | double |
CPCHECK_FROMCVAL | Показание на окончание поверки | double |
Запрос информации о ГПУ-дома-шкалы¶
export.gpuhousecplug¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Домов (RSP_GPU_HOUSE) RSP_GPU_HOUSE
структура ответа:
AGENT_ID | Код агента | int |
HOUSE_ID | ID дома | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
CPARTYPE_ID | ID таблицы типа шкалы | int |
CPARTYPE_ABBR | Тип шкалы (аббр.) | string |
CPARTYPE_NAME | Тип шкалы (наименование) | string |
CPARTYPE_DESC | Тип шкалы (описание) | string |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_ABBR | Параметры шкалы (аббр.) | string |
CTPAR_NAME | Параметры шкалы (наименование) | string |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
CTPAR_CODE | Код | string |
GPURES_ID | ID таблицы Коммунального ресурса | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
RESGRP_ID | ID таблицы группа ресурсов | int |
RESGRP_ABBR | Группа ресурсов (аббр.) | string |
RESGRP_NAME | Группа ресурсов (наименование) | string |
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
COUNTER_ID | ID таблицы ПУ | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
COUNTER_NO | No ПУ | string |
COUNTER_MAKEDATE | Дата выпуска | dateTime.iso8601 |
COUNTER_DESC | Примечание | string |
COUNTER_SEALING | Опломбирование | string |
LOCATION_ID | ID таблицы места установки | int |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
CPSTATUS_ID | ID таблицы состояний шкалы (виды) | int |
CPSTATUS_ABBR | Аббревиатура состояния | string |
CPSTATUS_NAME | Наименование состояния | string |
CPSTATUS_FIT | Признак работоспособной шкалы | int |
EXTID_COUNTER_GIS | Идентификатор GIS | int |
EXTID_COUNTER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о ГПУ-дома-показания¶
export.gpuhousecval¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Домов (RSP_GPU_HOUSE) RSP_GPU_HOUSE*
структура ответа:
AGENT_ID | Код агента | int |
HOUSE_ID | ID дома | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTVAL_ID | ID таблицы показаний | int |
COUNTVAL_NVAL | Текущие показания | double |
COUNTVAL_AVAL | Показание, взятое в расчет в предыдущем периоде | double |
COUNTVAL_DVAL | Показание, взятое в расчет в текущем периоде | double |
COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
COUNTVAL_CROSS | Переход через 0 шкалы | int |
COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
CVALCALC_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
COUNTVAL_DESC | Комментарий | string |
COUNTVAL_DEL | Отмена показания | int |
START_COUNTVAL_ID | ID таблицы показаний | int |
START_COUNTVAL_NVAL | Начальное показание | double |
START_COUNTVAL_AVAL | double | |
START_COUNTVAL_DVAL | double | |
START_COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
START_COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
START_COUNTVAL_CROSS | Переход через 0 шкалы | int |
START_COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
START_COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
START_COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
START_COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
START_COUNTVAL_DESC | Комментарий | string |
CVALTYPE_ID | ID таблицы типов показаний | int |
CVALTYPE_ABBR | Аббревиатура типа показания | string |
CVALTYPE_NAME | Наименование типа показания | string |
CVALTYPE_PRIORITY | Приоритет показания | int |
CVALTYPE_FNOCALC | Признак неучета показания в расчете | int |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
Запрос информации о ГПУ-домов-поверки¶
export.gpuhousecpcheck¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Домов (RSP_GPU_HOUSE) RSP_GPU_HOUSE
структура ответа:
COUNTER_ID | ID прибора учета | int |
CPLUG_ID | ID шкалы прибора учета | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
CPCHECK_FROMDATE | Дата начала поверки | dateTime.iso8601 |
CPCHECK_TODATE | Дата окончания поверки | dateTime.iso8601 |
CPCHECK_CSEALINSTALLDATE | Дата опломбирования ПУ после поверки | dateTime.iso8601 |
CPCHECK_TOCVAL | Показание на начало поверки | double |
CPCHECK_FROMCVAL | Показание на окончание поверки | double |
Запрос информации о ГПУ-гр.домов-шкалы¶
export.gpuhgrpcplug¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Гр. ДОМОВ (RSP_GPU_HGRP) RSP_GPU_HGRP
структура ответа:
AGENT_ID | Код агента | int |
HOUSEGROUP_ID | ID группы домов | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
CPARTYPE_ID | ID таблицы типа шкалы | int |
CPARTYPE_ABBR | Тип шкалы (аббр.) | string |
PARTYPE_NAME | Тип шкалы (наименование) | string |
CPARTYPE_DESC | Тип шкалы (описание) | string |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_ABBR | Параметры шкалы (аббр.) | string |
CTPAR_NAME | Параметры шкалы (наименование) | string |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
CTPAR_CODE | Код межпроверочного интервала | string |
GPURES_ID | ID таблицы Коммунального ресурса | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
RESGRP_ID | ID таблицы группа ресурсов | int |
RESGRP_ABBR | Группа ресурсов (аббр.) | string |
RESGRP_NAME | Группа ресурсов (наименование) | string |
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
COUNTER_ID | ID таблицы ПУ | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
COUNTER_NO | No ПУ | string |
COUNTER_MAKEDATE | Дата выпуска | dateTime.iso8601 |
COUNTER_DESC | Примечание | string |
COUNTER_SEALING | Опломбирование | string |
LOCATION_ID | ID таблицы места установки | int |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
CPSTATUS_ID | ID таблицы состояний шкалы (виды) | int |
CPSTATUS_ABBR | Аббревиатура состояния | string |
CPSTATUS_NAME» | Наименование состояния» | string |
CPSTATUS_FIT | Признак работоспособной шкалы | int |
EXTID_COUNTER_GIS | Идентификатор GIS | int |
EXTID_COUNTER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о ГПУ-гр.домов-показания¶
export.gpuhgrpcval¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Гр. ДОМОВ (RSP_GPU_HGRP) RSP_GPU_HGRP
структура ответа:
AGENT_ID | Код агента | int |
HOUSEGROUP_ID | ID группы домов | int |
GPUTYPE_ID | ID типа ГПУ | int |
GPUTYPE_ABBR | Аббревиатура типа ГПУ | string |
RESPROV_ID | ID таблицы принципал-поставщик | int |
RESOURCE_ID | ID ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
CPLUG_ID | ID шкалы | int |
CPLUG_TRANS | Коэффициент трансформации | double |
COUNTVAL_ID | ID таблицы показаний | int |
COUNTVAL_NVAL | Текущие показания | double |
COUNTVAL_AVAL | Показание, взятое в расчет в предыдущем периоде | double |
COUNTVAL_DVAL | Показание, взятое в расчет в текущем периоде | double |
COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
COUNTVAL_CROSS | Переход через 0 шкалы | int |
COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
CVALCALC_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
COUNTVAL_DESC | Комментарий | string |
COUNTVAL_DEL» | Отмена показания» | int |
START_COUNTVAL_ID | ID таблицы показаний | int |
START_COUNTVAL_NVAL | Начальное показание | double |
START_COUNTVAL_AVAL | double | |
START_COUNTVAL_DVAL | double | |
START_COUNTVAL_DATE | Дата показания | dateTime.iso8601 |
START_COUNTVAL_DATE_CA | Дата снятия показания | dateTime.iso8601 |
START_COUNTVAL_CROSS | Переход через 0 шкалы | int |
START_COUNTVAL_CONFIRMED | Флаг Подтверждено потребителем | int |
START_COUNTVAL_ACTUAL | Флаг актуального показания периода | dateTime.iso8601 |
START_COUNTVAL_INDATE | Дата ввода | dateTime.iso8601 |
START_COUNTVAL_CNGDT | Дата изменения | dateTime.iso8601 |
START_COUNTVAL_DESC | Комментарий | string |
CVALTYPE_ID | ID таблицы типов показаний | int |
CVALTYPE_ABBR | Аббревиатура типа показания | string |
CVALTYPE_NAME | Наименование типа показания | string |
CVALTYPE_PRIORITY | Приоритет показания | int |
CVALTYPE_FNOCALC | Признак неучета показания в расчете | int |
CPABLE_ID | ID таблицы состояния шкалы | int |
CPABLE_FROMPERIOD | Дата начала | dateTime.iso8601 |
CPABLE_TOPERIOD | Дата окончания | dateTime.iso8601 |
CPABLE_REGDATE | Дата регистрации | dateTime.iso8601 |
CPABLE_CTRANS | Коэффициент трансформации | double |
Запрос информации о ГПУ-гр.домов-поверки¶
export.gpuhgrpcpcheck¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис ГПУ Гр. ДОМОВ (RSP_GPU_HGRP) RSP_GPU_HGRP
структура ответа:
COUNTER_ID | ID прибора учета | int |
CPLUG_ID | ID шкалы прибора учета | int |
CPCHECK_DATE | Дата фактической поверки | dateTime.iso8601 |
CPCHECK_NEXTDATE | Дата плановой поверки | dateTime.iso8601 |
CPCHECK_FROMDATE | Дата начала поверки | dateTime.iso8601 |
CPCHECK_TODATE | Дата окончания поверки | dateTime.iso8601 |
CPCHECK_CSEALINSTALLDATE | Дата опломбирования ПУ после поверки | dateTime.iso8601 |
CPCHECK_TOCVAL | Показание на начало поверки | double |
CPCHECK_FROMCVAL | Показание на окончание поверки | double |
Запрос информации о журналах¶
export.jornalobjtypes¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
структура ответа:
JORNALOBJTYPE_ABBR | Аббревиатура | string |
JORNALOBJTYPE_NAME | Название | string |
JORNALOBJTYPE_DESC | Описание | string |
Запрос информации по справочнику принципалов¶
export.resellers¶
параметры запроса:
agent_id* int — id агента (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
reseller_id* int or null — id принципала
структура ответа:
RESELLER_ID | ID Принципала | int |
ORG_ID | ID Организации | int |
AGENT_ID | ID Агента | int |
RESELLER_ABBR | Аббревиатура | string |
RESELLER_NAME | Название | string |
RESELLER_BARPREFIX | Префикс принципала | string |
RESELLER_PAYCODE | Код оплаты | string |
RESELLER_FROMPERIOD | Дата начала | dateTime.iso8601 |
RESELLER_TOPERIOD | Дата окончания | dateTime.iso8601 |
RESELLER_TEST | Признак тестового принципала | int |
RESELLER_CA | Доступ в КА | int |
RESELLER_PSKRD | Разрешения оплаты по услугам | int |
RESELLER_PSKRDCA | Разрешения оплаты по услугам в Кабинете абонента | int |
RESELLER_CODE | Код принципала | int |
RESELLER_PHONE | Номер телефона | string |
RESELLER_FAX | Номер факса | string |
RESELLER_EMAIL | string | |
RESELLER_WEBSITE | Адрес web-сайта | string |
RESELLER_WTIME | Режим работы | string |
BANK_NAME | Наименование банка | string |
BANKDETAIL_CODE | Код банковского реквизита | string |
BANKDETAIL_RS | Расчетный счет | string |
BANK_KS | Корр. счет | string |
BANK_BIK | БИК | string |
EXTID_RESELLER_GIS | ИД принципала ГИС ЖКХ | string |
EXTID_RESELLER_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
OVHFUNDTYPE_ID | ID Фонда КР | int |
OVHFUNDTYPE_ABBR | Аббревиатура Фонда КР | string |
ACCTYPE_NAME | Тип абонента | string |
OBJBANKDETAIL_USEKVIT | Использовать для вывода в квитанцию | int |
OBJBANKDETAIL_FMAIN | Признак основного банковского реквизита | bool |
RECORD_ID | ИД принципала ГИС ЖКХ | string |
EXTID_RESELLER_ACCTYPE_GIS | Тип принципала | string |
GIS_BANKDETAIL_RS | Расчетный счет (Обмен с ГИС=да) | string |
GIS_BANK_BIK | БИК банка (р/с Обмен с ГИС=да) | string |
GIS_OBJBANKDETAIL_USEKVIT | Для сбора платежей (р/с Обмен с ГИС=да) | int |
Запрос информации о группе услуг агента¶
export.sgrp¶
параметры запроса:
agent_id* int — id агента (обязательный параметр)
year* int or null — год (обязательный параметр)
month* int or null — месяц (обязательный параметр)
servgroup* int or null — id идентификатора группы услуг
структура ответа:
SERVGROUP_ID | Идентификатор группы услуг | int |
AGENT_ID | Код агента | int |
SERVGROUP_FDOC | Платежные документы: NULL - любые, 1 - квитанции, 2 - счет-фактуры | int |
VPHISVAL_ID | Учетный ресурс | int |
PHISVAL_NAME | Единица измерения услуги | string |
RESOURCE_ID | Ед. изм. базы для начисления | int |
RESOURCE_NAME | Единица измерения ресурса | string |
GRPRULE_ID | ID группировки | int |
GRPRULE_NAME | Правило группировки | string |
GRPTYPE_ID | ID группы | int |
GRPTYPE_NAME | Тип группы | string |
RESELLER_ID | ID принципала | int |
RESELLER_ABBR | Принципал | string |
PROVIDER_ID | ID поставщика | int |
PROVIDER_ABBR | Поставщика | string |
SERVGROUP_ABBR | Аббревиатура группы услуг | string |
SERVGROUP_NAME | Наименование группы услуг | string |
SERVGROUP_TITLE | Название группы услуг в квитанцию | string |
SERVGROUP_COMINV_TITLE | Название группы услуг в счет-фактуру | string |
SERVICE_ID | ID услуги | int |
SERVICE_ABBR | Услуга | string |
SGRP_FROMPERIOD | Дата начала услуги в группе услуг | dateTime.iso8601 |
SGRP_TOPERIOD | Дата окончание услуги в группе услуг | dateTime.iso8601 |
RECORD_ID | ИД группы услуг ГИС ЖКХ | string |
EXTID_SERVGROUP_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о начислении (группа услуг)¶
export.servgroupcalculations¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — год (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
структура ответа:
ACCOUNT_ID | Код ЛС | int |
RESELLER_ID | Код Принципала | int |
RESELLER_ABBR | Аббревиатура принципала | string |
PROVIDER_ID | Код поставщика | int |
PROVIDER_ABBR | Аббревиатура поставщика | string |
RESOURCE_ID | Код ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
SERVGROUP_ABBR | Аббревиатура группы услуг | string |
SERVGROUP_NAME | Наименование группы услуг | string |
SERVGROUP_TITLE | Наименование группы услуг | string |
SERVGROUP_ID | Код группы услуг | int |
ORIGINAL_PERIOD | Исходный период базового объема | dateTime.iso8601 |
D_INRES | Вх. сальдо | double |
D_OUTRES | Исх. сальдо | double |
D_TAR | Тариф | double |
D_BASE | База для начисления по услуге (объем инд) | double |
DBT_VOL_IND | Объем с учетом корректировок (Инд.) | double |
DBT_VOL_ODN | Объем с учетом корректировок (Одн.) | double |
PHISVAL | Ед. изм объема ресурса | |
VOLSTATUS_ID | Код объема | int |
VOLSTATUS_ABBR | Статус получения объема | string |
D_PBASE | базовое начисление по услуге, руб (начисление инд) | double |
D_DPLGOT | начислено льготы по ресурсу, руб | double |
D_DPNLGOT | начислено льготы по ресурсу, руб | double |
D_STORN | перерасчет по ресурсу, руб | double |
D_ITOG | итого начислено по услуге, руб | double |
DBT_ID | ID начисления | int |
CSBALANCE_ID | ID начисления | int |
Запрос на формирование информации о ед. измерения¶
export.phisvals¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр)
структура ответа:
PHISVAL_ID | ID таблицы физ. величины | int |
PHISVAL_NAME | Физ.величина (аббр.) | string |
PHISVAL_ABBR | Физ.величина (наименование) | string |
PHISVAL_SERV | Ед. изм. комм. ресурса | int |
PHISVAL_NORM | Ед. изм. норматива | int |
PHISVAL_LOAD | Ед. изм. загрузки | int |
PHISVAL_DESC | Описание | string |
OKEI_CODE | Код ОКЕИ | string |
Запрос на формирование информации о коммунальных ресурсах¶
export.gpureses¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр)
структура ответа:
GPURES_ID | ID таблицы Коммунального ресурса | int |
RESCAT_ID | Категория ресурса | int |
RESGRP_ID | ID таблицы группа ресурсов | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
GPURES_NAME | Коммунальный ресурс (наименование) | string |
Запрос на формирование информации о маршрутных листах¶
export.bypasslist¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр) DPERSON_ID* int
структура ответа:
BYPASSLIST_ID | Код маршрутного листа | int |
BYPASSLIST_COUNTERKIND | Вид ПУ | int |
ACCTYPE_ID | Тип абонента (0-физическое лицо, 1-юридическое лицо) | int |
CVALTYPE_ID | ID таблицы типов показаний | int |
HOUSEGROUP_ID | ID группы домов | int |
DOCUMENT_SER | Серия | string |
DOCUMENT_NO | Номер договора на оказания услуг | string |
DOCUMENT_NAME | Название | string |
DOCUMENT_PERIOD | Период учета акта сторно | dateTime.iso8601 |
DOCUMENT_INDATE | Дата создания акта сторно | dateTime.iso8601 |
DOCUMENT_CLOSEDATE | Дата закрытия договора | date |
DOCUMENT_REGDATE | Дата и время создания акта сторно | dateTime.iso8601 |
DOCUMENT_DESC | Примечание | string |
PERSORG_ID | ИД ответственного лица организации | int |
DPERSON_ID | Пользователь | int |
Запрос на формирование информации об объектах маршрутного листа¶
export.bypasslist_objects¶
параметры запроса:
BYPASSLIST_ID* int
структура ответа:
BYPASSLIST_ID | Код маршрутного листа | int |
OBJDOC_ID | Код документа объекта | int |
OBJ_ID | Код объекта | int |
ACCOUNT_ID | Идентификатор ЛС | int |
ACCOUNT_NO | Номер ЛС | int |
ACCOUNT_OLDNO | „Старый“ номер ЛС (номер ЛС абонента из внешней системы биллинга) | string |
OBJDOCTYPE_ID | ИД задания | int |
OBJDOCTYPE_ABBR | Задания обходчику | string |
OBJDOCTYPE_NAME | Наименование задания | string |
OBJDOCTYPE_DESC | Примечание | string |
Запрос на формирование информации об учетных ресурсах¶
export.resources¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр)
структура ответа:
RESOURCE_ID | ID ресурса | int |
PHISVAL_ID | ID таблицы физ. величины | int |
GPURES_ID | ID таблицы Коммунального ресурса | int |
RESOURCE_ABBR | Аббревиатура ресурса | string |
RESOURCE_NAME | Единица измерения ресурса | string |
Запрос на формирование информации о типах приборов учета¶
export.countypes¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр)
структура ответа:
COUNTYPE_ID | ID таблицы типа прибора учета | int |
COUNTYPE_ABBR | Тип прибора учета (аббр.) | string |
COUNTYPE_NAME | Тип прибора учета (наименование) | string |
COUNTYPE_FREMOTECTRL | Возможность дистанционного отключения | int |
CTPAR_ID | ID таблицы параметров шкалы | int |
CTPAR_INT | Разрядность (целая) | int |
CTPAR_FRAC | Разрядность (дробная) | int |
CTPAR_CHKINT | Межпроверочный интервал | int |
GPURES_ABBR | Коммунальный ресурс (аббр.) | string |
PHISVAL_NAME | Физ.величина (аббр.) | string |
CPARTYPE_NAME | Тип шкалы (наименование) | string |
CPLUGTYPE_ABBR | Схема подключения | string |
CTPRECLASS_VAL | Класс точности | int |
ELCURRENT_NOMINAL | Номинальный ток | int |
ELCURRENT_MAXIMUM | Максимальный ток | int |
COUNTYPE_BRAND | Марка счетчика | string |
COUNTYPE_MODEL | Модель счетчика | string |
Запрос на формирование информации о местах установки ПУ¶
export.locations¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID (обязательный параметр)
структура ответа:
LOCATION_ID | ID таблицы места установки | int |
AGENT_ID | Код агента | int |
LOCATIONTYPE_ID | ID таблицы типа места установки | int |
LOCATIONTYPE_ABBR | Тип мест установки | string |
LOCATION_ABBR | Аббревиатура места установки | string |
LOCATION_DESC | Описание места установки | string |
LOCATION_SORTORDER | Порядок сортировки | int |
Запрос информации о доме¶
export.houses¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт» (необязательный параметр)
house_id — массив состоящий из идентификатор дома HOUSE_ID из ОП «Биллинг Эксперт» (необязательный параметр)
reseller_id — массив состоящий из идентификатор принципала RESELLER_ID из ОП «Биллинг Эксперт» (необязательный параметр)
структура ответа:
CITY_NAME | Наименование нас.пункт | string |
STREET_NAME | Наименование элемента | string |
HOUSE_ID | Идентификатор дома | int |
HOUSE_NO | Номер дома | string |
HOUSE_BULDNO | Строение | int |
HOUSE_LITER | Литера | string |
HOUSE_POSTINDEX | Почтовый индекс | int |
HOUSE_BDATE | Год постройки | dateTime.iso8601 |
EXTID_HOUSE_FIAS | Внешний ID дома ФИАС | string |
EXTID_HOUSE_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
HCAT_ABBR | Категория дома | string |
HTYPE_ABBR | Тип дома | string |
OVHFUNDTYPE_ABBR | Аббревиатура Фонда КР | string |
HWALL_ABBR | Материал стен | string |
HDESC_FLOORCNT | Этажность | string |
HDESC_S0 | Общая площадь | double |
HDESC_SOI | Площадь МОП для Электро | |
HBLAG_LIFT | Благоустройства : Наличие лифта | string |
HBLAG_GARB | Благоустройства : Наличие мусоропровода | string |
HBLAG_CGZS | Благоустройства : Наличие газа | string |
HEATYPE_ABBR | Благоустройства : Тип отопления | string |
HBLAG_CHVS | Благоустройства : Наличие ХВС | string |
HBLAG_EL | Благоустройство: Электроэнергия | |
OBJBANKDETAIL_USEKVIT | для сбора платежей (реквизиты банка на доме) | int |
BANK_BIK | БИК банка | string |
BANK_NAME | Наименование банка | string |
BANK_KS | Корр. счет | string |
BANKDETAIL_RS | Расчетный счет | string |
RESELLER_ABBR | Принципал | string |
ACCTYPE_NAME | Тип абонента | string |
Запрос информации по субсчету¶
export.resid¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
accounts array() — массив состоящий из номеров ЛС ACCOUNT_NO из ОП «Биллинг Эксперт»
базис Базис накопительного счета (RSP_ACCUM) RSP_ACCUM
структура ответа:
RESID_ID | ID накопительного счета | int |
ACCOUNT_ID | Идентификатор ЛС | int |
ACCOUNT_NO | Номер ЛС | int |
RESID_PERIOD | Период | date |
ACCUM_IN | Входящее сальдо | double |
ACCUM_PMNT | Погашено задолженности | int |
ACCUM_ADV | Авансировано поступлений | double |
ACCUM_ASTORN | Акты сальдо с/с | int |
ACCUM_STORN | Перерасчет | int |
ACCUM_DEC | Списано с остатка | int |
ACCUM_EDEC | Списано с остатка (в конце периода) | int |
ACCUM_OUT | Исходящее сальдо | double |
Запрос информации по группе домов¶
export.housegroup¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
house_id array() — массив состоящий из идентификатор дома HOUSE_ID из ОП «Биллинг Эксперт» (необязательный параметр)
структура ответа:
AGENT_ID | Код агента | int |
HOUSEGROUP_ID | ID группы домов | int |
HOUSE_ID | ID дома | int |
EXTID_HOUSE_FIAS | Внешний ID дома ФИАС | string |
EXTID_HOUSE_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации по группе помещений¶
export.flatgroup¶
параметры запроса:
agent* int — идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр)
year* int — год (обязательный параметр)
month* int — месяц (обязательный параметр)
flat_id array() — массив состоящий из идентификатор дома FLAT_ID из ОП «Биллинг Эксперт» (необязательный параметр)
структура ответа:
AGENT_ID | Код агента | int |
FLATGROUP_ID | ID группы помещения | int |
FLAT_ID | ID помещения | int |
EXTID_FLAT_GIS | ИД квартиры ГИС ЖКХ | string |
EXTID_FLAT_GIS_ABLE | Обмен с ГИС ЖКХ | boolean |
Запрос информации о просуженной задолженности¶
export.debtreq¶
параметры запроса:
agent* int - идентификатор агента AGENT_ID из ОП «Биллинг Эксперт» (обязательный параметр) reseller* int - идентификатор принципала RESELLER_ID из ОП «Биллинг Эксперт» (обязательный параметр) requests array() - массив состоящий из элементов request
request:
dict { „REQUEST_ID“: Номер запроса, „REQUEST_CREATEDATE“: Дата направления запроса, „REQUEST_FROMDATE“: Дата начала периода задолженности(Необязательное), „REQUEST_TODATE“: Дата окончания периода задолженности(Необязательное), „HOUSE_FIAS“: Код дома по ФИАС, „HOUSE_GUID“: Идентификационный код дома ГИС ЖКХ, „HOUSE_ADDR“: Адрес дома(Необязательное), „FLAT_NO“: Номер помещения }
структура ответа:
request_id | Номер запроса | int |
request_createdate | Дата направления запроса | string |
house_fias | Идентификатор дома | string |
house_addr | Адрес дома | string |
flat_no | Номер помещения | string |
status_number | Наличие просуженной задолженности.Есть(1)/Нет(0)/Нет данных(-1) | int |
status_number_str | Сообщение | string |
debt_agreement_exists | Наличие просуженных периодов | int |
debt_exists | Наличие задолженности | int |
depth_accepted | Глубина истории удовл. | int |
status_code | Статус | string |
status_msg | Статус.Сообщение | string |
agent_id | Агент | int |
person_guid | GUID сотрудника | string |
debt_month_count | Кол-во месяцев в структуре долга | string |
debt_sum | Общая Сумма долга(коп.) | double |
person_count | Кол-во жильцов N. Если N > 0, то формируются дополнительно N колонок для каждого person_lname_n, person_fname_n, person_mname_n |
int |
person_lname_n | Фамилия жильца n (n=1..N) | string |
person_fname_n | Имя жильца n (n=1..N) | string |
person_mname_n | Отчество жильца n (n=1..N) | string |
description | Комментарий для ответа | string |


Методы получения наборов данных¶
cursor.status — запрос статуса задачи
cursor.rowcount — запрос количества строк в сформированном задачей наборе данных
cursor.fetch — запрос на получение сформированных в задаче данных
cursor.close — закрытие набора данных (дальнейшая работа с ним становится невозможной)
Запрос статуса задачи¶
cursor.status¶
параметры запроса:
cursor_id text — идентификатор курсора, полученный при вызове метода формирования данных (обязательный параметр)
возвращаемый результат (тип int):
-1 — задача находится в очереди / исполнении
0 — задача успешно выполнена, набор данных сформирован
> 0 — задача завершилась с ошибкой
Запрос количества строк в сформированном задачей наборе данных¶
cursor.rowcount¶
параметры запроса:
cursor_id text — идентификатор курсора, полученный при вызове метода формирования данных (обязательный параметр)
возвращаемый результат (тип int):
количество строк в курсоре (сформированном наборе данных)
Запрос на получение сформированных в задаче данных¶
cursor.fetch¶
параметры запроса:
cursor_id text — идентификатор курсора, полученный при вызове метода формирования данных (обязательный параметр)
offset int — сдвиг. Использование данного параметра позволяет пропустить указанное количество строк перед тем как выводить результаты запроса.
По умолчанию равен 0. Является обязательным, если указывается третий параметр запроса.
limit int — ограничение на количество запрашиваемых строк курсора. Не является обязательным. По умолчанию равен 1000. Максимально возможное значение - 2000.
columns_lst list — Список необходимых к выдаче столбцов (фильтр). Необязательный параметр.
Результатом выполнения метода является набор данных, полученный из заданного курсора с учетом параметров offset и limit.
Закрытие курсора (набора данных)¶
cursor.close¶
параметры запроса:
cursor_id text — идентификатор курсора, полученный при вызове метода формирования данных (обязательный параметр)
После выполнения данного метода курсор удаляется, любая работа с ним становится невозможной.