Supplier invoices
Validate a supplier invoice
Approves a draft received invoice: checks the required fields, assigns it an internal number from the series and locks it as immutable.
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
This tool cannot be undone.
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.
Server annotation
It validates a document that is then locked. Today the validation does not send the document to the tax agency, but it cannot be undone.
Only from draft; from any other status it rejects the request without touching anything. It requires supplier, invoice file, date, at least one line and a total amount greater than zero; if any is missing it responds 409 conflict listing what a validatable invoice needs (it does not name the missing one: complete the invoice in the app). There is no tax compliance: the invoice is received, not issued. It takes no body. 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
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}/validate.
Related pages
Link to this section: Related pagesSupplier invoices
Validate a supplier invoice
Approves a draft received invoice: checks the required fields, assigns it an internal number from the series and locks it as immutable.
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?