Void an invoice by issuing a credit note

post

https://api.wafeq.com/ae/v1/invoices/{invoice_id}/void

Void a previously-sent invoice by issuing a full credit note (UBL 381)
that references it.

The credit note is reconstructed server-side from the stored original
request — the caller does not resend line items or party details. The result
is a normal credit note: sent over Peppol and reported to the FTA, and linked
back to the original (which then reads as credited_by the new note).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoice_id

string

required

Body Params

Optional body for voiding an invoice.

reason

string | null

Free-text reason for the void (added to the credit note notes)

credit_note_reason_code

string | null

Credit note reason code override (BTAE-03). Defaults to DL8.61.1.A.

Headers

authorization

string | null

x-ae-taxpayer-id

string

required

Taxpayer ID (txpay_…). Required with an organization API key (pk_…) for this taxpayer-specific operation, even for one taxpayer. Not a TIN. Optional with a taxpayer access token, which already names its taxpayer.

x-ae-grant-id

string | null

Grant ID (tgr_…) to act through, with an organization API key. The request then has exactly that grant's scopes and fails once the grant is revoked. Without it, the key acts through all of the organization's active grants on the taxpayer.

Responses

200Successful Response

422Validation Error