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.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiRnZlNldoR3dva2U2WGsiLCJpYXQiOjE3NjU2ODYzOTUsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoiX0wtVDlua05rYUJTN24iLCJleHAiOjE3NjgyNzgzOTV9.58JrRBCVLvr9szmkJSWDsQrZ1n0kAwtru6p5gOXkLLE
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.
Account
  • Cannot be Null
  • You must select an existing Account
Business Unit
  • Cannot be Null
  • You must select an existing Business Unit
The key dependencies and validations are:
"PeriodId ": "string"
  • Cannot be Blank
  • Cannot be NULL
  • Must be provided in the following format 20231001000
"RateReference":"string"
  • Cannot be Blank
  • Cannot be NULL
"Page":"string"
  • Can be Left Blank
  • If provided, must be in Decimals.
"Size ":"string"
  • Can be Left Blank
  • If provided, must be in Decimals.
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.
Account
  • Cannot be Null
  • You must select an existing Account
Business Unit
  • Cannot be Null
  • You must select an existing Business Unit
The key dependencies and validations are:
"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.
Account
  • Cannot be Null
  • You must select an existing Account
Business Unit
  • Cannot be Null
  • You must select an existing Business Unit
The key dependencies and validations are:
"PeriodId ": "string"
  • Cannot be Blank
  • Cannot be NULL
  • Must be provided in the following format 20231001000
"Iteration":"string"
  • Can be Left Blank
  • If provided, must be in decimals
"Size":"string"
  • Can be Left Blank
  • If provided, must be in decimals
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.