Payroll Webhook
Get updated information and status on payroll payments
Overview
SingleView's Payroll Webhook API services provides a way to integrate payroll systems with other software applications, allowing for automated data exchange and real-time updates. Webhook provides information on the approval status of the payroll as well as the payment status of the payroll.
Payroll Webhooks
Approval Status
{
"service": "svWebHookPayrollApprovalStatus",
"companyCode": "Company_Code",
"payrollPayId": "Payroll_Payment_ID",
"authId": "Authentication_ID",
"svRefId": "SingleView_Reference_ID",
"approval_status": X
}
Description
| JSON Tag | Description | Data Type |
|---|---|---|
| service | Information on type of webhook service required. In this case, it is mentioned as svWebHookPayrollApprovalStatus | String |
| companyCode | Unique company code | Numerical |
| payrollPayId | Unique payroll payment identification details | Numerical |
| authId | Unique authentication identification details | Numerical |
| svRefId | Unique SingleView transaction reference identification | Numerical |
| approval_status | Approval status of the payroll displayed as number among:3 = EXECUTED4 = REJECTED | Numerical |
Important information
Acknowledgement is required from the ERP side to confirm the receival of the request to get updates on the respective payroll's approval status.
{
status:"OK"
}
Payment Status
{
"service": "svWebHookPayrollPaymentStatus",
"companyCode": "Company_Code",
"payrollPayId": "Payroll_Payment_Id",
"authId": "Authentication_Id",
"svRefId": "SingleView_Reference_Id",
"payment_status": 0,
"payeeDetails": [
{
"bankCode": "Bank_Code",
"payeeId": "Payee_Id",
"seqNum": "Sequence_Number",
"txnDate": "YYYY-MM-DDTHH:MM:SSZ",
"status": 0
},
{
"bankCode": "Bank_Code",
"payeeId": "Payee_Id",
"seqNum": "Sequence_Number",
"txnDate": "YYYY-MM-DDTHH:MM:SSZ",
"status": 0
},
{
"bankCode": "Bank_Code",
"payeeId": "Payee_Id",
"seqNum": "Sequence_Number",
"txnDate": "YYYY-MM-DDTHH:MM:SSZ",
"status": 0
}
]
}
Description
| JSON Tag | Description | Data Type |
|---|---|---|
| service | Information on type of webhook service required. In this case, it is mentioned as svWebHookPayrollPaymentStatus | String |
| companyCode | Unique company code | Numerical |
| payrollPayId | Unique payroll payment identification details | Numerical |
| authId | Unique authentication identification details | Numerical |
| svRefId | Unique SingleView transaction reference identification | Numerical |
| payment_status | Overall payroll payments status displayed as number among:0 = COMPLETED1 = FAILED2 = BANK PROCESS3 = ONHOLD4 = OPEN5 = PARTIAL SUCCESS | Numerical |
| payeeDetails | Tag carrying information on the payee and their payment status in the response | Object |
| bankCode | Unique bank identification details | Numerical |
| payeeId | Unique Payee/Employee identification details | Numerical |
| seqNum | Sequence number of the payroll payment | Numerical |
| txnDate | Date and time of the transaction | String |
| status | Status of the individual payment displayed as number among:0 = COMPLETED1 = FAILED2 = BANK PROCESS3 = ONHOLD4 = OPEN | String |
Important information
Acknowledgement is required from the ERP side to confirm the receival of the request to receive updates on the respective payroll's payments processing statuses.
{
status:"OK"
}
Updated 7 months ago