GetBreakdownByEmpIdandPaySlip
GetBreakdownByEmpIdandPaySlip
Description:
This endpoint will provide breakdown of an employee payslip - the full details of their pay items, deduction items and net pay to the authorized requester.
Request:
Request headers:
|
Name |
Required |
Type |
Description |
|
Authorization |
Yes |
string |
access token |
Request parameters:
|
Name |
In |
Required |
Type |
Description |
|
employeeId |
template |
true |
string |
string[6] |
|
paySlipId |
template |
true |
string |
string[8] |
Response example:
Response: 200 OK
{
"firstName": "string",
"surname": "string",
"employeeName": "string",
"niNumber": "string",
"niCategory": "string",
"taxCode": "string",
"payslipNumber": 0.0,
"payrollCompany": 0.0,
"employeeNumber": "string",
"payDate": "string",
"netPay": 0.0,
"totalPayThisPeriod": 0.0,
"deductionsThisPeriod": 0.0,
"paymentMethod": "string",
"payPoint": "string",
"payGroup": 0.0,
"occupationCode": 0.0,
"costCenter": "string",
"department": "string",
"taxPeriod": 0.0,
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"postCode": "string",
"totalPayYtd": 0.0,
"totalDeductionsYtd": 0.0,
"messageLine1": "string",
"messageLine2": "string",
"personalItems": [
{
"payslipNumber": 0.0,
"employeeNumber": 0.0,
"payPeriod": "string",
"runNumber": 0.0,
"lineNumber": 0.0,
"descriptionDetails": "string",
"zone1Data": "string"
}
],
"statutoryDetails": [
{
"description": "string",
"valueThisPeriod": 0.0,
"valueToDate": 0.0
}
],
"payItems": [
{
"payItemName": "string",
"units": 0.0,
"rate": 0.0,
"thisPeriod": 0.0,
"yearToDate": 0.0
}
],
"deductionItems": [
{
"deductionItemName": "string",
"thisPeriod": 0.0,
"yearToDate": 0.0
}
],
"otherItems": [
{
"otherItemName": "string",
"thisPeriod": 0.0,
"yearToDate": 0.0
}
]
}
Response: 400 Bad Request
Bad Request
Response: 401 Unauthorized
Unauthorized
Response: 404 Not Found
Not Found
Response: 405 Method Not Allowed
Method Not Allowed
Response: 500 Internal Server Error
Internal Server Error
Created with the Personal Edition of HelpNDoc: Full-featured Documentation generator