Codelayer API Documentation

  • Introduction

    • General
    • Version History
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
      • Settings
    • HR Details

      • Employee Attendance
      • Employee Leave Summary
      • Employee List
      • Employee Payrevision
      • Employee Payroll
      • Employee Relieving
      • Employee TDS Calculated
      • Employee TDS Deducted
      • Employee Transfer
      • Employees Edited
    • Estate

      • Labor

        • Details
        • Register Face
      • Sync

        • Download Face File
        • Get Labor
        • Get Tasks
        • Post Muster
      • Authentication
      • Firm List
    • FrontOffice Poabs

      • Gatepass Save
    • Response Codes
Codelayer API Documentation
Employee Payroll

Payroll Details without TDS Amount

URL

hrdetails/emp_payroll

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
key String 32 32 M rfZJxCigwreTUnuEou7r4OfayYnhenCT Key obtained from authentiaction.
mnth Integer 1 12 M 11 Month
yer Integer 2016 2500 M 2019 Year
unitid Integer 1 M 45 Unit id from Firm List

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
payroll Array M Payroll details
companycode Integer 1 M 45 Unitid from Firm list
employeecode String 1 6 M 3110 Employee Code
payperiodcode Integer 1 M 2019110145 Reference Id
fromdate String 10 10 M 2019-11-01 From Date in YYYY-MM-DD format
todate String 10 10 M 2019-11-30 Till Date in YYYY-MM-DD format
earnedbasic Decimal M 14350.00 Earned Salary
earnedda Decimal M 0.00 Earned DA
earnedhra Decimal M 3587.00 Earned HRA
earnedcompositeallowance Decimal M 0.00 Earned Composite Allowance
earnedfoodallowance Decimal M 1000.00 Earned Food Allowance
earnedgasallowance Decimal M 0.00 Earned Gas Allowance
earnedmobileallowance Decimal M 0.00 Earned Mobile Allowance
earnedotherallowance Decimal M 0.00 Earned Other Allowance
earnedpetrolallowance Decimal M 0.00 Earned Petrol Allowance
earnedphoneallowance Decimal M 0.00 Earned Phone Allowance
earnedplantationallowance Decimal M 0.00 Earned Plantation Allowance
earnedservantallowance Decimal M 0.00 Earned Servant Allowance
earnedspecialallowance Decimal M 1062.00 Earned Special Allowance
earneduniformallowance Decimal M 0.00 Earned Uniform Allowance
earnedwashingallowance Decimal M 500.00 Earned Washing Allowance
earnededucationallowance Decimal M 0.00 Earned Education Allowance
earnedkitallowance Decimal M 0.00 Earned Kit Allowance
equipmentbata Decimal M 0.00 equipmentbata
lta Decimal M 0.00 LTA
medicalallowance Decimal M 0.00 Medical Allowance
nonpfarrear Decimal M 0.00 NON PF Arrear
advance Decimal M 0.00 Advance
loa Decimal M 0.00 LOAN
otherdeduct Decimal M 0.00 Other Deduction
pfarrear Decimal M 0.00 PF Arrear
esi Decimal M 150.00 ESI
pf Decimal M 0.00 PF
cpf Decimal M 0.00 CPF
bonus Decimal M 0.00 Bonus
leaveencashment Decimal M 0.00 Leave Encashment
incentive Decimal M 0.00 Incentive

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "mnth": "11",
    "yer": "2019",
    "unitid": "45"
}
Sample Success Response
{
    "payroll": [
        {
            "companycode": "45",
            "employeecode": "3110",
            "payperiodcode": "2019110145",
            "fromdate": "2019-11-01",
            "todate": "2019-11-30",
            "earnedbasic": "14350.00",
            "earnedda": "0.00",
            "earnedhra": "3587.00",
            "earnedcompositeallowance": "0.00",
            "earnedfoodallowance": "1000.00",
            "earnedgasallowance": "0.00",
            "earnedmobileallowance": "0.00",
            "earnedotherallowance": "0.00",
            "earnedpetrolallowance": "0.00",
            "earnedphoneallowance": "0.00",
            "earnedplantationallowance": "0.00",
            "earnedservantallowance": "0.00",
            "earnedspecialallowance": "1062.00",
            "earneduniformallowance": "0.00",
            "earnedwashingallowance": "500.00",
            "earnededucationallowance": "0.00",
            "earnedkitallowance": "0.00",
            "equipmentbata": "0.00",
            "lta": "0.00",
            "medicalallowance": "0.00",
            "nonpfarrear": "0.00",
            "advance": "0.00",
            "loa": "0.00",
            "otherdeduct": "0.00",
            "pfarrear": "0.00",
            "esi": "150.00",
            "pf": "0.00",
            "cpf": "0.00",
            "bonus": "0.00",
            "leaveencashment": "0.00",
            "incentive": "0.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}