Edit

Share via


Payroll worker benefit plan

Applies to these Dynamics 365 apps:
Human Resources

This article describes the Payroll worker benefit plan entity for Dynamics 365 Human Resources.

Physical name: mshr_payrollworkerbenefitplanentities.

Description

This entity provides information about the benefits plan for a given worker.

Properties

Property
Physical name
Type
Use Description
Personnel number
mshr_personnelnumber
String
Read-only
Required
The employee's unique personnel number.
Legal entity ID
mshr_legalentityID
String
Read-only Specifies the legal entity (company).
Period ID
mshr_periodid
String
Read-only The identifier of the period.
Plan ID
mshr_planid
String
Read-only The identifier of the plan.
Coverage option
mshr_coverageoptionid
String
Read-only Identification of the coverage option.
Deduction start date
mshr_deductionstartdatetime
Date time offset
Read-only Deduction start date.
Deduction end date
mshr_deductionenddatetime
Date time offset
Read-only Deduction end date.
Status
mshr_status
Benefit employee plan status option set
Read-only Status for the benefit plan.
Valid from
mshr_validfrom
Date Time Offset
Read-only The time from which this record is valid.
Valid to
mshr_validto
Date Time Offset
Read-only The time up to which this record is valid.
Plan type ID
mshr_plantypeid
String
Read-only The identifier of the plan type.
Plan type code
mshr_plantypecode
benefit plan type cover option set
Read-only The specification of the plan type.
Number of pay periods
mshr_payperiod
Integer
Read-only The number of pay periods that represents how often the benefit provider or employees are paid. This amount will be used to calculate the employee's annual benefit salary amount.
Employee amount
mshr_amountemployee
Decimal
Read-only The employee amount or percentage.
Employer amount
mshr_amountemployer
Decimal
Read-only The employer amount or percentage.
Primary field
mshr_primaryfield
String
System generated Primary field.
Worker ID value
_mshr_fk_worker_id_value
GUID
Foreign key: mshr_hcmworkerbaseentityid of mshr_hcmworkerbaseentity entity. System-generated unique identifier for the worker.
Period ID value
_mshr_fk_period_id_value
GUID
Foreign key: mshr_benefitperiodentityid of mshr_benefitperiodentity entity. System-generated unique identifier for the period.
Plan ID value
_mshr_fk_plan_id_value
GUID
Foreign key: mshr_benefitplanentityid of mshr_benefitplanentity entity. System-generated unique identifier for the plan.
Plan Type ID value
_mshr_fk_plantype_id_value
GUID
Foreign key: mshr_benefitplantypeentityid of mshr_benefitplantypeentity entity. System-generated unique identifier for the plan.
Coverage option ID value
_mshr_fk_coverageoption_id_value
GUID
Foreign key: mshr_benefitcoverageoptionentityid of mshr_benefitcoverageoptionentity entity. System-generated unique identifier for the plan.
Payroll worker benefit plan entity ID value
mshr_payrollworkerbenefitplanentityid
GUID
Read-only
System generated
System-generated unique identifier for the record.

Example query for Payroll worker benefit plan

Request

GET [Organization URI]/api/data/v9.1/mshr_payrollworkerbenefitplanentities?$filter=mshr_personnelnumber eq '000020'

Response

{
    "mshr_personnelnumber": "000020",
    "mshr_legalentityid": "USMF",
    "mshr_periodid": "2021",
    "mshr_planid": "Dental plan",
    "mshr_coverageoptionid": "Emp Only",
    "mshr_deductionstartdatetime": "2021-01-01T06:00:00Z",
    "mshr_deductionenddatetime": "2021-12-31T06:00:00Z",
    "mshr_status": 200000001,
    "mshr_validfrom": "2021-01-01T06:00:00Z",
    "mshr_validto": "2021-12-31T06:00:00Z",
    "mshr_plantypeid": "Dental",
    "mshr_plantypecode": 200000001,
    "mshr_payperiod": 12,
    "mshr_amountemployee": 47,
    "mshr_amountemployer": 57,
    "mshr_primaryfield": "000020 | USMF | 2021 | Dental plan",
    "_mshr_fk_worker_id_value": "000000ae-0000-0000-bfff-004105000000",
    "_mshr_fk_period_id_value": "00000807-0000-0000-ee02-005001000000",
    "_mshr_fk_plan_id_value": "00000c61-0000-0000-0200-005001000000",
    "_mshr_fk_plantype_id_value": "0000057c-0000-0000-0200-005001000000",
    "_mshr_fk_coverageoption_id_value": "00000391-0000-0000-0b00-005001000000",
    "mshr_payrollworkerbenefitplanentityid": "000006c4-0000-0000-bfff-004105000000"
}

See also

Payroll integration API introduction