Skip to content

Описание формата фала для импорта данных из сторонних систем

Notifications You must be signed in to change notification settings

vdme/import-format

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 

Repository files navigation

Импорт данных из сторонних систем в формате JSON

Json файл должен содержать информацию об одном доме и иметь следующую струкуру.

{
    "meters": [
        {
            "type": "...",
            "title": "...",
            "serial": "...",
            "brand": "...",
            "model": "...",
            "install_date": "2017-04-23",
            "stamp_date": "2017-04-23",
            "check_date": "2025-04-23",
            "replace_date": "2017-08-12",
            "ratio": 1,
            "loss_ratio": 0.00,
            "beginning_values": {
                "B": 2.000,
                "T1": 3.000,
                "T2": 3.000,
                "T3": 3.000,
            },
            "unit": "...",
            "values": [
                {
                    "date": "2017-06-25",
                    "period": "2017-06-01",
                    "values": {
                        "B": 3.000,
                        "T1": 3.000,
                        ...
                    }
                },
                ...
            ]
        },
        ...
    ],
    "premises": [
        {
            "flat_number": "...",
            "premises_type": "...",
            "overall_area": 45.34,
            "living_area": 28.45,
            "number_of_rooms": 2,
            "entrance": "...",
            "floor": 2,
            "radio": true,
            "number_of_tv": 1,
            "gis_id" : "1BCx0023456789",
            "meters": [
                {
                    "type": "...",
                    "title": "...",
                    "serial": "...",
                    "brand": "...",
                    "model": "...",
                    "install_date": "2017-04-23",
                    "stamp_date": "2017-04-23",
                    "check_date": "2025-04-23",
                    "replace_date": "2017-08-12",
                    "gis_id" : "3eyO04123604569",
                    "beginning_values": {
                        "B": 2.000,
                        "T1": 3.000,
                        "T2": 3.000,
                        "T3": 3.000,
                    },
                    "unit": "...",
                    "values": [
                        {
                            "date": "2017-06-25",
                            "period": "2017-06-01",
                            "values": {
                                "B": 3.000,
                                "T1": 3.000,
                                ...
                            }
                        },
                        ...
                    ]
                },
                ...
            ],
            "accounts": [
                {
                    "account": "...",
                    "date_from": "2017-01-01",
                    "date_to": "2017-12-31",
                    "registered": 2,
                    "residents_count": 2,
                    "saldo" : "...",
                    "saldo_period" : "...",
                    "calculated_area": 23.67,
                    "gis_id" : "12КН345678",
                    "gis_zhku_id" : "12КН345678-01",
                    "residents": [
                        {
                            "type": "...",
                            "share": "1/2",
                            "mobile_phone_1": "...",
                            "mobile_phone_2": "...",
                            "home_phone": "...",
                            "work_phone": "...",
                            "email": "...",
                            "residence" : {
                                "type" : "...",
                                "date_from" : "..."
                                "date_to" : "...",
                                "from" : {
                                    "country":"...",
                                    "region":"...",
                                    "district":"...",
                                    "city":"...",
                                    "locality":"...",
                                    "street":"...",
                                    "house":"...",
                                    "flat":"..."
                                },
                                "to" : {
                                    "country":"...",
                                    "region":"...",
                                    "district":"...",
                                    "city":"...",
                                    "locality":"...",
                                    "street":"...",
                                    "house":"...",
                                    "flat":"..."
                                }
                            }
                            "individual": {
                                "firstname": "...",
                                "lastname": "...",
                                "patronymic": "...",
                                "passport_serial": "...",
                                "passport_number": "...",
                                "passport_issued": "...",
                                "passport_code": "...",
                                "passport_issue_date": "...",
                                "ssn": "...",
                                "birthdate": "...",
                            },
                            "entity": {
                                "title": "...",
                                "inn": "...",
                                "kpp": "...",
                                "ogrn": "...",
                                "legal_address": "...",
                                "head_fullname": "...",
                                "head_post": "...",
                            }
                        },
                        ...
                    ],
                    "rooms": [
                        {
                            "number": "..."
                            "type": "..."
                            "title": "..."
                            "area": 12.32,
                            "balcony_area": 4.56,
                            "loggia_area": 4.56,
                            "rooms_height": 2.54,
                            "rooms_layout": "...",
                            "entrance": "...",
                            "floor_covering": "...",
                            "comment": "...",
                            "radio": true,
                            "number_of_tv": 1,
                            "gis_id" : "1HKM012345678"
                        },
                        ...
                    ],
                    "accruals": [
                        {
                            "period": "2017-01-01" 
                            "calculation_date": "2017-01-29 12:32:34",
                            "result": [
                                {
                                    "id_1c": "...",
                                    "title": "...",
                                    "rate": 12.56,
                                    "volume": 12.12345,
                                    "accrued": 238.23,
                                    "privileges": 0.00,
                                    "recalc": -12.34,
                                    "total": 225.78
                                },
                                ...
                            ]
                        },
                        ...
                    ],
                    "payments": [
                        {
                            "date": "2017-02-03",
                            "sum": 2500.00,
                            "period": "2017-01-01",
                            "penalties_included": 23.64,
                            "comment": "..."
                        },
                        ...
                    ]
                },
                ...
            ]
        },
        ...
    ],
}

