Сервисы по работе с договорами

Данные сервисы позволяют получать определённую информацию по договору

getContractInfo - получение информации по договору

Принимает параметры:

1. contractId - Идентификатор договора - тип number

Возвращаемый payload

Имя поля	Тип данных	Описание
clientId	number	Идентификатор клиента
clientShortName	string	Короткое имя клиента
contractNumber	string	Номер договора
openDate	Date	Дата вступления договора в силу
closeDate	Date	Дата окончания договора
amountAvailable	number	Текущий баланс договора
totalBalance	number	Суммарный баланс по картам договора
volumePrev	number	Расход литров за предыдущий месяц
volume	number	Расход литров за текущий месяц
creditLimit	number	Кредитный лимит
statusId	number	Код статуса договора
status	string	Статус договора
discountStatusCode	string	Код договора по потреблению
discountStatus	string	Значение для отображения статуса договора по потреблению
addInfo01Code	string	Код схемы оплаты
addInfo01	string	Схема оплаты
addInfo02Code	string	Код региона заключения договора
addInfo02	string	Регион заключения договора
addInfo03Code	string	Код схемы определения статуса по объёму потребления
addInfo03	string	Схема определения статуса по объёму потребления
addInfo04Code	string	Дополнительная информация. Возвращаемые данные зависят от типа договора. Возвращаемое значение не подвергается дополнительной обработке.
addInfo04	string	Дополнительная информация. Возвращаемые данные зависят от типа договора. Возвращаемое значение не подвергается дополнительной обработке.

Пример:

const { getContractInfoPayload: info } = await LicardAPI.getContractInfo(111111);

if (info.amountAvailable < 20000) sendNotify();

getContractBalance - получение баланса по договору/карте

Принимает параметры

1. contractId - Идентификатор договора/карты - тип number.

Возвращаемый payload - массив объектов:

Имя поля	Тип данных	Описание
balanceTypeCode	string	Код типа баланса Возможные значения: VOLUME, VOLUME_PREV, AVAILABLE
balanceValue	number	Значение баланса
balanceCurr	string	Код валюты баланса

getContractIdByNumber - получение идентификатора договора/карты по номеру

Принимаемые параметры:

1. Номер договора/карты

Возвращаемый payload

Имя поля	Тип данных	Описание
contractId	number	Идентификатор договора/карты