Fetch purchase order detail
GET/v1/entities/:entity_id/purchase_orders/:uuid
Retrieves one purchase order by uuid, in any status. The purchase order has the same
shape as in the list endpoint.
Requires the purchase_orders:read scope.
Accepts the same fields[...] and include=line_items,receipts,supplier parameters.
include=receipts additionally requires the purchase_order_receipts:read scope; without it
the request returns 403. Included receipts are narrowed to committed status only.
The purchase order is wrapped in a purchase_order key. The create, update and cancel
endpoints return it unwrapped, with extra fields such as the is_* flags.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 504
Returns a purchase order.
Unsupported or malformed fields or include param.
The Authorization header is missing, is not HTTP Basic, or does not carry a valid API key. Create and manage keys under Settings → API keys in the Bookkeep section of the Bookkeep app.
The key does not hold purchase_orders:read (or purchase_order_receipts:read when include=receipts is sent), or the key's store is not linked to {entity_id}.
No purchase order with that uuid for the key's store, or it has been deleted.
Rate limit reached. The inventory endpoints share one limit of 60 requests per minute per source IP address, counted across Purchase Orders, Suppliers, Receipts and Bills. The count resets at the start of each minute. No Retry-After header is sent. The body is JSON only when the request sends Accept: application/json; otherwise it is an HTML page.
The service did not respond in time. This is a read, so it is safe to retry after a short wait.