Chief executive officer, Compensation and benefits manager, Human resource assistant and 6 more roles
Business process
Develop people strategy
Menu item
HcmReasonCode
Main table
HcmReasonCode
Data entity
HcmReasonCodeEntity
Setup steps
1 on this page
Show what matters for
SETUP GUIDEHow to set it up8 sections. Choose a role to highlight what matters to you.
Everyone
1What it is and why
What it is
A setup page that holds reason codes, which explain why something changes for an employee, such as a benefits change or a termination.
What you do here
Use this page to create reason codes and choose the scenarios they apply to, such as Benefits management.
Example
For example, BEAT creates RESIGNATION (Terminate worker), SALARYCHANGE (Compensation) and MARRIAGE (Benefits management); when 3 employees resign in March, HR picks RESIGNATION on each termination, and the payroll integration passes it on as the status reason.
The page in Dynamics 365. page title tab to open what to set or check
About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.
Setup steps on this page
Set up Reason codes
Use this page to create reason codes and choose the scenarios they apply to, such as Benefits management.
Steps from Microsoft
Go to Human resources > Setup > Reason codes.
Select New.
Enter the reason code and a description.
Under Applicable scenarios, set the scenarios that can use the code, such as Benefits management.
The areas, such as Benefits management, where the reason code can be used.Microsoft Learn
Terminate worker = Yes
Common errors and fixes
Message
What to do
A reason code isn't offered when a worker is terminated or a benefit changes
The code's Applicable scenarios don't include that scenario. Set the scenario, such as Terminate worker or Benefits management, to Yes. Microsoft Learn
A Benefits management reason code is missing after the move to Personnel management
Codes longer than 15 characters didn't migrate. Open Reason codes in Benefits management, select the code and use Migrate reason code. Microsoft Learn
Test checklist
Create a reason code of 15 characters or fewer and set Benefits management to Yes under Applicable scenarios.
Change a worker's benefit enrollment and check the code can be selected.
On a leave type with Reason code required, add and enable the code and submit a leave request; check the code is required and offered.
Codes of 15 characters or fewer, each with its Applicable scenarios set (for example Benefits management, Terminate worker, Compensation)Reason codes have a 15-character maximum, and the Applicable scenarios decide where a code can be used, such as Benefits management.
How should reason codes be organised?Keeping Benefits management codes longer than 15 characters: they don't migrate automatically and must be migrated by hand with Migrate reason code. An existing Personnel management code can take only one Benefits management code.Test: Scenario controls where a code appears
Feature management and licence
Licence or add-in
Codes used by the Dayforce payroll integration (status reasons such as RESIGNATION and SALARYCHANGE) must exist with the scenario Learn lists. Human resource assistant, Recruiter and Payroll administrator maintain the codes; Human resource manager, Compensation and benefits manager, Payroll manager, Training manager and Chief executive officer view them. No Feature management feature is needed for this page.
Shared: reason codes are not per company. Data management lists the Reason codes entity as shared. Checked in Dynamics 365
Can it be undone
Hard to reverse: Codes are referenced by benefits changes, terminations, compensation changes and leave types; renaming means remapping those uses.
If you change it later
Reason codes have a 15-character maximum; longer codes from Benefits management did not migrate automatically and must be migrated by hand. Microsoft Learn
Technical architect
6Technical
Menu item
HcmReasonCodeChecked in Dynamics 365
Form
HcmReasonCodeChecked in Dynamics 365
Table
HcmReasonCodeShown as “REASON CODES” in Record infoKey field: ReasonCodeIdChecked in Dynamics 365
Data entities
HcmReasonCodeEntityReason codes Checked in Dynamics 365
Who can open it
PrivilegesMaintain reason codes for human resources HcmReasonCodeMaintainView reason codes for human resources HcmReasonCodeViewDutiesEnable organizational process HcmOrganizationalProcessEnableInquire into organizational process HcmOrganizationalProcessInquireEnable payroll process HcmPayrollProcessEnableInquire into payroll process HcmPayrollProcessInquireEnable recruitment process HcmRecruitmentProcessEnableInquire into recruitment process HcmRecruitmentProcessInquireEnable workforce management process HcmWorkforceProcessEnableInquire into workforce management process HcmWorkforceProcessInquire9 security rolesChief executive officer CompanyChiefExecutiveOfficerCompensation and benefits manager HcmCompensationAndBenefitsManagerHuman resource assistant HcmHumanResourceAssistantHuman resource manager HcmHumanResourceManagerPayroll administrator HcmPayrollAdministratorPayroll manager HcmPayrollManagerRecruiter HcmRecruiterTraining manager HcmTrainingManagerAccounting manager LedgerAccountingManagerChecked in Dynamics 365
Roles to set it up and use it
To set it up or change itHuman resource assistant HcmHumanResourceAssistantRecruiter HcmRecruiterPayroll administrator HcmPayrollAdministratorTo use itHuman resource manager HcmHumanResourceManagerCompensation and benefits manager HcmCompensationAndBenefitsManagerPayroll manager HcmPayrollManagerTraining manager HcmTrainingManagerChief executive officer CompanyChiefExecutiveOfficerGive people one of these roles. On this system, 9 roles can open this page.Checked in Dynamics 365
Developer
7Developer
Open it by URL
https://<your-environment>/?mi=HcmReasonCode
Integrate with
HcmReasonCodeEntity data entity Checked in Dynamics 365
Data migration
HcmReasonCodeEntity Reason codes with their applicable scenarios. Shared by all companies.Load order: Load with the Personnel management setup template, which lists: External links groups, Loan types, Media types, Regulatory establishments, Terms of employment, External links, Loan items, Media, Regulatory establishment details, Headquarters establishment for company, Ethnic origins, Issuing agency, Language codes, Reason codes, Titles, Veteran status, Levels, Compensation regions, Identification type, Screening type. Reason codes has no dependency inside the template; load it before leave types, terminations and compensation records that use the codes.Microsoft Learn