get
https://payrollservice-d5ffb79ba43a9141.onporter.run/api/v1/payroll/payment/status
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
/payment/status
Get the payment status of a statutory payment for a specified month and year (and if employeeId is provided for a particular employee in that specified month and year)
Input Schema
{
employeeId: String,
year: Number,
month: Number,
statutory: String,
}
when employeeId is added in the request body as
{
"employeeId": "6565fd213f1a350e840a015a",
"year": 2024,
"month": 6,
"statutory": "paye"
}
The data returned is no longer a list of payment records but an object of payment record for that employee
{
"success": true,
"message": "Payment record retrieved",
"data": {
"employeeId": "6565fd213f1a350e840a015a",
"month": 6,
"year": 2024,
"name": "paye",
"statutoryDetails": {
"stateForPaye": "Lagos",
"taxId": "RNS-123456",
"amount": 11681.33,
"manually_inputted": false,
"createdAt": "2024-02-11T07:11:23.272Z",
"updatedAt": "2024-02-11T13:22:12.997Z"
},
"status": "processing",
"timeline": "MONTHLY",
"createdAt": "2024-02-13T10:42:42.066Z"
}
}