Skip to main content
GET
Query Bill Information
Query bill information from specified property.

Request Params

string
Specified property ID where data will enter

Request Body

Array of Strings
Required enum type of data queried, must be a sublist of [“ELECTRICITY”, “GAS”, “WATER”, “FUEL”, “DISTRICTHEATING”, “WASTE”, “CHARGES”]
String
Required YYYYMMDD string start_date for the usage (inclusive)
String
Required YYYYMMDD string end_date for the usage (inclusive)

Response

array<object>
Usage and/or charge data associated with property id
string
Timestamp indicating when record was created
string
Address
string
Specifies the type of data source, one of “ELECTRICITY”, “GAS”, “WATER”, “FUEL”, “DISTRICTHEATING”, “WASTE”
string
Start date for the usage or charge period
string
End date for the usage or charge period
string
Total monetary charges incurred on the invoice (as string to preserve precision)
string
Currency code for charges
string
Usage amount extracted from billing data
string
Unit for usage amount
boolean
Indicates if the data has been estimated
string
Account number associated with usage
string
Meter ID associated with usage
string
Meter description associated with usage
string
Name of the associated bill file
string
Name of the folder containing the bill
string
Utility provider name
string
Total amount due on the bill
object
Additional custom fields specific to each utility type. Examples include: - Commercial Electric - Commercial Service Charge - Demand Cost - Demand Usage
  • Electric Tax - Power Cost Adjustment And any other provider-specific fields
object
Additional fields for electricity data
string
Peak usage associated with the network in kWh
string
Off-peak usage associated with the network in kWh
string
Peak demand of electricity meter
string
Units of peak demand
object
Additional fields for waste data
string
Type of waste associated from predefined choices
string
Number of bins associated with usage
string
Size of bins associated with usage
string
Units for the bin sizes associated with usage