Описание полей файла

Поле Название поля Тип Обязательное Описание
meters Общедомовые счетчики array Да Массив с объектами, хранящими информацию об общедомовых приборах учета
premises Помещения array Да Массив с объектами, хранящими информацию о помещениях

Описание объекта в массиве meters

Поле Название поля Тип Обязательное Описание
type Тип счетчика enum Да Варианты значений:
  • ХВС
  • ГВС
  • Эл. однотарифный
  • Эл. двухтарифный
  • Эл. трехтарифный
  • Газ
  • Отопление
title Название (описание) счетчика string Нет Текстовые данные
serial Заводской номер string Нет Текстовые данные
brand Марка счетчика string Нет Текстовые данные
model Модель счетчика string Нет Текстовые данные
install_date Дата установки счетчика Дата Нет См. тип Дата
stamp_date Дата опломбировки счетчика Дата Да См. тип Дата
check_date Дата следующей поверки Дата Нет См. тип Дата
replace_date Дата замены (вывода из эксплуатации) Дата Нет См. тип Дата
ratio Коэффициент трансформации (для счетчиков электроэнергии) int Нет Поле необходимо только для общедомовых приборов учета
loss_ratio Коэффициент потери (для счетчиков электроэнергии) int Нет Поле необходимо только для общедомовых приборов учета
beginning_values Начальные показания на момент опломбирования Показания счетчиков Нет См. тип Показания счетчика
unit Единица измерения (для счетчика отопления) enum Да (для счетчиков отопления) Возможные значения:
- Гкал
- кВт/ч
- МВт/ч
values Показания по счетчику array Нет Массив объектов с показаниями
gis_id Идентификатор ГИС ЖКХ string Нет Текстовые данные

Описание объекта в массиве premises (Помещения)

Поле Название поля Тип Обязательное Описание
flat_number Номер квартиры (помещения) string Да
premises_type Вид помещения enum Да Возможные варианты
  • квартира
  • совместная квартира
  • коммунальная квартира
  • нежилое
  • кладовка
  • машиноместо
overall_area Общая площадь float Да
living_area Жилая площадь float Да
number_of_rooms Количество комнат int Нет
entrance Номер подъезда string Нет
floor Номер этажа int Нет
radio Наличие радио bool Да true или false
number_of_tv Количество ТВ-антенн int Да
meters Приборы учета array Нет Массив с объектами, хранящими информацию об индивидуальных приборах учета
accounts Лицевые счета array Да Массив с объектами, хранящими данные о ЛС
gis_id Идентификатор ГИС ЖКХ string Нет Текстовые данные

