Spend Forecast Periods | 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)
`forecastId`	`uuid`	Required	forecast Id Related resource: `spendForecasts`
`periodStart`	`string`	Required	period Start
`periodEnd`	`string`	Required	period End
`periodLabel`	`string`	Required	period Label
`periodIndex`	`number`	Required	period Index
`forecastAmount`	`string`	Optional	forecast Amount
`landAcquisition`	`string`	Optional	land Acquisition
`hardCosts`	`string`	Optional	hard Costs
`softCosts`	`string`	Optional	soft Costs
`financing`	`string`	Optional	financing
`contingency`	`string`	Optional	contingency
`otherCosts`	`string`	Optional	other Costs
`actualAmount`	`string`	Optional	actual Amount
`actualLandAcquisition`	`string`	Optional	actual Land Acquisition
`actualHardCosts`	`string`	Optional	actual Hard Costs
`actualSoftCosts`	`string`	Optional	actual Soft Costs
`actualFinancing`	`string`	Optional	actual Financing
`actualContingency`	`string`	Optional	actual Contingency
`actualOtherCosts`	`string`	Optional	actual Other Costs
`varianceAmount`	`string`	Optional	variance Amount
`variancePercent`	`string`	Optional	variance Percent
`cumulativeForecast`	`string`	Optional	cumulative Forecast
`cumulativeActual`	`string`	Optional	cumulative Actual
`cumulativeVariance`	`string`	Optional	cumulative Variance
`notes`	`string`	Optional	notes
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)