Retrieves the bill audit workflow settings for the organization
Use this endpoint to check whether historical bills (60 or more days old at upload) are audited.
It requires only bill and batch view access, so screens that process bills can read it without access to the workflow settings page.
To read all workflow sections at once, use GET /api/v3/workflow. To change the setting, use PUT /api/v202410/workflow
(only EnergyCAP staff can change it).
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
AuditWorkflowSettings
| Property | Description | Type |
|---|---|---|
| auditHistoricalBills | When true, bills that are 60 or more days old at upload are audited like any other bill. When false, they are not audited. Only EnergyCAP staff can change this setting. When null in a request, the current value is kept. | boolean |
Example Response
{ "auditHistoricalBills": false
}