Process a Payroll
Make payroll payments using SingleView APIs
Overview
Payroll payments can be processed through SingleView APIs and require the following details to be enclosed in the payment processing request:
Mandatory information
- The user must provide the valid credentials in the header
- Valid
clientid,clientsecret, andsignature- The request should be in the specified format
- The request should include all the mandatory details with appropriate request tags
Process a Payroll
Endpoint details
| Endpoint URL | Method | Grant type |
|---|---|---|
/v1/api/erp/svPayrollService | POST | The header must include: 1. clientid2. clientsecret3. signature |
Initiate Payroll Payments
Note: A minimum of 3 payment entries are required to process a payroll request.
Sample request
curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svPayrollService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"svPayrollServiceRQ": {
"company": [
{
"companyCode": "Enter_Company_Code",
"payroll": [
{
"acERPcode": "Enter_Account_ERP_Code",
"amount": "Enter_Amount",
"currency": "Enter_Currency",
"description": "Enter_Description",
"dueDate": "YYYY-MM-DD",
"userName": "Enter_Username",
"payrollPayId":"Enter_Payroll_Payment_ID",
"payeeDetails": [
{
"bankCode": "Enter_Bank_Code",
"iban": "Enter_IBAN",
"name": "Enter_Name",
"payeeId": "Enter_Payee_ID",
"nationalId": "Enter_National_ID",
"basicSalary": "Enter_Basic_Salary",
"housingAllowance": "Enter_Housing_Allowance",
"otherAllowance": "Enter_Other_Allowance",
"deduction": "Enter_Deduction",
"amount": "Enter_Amount",
"currency": "Enter_Currency",
"remarks": "Enter_Remarks"
},
{
"bankCode": "Enter_Bank_Code",
"iban": "Enter_IBAN",
"name": "Enter_Name",
"payeeId": "Enter_Payee_ID",
"nationalId": "Enter_National_ID",
"basicSalary": "Enter_Basic_Salary",
"housingAllowance": "Enter_Housing_Allowance",
"otherAllowance": "Enter_Other_Allowance",
"deduction": "Enter_Deduction",
"amount": "Enter_Amount",
"currency": "Enter_Currency",
"remarks": "Enter_Remarks"
},
{
"bankCode": "Enter_Bank_Code",
"iban": "Enter_IBAN",
"name": "Enter_Name",
"payeeId": "Enter_Payee_ID",
"nationalId": "Enter_National_ID",
"basicSalary": "Enter_Basic_Salary",
"housingAllowance": "Enter_Housing_Allowance",
"otherAllowance": "Enter_Other_Allowance",
"deduction": "Enter_Deduction",
"amount": "Enter_Amount",
"currency": "Enter_Currency",
"remarks": "Enter_Remarks"
}
]
}
]
}
]
}
}
Request description
| JSON Tag | Description | Data Type |
|---|---|---|
| clientid Mandatory | Unique client identification | String |
| clientsecret Mandatory | Unique client secret key | String |
| signature Mandatory | 64-Bit encrypted signature code | String |
| svPayrollServiceRQ Mandatory | Tag carrying information on request to process a payroll payment | Object |
| company Mandatory | Tag carrying information about company | Object |
| companyCode Mandatory | Unique company code | Numerical |
| payroll Mandatory | Tag carrying information on payroll details in the request | Object |
| acERPcode Mandatory | Unique account ERP identification code | Numerical |
| amount Mandatory | Total amount of the payroll | Numerical |
| currency Mandatory | Currency representing the payroll amount | String |
| description Mandatory | Description of the payroll | String |
| dueDate Mandatory | Due date for processing the payroll | String |
| userName Mandatory | Unique user identification details | String |
| payrollPayId Mandatory | Unique payroll payment identification | String |
| payeeDetails Mandatory | Tag carrying information of payees included in the payroll request | Object |
| bankCode Mandatory | Unique bank identification code | Stringt |
| iban Mandatory | Unique international bank account number | String |
| name Mandatory | Name of the payee | String |
| payeeId Mandatory | Unique employee code or payee code identification | String |
| nationalId Mandatory | Unique national identification details of the payee | String |
| basicSalary Mandatory | Basic salary amount of the payee | Numerical |
| housingAllowance Mandatory | Housing allowance amount of the payee | Numerical |
| otherAllowance Mandatory | Other allowance amount of the payee | Numerical |
| deduction Mandatory | Total deduction amount of the payee | Numerical |
| amount Mandatory | Total amount for the payee | Numerical |
| currency Mandatory | Currency representing the payee amount | String |
| remarks Optional | Remarks for payment to the payee | String |
Sample response
{
"svPayrollServiceRS": {
"company": [
{
"companyCode": "Company_Code",
"payroll": [
{
"acERPcode": "Account_ERP_Code",
"payrollPayId":"Payroll_Payment_ID",
"authId":"Authentication_ID",
"status": 0,
"message": "Status_Message",
"payeeDetails": [
{
"bankCode": "Bank_Code",
"payeeId": "Payee_ID"
},
{
"bankCode": "Bank_Code",
"payeeId": "Payee_ID"
},
{
"bankCode": "Bank_Code",
"payeeId": "Payee_ID"
}
]
}
]
}
]
}
}
Response description
| JSON Tag | Description | Data Type |
|---|---|---|
| svPayrollServiceRS | Tag carrying information on process response for payroll processing request | Object |
| company | Tag carrying information on company | Object |
| companyCode | Unique company identification code | Numerical |
| payroll | Tag carrying information on payroll payments in the response | Object |
| acERPcode | Unique ERP account code | Numerical |
| payrollPayId | Unique payroll payment identification details | String |
| authId | Unique authentication identification details | String |
| status | Status code of the response | Boolean |
| message | Status message description | String |
| payeeDetails | Tag carrying information on payee payment details in the response | Object |
| bankCode | Unique bank code identification | String |
| payeeId | Unique payee/employee identification | String |
Updated 3 months ago