GetNewStarterTemplate
GetNewStarterTemplate
Description:
Generates sample request for post new starter details API for given Company and EmployeeId that the requester is authorized to view.
Request:
https://dev02-api-gateway.moorepay.co.uk/workers/v1/Worker/GetNewStarterTemplate/{companyId}[?employeeId][&hrEmployeeId]
Request headers:
|
Name |
Required |
Type |
Description |
|
Authorization |
Yes |
string |
access token |
Request parameters:
|
Name |
In |
Required |
Type |
Description |
|
companyId |
template |
true |
string |
string[2] |
|
employeeId |
query |
false |
string |
string[6] |
|
hrEmployeeId |
query |
false |
string |
HR Employee Id |
Response example:
Response: 200 OK
{
"supplemental": {
"previousEmploymentLeavePeriod": 0,
"previousEmploymentWeekMonth": "string",
"p46Statement": "string",
"pensionerRecordOnly": "string",
"taxDistrict": "string",
"ospSchemeCode": "string",
"mainPensionSchemeCode": 0,
"mainPensionRefNumber": "string",
"secondPensionSchemeCode": 0,
"secondPensionRefNumber": "string",
"noOfPeriodsSuspended": 0,
"basePensPay": 0,
"studentIndicator":"string",
"payslipUseOPB": "string",
"resetOnlinePassword": "string",
"exPatInd": "string",
"pensionBereaveInd": "string",
"studentLoansP46Indicator": "string",
"pensionStartDate": "string",
"pensionLeaveDate": "string"
},
"deductions": [
{
"deduction": {
"companyCode": 0,
"employeeNumber": 0,
"paydeductionCode": 0,
"costCentre": "string",
"department": "string",
"occupationCode": 0,
"payOrDeduction": "string",
"gradeType1": 0,
"rate": 0,
"stdAmountavgEarnssp": 0,
"effectivePeriod": "string",
"stopMarker": "string",
"lastPayPeriod": "string",
"lastPayPdPrintd": "string",
"hoursTptotlContniemprContpenarrUpdtaoe": 0,
"amountThisPeriod": 0,
"taxYtdHrstotalCumniemprCumpenprtEarnaoe": 0,
"amountTaxYtdbalanceloan": 0,
"prtEarnCfaoelstdPiwsspcrValTph": 0,
"amountAcMtd": 0,
"lelErngsLuniarraoefixEerContpe": 0,
"amountAcQtd": 0,
"lelptErngsLuniwtDysssppriaoecrb": 0,
"amountAcYtd": 0,
"analysisProprtion": 0,
"cumYtdcrblPayCumholcloanAmtloanerngsYtd": 0,
"hrsUpdtprtEarnCfUpdtaoedaysPaidClrdssp": 0,
"amountLastUpdate": 0,
"differentialRate": 0,
"savedRate": 0,
"savedHours": 0,
"lelErngsYtdnierngsTpprsi": 0,
"lelptErngsYtdniwksTpprsi": 0,
"ptuelErngSYtdniersPayYtdpenclas": 0,
"uelErngsYtdnieesPayYtdpenerngs": 0,
"lelErngsTpniwksLuprsi": 0,
"lelptErngsTpniclassLuprsi": 0,
"ptuelErngSTpniersPayTppenwksYt": 0,
"uelErngsTpEePenPayTp": 0,
"ptuelErngsLuErPenPayLu": 0,
"uelErngsLuEePenPayLu": 0,
"autoPay": "string",
"employeeValue11": 0,
"payDeductionCodeDescription": "string"
},
"extension": {
"companyId": "string",
"employeeId": "string",
"payDeductionCode": 0,
"costCentre": "string",
"department": "string",
"occupationCode": 0,
"localAuthCode": "string",
"localAuthReference": "string",
"bankSortCode": 0,
"bankAccountNumber": 0,
"buildsocrefnumb": "string",
"referenceNumber": "string",
"exclusionPeriod": "string",
"reinstatePeriod": "string",
"bacsId": 0
}
}
],
"payments": [
{
"payment": {
"companyCode": 0,
"employeeNumber": 0,
"paydeductionCode": 0,
"costCentre": "string",
"department": "string",
"occupationCode": 0,
"payOrDeduction": "string",
"gradeType1": 0,
"rate": 0,
"stdAmountavgEarnssp": 0,
"effectivePeriod": "string",
"stopMarker": "string",
"lastPayPeriod": "string",
"lastPayPdPrintd": "string",
"hoursTptotlContniemprContpenarrUpdtaoe": 0,
"amountThisPeriod": 0,
"taxYtdHrstotalCumniemprCumpenprtEarnaoe": 0,
"amountTaxYtdbalanceloan": 0,
"prtEarnCfaoelstdPiwsspcrValTph": 0,
"amountAcMtd": 0,
"lelErngsLuniarraoefixEerContpe": 0,
"amountAcQtd": 0,
"lelptErngsLuniwtDysssppriaoecrb": 0,
"amountAcYtd": 0,
"analysisProprtion": 0,
"cumYtdcrblPayCumholcloanAmtloanerngsYtd": 0,
"hrsUpdtprtEarnCfUpdtaoedaysPaidClrdssp": 0,
"amountLastUpdate": 0,
"differentialRate": 0,
"savedRate": 0,
"savedHours": 0,
"lelErngsYtdnierngsTpprsi": 0,
"lelptErngsYtdniwksTpprsi": 0,
"ptuelErngSYtdniersPayYtdpenclas": 0,
"uelErngsYtdnieesPayYtdpenerngs": 0,
"lelErngsTpniwksLuprsi": 0,
"lelptErngsTpniclassLuprsi": 0,
"ptuelErngSTpniersPayTppenwksYt": 0,
"uelErngsTpEePenPayTp": 0,
"ptuelErngsLuErPenPayLu": 0,
"uelErngsLuEePenPayLu": 0,
"autoPay": "string",
"employeeValue11": 0,
"payDeductionCodeDescription": "string"
},
"effective": {
"companyNumber": 0,
"employeeNumber": 0,
"paydeductionCode": 0,
"payDeductionDescription": "string",
"startDate": "2021-04-08T09:23:35.404Z",
"endDate": "2021-04-08T09:23:35.404Z",
"periodAmount": 0,
"annualSalary": 0,
"basicHours": 0,
"periodActivated": "string"
}
}
],
"payrollCompanyCode": "string",
"idNumber": "string",
"hrEmployeeId": "string",
"title": "string",
"surname": "string",
"firstForename": "string",
"secondForename": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"postCode": "string",
"country": "string",
"dateOfBirth": "string",
"niNumber": "string",
"hmrcDocType": "string",
"taxCode": "string",
"taxCodePrefix": "string",
"niCode": "string",
"payType": "string",
"bankAccountNum": "string",
"sortCode": "string",
"bacsACName": "string",
"buildingSocRollNo": "string",
"positionID": "string",
"grade": "string",
"payslipPostOption": "string",
"partFull": "string",
"costCentre": "string",
"department": "string",
"occupationCode": 0,
"payPoint": "string",
"refField1": "string",
"refField2": "string",
"empActualWrkngPattern": "string",
"sspDaysPerWeek": 0,
"startDate": "string",
"basicHours": 0,
"contractDays": 0,
"workPhoneNo": "string",
"extension": "string",
"workMobilePhone": "string",
"homePhoneNumber": "string",
"personalMobileNumber": "string",
"personalMobileNumber2": "string",
"otherContactNumber": "string",
"personalEmailAddress": "string",
"businessEmailAddress": "string",
"maritalStatus": "string",
"gender": "string",
"normalHoursWorkedCode": "string",
"payPeriodDue": 0,
"sspQualifyingPattern": "string",
"annualSalary": 0,
"contServiceDate": "string",
"primaryCostCode": "string",
"secondaryCostCode": "string",
"payslipUseOPB": "string",
"taxMethod": "string",
"defermentDate": "string",
"defermentExpiryDate": "string",
"defermentEvidence": "string",
"proofOfAgeDateSuppl": "string",
"proofOfAgeEvidence": "string",
"director": "string",
"directorTaxWkStart": 0,
"payslipMessageLine1": "string",
"payslipMessageLine2": "string",
"previousEmploymentPayeReference": "string",
"previousGross": 0,
"previousTax": 0,
"previousEmploymentTaxCodeLastUsed": "string",
"previousEmploymentTaxBasisLastUsed": "string",
"pensionersAnnualPayment": 0,
"nestEnrolementDate": "string",
"nestOptOutDate": "string",
"activationDate": "string",
"irregularPayments": "string",
"paymentToANoneIndividual": "string",
"onStrike": "string",
"apprenticeshipStartDate": "string",
"apprenticeshipEndDate": "string",
"postGraduateLoan": "string",
"previousEmploymentDateOfLeaving": "string",
"workPeriodIntention": "string",
"typeOfPay": "string",
"autoPay": "string",
"leaveWorkPattern": "string",
"hourlyRate": 0,
"loanStartPeriod": "string",
"eeaCitizen": "string"
}
Response: 400 Bad Request
Bad Request
Response: 401 Unauthorized
Unauthorized
Response: 404 Not Found
Not Found
Response: 405 Method Not Allowed
Method Not Allowed
Response: 500 Internal Server Error
Internal Server Error
Created with the Personal Edition of HelpNDoc: Full-featured Kindle eBooks generator