new module:models/ManagePBTRequest(customer, contact, customer_account, funding_account, payment_amount_type, days_before_due)
This class subject to change without prior notice, Please dont use this class directly.
Constructs a newManagePBTRequest
.
Parameters:
Name | Type | Description |
---|---|---|
customer |
module:models/CustomerMinimalRequest | |
contact |
module:models/PbtContact | |
customer_account |
module:models/CustomerAccountMinimalRequest | |
funding_account |
module:models/PBTFundingAccountMinimalRequest | |
payment_amount_type |
module:models/ManagePBTRequest.PaymentAmountTypeEnum | The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. |
days_before_due |
String | The number of days before the payment due date on which the payment alert is to be sent to the enrolled customer to the contact phone provided here. |
Members
-
static, readonly EnrollmentStatusEnum :String
-
Allowed values for the
enrollment_status
property.Properties:
Name Type Description enrolled
String value: "enrolled"
unenrolled
String value: "unenrolled"
-
static, readonly PaymentAmountTypeEnum :String
-
Allowed values for the
payment_amount_type
property.Properties:
Name Type Description current_balance
String value: "current_balance"
minimum_payment_due
String value: "minimum_payment_due"
past_payment_due
String value: "past_payment_due"
statement_balance
String value: "statement_balance"
-
inner contact :module:models/PbtContact
-
-
inner customer :module:models/CustomerMinimalRequest
-
-
inner customer_account :module:models/CustomerAccountMinimalRequest
-
-
inner days_before_due :String
-
The number of days before the payment due date on which the payment alert is to be sent to the enrolled customer to the contact phone provided here.
-
inner enrollment_status :module:models/ManagePBTRequest.EnrollmentStatusEnum
-
The status of the payment enrolment. Use “unenrolled” to cancel the existing enrolment.
-
inner funding_account :module:models/PBTFundingAccountMinimalRequest
-
-
inner payment_amount_type :module:models/ManagePBTRequest.PaymentAmountTypeEnum
-
The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
Methods
-
static constructFromObject(data, obj) → {module:models/ManagePBTRequest}
-
Constructs a
ManagePBTRequest
from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdata
toobj
if supplied or a new instance if not.Parameters:
Name Type Description data
Object The plain JavaScript object bearing properties of interest.
obj
module:models/ManagePBTRequest Optional instance to populate.