getRecommendedPayment

Описание

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

При расчёте учитываются абонентские платы:

• тарифных планов;
• периодических услуг (как дополнительных, так и основных).

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

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

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

Необходимая авторизация

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

Входные параметры

Параметр	Тип	Обязательный	Описание	Доступно с версии
id	long		Идентификатор пользовательского договора из базы данных ядра LANBilling. Параметр agreements.agrm_id
mode	long		Параметр, отвечающий за метод расчета рекомендованного платежа. mode = 0. По умолчанию значение абонентской платы на текущий момент. mode = 1. Метод возвращает значение абонентской платы на текущий момент за вычетом баланса. mode = 2. Метод возвращает значение с учётом порогов разблокировки на договоре: Если УЗ на договоре находится не в финансовой блокировке, то для неё вернется значение «0». Если на договоре указана сумма для разблокировки, то вернётся максимальное значение, выбранное из указанной суммы на договоре и суммарной АП на договоре за вычетом баланса договора. Если на договоре указан порог разблокировки в днях и месяцах, то вернётся значение, необходимое для работы всех УЗ и услуг на договоре. mode = 3. Рекомендованный платёж считается следующим образом: возвращается сумма АП, порогов разблокировки по всем УЗ договора за вычетом баланса. Для каждой УЗ происходят вычисления: если УЗ находится в финансовой блокировке, то рекомендованная сумма обещанного платежа будет равна сумме списаний до конца месяца, при условии что УЗ выйдет из блокировки текущей датой вызова метода. Для УЗ в финансовой блокировке на предоплатном договоре, учитываются параметры порогов выхода из блокировки «agreements.block_amount», «agreements.block_days» и «agreements.block_months». Если полученное расчётное значение меньше, чем сумма порога разблокировки, то в качестве рекомендованной суммы по данной УЗ берётся сумма по порогу разблокировки. если УЗ не находится в финансовой блокировке, то в качестве рекомендованной суммы обещанного платежа по данной УЗ берётся сумма, исходящая из АП тарифа и услуг. В обоих случаях учитывается расписание смены тарифного плана услуг, запланированных блокировок и установленных скидок.
date	string		Дата, на которую вычисляется сумма платежа
considerinstallment	bool		Учитывать рассрочки
datefrom	string		Начальная дата периода для расчёта рекомендованного платежа	2.0.55
dateto	string		Конечная дата периода для расчёта рекомендованного платежа	2.0.55
datechangeblock	string		Дата смены блокировки	2.0.55

Возвращаемые параметры

Параметр	Тип	Обязательный	Описание
ret	double		Сумма рекомендуемого платежа

Определение типа

<!-- operation request element -->
<element name="getRecommendedPayment">
 <complexType>
  <sequence>
   <element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
   <element name="mode" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
   <element name="date" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
   <element name="considerinstallment" type="xsd:boolean" minOccurs="0" maxOccurs="1" default="false"/>
   <element name="datefrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
   <element name="dateto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
   <element name="datechangeblock" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
  </sequence>
 </complexType>
</element>

<!-- operation response element -->
<element name="getRecommendedPaymentResponse">
 <complexType>
  <sequence>
   <element name="ret" type="xsd:double" minOccurs="1" maxOccurs="1"/>
  </sequence>
 </complexType>
</element>