Skip to navigation

Void Invoice

View as Markdown

Voids a posted invoice. reason is optional unless workspace configuration requires it.

Requires the can_void_sales_invoice permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Path parameters

idstringRequired
Invoice ID.

Request

This endpoint expects an object.
reasonstringOptional

Response

OK
statusboolean
messagestring

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error