EmpBenefitSummary
Represents statistics about benefits provided to employees and the usage of benefits. This object is available in API version 57.0 and later.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the status of the benefit that’s used by the employee.
-
Possible values:
EntitledReturnedUsed
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-
Description: Specifies the country of the employee for whom the benefits information is provided.
-
Possible values:
AD—AndorraAE—United Arab EmiratesAF—AfghanistanAG—Antigua and BarbudaAI—AnguillaAL—AlbaniaAM—ArmeniaAO—AngolaAQ—AntarcticaAR—ArgentinaAT—AustriaAU—AustraliaAW—ArubaAX—Aland IslandsAZ—AzerbaijanBA—Bosnia and HerzegovinaBB—BarbadosBD—BangladeshBE—BelgiumBF—Burkina FasoBG—BulgariaBH—BahrainBI—BurundiBJ—BeninBL—Saint BarthélemyBM—BermudaBN—Brunei DarussalamBO—Bolivia, Plurinational State ofBQ—Bonaire, Sint Eustatius and SabaBR—BrazilBS—BahamasBT—BhutanBV—Bouvet IslandBW—BotswanaBY—BelarusBZ—BelizeCA—CanadaCC—Cocos (Keeling) IslandsCD—Congo, the Democratic Republic of theCF—Central African RepublicCG—CongoCH—SwitzerlandCI—Côte d’IvoireCK—Cook IslandsCL—ChileCM—CameroonCN—ChinaCO—ColombiaCR—Costa RicaCU—CubaCV—Cape VerdeCW—CuraçaoCX—Christmas IslandCY—CyprusCZ—CzechiaDE—GermanyDJ—DjiboutiDK—DenmarkDM—DominicaDO—Dominican RepublicDZ—AlgeriaEC—EcuadorEE—EstoniaEG—EgyptEH—Western SaharaER—EritreaES—SpainET—EthiopiaFI—FinlandFJ—FijiFK—Falkland Islands (Malvinas)FO—Faroe IslandsFR—FranceGA—GabonGB—United KingdomGD—GrenadaGE—GeorgiaGF—French GuianaGG—GuernseyGH—GhanaGI—GibraltarGL—GreenlandGM—GambiaGN—GuineaGP—GuadeloupeGQ—Equatorial GuineaGR—GreeceGS—South Georgia and the South Sandwich IslandsGT—GuatemalaGW—Guinea-BissauGY—GuyanaHK—Hong KongHM—Heard Island and McDonald IslandsHN—HondurasHR—CroatiaHT—HaitiHU—HungaryID—IndonesiaIE—IrelandIL—IsraelIM—Isle of ManIN—IndiaIO—British Indian Ocean TerritoryIQ—IraqIR—Iran, Islamic Republic ofIS—IcelandIT—ItalyJE—JerseyJM—JamaicaJO—JordanJP—JapanKE—KenyaKG—KyrgyzstanKH—CambodiaKI—KiribatiKM—ComorosKN—Saint Kitts and NevisKP—Korea, Democratic People’s Republic ofKR—Korea, Republic ofKW—KuwaitKY—Cayman IslandsKZ—KazakhstanLA—Lao People’s Democratic RepublicLB—LebanonLC—Saint LuciaLI—LiechtensteinLK—Sri LankaLR—LiberiaLS—LesothoLT—LithuaniaLU—LuxembourgLV—LatviaLY—LibyaMA—MoroccoMC—MonacoMD—Moldova, Republic ofME—MontenegroMF—Saint Martin (French part)MG—MadagascarMK—North MacedoniaML—MaliMM—MyanmarMN—MongoliaMO—MacaoMQ—MartiniqueMR—MauritaniaMS—MontserratMT—MaltaMU—MauritiusMV—MaldivesMW—MalawiMX—MexicoMY—MalaysiaMZ—MozambiqueNA—NamibiaNC—New CaledoniaNE—NigerNF—Norfolk IslandNG—NigeriaNI—NicaraguaNL—NetherlandsNO—NorwayNP—NepalNR—NauruNU—NiueNZ—New ZealandOM—OmanPA—PanamaPE—PeruPF—French PolynesiaPG—Papua New GuineaPH—PhilippinesPK—PakistanPL—PolandPM—Saint Pierre and MiquelonPN—PitcairnPR—Puerto RicoPS—PalestinePT—PortugalPY—ParaguayQA—QatarRE—ReunionRO—RomaniaRS—SerbiaRU—Russian FederationRW—RwandaSA—Saudi ArabiaSB—Solomon IslandsSC—SeychellesSD—SudanSE—SwedenSG—SingaporeSH—Saint Helena, Ascension and Tristan da CunhaSI—SloveniaSJ—Svalbard and Jan MayenSK—SlovakiaSL—Sierra LeoneSM—San MarinoSN—SenegalSO—SomaliaSR—SurinameSS—South SudanST—Sao Tome and PrincipeSV—El SalvadorSX—Sint Maarten (Dutch part)SY—Syrian Arab RepublicSZ—EswatiniTC—Turks and Caicos IslandsTD—ChadTF—French Southern TerritoriesTG—TogoTH—ThailandTJ—TajikistanTK—TokelauTL—Timor-LesteTM—TurkmenistanTN—TunisiaTO—TongaTR—TürkiyeTT—Trinidad and TobagoTV—TuvaluTW—TaiwanTZ—Tanzania, United Republic ofUA—UkraineUG—UgandaUS—United StatesUY—UruguayUZ—UzbekistanVA—Holy See (Vatican City State)VC—Saint Vincent and the GrenadinesVE—Venezuela, Bolivarian Republic ofVG—Virgin Islands, BritishVN—VietnamVU—VanuatuWF—Wallis and FutunaWS—SamoaXK—KosovoYE—YemenYT—MayotteZA—South AfricaZM—ZambiaZW—Zimbabwe
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The description of the employee benefit statistics.
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The unique identifier of the reporting period. This field is a relationship field.
- Relationship Name: DisclsReportingPeriod
- Relationship Type: Lookup
- Refers To: DisclsReportingPeriod
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the type of benefit offered by the organization.
-
Possible values:
Disability and Invalidity CoverageHealth CareLife InsuranceOtherRetirement ProvisionStock OwnershipBargaining AgreementWorkers RepresentativeNo Social ProtectionHealth and Safety Management SystemFamily Related Leave (Parental, Maternity, Paternity, Care)
- Type: double
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The number of employees receiving the benefit.
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The percentage of employees receiving the benefit.
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the type of employment.
-
Possible values:
AllFull-TimeFull-Time EquivalentNon-Guaranteed HoursPart-TimePermanentTemporaryNon-Employee or Self-EmployedProvided By Undertakings
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the gender of the employee for whom the benefits information is provided.
-
Possible values:
FemaleMaleNon-BinaryNot DisclosedOther
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the employee is eligible for the benefit (
true) or not (false). - Default value:
false
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed a record related to this record.
- 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.
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: Name of the record.
- 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
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the type of calculation used to determine the percentage of employees who received the benefit.
-
Possible values:
RetentionReturn to Work
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The primary location from where the organization operates.
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The account that’s identified as a subsidiary company. This field is a relationship field.
- Relationship Name: SubsidiaryAccount
- Relationship Type: Lookup
- Refers To: Account
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.
- EmpBenefitSummaryChangeEvent (API Version 63.0)
Change events are available for the object.
- EmpBenefitSummaryFeed
Feed tracking is available for the object.
- EmpBenefitSummaryHistory
History is available for tracked fields of the object.
- EmpBenefitSummaryShare
Sharing is available for the object.