Budget

Tracks an estimate of future revenue or expenses during a specific time period. This object is available in API version 53.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available only if the Grants Management or Grantmaking license is enabled, Grants Management or Grantmaking is enabled, and the Manage Budgets system permission is assigned to users.

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account associated with the budget.
This field is available from API version 58.0 and later.

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

Amount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The total amount of funds for a budget shown in currency format.

EstimatedUtilizationAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The amount that's estimated to be utilized from the budget.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description of the budget and its related business processes.

IsSubmitted

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the budget has been submitted. This field is available from API version 58.0 and later.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the budget.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the owner who owns the record.
This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ParentBudgetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the associated parent budget.
This field is available from API version 56.0 and later.

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

PeriodEndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The end of the date range for which the budget applies.

PeriodName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the time period to which the budget applies.

PeriodStartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The beginning of the date range for which the budget applies.

ProgramId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The program associated with the budget.
This field is available from API version 58.0 and later.

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

Quantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The quantity used to track a budget for non-currency projects. For example, this could be number of hours or number of resources.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The status of the budget.
Possible values:
- Active
- Archived
- Planned

Type

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Categorizes the budget by how it will be used.
Possible values:
- Department
- Program
- Project

UtilizedAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The amount that has already been utilized from the budget.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

BudgetFeed: Feed tracking is available for the object.
BudgetHistory: History is available for tracked fields of the object.
BudgetOwnerSharingRule: Sharing rules are available for the object.
BudgetShare: Sharing is available for the object.

Public Sector Developer Guide