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

Listing Billing Accounts

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

HTTP Request

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

Examples

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

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

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

# Get the Billing Accounts for meters 98765 and 43210
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/accounting/billing-accounts?meters=98765,43210'

Query Parameters

Response

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

BillingAccountListing

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

HTTP Response Codes