GET api/PayrollGeneration/LockPayrollPeriod?CPMClientID={CPMClientID}&CPMUserName={CPMUserName}&CompCode={CompCode}&PayrollArea={PayrollArea}&PayrollLockStatus={PayrollLockStatus}

Request Information

URI Parameters

Name	Type	Additional information
CPMClientID	string	Required
CPMUserName	string	Required
CompCode	string	Required
PayrollArea	string	Required
PayrollLockStatus	string	Required

Body Parameters

None.

Response Information

Resource Description

PayrollGenerationResponse

Name	Type	Additional information
EmpRemunarationList	Collection of EmployeeRemunaration	None.
WageDetailsList	Collection of WageDetails	None.
EmployeeDataList	Collection of WageEmployee	None.
listOfPreviousRecords	Collection of AppDowndowns	None.
PayrollLockList	Collection of PayrollLock	None.
ScreenCntrlList	string	None.
listOfWageTypesJson	string	None.
EmployeeList	string	None.
DepartmentList	string	None.
PaymentCategoryList	string	None.
PaymentTypeList	string	None.
CompanyList	string	None.
PayrollAreaList	string	None.
YearsList	Collection of AppDowndowns	None.
MonthsList	Collection of AppDowndowns	None.
Exists	string	None.
Currency	string	None.
Message	string	None.
Status	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EmpRemunarationList": [
    {
      "Id": 1,
      "ERID": 2,
      "DeptId": "sample string 3",
      "CompanyCode": "sample string 4",
      "PayrollArea": "sample string 5",
      "EmployeeId": "sample string 6",
      "StartDate": "sample string 7",
      "EndDate": "sample string 8",
      "OldStartDate": "sample string 9",
      "Currency": "sample string 10",
      "CTC": "sample string 11",
      "MonthCTC": "sample string 12",
      "Document": "sample string 13",
      "CreatedBy": "sample string 14",
      "CreatedDate": "sample string 15",
      "ModifiedBy": "sample string 16",
      "ModifiedDate": "sample string 17",
      "Status": true,
      "Revise": true,
      "Flag": "sample string 20",
      "Total_Amount": "sample string 21",
      "IsPayrollGenerated": true,
      "PreviousRecords": [
        {
          "ID": "sample string 1",
          "Value": "sample string 2",
          "DefaultValue": true
        },
        {
          "ID": "sample string 1",
          "Value": "sample string 2",
          "DefaultValue": true
        }
      ],
      "Year": "sample string 23",
      "Month": "sample string 24",
      "Addition": "sample string 25",
      "Deduction": "sample string 26",
      "Adjustments": "sample string 27",
      "TotalPay": "sample string 28"
    },
    {
      "Id": 1,
      "ERID": 2,
      "DeptId": "sample string 3",
      "CompanyCode": "sample string 4",
      "PayrollArea": "sample string 5",
      "EmployeeId": "sample string 6",
      "StartDate": "sample string 7",
      "EndDate": "sample string 8",
      "OldStartDate": "sample string 9",
      "Currency": "sample string 10",
      "CTC": "sample string 11",
      "MonthCTC": "sample string 12",
      "Document": "sample string 13",
      "CreatedBy": "sample string 14",
      "CreatedDate": "sample string 15",
      "ModifiedBy": "sample string 16",
      "ModifiedDate": "sample string 17",
      "Status": true,
      "Revise": true,
      "Flag": "sample string 20",
      "Total_Amount": "sample string 21",
      "IsPayrollGenerated": true,
      "PreviousRecords": [
        {
          "ID": "sample string 1",
          "Value": "sample string 2",
          "DefaultValue": true
        },
        {
          "ID": "sample string 1",
          "Value": "sample string 2",
          "DefaultValue": true
        }
      ],
      "Year": "sample string 23",
      "Month": "sample string 24",
      "Addition": "sample string 25",
      "Deduction": "sample string 26",
      "Adjustments": "sample string 27",
      "TotalPay": "sample string 28"
    }
  ],
  "WageDetailsList": [
    {
      "WID": 1,
      "WageType": "sample string 2",
      "PaymentCategory": "sample string 3",
      "Description": "sample string 4",
      "Amount": "sample string 5",
      "Total_Amount": "sample string 6",
      "ERID": 7,
      "CreatedBy": "sample string 8",
      "ADStatus": "sample string 9",
      "CreatedDate": "sample string 10",
      "ModifiedBy": "sample string 11",
      "ModifiedDate": "sample string 12",
      "IsModified": 13
    },
    {
      "WID": 1,
      "WageType": "sample string 2",
      "PaymentCategory": "sample string 3",
      "Description": "sample string 4",
      "Amount": "sample string 5",
      "Total_Amount": "sample string 6",
      "ERID": 7,
      "CreatedBy": "sample string 8",
      "ADStatus": "sample string 9",
      "CreatedDate": "sample string 10",
      "ModifiedBy": "sample string 11",
      "ModifiedDate": "sample string 12",
      "IsModified": 13
    }
  ],
  "EmployeeDataList": [
    {
      "EmployeeName": "sample string 1",
      "EmployeeNo": "sample string 2",
      "Department": "sample string 3",
      "Designation": "sample string 4",
      "Location": "sample string 5",
      "Totaldays": "sample string 6",
      "LOP": "sample string 7",
      "EffectiveWorkingDays": "sample string 8"
    },
    {
      "EmployeeName": "sample string 1",
      "EmployeeNo": "sample string 2",
      "Department": "sample string 3",
      "Designation": "sample string 4",
      "Location": "sample string 5",
      "Totaldays": "sample string 6",
      "LOP": "sample string 7",
      "EffectiveWorkingDays": "sample string 8"
    }
  ],
  "listOfPreviousRecords": [
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    },
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    }
  ],
  "PayrollLockList": [
    {
      "Id": 1,
      "LastStartDate": "sample string 2",
      "LastEndDate": "sample string 3",
      "CurrentStartDate": "sample string 4",
      "CurrentEndDate": "sample string 5",
      "PayrollLockStatus": "sample string 6",
      "Status": "sample string 7",
      "CreatedBy": "sample string 8",
      "CreatedDate": "sample string 9",
      "UpdatedBy": "sample string 10",
      "UpdatedDate": "sample string 11"
    },
    {
      "Id": 1,
      "LastStartDate": "sample string 2",
      "LastEndDate": "sample string 3",
      "CurrentStartDate": "sample string 4",
      "CurrentEndDate": "sample string 5",
      "PayrollLockStatus": "sample string 6",
      "Status": "sample string 7",
      "CreatedBy": "sample string 8",
      "CreatedDate": "sample string 9",
      "UpdatedBy": "sample string 10",
      "UpdatedDate": "sample string 11"
    }
  ],
  "ScreenCntrlList": "sample string 1",
  "listOfWageTypesJson": "sample string 2",
  "EmployeeList": "sample string 3",
  "DepartmentList": "sample string 4",
  "PaymentCategoryList": "sample string 5",
  "PaymentTypeList": "sample string 6",
  "CompanyList": "sample string 7",
  "PayrollAreaList": "sample string 8",
  "YearsList": [
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    },
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    }
  ],
  "MonthsList": [
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    },
    {
      "ID": "sample string 1",
      "Value": "sample string 2",
      "DefaultValue": true
    }
  ],
  "Exists": "sample string 9",
  "Currency": "sample string 10",
  "Message": "sample string 11",
  "Status": "sample string 12"
}

