Retrieve a purchase request
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Response
The request.
Response Attributes
Request UUID. Use it for retrieve.
Hivebuy request number, digits only. The UI shows it with the company prefix.
The linked purchase order's external (ERP) order number. null until the request becomes an order.
The linked purchase order's client external id. null until the request becomes an order.
Title.
Free text, empty string when none.
Status code.
DPARCCRWhen the request was filed.
ISO 4217 code.
Sum of the lines, net. Decimal string.
Sum of the lines, gross. Decimal string.
Flat header discount, null when none. Decimal string.
A person, as embedded in a purchase request.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError