Get Bill Forecast
get
/apis/billforecast-v2/{utilityCode}/customers/{id}/bill_forecast
Retrieve a customer's bill forecast. Returns forecasted usage and costs for all accounts of a customer with interval data. Forecasting a billing period is based on the calculation date which is the current date (now) by default. When a Utility Account has no modeled rates only a usage forecast is returned.
Request
Path Parameters
-
id(required):
The unique Opower identifier of the Customer for which to run the bill forecast calculation
-
utilityCode(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 2001-12-31) or `YYYY-MM-DDThh:mm:ssTZD` (example 2001-12-31T23:59:59-05:00) or `YYYY-MM-DDThh:mm:ss.sTZD` (example 2001-12-31T23: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. A forecast is not guaranteed for all customer accounts. For example, a customer may have electric smart meter and gas analog meter. Interval data is required to generate a bill forecast.
400 Response
Invalid request
401 Response
Unauthorized
403 Response
Forbidden
404 Response
Customer not found
412 Response
Packaged IntenalServerError from moosage with provided message
500 Response
Internal error
503 Response
Service Unavailable