Overview

SingleView Payroll Enquiry service connects you via a secure channel and enables you to enquire about the status of payroll transactions quickly and easily. The key feature of the service allows the user to get immediate acknowledgment about the most recent status of their payments.

📘
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

Payroll Payments Enquiry

Try in API Reference ➜

Endpoint details

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

Get Payroll Payments Enquiry

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svPayrollPayEnquiryService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"svPayrollPayEnquiryServiceRQ": {
  "company": [
    {
        "companyCode": "1234",
        "fromDate": "2025-04-14T15:56:49",
        "toDate": "2025-04-14T15:56:49",
        "transactionId": [
          "663268001", "663268002"
        ],
        "type": "payment"
      }
  ]
}
}'

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
svPayrollPayEnquiryServiceRQ Mandatory	Tag carrying information on request to process a payroll enquiry	Object
company Mandatory	Tag carrying information about the company for payroll transaction	Object
companyCode Mandatory	Unique company identification code Length of input: Min 3 Characters Max 20 Characters	Numerical
fromDate Mandatory	Initial date of the transaction period to be mentioned in `YYYY-MM-DDTHH:MM:SS` format	Date
toDate Mandatory	Final date of the transaction period to be mentioned in `YYYY-MM-DDTHH:MM:SS` format	Numerical
transactionId Mandatory	Unique identification details of the payroll transaction	Array of strings Numerical
type Mandatory	Type of payment to be mentioned as `payment`	String

Sample response

{
  "svPayrollPayEnquiryServiceRS": {
    "company": [
      {
        "companyCode": "1101",
        "payroll": [
          {
            "transactionId": "663268676",
            "description": "payroll payment",
            "dueDate": "2023-12-16T00:00:00.000Z",
            "currency": "SAR",
            "totalAmount": "10000",
            "payeesCount": 3,
            "txnDate": "2023-12-16T00:00:00.000Z",
            "status": 4,
            "approval_status": 2,
            "type": "payment",
            "payeeDetails": [
              {
                "payId": "",
                "authId": "666387499",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              },
              {
                "payId": "",
                "authId": "662422017",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              },
              {
                "payId": "",
                "authId": "667224345",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              }
            ]
          },
          {
            "transactionId": "669238928",
            "description": "payroll payment",
            "dueDate": "2023-12-16T00:00:00.000Z",
            "currency": "SAR",
            "totalAmount": "10000",
            "payeesCount": 3,
            "txnDate": "2023-12-16T00:00:00.000Z",
            "status": 4,
            "approval_status": 2,
            "type": "payment",
            "payeeDetails": [
              {
                "payId": "",
                "authId": "669222540",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              },
              {
                "payId": "",
                "authId": "661220957",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              },
              {
                "payId": "",
                "authId": "665611249",
                "seqNum": "",
                "svRefId": "",
                "amount": "1650",
                "currency": "SAR",
                "status": 4,
                "bankCharges": "N",
                "chargeAmount": "0"
              }
            ]
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svPayrollPayEnquiryServiceRS	Tag carrying information on process response for payroll enquiry request	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Alphanumeric
payroll	Tag carrying information on payroll payments in the response	Object
transactionId	Unique transaction identification details of the payment	Alphanumeric
description	Description of the payroll	String
dueDate	Scheduled date of payroll payments processing	Date
currency	Currency of the payroll payments	Alphabetic
totalAmount	Total amount for the payroll transactions	Numeric
payeesCount	Number of payees in the payroll transaction	Numeric
txnDate	Date of transaction of the payroll payments	Date
status	Status of the transaction	Numeric
approval_status	Approval status of the payroll	Numeric
type	Type of the transaction request as `payment`	String
payeeDetails	Tag carrying information on individual payees included in the payroll	Object
payId	Unique payment identification details of the individual payee included in the payroll	String
authId	Unique authentication identification details of the individual transactions	String
seqNum	Unique sequence number of the payroll payment	Alphanumeric
svRefId	Unique SingleView reference identification details	Alphanumeric
amount	Amount of the payroll payment	Numeric
currency	Currency of the payment for payee	Alphabetic
status	Status of the transaction	Numeric
bankCharges	Details if any bank charges are applied for the transaction	Alphabetic
chargeAmount	Amount representing the bank charges	Numeric