Get Bill Period
get
/apis/billforecast-v2/{utility}/accounts/{id}/bill-period
Retrieves an account bill period, which is provided from a report database or calculated as the median of historical bill periods.
Request
Path Parameters
-
id(required):
The unique Opower identifier of the Account for which to run the bill period dates
-
utility(required):
A 3- or 4-character representation of the client code. Valid example - "util"
Query Parameters
-
asOf:
Date in ISO-8601 format `YYYY-MM-DD` (example 2020-01-11) or `YYYY-MM-DDThh:mm:ssTZD` (example 2020-01-11T23:59:59-05:00) or `YYYY-MM-DDThh:mm:ss.sTZD` (example 2020-01-11T23:59:59.999+03:00) as of beginning of which the calculation should be run. All the usages which are recorded in our systems but are earlier than this date are ignored when forecasting. TZD can be empty (meaning UTC timezone) or specify a timezone explicitly (e.g. -03:00). Use -00:00 for UTC as Z is not currently supported. + is a reserved character in URIs, use its encoding %2B. Default value of the parameter is "now"
Header Parameters
-
Authorization(required):
Oauth2 bearer token. E.g. 'Bearer 92c6465e-2276-429d-952f-bb3e22c8990c'
Response
200 Response
Successful response. This does not guarantee a bill period is retrieved. For example, billing periods are not provided for accounts if the account or account history data cannot be found.
400 Response
Invalid request
401 Response
Unauthorized
403 Response
Forbidden
404 Response
Not found
500 Response
Internal error
503 Response
Service Unavailable