Описание объекта массива accounts

Поле Название поля Тип Обязательное Описание
account Номер лицевого счета string Да
date_from Дата открытия ЛС Дата Да См. тип Дата
date_to Дата закрытия ЛС Дата Нет См. тип Дата
registered Количество зарегистрированных int Да
residents_count Количество проживающих int Да
saldo Начальное сальдо decimal(10,2)
saldo_period Начальное сальдо Дата Да, если есть сальдо
calculated_area Расчетная площадь float Да (только для коммунальных и совместных квартир)
residents Жители(Собственники) array Да Массив с объектами, хранящими информацию о жителях и собственниках
rooms Комнаты array Да (только для коммунальных и совместных квартир) Массив с объектами, хранящими информацию о комнатах ЛС
accruals Начисления array Нет Массив объектов с данными о начислениях. Элементы массива являются объекты с информацией о начислениях в периоде
payments Платежи array Нет Массив с объектами, хранящими информацию о платежах
gis_id Идентификатор ГИС ЖКХ string Нет Текстовые данные
gis_zhku_id Идентификатор ЖКУ ГИС ЖКХ string Нет Текстовые данные
Описание объекта массива residents
Поле Название поля Тип Обязательное Описание
type Тип жителя(собственника) enum Да Возможные значения:
  • физ. лицо
  • юр. лицо
is_owner Собственник enum Да Возможные значения:
  • Да
  • Нет
для юр. лица всегда "Да"
main_payer Основной плательщик enum Да Возможные значения:
  • Да
  • Нет
share Доля собственности string Да, если собственник В формате «142/584», «1/2», «1/1»
mobile_phone_1 Мобильный телефон string Нет
mobile_phone_2 Мобильный телефон string Нет
home_phone Домашний телефон string Нет
work_phone Рабочий телефон string Нет
email Email string Нет
relationship enum string Нет Возможные значения:
  • "собственник"
  • "наниматель"
  • "квартирант"
  • "муж"
  • "жена"
  • "сын"
  • "дочь"
  • "брат"
  • "сестра"
  • "дедушка"
  • "бабушка"
  • "зять"
  • "тесть"
  • "теща"
  • "свекор"
  • "свекровь"
  • "шурин"
  • "свояченица"
  • "невестка"
  • "деверь"
  • "золовка"
  • "мать"
  • "отец"
  • "внук"
  • "внучка"
  • "опекаемый(ая)"
  • "падчерица"
  • "пасынок"
  • "племянник"
  • "племянница"
  • "нет родственных отношений"
residence Регистрация object Да (для type = "физ. лицо") Объект с данными о регистрации, если физ. лицо
individual Физ. лицо object Да (для type = "физ. лицо") Объект с данными о владельце, если физ. лицо
entity Юр. лицо object Да (для type = "юр. лицо") Объект с данными о владельце, если юр. лицо
Описание объекта residence
Поле Название поля Тип Обязательное Описание
type Тип регистрации enum('const','tmp') Да Возможные значения:
  • const - по месту жительства (постоянная)
  • tmp - по месту пребывания (временная)

date_from Дата начала регистрации Дата Да См. тип Дата
date_to Дата окончания регистрации Дата Нет См. тип Дата
from Регистрация object Нет Объект с листком прибытия
to Регистрация object Нет Объект с листком убытия
Описание объекта листка прибытия/убытия arrival-departure-form
Поле Название поля Тип Обязательное Описание
country Страна string Нет
region Регион string Нет
district Район string Нет
city Город string Нет
locality Населенный пункт string Нет
street Улица string Нет
house Номер дома string Нет
flat Номер квартиры string Нет
Описание объекта individual
Поле Название поля Тип Обязательное Описание
firstname Имя string Нет
lastname Фамилия string Да
patronymic Отчество string Нет
passport_serial Серия паспорта string Нет
passport_number Номер паспорта string Нет
passport_issued Кем выдан string Нет
passport_code Код подразделения string Нет
passport_issue_date Дата выдачи Дата Нет См. тип Дата
ssn СНИЛС string Нет
birthdate Дата рождения Дата Нет См. тип Дата
Описание объекта массива entity
Поле Название поля Тип Обязательное Описание
title Наименование физ. лица string
inn ИНН string
kpp КПП string
ogrn ОГРН string
legal_address Юридический адрес string
head_fullname ФИО руководителя string
head_post Должность руководителя string
Описание объекта массива rooms
Поле Название поля Тип Обязательное Описание
number Номер комнаты string Да
type Тип комнаты enum Нет Возможные значения
  • Жилая комната
  • Кухня
  • Кухня-столовая
  • Туалет
  • Ванная
  • Прихожая
  • Коридор
  • Кладовка
  • Жилая комната-кухня
  • Совмещенный санузел
