Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 2.88 KB

Bill.md

File metadata and controls

27 lines (24 loc) · 2.88 KB

Bill

Properties

Name Type Description Notes
billType string 'Type classification of the bill' '"REGULAR" -> Regular Bill' '"OVERDUE" -> Late bill that is overdue'
penaltyAmount double Late payment penalty amount in local currency.
payOrder float Payment order. The bill with the lowest number has to be paid first, starting with 1. If no payment order is enforced, all bills have the order 0.
payItemId string Unique Payment Item ID for payment item identification
payItemDescr string Contains optional description about payment details (e.g. merchant provided bill types) [optional]
serviceNumber string service number with merchant (e.g. meter number in bills from a utility provider or a phone number for a mobile operator)
serviceid int Unique Service Identifier
merchant string Unique merchant code
amountType string 'Supported amount type for the payment of this bill:' '&quot;FIXED&quot; -> Bill needs to be paid in full, (Payment amount = bill amount provided in &quot;amountLocalCur&quot;)' '&quot;PARTIAL&quot; -> Partial bill amount can be paid. (Payment amount < bill amount provided in &quot;amountLocalCur&quot;))' '&quot;OVERPAY&quot; -> More than the actual bill amount owed can be paid. (Payment amount > bill amount provided in &quot;amountLocalCur&quot;). Overpayments are subject to country specific regulations and may be limited to a certain threshold. ' '&quot;CUSTOM&quot; -> Amount can be freely entered, independent of bill amount provided in &quot;amountLocalCur&quot;'
localCur string Local currency of service.(eg: XAF) (Format: ISO 4217)
amountLocalCur float Open bill amount in local currency – (only searchable bills). [optional]
billNumber string Unique bill number in selected merchant service [optional]
customerNumber string Customer number with merchant [optional]
billMonth string Month of bill generation. Format: MM e.g. &quot;03&quot; for March [optional]
billYear string Year of bill generation. Format: YYYY e.g. &quot;2016&quot; [optional]
billDate \DateTime Exact date of bill generation (Format: ISO 8601) [optional]
billDueDate \DateTime Bill due date (Format: ISO 8601) [optional]
optStrg string Optional string field [optional]
optNmb float Optional number field [optional]

[Back to Model list] [Back to API list] [Back to README]