Skip to main content
GET
/
property
/
query_bill_information
/
{property_id}
Query Bill Information
curl --request GET \
  --url https://app.leafpress.io/property/query_bill_information/{property_id} \
  --header 'Authorization: Basic <encoded-value>'

Documentation Index

Fetch the complete documentation index at: https://docs.leafpress.io/llms.txt

Use this file to discover all available pages before exploring further.

Query bill information from specified property.

​
Request Params

​
property_id
string
Specified property ID where data will enter

​
Request Body

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

​
Response

​
data
array<object>
Usage and/or charge data associated with property id
​
created
string
Timestamp indicating when record was created
​
address
string
Address
​
type
string
Specifies the type of data source, one of “ELECTRICITY”, “GAS”, “WATER”, “FUEL”, “DISTRICTHEATING”, “WASTE”
​
start_date
string
Start date for the usage or charge period
​
end_date
string
End date for the usage or charge period
​
charges
string
Total monetary charges incurred on the invoice (as string to preserve precision)
​
currency
string
Currency code for charges
​
usage
string
Usage amount extracted from billing data
​
usage_unit
string
Unit for usage amount
​
estimated
boolean
Indicates if the data has been estimated
​
account_number
string
Account number associated with usage
​
meter_id
string
Meter ID associated with usage
​
meter_description
string
Meter description associated with usage
​
bill_file_name
string
Name of the associated bill file
​
folder_name
string
Name of the folder containing the bill
​
provider
string
Utility provider name
​
total_due
string
Total amount due on the bill
​
custom_fields
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
​
electricity_fields
object
Additional fields for electricity data
​
network_peak_usage_kwh
string
Peak usage associated with the network in kWh
​
network_offpeak_usage_kwh
string
Off-peak usage associated with the network in kWh
​
peak_demand
string
Peak demand of electricity meter
​
peak_demand_units
string
Units of peak demand
​
waste_fields
object
Additional fields for waste data
​
waste_type
string
Type of waste associated from predefined choices
​
num_bins
string
Number of bins associated with usage
​
bin_size
string
Size of bins associated with usage
​
bin_size_units
string
Units for the bin sizes associated with usage