Hivebuy External API (v2)

Sections

Theme switcher

Bulk upsert legal entities

Header Parameters

Authorizationstring

Path Parameters

companyIdstring Required

Company ID. Must be one of the IDs returned by GET /api/v2/companies/.

Body Parameters

idstring

Optional, for matching only: the legal entity's id. An id that matches nothing in this company falls through to the next lookup field, and a new record is created with a fresh id.

namestring Required
identifierstring | null
descriptionstring | null
vatNumberstring | null
accountingAreastring | null
invoiceEmailstring | null
departmentsarray

Department ids. Must belong to this company.

Show child attributes

approversarray

User ids. Each must be an active member of this company.

Show child attributes

buyersarray

User ids. Each must be an active member of this company.

Show child attributes

categoriesarray

Category ids. Must belong to this company.

Show child attributes

paymentMethodstring | null

Must belong to this company.

legalEntityDeliveryAddressesarray | null

Delivery-address links. null is accepted and means "no links".

Show child attributes

legalEntityInvoiceAddressesarray | null

Invoice-address links. null is accepted and means "no links".

Show child attributes

legalEntityPaymentMethodsarray

Payment-method links.

Show child attributes

Response

200
Object

Always 200, even when rows failed: per-row results in upserted and errors, in row order.

Response Attributes

upsertedarray Required

One entry per stored row, in row order: the row as you sent it, plus the record's id and the action taken.

Show child attributes

errorsarray Required

One entry per failed row. A failed row never fails the batch.

400
Object

The whole request was refused: the body is not a JSON array, or it has more than 50 rows. Plain {"error": …} body, this one predates the error envelope and existing clients parse it.

Response Attributes

errorstring
receivedinteger

Only on the over-limit refusal.

upsertLimitinteger

Only on the over-limit refusal.

401
Object

Missing, invalid, or expired API key, or a session credential was used instead of an API key.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

403
Object

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

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

429
Object

Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

POST

/

Select
1

Response