Описание методов интеграции API с голосовым роботом

Тестовый стенд: http://tkerc.com:5051

PersonalAccount		Тип	Описание	Пример
GET	/api/PersonalAccount/GetPersonalAccountInfo Получение информации по лицевому счету
Входные параметры	street	string	Улица	“Баруди”
	numHouse	string		20а
	numApartment	string		6
	numRoom	string
	surname	string
	shortNum	string		6391
Выходные параметры	personalAccount	string	Номер лицевого счёта	"5356776391"
	dateOpen	date	Дата открытия	"2015-04-01T00:00:00"
	square	float	Общая площадь	34,5
	countRoom	integer	Количество комнат	0

Charge		Тип	Описание	Пример
GET	/api/Charge/ChargesPerMonth/{publicPersonalAccount} Получение начислений за месяц и год
Входные параметры	publicPersonalAccount	string	Номер лицевого счёта	“5356776391”
	month	Integer	Месяц начисления	12
	year		Год начисления	2021
Выходные параметры	sum	currency	Входящее сальдо	3573.07
	sumMonth	currency	Начислено за месяц	3573.07
	sumBalance	currency	Начислено к оплате	5529.33
	date	Date	Расчётный месяц	"2022-08-01T00:00:00"
GET	/api/Charge/ChargesPerMonth/{publicPersonalAccount} Получение расшифровки начислений по услугам за предыдущий месяц
Входные параметры	publicPersonalAccount	string	Номер лицевого счёта	“5356776391”
	serviceName	String	Наименование услуги	Уборка подъезда
	serviceNumber	integer	Номер по порядку в счёте на оплату	7
Выходные параметры	charges	currency	Начислено к оплате по услуге	84,53
	description	String	Расшифровка	К оплате 84.53 рублей, в том числе 84.53 рублей за текущий месяц,84.53 рублей долг за прошлый период. Начислено 84.53 по следующим данным : тариф 2.4500 рублей * расход 34.50

Counters		Тип	Описание	Пример
GET	/api/Counter/GetCounters/{publicPersonalAccount} Получение списка приборов учета
Входные параметры	publicPersonalAccount	string	Номер лицевого счёта	“5356776391”
Выходные параметры	itemNumber	Integer	Номер по порядку в счёте на оплату	1
	serviceName	string	Наименование услуги	Горячая вода
	number	string	Заводской номер	"К-73813-ПВ"
	value	float	Последнее показание	381,0000
	dateUchet	Date	На какую дату последнее показание	"2022-09-01T00:00:00"
	verificationDateNext	Date	Дата следующей поверки	null
POST	/api/Counter/SaveValue /api/Counter/SaveValue
Входные параметры	publicPersonalAccount	string	Номер лицевого счёта	“5356776391”
	counterNumber	currency	Номер счётчика в счете на оплату	1
	counterValue	float	показание	382,0000

Payment		Тип	Описание	Пример
GET	/api/Payment/GetPayment/{publicPersonalAccount} Получение списка оплат
Входные параметры	publicPersonalAccount	string	Номер лицевого счёта	“5356776391”
Выходные параметры	itemNumber	Integer	Номер по порядку
	sum	string	Сумма оплаты	5539,66
	date	date	Дата оплаты	"2022-08-08T00:00:00",
	source	float	Откуда поступила оплата	"ПАО АК БАРС БАНК"

Пример счёта на оплату

Быстрые ссылки

Дерево страниц

PersonalAccount

Charge

Counters

Payment