Fetch Salary Slip
Introduction
Our Salary Extraction API offers a comprehensive solution for extracting and analyzing salary details from employee pay slips. Designed for seamless integration, this API captures essential payroll information and presents it in a structured format. Whether you're automating payroll management or conducting financial assessments, this API delivers accurate and detailed salary data for your needs.
Key Features:
- Employee Information: Extracts key details such as employee name, designation, and employer information.
- Compensation Breakdown: Provides a clear breakdown of net salary, gross salary, and detailed deductions including EPF, ESI, Professional Tax, and other deductions.
- Employment Details: Includes essential employment data like work location, date of joining, and salary credit month.
- Tax and Identification: Captures critical identifiers such as PAN and UAN numbers.
- Payment Structure: Outlines the basic salary, HRA, and mode of payment, ensuring a complete picture of the salary structure.
Sample cURL:
curl --location 'https://api-preproduction.signzy.app/api/v3/fetch/salary-slip' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data '{
"requestId": ""
}'Request headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Request body parameters
Parameter | Data type | Description | Required |
|---|---|---|---|
requestId | String | Unique requestId generated in the response of the first API | Mandatory |
{
"requestId": "6958d5b3-3363-4303-a896-e30d611f0d0a"
}Response body parameters
Parameter | Data Type | Description |
|---|---|---|
result | Object | Contains message and salary slip details extracted from the salary slip |
result.message | String | Summary message showing number of slips extracted. |
result.salarySlip | Array<Object> | Array of salary slip objects, each grouped by month. |
<MONTH YEAR> (e.g., "MAR 2023") | Object | Month-wise salary slip details. |
employeeName | String | Name of the employee. |
employeeId | String | Employer-assigned employee ID. |
designation | String | Job title/role of employee. |
department | String | Department of employee. |
pan | String | Employee’s PAN number. |
uan | String | Universal Account Number (EPFO). |
bankAccountNo | String | Salary bank account number. |
companyName | String | Employer company name. |
companyAddress | String | Company’s registered address. |
taxIdentificationNumber | String | Company’s TIN/TAN for tax purposes. |
employerProvidentFundAccountNumber | String | Employer’s EPFO PF account number. |
dateOfJoining | String | Employee’s joining date (DD/MM/YYYY); empty if unavailable. |
earnings | Object | Earnings breakup. |
earnings.basic | String | Basic salary. |
earnings.hra | String | House Rent Allowance (HRA). |
earnings.medicalExpenses | String | Medical allowance/benefits. |
earnings.conveyanceAllowance | String | Travel/transport allowance. |
earnings.educationAllowance | String | Education allowance for employee. |
earnings.personalAllowance | String | Personal/special allowance. |
deductions | Object | Breakup of all deductions applied. |
deductions.pfContribution | String | Employee PF contribution. |
deductions.esiContribution | String | Employee ESI contribution. |
deductions.professionalTax | String | Professional tax. |
deductions.mlwf | String | Maharashtra Labour Welfare Fund deduction. |
deductions.adjustmentAmount | String | Adjustments (positive/negative). |
deductions.tds | String | TDS/Income tax deduction. |
deductions.lossOfPayAbsence | String | Loss-of-pay deduction based on absences. |
deductions.advanceLoan | String | Repayment of advance/loan taken from employer. |
deductions.otherRecovery | String | Any other miscellaneous recovery/deduction. |
payMonthAndYear | String | Salary period month and year (e.g., "APR 2025"). |
payPeriod | String | Number of payable days in the month. |
grossEarnings | String | Total earnings before deductions. |
totalDeductions | String | Total of all deductions. |
netPay | String | Final take-home salary after deductions. |
Sample Status Codes And Messages
{
"result": {
"message": "1 salary slips found in 1 pages",
"salarySlip": [
{
"APR 2025": {
"employeeName": "Rohit Verma",
"employeeId": "EMP458721",
"designation": "Senior Software Engineer",
"department": "Engineering",
"pan": "AQDPV6721K",
"uan": "101998772345",
"bankAccountNo": "123456789012",
"companyName": "TechNova Innovations Pvt Ltd",
"companyAddress": "Plot 14, Cyber Heights, Sector 62, Noida, Uttar Pradesh - 201309",
"taxIdentificationNumber": "TAN12345A",
"employerProvidentFundAccountNumber": "DL/12345/678900",
"dateOfJoining": "15/07/2021",
"earnings": {
"basic": "52000.00",
"hra": "26000.00",
"medicalExpenses": "1500.00",
"conveyanceAllowance": "2000.00",
"educationAllowance": "500.00",
"personalAllowance": "8500.00"
},
"deductions": {
"pfContribution": "6240.00",
"esiContribution": "0.00",
"professionalTax": "200.00",
"mlwf": "0.00",
"adjustmentAmount": "0.00",
"tds": "4500.00",
"lossOfPayAbsence": "0.00",
"advanceLoan": "0.00",
"otherRecovery": "0.00"
},
"payMonthAndYear": "APR 2025",
"payPeriod": "30",
"grossEarnings": "90500.00",
"totalDeductions": "10940.00",
"netPay": "79560.00"
}
}
]
}
}