title Название комнаты string Нет
area Площадь float Да
balcony_area Площадь балкона float Нет
loggia_area Площадь лоджии float Нет
rooms_height Высота потолка float Нет
rooms_layout Планировка комнаты enum Нет Возможные значения
  • Изолированная
  • Смежная
  • Смежно-изолированная
entrance Вход enum Нет Возможные значения
  • Из коридора
  • Из прихожей
  • Из комнаты
floor_covering Покрытие пола enum Нет Возможные значения
  • Керамическая плитка
  • Паркет
  • Паркетная доска
  • Линолеум
  • Ламинат
comment Примечание string Нет
radio Наличие радио bool Нет true или false
number_of_tv Количество ТВ антенн int Нет
gis_id Идентификатор ГИС ЖКХ string Нет Текстовые данные
Описание значений массива accruals
Поле Название поля Тип Обязательное Описание
period Период начисления Дата Да За какой период произведено начисление
calculation_date Время начисления ДатаВремя Да Когда было произведено начисление
result Результаты начислений array Да Массив с объектами, хранящими начисления по услугам
Описание объекта массива result
Поле Название поля Тип Обязательное Описание
id_1c ID услуги в программе 1С string Нет
title Название услуги string Да
rate Тариф decimal(10,2) Да
volume Объем (расход) decimal(15,5) Да
accrued Сумма начислено decimal(10,2) Да
privileges Сумма льготы decimal(10,2) Да
recalc Сумма перерасчета decimal(10,2) Да
total Итого начислено по услуге decimal(10,2) Да
Описание объекта массива payments
Поле Название поля Тип Обязательное Описание
date Дата платежа Дата Да
sum Сумма платежа decimal(10,2) Да
period Период платежа Период Да Платеж, за который совершен платеж
penalties_included Включая пени decimal(10,2) Нет Какая сумма из платежа должна закрыть пени
comment Примечание string Нет

Описание объекта показаний счетчика

Поле Название поля Тип Обязательное Описание
date Дата внесения показаний Дата Да См. тип Дата
period Период показаний Период Да См. тип Период
values Показания Показания счетчика Да См. тип Показания счетчика

Пользовательские типы

Тип Описание
Дата Дата я вляется строкой string в формате ГГГГ-ММ-ДД.
Например: "2017-04-12"
ДатаВремя ДатаВремя я вляется строкой string в формате ГГГГ-ММ-ДД ЧАС:МИН:СЕК.
Например: "2017-04-23 08:04:09"
Период Период я вляется строкой string в формате ГГГГ-ММ-01, -01 в конце.
Например: "2017-04-01"
Показания счетчика Показания счетчика описываются объектом где:
  • Ключ - ставка, по которой подано показание;
  • Значение - показание, decimal(10,3) "максимум 10 знаков, из низ 3 после запятой".
Возможные значения ключей:
  • "B" - базовая ставка (для всех однотарифных счетчиков)
  • "T1" и "T2" - ставки для электроэнергии двухтарифной
  • "T1", "T2" и "T3" - ставки для электроэнергии трехтарифной

About

Описание формата фала для импорта данных из сторонних систем

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published