Update a project
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.
Body Parameters
Your own project number. Sortable via ?ordering=projectNumber.
Reference in your system. Not interpreted by Hivebuy.
A active, C closed.
ACParent project. Must belong to this company.
Must belong to this company.
Company address id. Must belong to this company and must not be deleted.
Company address id. Must belong to this company and must not be deleted.
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.
USE_PURCHASE_REQUEST_WORKFLOWSSIMPLEMEDIUMEXTENDEDTotal budget as a decimal string.
User ids. Each must be an active member of this company.
Show child attributes
User ids. Each must be an active member of this company.
Show child attributes
User ids. Each must be an active member of this company.
Show child attributes
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 (prefer totalProjectBudget). usedBudget is normally computed by Hivebuy from orders and invoices. When an API key sends usedBudget, the sender's system (typically the ERP) takes ownership of the used figure: Hivebuy stores the value as sent, stops recalculating it, sets useExternalBudget to true and stamps externalBudgetSyncedAt...
Total budget as a decimal string, e.g. "250000.00". Equivalent to totalProjectBudget.
ISO 4217 code. Omit it to use the company currency. Must match the currency of the stored budget and of every other money value in this object, otherwise the row fails with validation_error.
Spent. Computed by Hivebuy from orders and invoices, unless an API key sends it: then the sender owns the figure until releaseExternalBudget (see the schema description).
Accepted and ignored. Hivebuy always computes it from open purchase requests.
Accepted and ignored. Always derived as amount minus used minus pending.
Set to true to hand an ERP-owned usedBudget back to Hivebuy. Hivebuy recomputes used from its own orders and invoices and clears externalBudgetSyncedAt. Ignored when the budget is not ERP-owned. Any caller may send it.
Response
Updated. The body is the read shape.
Response Attributes
A active, C closed.
AC Show child attributes
Show child attributes
Show child attributes
Read-only. Maintained through the departments themselves, not here.
Show child attributes
Read-only. The full delivery addresses linked to the project.
Show child attributes
USE_PURCHASE_REQUEST_WORKFLOWSSIMPLEMEDIUMEXTENDEDDecimal string, e.g. "1250.00".
ISO 4217 code, inherited from the company.
The project's budget as stored. amount follows totalProjectBudget. pendingBudget is computed by Hivebuy from open purchase requests and remainingBudget is always amount minus used minus pending. usedBudget is computed by Hivebuy from orders and invoices, or, while useExternalBudget is true, the figure the ERP last pushed (see BudgetWrite). This is the read shape; the write shape is BudgetWrite.
The budget itself.
ISO 4217 code. The company currency unless a write set another one.
Spent. Hivebuy's figure from orders and invoices, or the ERP's figure while useExternalBudget is true.
Committed in open purchase requests, not yet spent. Always computed by Hivebuy.
amount minus used minus pending. Always derived.
true while an external system (the ERP) owns usedBudget. Set when an API key writes usedBudget, cleared by releaseExternalBudget.
When the ERP last wrote usedBudget. null while Hivebuy computes the used figure itself.
When the row was created.
When the row itself last changed.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Validation failed.
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
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