The Resource Forecast Object

The Resource Forecast object is the core data record in Resource Hero. Each record represents planned or actual hours for a Resource Assignment on a given date. Multiple Resource Forecast records can exist for the same assignment and date. Forecasts are typically created and managed automatically through the Matrix interface, auto-forecasting, and time tracking components, though they can also be created or edited directly via the API or data tools for integration purposes.

Core Fields

FieldAPI NameTypeDescription
Resource AssignmentResource_Assignment__cMaster-DetailThe parent Resource Assignment this forecast belongs to. Controls sharing and rollup calculations.
Forecast DateForecastDate__cDateThe specific date this forecast record represents.
ForecastForecast__cNumberPlanned hours for this date.
ActualActual__cNumberLogged actual hours for this date.
CapacityCapacity__cNumberAvailable capacity hours for this date (used in capacity planning).
CategoryCategory__cPicklistClassifies the forecast record. Default value: General.
Is BillableRH_Is_Billable__cCheckboxWhether hours on this record count as billable. Drives all Billable formula fields.

Notes Fields

FieldAPI NameTypeDescription
Forecast NotesForecast_Notes__cLong Text AreaNotes related to the forecasted hours.
Actual NotesActual_Notes__cLong Text AreaNotes related to actual hours logged.
Capacity NotesCapacity_Notes__cLong Text AreaNotes related to capacity for this date.

Amount & Cost Fields

FieldAPI NameTypeDescription
Forecast AmountForecast_Amount__cCurrency (Formula)Forecast hours × billing rate from the parent Resource Assignment.
Actual AmountActual_Amount__cCurrency (Formula)Actual hours × billing rate from the parent Resource Assignment.
Remaining Forecast HoursRemaining_Forecast__cNumber (Formula)Forecast − Actual.
Remaining Forecast AmountRemaining_Forecast_Amount__cCurrency (Formula)Forecast Amount − Actual Amount.
Forecast CostForecast_Cost__cCurrencyInternal cost of forecasted hours. Populated automatically from resource rate configuration.
Actual CostActual_Cost__cCurrencyInternal cost of actual hours logged. Populated automatically from resource rate configuration.

Billable Fields

These fields split hours and amounts based on the Is Billable checkbox.

FieldAPI NameTypeDescription
BillableRH_Billable__cNumber (Formula)Actual hours when Is Billable = true, otherwise 0.
Non-BillableRH_Non_Billable__cNumber (Formula)Actual hours when Is Billable = false, otherwise 0.
Billable AmountRH_Billable_Amount__cCurrency (Formula)Actual Amount when Is Billable = true, otherwise 0.
Billable CostRH_Billable_Cost__cCurrency (Formula)Actual Cost when Is Billable = true, otherwise 0.

Snapshot Fields

Snapshots capture a point-in-time copy of forecast data for comparison and reporting purposes. These fields are populated automatically when a snapshot is taken.

FieldAPI NameTypeDescription
Is SnapshotIs_Snapshot__cCheckbox (Formula)True if this record belongs to a snapshot Resource Assignment.
Snapshot HoursSnapshot_Hours__cNumberFrozen copy of hours at the time the snapshot was taken.
Snapshot Cost RateSnapshot_Cost_Rate__cCurrencyFrozen cost rate at the time the snapshot was taken.
Snapshot AmountSnapshot_Amount__cCurrency (Formula)Snapshot Hours × billing rate from the parent assignment.
Snapshot CostSnapshot_Cost__cCurrency (Formula)Snapshot Hours × Snapshot Cost Rate.
Snapshot NotesSnapshot_Notes__cLong Text AreaNotes captured at the time of the snapshot.

System Fields

These fields are managed by Resource Hero and are not typically edited directly.

FieldAPI NameTypeDescription
Cost RateCost_Rate__cCurrencyHourly cost rate applied to this record. Populated automatically based on the resource’s rate configuration.
Resource RateResource_Rate__cLookupThe Resource Rate record used to populate Cost Rate. Set automatically based on the resource and forecast date.
Prevent Matrix DeletePrevent_Matrix_Delete__cCheckboxChecking this box prevents the record from being deleted by actions taken in the Matrix interface.
Protected ActualProtected_Actual__cCheckboxWhen true, this record’s actual hours cannot be updated through the Matrix, the time tracking interface, or auto-forecasting.
HolidayHoliday__cLookupSet automatically when the forecast date falls on a holiday.
Holiday Schedule AssignmentHoliday_Schedule_Assignment__cLookupLinks to the holiday schedule assignment that applies to this resource on this date.
PTO RequestPTO_Request__cLookupLinks to a PTO request record when one affects this forecast date.

Note for integrations: Resource Forecast records linked to a Holiday, Holiday Schedule Assignment, or PTO Request, as well as records where Capacity is greater than 0, are managed exclusively by Resource Hero and cannot be created, updated, or deleted via external processes. Attempting to modify these records directly will be blocked.

Related Support Posts:

Ready to get started?

Schedule a call to see if Resource Hero is right for you

Book now