To extract data from PeopleHR so you can import it into TT Payroll, you can use the extractor tool. You can also load payslips from TT Payroll into PeopleHR with this integration.
Prerequisites
Before you can run the tool, you need to create the following queries in PeopleHR. The queries are mandatory but the logbooks are optional.
Query name | Payroll : Payroll |
Selected areas | Employment, Payroll Company |
Query name | TT Core Data Extract (Do not remove) |
Selected areas | Employee Details, Salary Details, Contact Details, Leavers, WorkPattern, EmployeeID, Title, First Name, Last Name, Gender, Date of Birth, Start Date, Job Role, Company, Location, Department, NIS/SSN,Employment Type, Employee status, Salary Type, Salary Amount, Payment Frequency, Employee Address, Personal Phone Number, Bank Name, BankAddress, Bank code, Account code, Account Name, Final day of employment, Working hours |
There are a number of data items you can send to TT Payroll which are optional. If you need to send these to TT Payroll, create logbook screens and enter the data there. The logbooks are:
Logbook name | Social Security Card Type |
Data items | Card Type |
Logbook name | Tax Records |
Data items | Tax Reference, Tax Rate %, Tax Code and ID Number |
Logbook name | Right to Work |
Data items | Employment Status, Contract Type |
Logbook name | Cost Centre Codes |
Data items | Division Code |
If you create these logbooks, you need to add the logbook information to the TT Core Data Extract (Do not remove) query.
Set up
📌Note: Before you follow the steps, you need to create an API key with access to all endpoints.
Download the TT Payroll Extractor Tool .
Open the downloaded file then click Settings.
Complete the fields:
API Key | Enter the API key you created. |
Pay Method | Enter the value from column P under the TT core data extract, this value is for the banking provider. |
Company/Payroll Company | Select the relevant company or payroll. |
Code | This is the company code as you have it in TT payroll. |
Location | If you produce payroll for employees in a certain location you can specify that location here, otherwise, select All. |
Enabled |
|
Then click Save.
Use the tool
When you click Save, you go back to the first screen of the tool. There are three steps to this.
Re-assign PW Employee Ids to Numeric Only
TT Payroll only accepts numeric employee IDs, therefore this option searches all of your employee ID numbers and if there are any with letters, they convert into a numerical value on the employee's People HR record.
Produce TT Payroll Extract
This runs your payroll query in PeopleHR, exports it and converts it into a format that TT Payroll can accept. Once you do this, you have the option to choose an output location. This file contains all of the correct information for TT Payroll.
Enter a name then click Save.
Load Payslips
Finally, you have the option to Load Payslips. TT Payroll produces one payslip per employee.
Browse to a folder e.g. JunePayslips, then press 3 and select the relevant location. This loads each payslip and renames it to .pdfx when done.
📌Note: You need to keep any tool or software that you use up to date with the most recent version. This ensures you are up to date with any bug fixes.
You can also run TT Payroll loader in silent mode, this way you can script it to produce the export file automatically the approach is that you run the silent exe. if you don't supply any args, you get a list of available options:
"-renumber", "-export", "-load", "-h"