ProgramInitiative

Represents information about a sustainability initiative in a program. This object is available in API version 59.0 and later.

Supported Calls

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

Fields

Field Details
ActualCost
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The actual cost of the program initiative.
BusinessRegion
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The business region where the initiative is running.
Possible values are:
  • AMER
  • ANZ
  • APAC
  • Africa
  • Central America
  • Central Asia
  • EMEA
  • Europe
  • LATAM
  • Middle East
  • North America
  • South America
  • Southeast Asia
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the initiative is running.
Country
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The country where the initiative is running.
Possible values are:
  • AD—Andorra
  • AE—United Arab Emirates
  • AF—Afghanistan
  • AG—Antigua and Barbuda
  • AI—Anguilla
  • AL—Albania
  • AM—Armenia
  • AO—Angola
  • AQ—Antarctica
  • AR—Argentina
  • AT—Austria
  • AU—Australia
  • AW—Aruba
  • AX—Aland Islands
  • AZ—Azerbaijan
  • BA—Bosnia and Herzegovina
  • BB—Barbados
  • BD—Bangladesh
  • BE—Belgium
  • BF—Burkina Faso
  • BG—Bulgaria
  • BH—Bahrain
  • BI—Burundi
  • BJ—Benin
  • BL—Saint Barthélemy
  • BM—Bermuda
  • BN—Brunei Darussalam
  • BO—Bolivia, Plurinational State of
  • BQ—Bonaire, Sint Eustatius and Saba
  • BR—Brazil
  • BS—Bahamas
  • BT—Bhutan
  • BV—Bouvet Island
  • BW—Botswana
  • BY—Belarus
  • BZ—Belize
  • CA—Canada
  • CC—Cocos (Keeling) Islands
  • CD—Congo, the Democratic Republic of the
  • CF—Central African Republic
  • CG—Congo
  • CH—Switzerland
  • CI—Côte d'Ivoire
  • CK—Cook Islands
  • CL—Chile
  • CM—Cameroon
  • CN—China
  • CO—Colombia
  • CR—Costa Rica
  • CU—Cuba
  • CV—Cape Verde
  • CW—Curaçao
  • CX—Christmas Island
  • CY—Cyprus
  • CZ—Czechia
  • DE—Germany
  • DJ—Djibouti
  • DK—Denmark
  • DM—Dominica
  • DO—Dominican Republic
  • DZ—Algeria
  • EC—Ecuador
  • EE—Estonia
  • EG—Egypt
  • EH—Western Sahara
  • ER—Eritrea
  • ES—Spain
  • ET—Ethiopia
  • FI—Finland
  • FJ—Fiji
  • FK—Falkland Islands (Malvinas)
  • FO—Faroe Islands
  • FR—France
  • GA—Gabon
  • GB—United Kingdom
  • GD—Grenada
  • GE—Georgia
  • GF—French Guiana
  • GG—Guernsey
  • GH—Ghana
  • GI—Gibraltar
  • GL—Greenland
  • GM—Gambia
  • GN—Guinea
  • GP—Guadeloupe
  • GQ—Equatorial Guinea
  • GR—Greece
  • GS—South Georgia and the South Sandwich Islands
  • GT—Guatemala
  • GW—Guinea-Bissau
  • GY—Guyana
  • HK—Hong Kong
  • HM—Heard Island and McDonald Islands
  • HN—Honduras
  • HR—Croatia
  • HT—Haiti
  • HU—Hungary
  • ID—Indonesia
  • IE—Ireland
  • IL—Israel
  • IM—Isle of Man
  • IN—India
  • IO—British Indian Ocean Territory
  • IQ—Iraq
  • IR—Iran, Islamic Republic of
  • IS—Iceland
  • IT—Italy
  • JE—Jersey
  • JM—Jamaica
  • JO—Jordan
  • JP—Japan
  • KE—Kenya
  • KG—Kyrgyzstan
  • KH—Cambodia
  • KI—Kiribati
  • KM—Comoros
  • KN—Saint Kitts and Nevis
  • KP—Korea, Democratic People's Republic of
  • KR—Korea, Republic of
  • KW—Kuwait
  • KY—Cayman Islands
  • KZ—Kazakhstan
  • LA—Lao People's Democratic Republic
  • LB—Lebanon
  • LC—Saint Lucia
  • LI—Liechtenstein
  • LK—Sri Lanka
  • LR—Liberia
  • LS—Lesotho
  • LT—Lithuania
  • LU—Luxembourg
  • LV—Latvia
  • LY—Libya
  • MA—Morocco
  • MC—Monaco
  • MD—Moldova, Republic of
  • ME—Montenegro
  • MF—Saint Martin (French part)
  • MG—Madagascar
  • MK—North Macedonia
  • ML—Mali
  • MM—Myanmar
  • MN—Mongolia
  • MO—Macao
  • MQ—Martinique
  • MR—Mauritania
  • MS—Montserrat
  • MT—Malta
  • MU—Mauritius
  • MV—Maldives
  • MW—Malawi
  • MX—Mexico
  • MY—Malaysia
  • MZ—Mozambique
  • NA—Namibia
  • NC—New Caledonia
  • NE—Niger
  • NF—Norfolk Island
  • NG—Nigeria
  • NI—Nicaragua
  • NL—Netherlands
  • NO—Norway
  • NP—Nepal
  • NR—Nauru
  • NU—Niue
  • NZ—New Zealand
  • OM—Oman
  • PA—Panama
  • PE—Peru
  • PF—French Polynesia
  • PG—Papua New Guinea
  • PH—Philippines
  • PK—Pakistan
  • PL—Poland
  • PM—Saint Pierre and Miquelon
  • PN—Pitcairn
  • PR—Puerto Rico
  • PS—Palestine
  • PT—Portugal
  • PY—Paraguay
  • QA—Qatar
  • RE—Reunion
  • RO—Romania
  • RS—Serbia
  • RU—Russian Federation
  • RW—Rwanda
  • SA—Saudi Arabia
  • SB—Solomon Islands
  • SC—Seychelles
  • SD—Sudan
  • SE—Sweden
  • SG—Singapore
  • SH—Saint Helena, Ascension and Tristan da Cunha
  • SI—Slovenia
  • SJ—Svalbard and Jan Mayen
  • SK—Slovakia
  • SL—Sierra Leone
  • SM—San Marino
  • SN—Senegal
  • SO—Somalia
  • SR—Suriname
  • SS—South Sudan
  • ST—Sao Tome and Principe
  • SV—El Salvador
  • SX—Sint Maarten (Dutch part)
  • SY—Syrian Arab Republic
  • SZ—Eswatini
  • TC—Turks and Caicos Islands
  • TD—Chad
  • TF—French Southern Territories
  • TG—Togo
  • TH—Thailand
  • TJ—Tajikistan
  • TK—Tokelau
  • TL—Timor-Leste
  • TM—Turkmenistan
  • TN—Tunisia
  • TO—Tonga
  • TR—Türkiye
  • TT—Trinidad and Tobago
  • TV—Tuvalu
  • TW—Taiwan
  • TZ—Tanzania, United Republic of
  • UA—Ukraine
  • UG—Uganda
  • US—United States
  • UY—Uruguay
  • UZ—Uzbekistan
  • VA—Holy See (Vatican City State)
  • VC—Saint Vincent and the Grenadines
  • VE—Venezuela, Bolivarian Republic of
  • VG—Virgin Islands, British
  • VN—Vietnam
  • VU—Vanuatu
  • WF—Wallis and Futuna
  • WS—Samoa
  • XK—Kosovo
  • YE—Yemen
  • YT—Mayotte
  • ZA—South Africa
  • ZM—Zambia
  • ZW—Zimbabwe
CurrencyCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The currency in which the cost was incurred.
Possible values are:
  • AED
  • AFN
  • ALL
  • AMD
  • ANG
  • AOA
  • ARS
  • AUD
  • AWG
  • AZN
  • BAM
  • BBD
  • BDT
  • BGN
  • BHD
  • BIF
  • BMD
  • BND
  • BOB
  • BRL
  • BSD
  • BTN
  • BWP
  • BYN
  • BZD
  • CAD
  • CDF
  • CHF
  • CLP
  • CNY
  • COP
  • CRC
  • CSD
  • CUP
  • CVE
  • CZK
  • DJF
  • DKK
  • DOP
  • DZD
  • EGP
  • ERN
  • ETB
  • EUR
  • FJD
  • FKP
  • GBP
  • GEL
  • GHS
  • GIP
  • GMD
  • GNF
  • GTQ
  • GYD
  • HKD
  • HNL
  • HRK
  • HTG
  • HUF
  • IDR
  • ILS
  • INR
  • IQD
  • IRR
  • ISK
  • JMD
  • JOD
  • JPY
  • KES
  • KGS
  • KHR
  • KMF
  • KPW
  • KRW
  • KWD
  • KYD
  • KZT
  • LAK
  • LBP
  • LKR
  • LRD
  • LYD
  • MAD
  • MDL
  • MGA
  • MKD
  • MMK
  • MOP
  • MRU
  • MUR
  • MWK
  • MXN
  • MYR
  • MZN
  • NAD
  • NGN
  • NIO
  • NOK
  • NPR
  • NZD
  • OMR
  • PAB
  • PEN
  • PGK
  • PHP
  • PKR
  • PLN
  • PYG
  • QAR
  • RON
  • RSD
  • RUB
  • RWF
  • SAR
  • SBD
  • SCR
  • SDG
  • SEK
  • SGD
  • SHP
  • SLL
  • SOS
  • SRD
  • STN
  • SYP
  • SZL
  • THB
  • TJS
  • TND
  • TOP
  • TRY
  • TTD
  • TWD
  • TZS
  • UAH
  • UGX
  • USD
  • UYU
  • UZS
  • VES
  • VND
  • VUV
  • WST
  • XAF
  • XCD
  • XOF
  • XPF
  • YER
  • ZAR
The default value is USD.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the initiative.
EmissionsActivityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The emissions activity impacted by the initiative.
This field is a relationship field.
Relationship Name
EmissionsActivity
Relationship Type
Lookup
Refers To
EmissionsActivity
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the initiative ends.
EstimatedCost
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The estimated cost of the program initiative.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the initiative is active (true) or not (false).
The default value is 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. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
ManagerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The manager of the initiative.
This field is a relationship field.
Relationship Name
Manager
Relationship Type
Lookup
Refers To
User
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the initiative.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ProgramId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The program associated with the initiative.
This field is a relationship field.
Relationship Name
Program
Relationship Type
Lookup
Refers To
Program
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the initiative begins.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The status of the initiative.
Possible values are:
  • Active
  • Cancelled
  • Completed
  • Planned
Type
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
The type of initiative that is part of the program.
Possible values are:
  • Environmental
  • Governance
  • Social

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.

ProgramInitiativeFeed
Feed tracking is available for the object.
ProgramInitiativeHistory
History is available for tracked fields of the object.
ProgramInitiativeShare
Sharing is available for the object.