Hivebuy External API (v2)

Sections

Theme switcher

Update a legal entity

Header Parameters

Authorizationstring

Path Parameters

companyIdstring Required

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

idstring Required

Row id. A row belonging to another company is 404 on every verb, never 403.

Body Parameters

namestring
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

Updated. The body is the read shape.

Response Attributes

idstring
namestring Required
identifierstring | null

Short code for the entity. Sortable via ?ordering=identifier.

descriptionstring | null
vatNumberstring | null
accountingAreastring | null

Accounting area. The d.velop integration reads this as its company_id, so changing it affects that export.

invoiceEmailstring | null

Where invoices for this entity are sent.

departmentsarray

Show child attributes

approversarray

Show child attributes

buyersarray

Show child attributes

categoriesarray

Show child attributes

paymentMethodstring | null

Default payment method.

legalEntityDeliveryAddressesarray

Linked delivery addresses, nested in full.

Show child attributes

legalEntityInvoiceAddressesarray

Linked invoice addresses, nested in full.

Show child attributes

legalEntityPaymentMethodsarray

Linked payment methods, nested in full.

Show child attributes

createdAtstring

When the row was created.

readOnly
updatedAtstring

When the row itself last changed.

readOnly
deletedstring | null

null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.

readOnly
400
Object

Validation failed.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

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

404
Object

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

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

PATCH

/

Select
1

Response