Hivebuy External API (v2)

Sections

Theme switcher

Update a project

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
descriptionstring | null
projectNumberstring | null

Your own project number. Sortable via ?ordering=projectNumber.

externalIdstring | null

Reference in your system. Not interpreted by Hivebuy.

costCenterstring | null
statusstring

A active, C closed.

Enum values:
AC
activeboolean
parentstring | null

Parent project. Must belong to this company.

legalEntitystring | null

Must belong to this company.

deliveryAddressstring | null

Company address id. Must belong to this company and must not be deleted.

invoiceAddressstring | null

Company address id. Must belong to this company and must not be deleted.

projectApprovalFlowTypestring

Who approves for the project: SIMPLE project owner, MEDIUM owner and budget owner, EXTENDED owner, budget owner and the department heads involved, or USE_PURCHASE_REQUEST_WORKFLOWS to fall back to the normal request workflows.

Enum values:
USE_PURCHASE_REQUEST_WORKFLOWSSIMPLEMEDIUMEXTENDED
totalProjectBudgetstring | null

Total budget as a decimal string.

membersarray

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

Show child attributes

approversarray

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

Show child attributes

budgetOwnersarray

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

Show child attributes

budgetallof

Budget figures you may set on a project write. Every key is optional. amount is the total; sending it is the same as sending totalProjectBudget. usedBudget, pendingBudget and remainingBudget are normally computed by Hivebuy from purchase requests and invoices. Sending any of them overrides the computed value and skips Hivebuy's own recalculation for this write, so a system of record for consumption (an ERP) can push its figures. The override holds until the next purchase requ...

Show child attributes

Response

200
Object

Updated. The body is the read shape.

Response Attributes

idstring
namestring Required
descriptionstring | null
projectNumberstring | null
externalIdstring | null
costCenterstring | null
statusstring

A active, C closed.

Enum values:
AC
activeboolean
parentstring | null
legalEntitystring | null
membersarray

Show child attributes

approversarray

Show child attributes

budgetOwnersarray

Show child attributes

participatingDepartmentsarray

Read-only. Maintained through the departments themselves, not here.

Show child attributes

deliveryAddressstring | null
invoiceAddressstring | null
projectDeliveryAddressesarray

Read-only. The full delivery addresses linked to the project.

Show child attributes

projectApprovalFlowTypestring
Enum values:
USE_PURCHASE_REQUEST_WORKFLOWSSIMPLEMEDIUMEXTENDED
totalProjectBudgetstring | null

Decimal string, e.g. "1250.00".

totalProjectBudgetCurrencystring

ISO 4217 code, inherited from the company.

readOnly
budgetobject

Server-maintained budget figures. Read-only: budgets are not managed through this API.

readOnly

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