Utility Bill Capture for Payment is designed to extract the data necessary to pay a utility bill.
Data Structure
The data model has 3 levels:
- Credentials: the credentials used to connect and end user’s utility account(s).
- Accounts: accounts within the end-user’s utility credential. A single request can have many accounts.
- Statement: the end-user’s historical usage and spend.
Statements
| Billing Address | Unique fields for the Name, Street, City, State, Zip and full address of the account. This is the location where invoices are mailed. Often the same as Service Address. | Jane Smith 123 Main St. Houston, TX 77001 |
| Service Address | The Name, Street, City, State, Zip and full address of the account. This is the location where utility service is delivered. Note: Service address is available far less often than Billing Address. | Jane Smith 123 Main St. Houston, TX 77001 |
| Payment Address | The Name, Street, City, State, Zip and full address of the account. This is the location where the utility service receives payment. | Energy Co 123 Main St. Houston, TX 77001 |
| Currency | The currency listed by the utility provider. | USD, EUR, GBP |
| Total Bill | The total account balance at the end of the billing period. | 100.00 |
| Outstanding Ballance | The difference between the last statement and payment. This field is not always available. | 100.00 |
| Previous Charges | The sum of charges accrued during the previous pay period. This field is not always available | 100.00 |
| Current Charges | The sum of charges related to a statement’s billing period. This is sometimes different than “amount due”. This field is not always available | 100.00 |
| Statement Interval Start | The start date of the billing period | 2018-10-01 |
| Statement Interval End | The end date of the billing period | 2018-11-05 |
| Statement Date | Date of the publication of the statement. If no statement date is listed, the final day of the service period is used. | 2018-11-05 |
| Due Date | Date that payment of the account balance becomes due. | 2018-11-18 |
| Statement Source | The original PDF data source. | – |
