Skip to main content

Run DPN Payroll plugin

Generate payroll extract files to load directly into DPN Payroll.

Claudia Popovici avatar
Written by Claudia Popovici
Updated over 3 weeks ago

As a PeopleHR admin, you can extract files to import into DPN Payroll. To gather the data you want to upload, you need to create specific queries and logbooks in PeopleHR.

Core data

Prerequisites

Employee details such as name, job role, contact details and so on represent core data.

Some of the field names you have in DPN Payroll differ from the ones in PeopleHR as follows:

DPN field name

PeopleHR field name

Employee Number

Employee ID

Occupation

Job Role

Left Date

Final Day of Employment

Surname

Last Name

Forename(s)

First Name

Account No

Account Code

Sort code

Bank Code

Part time / Full time

Employment Type

📌Note: You can't change the following hard-coded fields:

  • Payroll Status: Active or inactive.

  • Status: New, updated or leaver.

  • Initial: Take the first letter of the first name and the first letter of the last name.

  • NI/SS Category: Take the last letter from the NI number.


Query: Core Data

Now, you're ready to create your query with the exact name Payroll : DPN and the fields we describe in the table below.

Area

Fields

Employee Details

  • Employee ID

  • First Name

  • Last Name

  • Title

  • Known As

  • Date of Birth

  • Employment type

  • Department

  • Job role

  • Start Date

  • NI/SSN

  • Contracted hours

Contacts

  • Address Line 1

  • Address Line 2

  • Town/City

  • County/State

  • Country

  • Post Code

  • Bank Name

  • Bank Code

  • Account Name

  • Account code

Leavers

  • Final Date of Employment


Build the logbook

Next, create your custom logbook screen with the name Payroll Details and the fields below:

Field name

Field type

Marital Status

Dropdown

Tax Reference

Text field

Tax Code

Dropdown

Payment method

Dropdown

NI Table

Text field

Query: Additional Core Data

Now, create your query with the name Payroll : DPN Custom and the fields we describe in the below table. You can skip the filters.

Area

Fields

Employee Details

  • Employee ID

  • First Name

  • Last Name

Payroll Details

  • Marital Status (Payroll Details)

  • Tax Reference (Payroll Details)

  • Tax Code (Payroll Details)

  • Payment Method (Payroll Details)

  • NI Table (Payroll Details)

Salary and payments

Basic salary data

Ensure your employees have a salary record in their personal records.

You don't need to build a query on this data as you automatically pick this up when running the tool.

In the table below, we explain how you need to record an employee's salary in PeopleHR based on their salary type and the automatic calculation.

Salary type

Set salary type as

Set payment frequency as

Set amount as

Calculation

Annual salaries

Annual

Monthly

Employee's monthly amount

Current employees: Gross basic pay is the annual salary divided by 12

Starters and Leavers: Salary divided by 52 divided by the number of days worked per week multiplied by the number of days worked in a month.

Paid at a daily rate

Daily

Monthly

Employee's daily amount

Number of the days their manager approved in the payment period date range multiplied by the employee’s salary amount on the daily rate.

Paid at an hourly rate

Hourly

Monthly

Employee's hourly amount

Number of hours their manager approved in the payment period date range multiplied by the employee’s salary amount on the hourly rate.

Send Entitlements and deductions to payroll

If you want to include entitlements and deductions, ensure that your employees have entitlements or deductions in their personal salary records.

You don't need to build a query on this data as you automatically pick this up when running the tool.

Send Ad-hoc payments to payroll

To record ad-hoc adjustments, create a logbook with the name Ad-hoc Pay Adjustments and the fields we describe below.

Fields

Field type

Field name

Field 1

Dropdown

Payment or Deduction

Field 2

Dropdown

Type

Field 3

Number field

Amount

Now, create the query with the exact name Payroll : Ad-hoc and select the fields we describe in the table below.

Area

Fields

Employee Details

  • Employee ID

  • First Name

  • Last Name

Ad-hoc Pay Adjustments

  • Payment or Deduction (Ad-hoc Pay Adjustments)

  • Type (Ad-hoc Pay Adjustments)

  • Amount (Ad-hoc Pay Adjustments)

  • Payment Date (Ad-hoc Pay Adjustments)


Send Overtime (Assignment) Data to Payroll

To capture employees' overtime data that is logged via Assignments within PeopleHR, create a query with the exact name Payroll : Overtime Feed and the fields we describe in the table below.

Note: Filter Assignment Status to only show approved assignments.

Area

Fields

Employee Details

  • Employee ID

  • First Name

  • Last Name

Assignment

  • Assignment Date

  • Project

  • Detail

  • Assignment Total Hours

  • Assignment Total Amount

  • Assignment Status

  • Assignment Last Action Date

Run the DPN Payroll integration

To set the DPN Payroll integration, follow the steps below:

  1. Create an API key with the Query, Employee and Salary endpoints.

  2. Click Plugins then click New Requests.

  3. Click DPN Payroll.

  4. Paste in your API key.

  5. Set the relevant details:

    • Payroll Start and Payroll End Date: With these dates, you define the salary, payment and deductions along with any payments entered into the Ad-Hoc payments logbook.

    • Hourly/Overtime Calculations Start and End date: With these dates, you define overtime payments recorded under the Assignments section of the employees' planner.

    • Locations: Use this to split or filter the report based on location. To export all employees, leave it blank.

    • Scheme EE and Scheme ER: Enter the payment or deduction name and separate it with a comma for any payments or deductions you want to flag with this status. If you're unsure on which payments or deduction names to include, speak with your DPN representative

  6. Click Submit.

  • Once you create a new request, allow up to two minutes to view this in Requests.

  • To download any file attached to the request, click Download.

  • To repeat the same request, click Repeat.

  • If your request failed, to view the error details, click the log icon image.png.

Did this answer your question?