Payslip & Remittance - API Requests

This document provides information about the PurePro public API endpoints associated with payslip and remittance operations and their objects.
Common operations;

https://slite.com/api/files/EIV5dLOjoCYGjk/imported-image?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiRnZlNldoR3dva2U2WGsiLCJpYXQiOjE3NzEwODQxMjYsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiRld3c0xJVXpIeXZ4UVIiLCJleHAiOjE3NzM2NzYxMjZ9.VqrgGeo8gv3nSpSUbKxrc6KkYzFJ_0dKBjG_yQAHbHE
Please select one of the options below: -

Payslips & Remittances

RateDetail

Method:

Base URL:  {{publicApiUrl}}/Payslip/RateDetail/{{accountReference}}/{{businessUnitReference}}/20231701000?rateReference=1000&page=1&size=100
To get details from a payslip or remittance via public API you need to pass the account and business unit reference to the base URL with the required parameters in the URL.
Property
Acceptable Format
Validations
Account
String
  • Cannot be Null
  • Cannot be left blank
Business Unit
String
  • Cannot be Null
  • Cannot be left blank
The key dependencies and validations are:
Property
Acceptable Format
Validations
PeriodID
String
  • Cannot be Null
  • You must input the period for which you want to view the document for
  • Must be provided in the following format 20231001000
RateReference
String
  • Cannot be Null
  • Cannot be left blank
Page
Decimals
  • Can be Left Blank
Size
Decimals
  • Can be Left Blank
If the results are displayed, then it should return 200 OK with results like this below:
{"accountReference": "Test 1",
"businessUnitReference": "BU1",
"periodId": 20231701000,
"rateReference": "1000",
"rateDescription": "Basic Pay",
"weekEndingDate": "2023-07-21T00:00:00",
"page": 1,
"size": 100,
"totalCount": 0,
"workerDetails": []
}

GetPayslips

Method: 
Base URL: {{publicApiUrl}}/payslip/{{accountReference}}/{{businessUnitReference}}/20231001000
To get details of all payslips or remittances in a period for an account via public API you need to pass the account and business unit reference to the base URL with the required parameters in the URL.
Property
Acceptable Format
Validations
Account
String
  • Cannot be Null
  • Cannot be left blank
Business Unit
String
  • Cannot be Null
  • Cannot be left blank
The key dependencies and validations are:
Property
Acceptable Format
Validations
PeriodID
String
  • Cannot be Blank
  • Cannot be NULL
  • Must be provided in the following format 20231001000
If the results return, then it should return 200 OK with results.

GetPayslipsPaginated

Method: 
Base URL: {{publicApiUrl}}/payslip/GetPaginated/{{accountReference}}/{{businessUnitReference}}/20231001000?iteration=1&size=10
To get details of all payslips or remittances in a period for an account via public API you need to pass the account and business unit reference to the base URL with the required parameters in the URL.
Property
Acceptable Format
Validations
Account
String
  • Cannot be Null
  • Cannot be left blank
Business Unit
String
  • Cannot be Null
  • Cannot be left blank
The key dependencies and validations are:
Property
Acceptable Format
Validations
PeriodID
String
  • Cannot be Blank
  • Cannot be NULL
  • Must be provided in the following format 20231001000
Iteration
Decimals
  • Can be Left Blank
Size
Decimals
  • Can be Left Blank
If the results are displayed, then it should return 200 OK with results.

The contents of this document, along with any associated documents, are the property of PurePro Solutions Ltd. and are shared in strict confidence with the intended recipient. These materials may not be reproduced, shared, or used in any manner without prior written consent from PurePro Solutions Ltd. Unauthorized use or distribution is prohibited.