RetailHardHat Developer docs

REST API documentation

Project Budget Items

Budget line items for a project (accessed via /api/v1/projects/:id/budget)

Supported operations

MethodPathDescription
GET/api/v1/projects/:id/budgetList budget items — filter by category, status
POST/api/v1/projects/:id/budgetAdd a budget item to a project
PATCH/api/v1/projects/:id/budget/:itemIdUpdate a project budget item
DELETE/api/v1/projects/:id/budget/:itemIdDelete a project budget item

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
projectIduuidRequiredproject Id

Related resource: projects

categorystringRequiredcategory
descriptionstringRequireddescription
plannedAmountstringRequiredplanned Amount
actualAmountstringOptionalactual Amount
notesstringOptionalnotes
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)