After each successful transaction you will be provided with a response including the following data set and the respective payslip file provided by the Payroll platform / end-user (via upload). Some data points are not always available, due to the difference of information provided by the different payroll providers.
- Employee Name, Address, Employee ID, National Insurance No., Email
- Employer Name and Address
- Start and End Date of employment
- Month, Pay date, Tax Month,
- Currency, Payment Method
- Data Source, Payslip file
- Total monthly earning, variable earnings
- Total monthly deduction, variable deductions
- YTD earnings
- YTD tax and NI contributions
- Annual Salary
You can find a link to the payslip file inside the transaction response. That link will be downloadable for at least 3 months.
The following list will show you what data points are provided in the response and specially which of the data is always provided and which ones can vary.
API JSON Response values
All values that are marked optional won't appear in the JSON response if missing on the payslip / hr portal.
For all mandatory fields, it can happen due to a flawed / faulty payslip, that a value is missing, which then will be having a "null" value. In this case we advise to re-check the attached payslip and contact your end user.
You will find this information also in the GET Transaction endpoint section of the API reference.
Status of the transaction (Pending, Failed, Completed, Timeout)
Payroll / HR provider name OR 'manual upload'
Time of transaction creation
Last update of the transaction
All data in that block relate to the employee
Internal company ID of the employee, displayed on the payslip / HR tool
Employees full name
Employee tax code
Employee National Insurance number (N.I.)
Employees annually salary as displayed on the payslip
Employee personal email
Start date of the current employment
All data in that block relate to the employer
Month of the issued Payslip
Salary payment date
Salary payment method
Total net amount paid to employee
Link to download the payslip
All data in that block relate to the earnings displayed on that months payslip
Employee monthly salary
Optional and variable item in the monthly earnings list (array).
Sum of all Items in the earnings block (displayed on the payslip)
All data in that block relate to the deductions displayed on that months payslip
Employee income tax
Employee N.I. contributions
Optional and variable item in the monthly deduction list
Sum of all Items in the deductions block (displayed on the payslip)
Year to date gross pay of this employment
Year to date taxable pay of this employment
Year to date national insurance contribution
Total amount of tax paid year to date
*not always available on payslips
**data retrieved directly from the HR portal, not always possible