NOTE: We're in the process of rolling out the accounting API to all of the utilities we support. Accounting information is currently only available for ConEd, PCE, PG&E, PSE&G, SoCal Gas, SRP, Eversource, and SVCE.
Get a list of Billing Accounts, reverse ordered by created date. Use parameters to filter the list.
GET https://utilityapi.com/api/v2/accounting/billing-accounts
# 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'
Parameter | Format | Description | Example |
---|---|---|---|
uids |
List(UID String) |
Filter by Billing Account uids.
Separate with commas (, ).
|
uids=123,456 |
authorizations |
List(UID String) |
Filter by Authorization uids.
Separate with commas (, ).
|
authorizations=888,999 |
meters |
List(UID String) |
Filter by Meter uids.
Separate with commas (, ).
|
meters=112,334,556 |
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, }
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.
Parameter | Format | Description | Example |
---|---|---|---|
billing_accounts |
List(Billing Account) | List of Billing Account results. | [{"uid": ...}, ...] |
next |
URL or
null
|
If there are more results than the page limit, this is a link to the next set of results. | "https://utilityapi.com/api/v2/accounting/billing-accounts?after=234" |
// Example BillingAccountListing { "billing_accounts": [...], "next": null, }
Code | Response Format | Description |
---|---|---|
200 |
BillingAccountListing | Successful request. |
400 |
Error |
The query parameters included are malformed. Check the error
in the response for the type of error:
|
401 |
Error |
Invalid or missing access_token . See our docs on
Authentication for
how to properly use your access_token .
|
429 |
N/A |
The request was rate limited.
Check the Retry-After response header for how long to wait
until retrying the request. Do not expect any specific response format for
this error (could be html, json, or nothing).
|
500 |
N/A | Internal server error. Do not expect any specific response format for this error (could be html, json, or nothing). This error is logged and will be fixed by our engineers. |
503 |
N/A | Site is currently down for maintenance. Do not expect any specific response format for this error (could be html, json, or nothing). |
504 |
N/A | We tried to build this request but timed out. Please try again later. Do not expect any specific response format for this error (could be html, json, or nothing). |