text/plain

Sample:

{"EmpRemunarationList":[{"Id":1,"ERID":2,"DeptId":"sample string 3","CompanyCode":"sample string 4","PayrollArea":"sample string 5","EmployeeId":"sample string 6","StartDate":"sample string 7","EndDate":"sample string 8","OldStartDate":"sample string 9","Currency":"sample string 10","CTC":"sample string 11","MonthCTC":"sample string 12","Document":"sample string 13","CreatedBy":"sample string 14","CreatedDate":"sample string 15","ModifiedBy":"sample string 16","ModifiedDate":"sample string 17","Status":true,"Revise":true,"Flag":"sample string 20","Total_Amount":"sample string 21","IsPayrollGenerated":true,"PreviousRecords":[{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true},{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true}],"Year":"sample string 23","Month":"sample string 24","Addition":"sample string 25","Deduction":"sample string 26","Adjustments":"sample string 27","TotalPay":"sample string 28"},{"Id":1,"ERID":2,"DeptId":"sample string 3","CompanyCode":"sample string 4","PayrollArea":"sample string 5","EmployeeId":"sample string 6","StartDate":"sample string 7","EndDate":"sample string 8","OldStartDate":"sample string 9","Currency":"sample string 10","CTC":"sample string 11","MonthCTC":"sample string 12","Document":"sample string 13","CreatedBy":"sample string 14","CreatedDate":"sample string 15","ModifiedBy":"sample string 16","ModifiedDate":"sample string 17","Status":true,"Revise":true,"Flag":"sample string 20","Total_Amount":"sample string 21","IsPayrollGenerated":true,"PreviousRecords":[{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true},{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true}],"Year":"sample string 23","Month":"sample string 24","Addition":"sample string 25","Deduction":"sample string 26","Adjustments":"sample string 27","TotalPay":"sample string 28"}],"WageDetailsList":[{"WID":1,"WageType":"sample string 2","PaymentCategory":"sample string 3","Description":"sample string 4","Amount":"sample string 5","Total_Amount":"sample string 6","ERID":7,"CreatedBy":"sample string 8","ADStatus":"sample string 9","CreatedDate":"sample string 10","ModifiedBy":"sample string 11","ModifiedDate":"sample string 12","IsModified":13},{"WID":1,"WageType":"sample string 2","PaymentCategory":"sample string 3","Description":"sample string 4","Amount":"sample string 5","Total_Amount":"sample string 6","ERID":7,"CreatedBy":"sample string 8","ADStatus":"sample string 9","CreatedDate":"sample string 10","ModifiedBy":"sample string 11","ModifiedDate":"sample string 12","IsModified":13}],"EmployeeDataList":[{"EmployeeName":"sample string 1","EmployeeNo":"sample string 2","Department":"sample string 3","Designation":"sample string 4","Location":"sample string 5","Totaldays":"sample string 6","LOP":"sample string 7","EffectiveWorkingDays":"sample string 8"},{"EmployeeName":"sample string 1","EmployeeNo":"sample string 2","Department":"sample string 3","Designation":"sample string 4","Location":"sample string 5","Totaldays":"sample string 6","LOP":"sample string 7","EffectiveWorkingDays":"sample string 8"}],"listOfPreviousRecords":[{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true},{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true}],"PayrollLockList":[{"Id":1,"LastStartDate":"sample string 2","LastEndDate":"sample string 3","CurrentStartDate":"sample string 4","CurrentEndDate":"sample string 5","PayrollLockStatus":"sample string 6","Status":"sample string 7","CreatedBy":"sample string 8","CreatedDate":"sample string 9","UpdatedBy":"sample string 10","UpdatedDate":"sample string 11"},{"Id":1,"LastStartDate":"sample string 2","LastEndDate":"sample string 3","CurrentStartDate":"sample string 4","CurrentEndDate":"sample string 5","PayrollLockStatus":"sample string 6","Status":"sample string 7","CreatedBy":"sample string 8","CreatedDate":"sample string 9","UpdatedBy":"sample string 10","UpdatedDate":"sample string 11"}],"ScreenCntrlList":"sample string 1","listOfWageTypesJson":"sample string 2","EmployeeList":"sample string 3","DepartmentList":"sample string 4","PaymentCategoryList":"sample string 5","PaymentTypeList":"sample string 6","CompanyList":"sample string 7","PayrollAreaList":"sample string 8","YearsList":[{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true},{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true}],"MonthsList":[{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true},{"ID":"sample string 1","Value":"sample string 2","DefaultValue":true}],"Exists":"sample string 9","Currency":"sample string 10","Message":"sample string 11","Status":"sample string 12"}