Create a Payroll

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, and signature
The request should be in the specified format
The request should include all the mandatory details with appropriate request tags

Endpoint details

Endpoint URL	Method	Grant type
`/v1/api/erp/svPayrollService`	POST	`clientid` `clientsecret` `signature`

Validation requirement

A minimum of 3 payment entries are required to process a payroll request
Value of the basicSalary tag cannot be 0
Only KSA-based bank accounts can be included under the beneficiary accounts in the payroll
payeeId must be unique for all the transactions

Sample 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 details Length of input: Min 3 Characters Max 20 Characters	String
clientsecret Mandatory	Unique client identification secret code Length of input: Min 3 Characters Max 20 Characters	String
signature Mandatory	64-Bit string obtained by processing client signature key through Base-64 and SHA-256	String
svPayrollServiceRQ Mandatory	Tag carrying information on request to process a payroll	Object
company Mandatory	Tag carrying information about the company	Object
companyCode Mandatory	Unique company identification code Length of input: Min 3 Characters Max 20 Characters	String
payroll Mandatory	Tag carrying information on payroll details in the request	Object
acERPcode Mandatory	Unique account ERP identification code Min: 9 Characters	Alphanumeric
amount Mandatory	Total amount of the payroll	Numerical
currency Mandatory	Currency representing the payroll amount	String
description Mandatory	Description of the payroll Length of input: Min 3 Characters Max 20 Characters	String
dueDate Mandatory	Due date for processing the payroll in `YYYY-MM-DDTHH:MM:SSZ` format	Date
userName Mandatory	Unique user identification details Length of input: Min 3 Characters Max 20 Characters	String
payrollPayId Mandatory	Unique payroll payment identification Length of input: Min 3 Characters Max 20 Characters	String
payeeDetails Mandatory	Tag carrying information of payees included in the payroll request	Object
bankCode Mandatory	Unique bank identification code Length of input: Min 3 Characters Max 20 Characters	Stringt
iban Mandatory	Unique international bank account number	String
name Mandatory	Name of the payee Length of input: Min 3 Characters Max 35 Characters	String
payeeId Mandatory	Unique employee code or payee code identification Length of input: Min 3 Characters Max 20 Characters	String
nationalId Mandatory	Unique national identification details of the payee Length of input: 10 Digits	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 Length of input: Min 3 Characters Max 20 Characters	String

Sample response

Success Payroll Scenario

{
  "svPayrollServiceRS": {
    "company": [
      {
        "companyCode": "Company_Code",
        "payroll": [
          {
            "acERPcode": "Account_ERP_Code",
            "payrollPayId":"Payroll_Payment_ID",
            "transactionId":"Transacation_ID",
            "status": 0,
            "message": "Status_Message"}
        ]
      }
    ]
  }
}

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	String
payroll	Tag carrying information on payroll payments in the response	Object
acERPcode	Unique ERP account code	Alphanumeric
payrollPayId	Unique payroll payment identification details	String
transactionId	Unique transaction identification details	String
status	Status code of the payroll response	Boolean
message	Status message payroll response description	String
Tags appearing for failed payments scenario
payeeDetails	Tag carrying information on payee payment details in the response	Object
bankCode	Unique bank code identification	String
payeeId	Unique payee/employee identification	String
status	Status code of the payroll payment	Numeric
message	Status message payroll payment description	String

Categories

Getting started

Authentication

ERP API Services

Create a Payroll

Create a Payroll

Endpoint details

Sample request

Sample response