1. Documentation
2. API
3. Bills
4. List

Listing Bills

Get a list of Bills corresponding to at least one Meter or Authorization filter parameter. Unfortunately, getting a list of all bills for every Meter is usually too resource intensive, so we return an error if you try to request bills without an authorizations or meters query parameter.

HTTP Request

GET https://utilityapi.com/api/v2/bills

Examples

# Get a list of all a meter's bills
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/bills?meters=123'

# Get a year's worth of bills for all meters under an authorization
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/bills?authorizations=222&start=2015-01-01&end=2015-12-31'

# Get the latest bill for a meter
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/bills?meters=222&limit=1&order=latest_first'

Query Parameters

Use at least one Meter or Authorization filter parameter. Unfortunately, getting a list of all bills for every Meter is usually too resource intensive, so we return an error if you try to request bills without an authorizations or meters query parameter.

Response

Returns a BillListing object containing a list of Bill objects. If the number of results is over 1000, a next parameter will have the link to the next in the series of lists.

// Example result
{
    "bills": [
        {"uid": "12837438", "created": ...},
        {"uid": "12837438", "created": ...},
        ...
    ],
    "next": null,
}

BillListing

This is the object that contains the Bill results for the request. We don't just return a straight list of results so that we can paginate results if needed. Currently, the maximum results per request is set at 1000.

// Example BillListing
{
    "bills": [...],
    "next": null,
}

HTTP Response Codes