Create a purchase request
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Body Parameters
Required.
Free text.
Required. UUID, name or GL account.
Required. UUID, name or supplier number.
UUID, name or cost center.
Required. UUID or email of an active member of the company. The request is filed for this person.
ISO 4217 code. Default: the company currency.
Company address UUID for delivery.
Company address UUID for invoicing.
Flat header discount in the header currency.
Request-level custom fields. null reads as none.
Show child attributes
Show child attributes
Response
The created 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
Validation failed. Every problem is listed; attr names the field.
Response Attributes
validationErrorclientErrorserverError 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
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError