PUT /api/v3/bill/void

Sets or clears the void flag on one or more bills

BillActionVoidV3 Permissions: BillsAndBatches (Edit)
Use this endpoint to void or unvoid bills in bulk. Voided bills are excluded from exports, reports, and calculations. Voided bills cannot be edited.

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

BillActionVoid
Property Description Type
ids List of bill IDs to void or unvoid. Must contain at least one ID. Cannot be Empty Required (defined) integer[]
void When true, voids the specified bills. When false, unvoids (restores) them. Required (defined) boolean
Example Request Body application/json 
{  "ids": [
    1
  ],  "void": 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
}