Supplier invoices
Void a supplier invoice
Voids an already VALIDATED received invoice with a reason, which is required and is kept.
supplier-invoices:writesupplier-invoices:write- 120/min
- May need an add-on
- Server annotation: Destructive
- Requires human confirmation
- Not reversible
Result
generated from the schema
Not reversible
Voiding takes the document to voided, and no operation undoes it.
Requires human confirmation
Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone. The server flags this tool with _meta["anthropic, which clients that honor it use to ask a person before every call.
It keeps its internal number —voiding does not release the numbering— and moves to voided. Only from validated: a draft is deleted from the application, not voided. It does not touch the treasury payment that may have paid it or the purchase order that originated it. It requires the purchases add-on (402 without it). Returns the full invoice, the same projection as its GET.
Arguments
Supplier invoice identifier.
Limits: min length 1
Reason for voiding. It is stored on the invoice and in its history.
Limits: min length 1, max length 500
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Supplier invoice identifier.
Number the supplier put on the invoice; null if it was not recorded.
Status of the invoice within the purchasing cycle.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs POST /api/v1/supplier-invoices/{supplierInvoiceId}/void.
Related pages
Link to this section: Related pagesSupplier invoices
Void a supplier invoice
Voids an already VALIDATED received invoice with a reason, which is required and is kept.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?