Skip to content
ZUTAX ZUTAX Documentation

Cancel invoice

POST
/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/invoices/{invoice_id}/cancel

Cancel an invoice while still pre-dispatch. Once dispatch has started, issue a credit note instead.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
invoice_id
required
Invoice Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Workspace-ID
Any of:
string
X-API-Key
Any of:
string
X-Tenant-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
InvoiceCancelRequest

Cancel invoice request.

object
reason
required
Reason
string
>= 1 characters <= 500 characters
Examples

Request payload example

{
  "reason": "string"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}