Skip Navigation

The online Trailblazer Community becomes read-only Oct 30, 2026. Read More

Energy and Utilities Cloud Developer Guide

Benefit

Represents information about benefits associated with a program. This object is available with Program Management in API version 57.0 and later.

Fields

BenefitManagerId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The person in charge of the benefit.

This field is a relationship field.

BenefitStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the status of the benefit.
Default value: Active
Possible values:
- Active
- Cancelled
- Completed
- Planned

BenefitTypeId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Specifies the type of the benefit.

This field is a relationship field.

CurrentMonthDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the current month.

CurrentYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the current year.

CurrentYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the current year.

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the benefit.

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date until when the benefit is valid.

EnrollmentCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of times the benefit is applicable to an individual.

GoalDefinitionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The goal definition associated with the benefit.

This field is a relationship field.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the benefit is active.
Default value: false

IsBenefitCalculated

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the Benefit is calculated in runtime
Default value: false

MaximumBenefitAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The maximum amount that can be disbursed for a period.

MinimumBenefitAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The minimum amount that can be disbursed for a period.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the benefit.

PreviousMonthDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous month.

PreviousYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the previous year.

PreviousYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous year.

ProgramId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the program that’s associated with the benefit.

This field is a relationship field.
Relationship Name: Program
Relationship Type: Lookup
Refers To: Program

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when the benefit starts.

UnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the unit of measure that’s used to calculate the benefit.

This field is a relationship field.