Deal Budgets | RetailHardHat REST API docs

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.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`dealId`	`uuid`	Optional	deal Id Related resource: `deals`
`siteId`	`uuid`	Optional	site Id
`name`	`string`	Required	name
`version`	`number`	Optional	version
`status`	`enum`	Optional	status Values: `draft`, `submitted`, `approved`, `locked`
`isCurrent`	`boolean`	Optional	is Current
`parentBudgetId`	`uuid`	Optional	parent Budget Id
`totalLandAcquisition`	`string`	Optional	total Land Acquisition
`totalHardCosts`	`string`	Optional	total Hard Costs
`totalSoftCosts`	`string`	Optional	total Soft Costs
`totalFinancing`	`string`	Optional	total Financing
`totalContingency`	`string`	Optional	total Contingency
`totalOther`	`string`	Optional	total Other
`totalDevelopmentCost`	`string`	Optional	total Development Cost
`totalEstimated`	`string`	Optional	total Estimated
`totalActual`	`string`	Optional	total Actual
`squareFootage`	`number`	Optional	square Footage
`unitCount`	`number`	Optional	unit Count
`costPerSF`	`string`	Optional	cost Per S F
`costPerUnit`	`string`	Optional	cost Per Unit
`assumptions`	`string`	Optional	assumptions
`notes`	`string`	Optional	notes
`selectedCategories`	`array`	Optional	selected Categories
`approvedBy`	`string`	Optional	approved By
`approvedAt`	`datetime`	Optional	approved At
`lockedAt`	`datetime`	Optional	locked At
`lockedBy`	`string`	Optional	locked By
`createdBy`	`string`	Optional	created By
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)