Payroll integration API introduction

Note

For the payroll integration to work for customers using the mshr entities, the row version change tracking must be disabled. To disable row version change tracking, reach out to Microsoft support to enable the DMFDisableSqlRowVersionCtForCDSVirtualEntity flight. Enabling this flight will disable row version change tracking.

Applies to these Dynamics 365 apps:
Human Resources

This document describes the Dynamics 365 Human Resources Payroll integration API. The API enables streamlined end-to-end integrations between Human Resources and partnering payroll systems. The integrated experience begins in Human Resources with the employee profile, salary and deduction, and contribution information. When you hire an employee and enter the required profile and pay information into Human Resources, the payroll system pulls this information to use when processing payroll. Any updates made to the employee or pay information are also pulled for use in later pay runs.

To enable the integration, Human Resources includes the following components:

• Functionality to mark an employee as ready to pay.
• An integration API opening up the new functionality to integrating applications.

Microsoft Dataverse

This API is built on Microsoft Dataverse (formerly Common Data Service). All RESTful interaction with this API is done via the Microsoft Dataverse Web API, which uses OData. This API is a subset of the Dataverse Web API. The Dataverse Web API defines characteristics such as authentication, SLAs, batch, concurrency control, and error handling.

For more general information about the Microsoft Dataverse Web API, see:

• What is Microsoft Dataverse?
• Use the Microsoft Dataverse Web API
• Microsoft Dataverse developer guide

This documentation includes details and developer guidance for using the Dataverse Web API, including the following topics:

• Authenticate to Microsoft Dataverse with the Web API
• Perform operations using the Web API
• Use change tracking to synchronize data with external systems

Virtual tables for Human Resources in Dataverse

The endpoints for the Payroll integration API use the virtual table platform capabilities of Microsoft Dataverse. By default, the virtual tables and their associated API endpoints aren't deployed for Human Resources environments, enabling organizations to determine which OData endpoints will be exposed for the environment. To use the API, the virtual tables for the Human Resources entities must be generated for the environment.

For information on generating the virtual tables for the API, see Configure Dataverse virtual tables.

Data model

The following diagram illustrates relationships within the API. Several types have foreign keys to other, pre-existing entities in Human Resources that aren't illustrated here. This document provides information on entities that are specific to payroll integration scenarios. However, there are many other entities in the Dataverse Web API for Human Resources that may also be relevant to your integration. Some of these entities are referenced in foreign key relationships or navigation properties.

Payroll employee and related entities

Entities:

• Payroll employee
• Payroll worker address
• Payroll fixed compensation plan
• Payroll variable compensation plan
• Payroll position job
• Payroll position

See also

Generate and review payroll entities
Configure Human Resources parameters
Configure Human Resources shared parameters
What is Microsoft Dataverse?
Use the Microsoft Dataverse Web API