Spend Forecasts | 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`	Required	deal Id Related resource: `deals`
`budgetId`	`uuid`	Required	budget Id Related resource: `dealBudgets`
`name`	`string`	Required	name
`version`	`number`	Optional	version
`status`	`enum`	Optional	status Values: `draft`, `pending_approval`, `approved`, `published`, `superseded`
`isCurrent`	`boolean`	Optional	is Current
`parentForecastId`	`uuid`	Optional	parent Forecast Id
`periodType`	`enum`	Optional	period Type Values: `monthly`, `quarterly`
`startDate`	`string`	Required	start Date
`endDate`	`string`	Required	end Date
`phases`	`json`	Optional	phases
`defaultCurveType`	`enum`	Optional	default Curve Type Values: `even`, `front_loaded`, `back_loaded`, `s_curve`, `custom`
`budgetTotal`	`string`	Optional	budget Total
`budgetTotalLandAcquisition`	`string`	Optional	budget Total Land Acquisition
`budgetTotalHardCosts`	`string`	Optional	budget Total Hard Costs
`budgetTotalSoftCosts`	`string`	Optional	budget Total Soft Costs
`budgetTotalFinancing`	`string`	Optional	budget Total Financing
`budgetTotalContingency`	`string`	Optional	budget Total Contingency
`budgetTotalOther`	`string`	Optional	budget Total Other
`forecastTotal`	`string`	Optional	forecast Total
`totalActuals`	`string`	Optional	total Actuals
`varianceAmount`	`string`	Optional	variance Amount
`variancePercent`	`string`	Optional	variance Percent
`peakMonthlySpend`	`string`	Optional	peak Monthly Spend
`next30DaysSpend`	`string`	Optional	next30 Days Spend
`next60DaysSpend`	`string`	Optional	next60 Days Spend
`next90DaysSpend`	`string`	Optional	next90 Days Spend
`assumptions`	`string`	Optional	assumptions
`notes`	`string`	Optional	notes
`reforecastReason`	`string`	Optional	reforecast Reason
`publishedBy`	`string`	Optional	published By
`publishedAt`	`datetime`	Optional	published At
`approvedBy`	`string`	Optional	approved By
`approvedAt`	`datetime`	Optional	approved At
`createdBy`	`string`	Optional	created By
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)