PUT /api/v3/bill/approve

Sets or clears the approved flag on one or more bills

BillActionApproveV3 Permissions: ApproveBills (Manage)
Use this endpoint to approve or unapprove bills in bulk. Approved bills can proceed to export. Requires the ApproveBills.Manage permission.

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

BillActionApprove
Property Description Type
approve When true, approves the specified bills. When false, removes approval (unapproves). Required (defined) boolean
ids List of bill IDs to approve or unapprove. Must contain at least one ID. Cannot be Empty Required (defined) integer[]
Example Request Body application/json
{  "approve": false,  "ids": [
    1
  ]
}

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
}