PUT /api/v3/bill/accrualExclusion

Excludes or includes bills in accrual calculations

SetBillAccrualExclusionV3 Permissions: AccrualSettings (Manage)
Use this endpoint to mark bills as excluded from accrual processing, or to undo a previous exclusion. Excluded bills are not considered when generating accrual estimates.

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, including the request body.

Request Body

BillAccrualExclusionRequest
Property Description Type
billIds List of bill IDs to exclude from accruals or include again Required integer[]
exclude Whether or not the bill ids should be excluded from accruals, or included again Required boolean
Example Request Body application/json 
{  "billIds": [
    1
  ],  "exclude": false
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

UpdateResult
Property Description Type
selected The total number of items that were targeted by the bulk operation Required (defined) integer (int32)
updated The number of items that were actually modified (excludes items that already matched the target state) Required (defined) integer (int32)
Example Response application/json 
{  "selected": 1,  "updated": 1
}