Void Invoice

This endpoint voids an invoice

POST /v1/invoice/void

cURL

curl --location --request POST 'https://api.stateset.com/v1/invoice/void' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "id": ""
}'

Response

{
  "success": 1
}

Legacy contract: confirm deployment before use. This page does not establish a provisioned public service. Check the dated host report and obtain a supported host and API version. New integrations should begin with the API directory or local commerce walkthrough.

Body

id · string

This is the ID of the invoice to be voided.

Response

success · number

Indicates whether the call was successful. 1 if successful, 0 if not.

This endpoint returns an acknowledgement rather than the affected resource. success is 1 when the write was applied and 0 when it was not — read the resource back if you need its new state.

Errors

Succeeds with 201. Failures return 400, 401, 403, 422 or 429 with an error body, per the platform status-code contract.

cURL

curl --location --request POST 'https://api.stateset.com/v1/invoice/void' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "id": ""
}'

Response

{
  "success": 1
}