1. Documentation
2. API
3. Billing Summaries
4. List

Listing Billing Summaries

Get a list of Billing Summaries, reverse ordered by created date. Use parameters to filter the list.

HTTP Request

GET https://utilityapi.com/api/v2/accounting/billing-summaries

Examples

# Get a list of all Billing Summaries
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-summaries'

# Get some specific Billing Summaries 123 and 456
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-summaries?uids=123,456'

# Get the Billing Summaries for a specific Authorization
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-summaries?authorizations=1234'

# Get the Billing Summaries for a specific Billing Account
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-summaries?billing_accounts=5678'

# Get the Billing Summaries for a specific Meter
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-summaries?meters=122344'

Query Parameters

Response

Returns a BillingSummaryListing object containing a list of Billing Summary 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
{
    "billing_summaries": [
        {"uid": "12837438", "authorization_uid": ...},
        {"uid": "12837439", "authorization_uid": ...},
        ...
    ],
    "next": null,
}

BillingSummaryListing

This is the object that contains the Billing Summary 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 BillingSummaryListing
{
    "billing_summaries": [...],
    "next": null,
}

HTTP Response Codes