Purchase orders
Receive material from a purchase order
Declares what arrived and in what quantity, line by line.
purchase-orders:writepurchase-orders:write- 120/min
- May need an add-on
- Server annotation: Destructive
- Requires human confirmation
- Send your own idempotencyKey
Result
generated from the schema
Send your own idempotencyKey
A retry without the same key duplicates the effect. Send your own idempotencyKey (a UUID) and resend the same one if you retry.
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.
newStockReceived registers NEW inventory, so always send the Idempotency-Key header: without it, a retry duplicates the stock. The order may end up partially received. The line identifier is lineId. Returns the full purchase order, the same projection as its GET. meta. says how many lines the call declared as received. A draft or cancelled order responds 409 conflict.
Arguments
Purchase order identifier.
Limits: min length 1
Warehouse where the material comes in. Defaults to the warehouse of the account.
Received lines. At least one.
Limits: min 1 items
Show child attributesHide child attributes
Purchase order line being received.
Limits: min length 1
Units received for that line.
Limits: min 0
Of those received, how many register new inventory.
Limits: min 0
Reception notes.
Limits: max length 1000
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
Unique purchase order identifier.
Purchase order number; null while it is a draft.
Purchase order status.
Available options: draft, pending, completed, cancelled
Purchase order type.
Available options: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment
true if the purchase order is still a draft.
Purchase order date in ISO 8601 UTC; null if not set.
Supplier identifier; null while a draft has no supplier. Resolve it against /api.
Free-form reference of the purchase order; null if it has none.
Currency of the purchase order, as an ISO 4217 code.
Subtotal before discounts and taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Discount total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Tax total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Taxable base, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Total including taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Amount already paid, as a decimal string "1234.50"; null if no payment has been recorded.
Limits: pattern ^-?\d+\.\d{2}$
Associated rental order; null if it has none.
Number of that order; null if it has none.
Associated project; null if it has none.
Repair ticket that originated the purchase; null if it does not come from one.
Purchase order notes; null if it has none.
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/purchase-orders/{purchaseOrderId}/receive.
Related pages
Link to this section: Related pagesPurchase orders
Receive material from a purchase order
Declares what arrived and in what quantity, line by line.
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?