RetailHardHat Developer docs

REST API documentation

Deal Budget Line Items

Individual line items within deal budgets

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

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)
budgetIduuidRequiredbudget Id

Related resource: dealBudgets

parentCategoryenumRequiredparent Category

Values: land_acquisition, hard_costs, soft_costs, financing, contingency, other

categoryenumRequiredcategory

Values: land_acquisition, hard_costs, soft_costs, financing, contingency, other

subcategorystringOptionalsubcategory
displayOrdernumberOptionaldisplay Order
descriptionstringRequireddescription
amountstringOptionalamount
quantitystringOptionalquantity
unitCoststringOptionalunit Cost
unitstringOptionalunit
assigneeIduuidOptionalassignee Id
isContingencybooleanOptionalis Contingency
contingencyPercentstringOptionalcontingency Percent
contingencyBasisstringOptionalcontingency Basis
notesstringOptionalnotes
assumptionsstringOptionalassumptions
sourceReferencestringOptionalsource Reference
sourceBidIduuidOptionalsource Bid Id
sourceBidLinkedAtdatetimeOptionalsource Bid Linked At
actualAmountstringOptionalactual Amount
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)