PostNewStarter
PostNewStarter
Description:
Inserts submitted new worker complete details if requester is authorized to do so.
Request:
https://dev02-api-gateway.moorepay.co.uk/workers/v1/Worker/PostNewStarter
Request headers:
|
Name |
Required |
Type |
Description |
|
Authorization |
Yes |
string |
access token |
Request body:
{
"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"
}
Additional Information:
Employee model
|
Field Name |
Comment |
|
payrollCompanyCode |
|
|
idNumber |
Blank if, Autogenerate is configured for given company or else its Mandatory |
|
hrEmployeeId |
|
|
title |
|
|
surname |
|
|
firstForename |
|
|
secondForename |
|
|
addressLine1 |
|
|
addressLine2 |
|
|
addressLine3 |
Not Mandatory, But need to be passed blank. If not available |
|
addressLine4 |
Not Mandatory, But need to be passed blank. If not available |
|
postCode |
Not Mandatory, But need to be passed blank. If not available |
|
dateOfBirth |
Format yyyy-MM-dd |
|
niNumber |
|
|
hmrcDocType |
Must be between 1-6 |
|
taxCode |
-Default can be passed as “0T” -Mandatory,If HMRCDocType="1" or "2" and Supplemental.P46Statement is A/B/C -Mandatory,If HMRCdoctype="4" or "5" or "6" then Taxcode is Mandatory |
|
taxCodePrefix |
If Passed, then it should be S/C |
|
niCode |
Default 'A' |
|
payType |
Can be passed as B/C/S |
|
bankAccountNum |
Mandatory, if PayType is B/S |
|
sortCode |
Mandatory, if PayType is B/S |
|
bacsACName |
Mandatory, if PayType is B/S |
|
buildingSocRollNo |
Mandatory, if PayType is S |
|
bankAccountNo2 |
|
|
sortCode2 |
|
|
bacsACName2 |
|
|
buildingSocRollNo2 |
|
|
positionID |
Client provide - Or default '9998' |
|
grade |
|
|
paySlipPostOption |
Default of 'XXXX' with 'POST' 'ENV' valid options |
|
partFull |
|
|
costCentre |
|
|
department |
|
|
occupationCode |
|
|
payPoint |
|
|
refField1 |
|
|
refField2 |
|
|
empActualWrkngPattern |
Default “-YYYYY-” |
|
daysWorkedPerWeek |
|
|
startDate |
Date format yyyy-MM-dd |
|
basicHours |
Mandatory, If typeofPay is A/H; Default 37.5 |
|
annualHours |
|
|
workPhoneNo |
|
|
extension |
|
|
workMobilePhone |
|
|
homePhoneNumber |
|
|
personalMobileNumber |
|
|
personalMobileNumber2 |
|
|
otherContactNumber |
|
|
personalEmailAddress |
|
|
businessEmailAddress |
|
|
maritalStatus |
Can be passed C/D/M/S/W |
|
gender |
|
|
leaveDate |
Date format yyyy-MM-dd |
|
periodOfLeaving |
|
|
yearOfLeaving |
|
|
leaveReasonCode |
|
|
normalHoursWorkedCode |
If Passed, then it should be A/B/C/D/E |
|
payPeriodDue |
Range(0.0, 99.99) |
|
sspQualifyingPattern |
Default “-YYYYY-” |
|
annualSalary |
Mandatory,If typeofPay is A |
|
contServiceDate |
Date format yyyy-MM-dd |
|
primaryCostCode |
|
|
secondaryCostCode |
|
|
payslipUseOPB |
|
|
taxMethod |
|
|
defermentDate |
Mandatory, if NiCode is J/Z |
|
defermentExpiryDate |
Mandatory, if NiCode is J/Z |
|
defermentEvidence |
Mandatory, if NiCode is B/J/Z |
|
proofOfAgeDateSuppl |
Mandatory, if NiCode is C/M/H |
|
proofOfAgeEvidence |
Mandatory, if NiCode is C/M/H |
|
director |
|
|
directorTaxWkStart |
if Director=Y or P, then value should be below 8 |
|
payslipMessageLine1 |
|
|
payslipMessageLine2 |
|
|
previousEmploymentPayeReference |
Mandatory, If HmrcDocType=”1” |
|
previousGross |
Should be 0, when HMRCDoctype=”1” and PreviousEmploymentTaxBasisLastUsed=”1” |
|
previousTax |
|
|
previousEmploymentTaxCodeLastUsed |
Mandatory, If HmrcDocType=”1” |
|
previousEmploymentTaxBasisLastUsed |
|
|
pensionersAnnualPayment |
Mandatory, when HMRCdoctype=”1” and Supplemental.PensionerRecordOnly=”Y” or If HMRCDoctype=”6" |
|
nestEnrolementDate |
|
|
nestOptOutDate |
|
|
activationDate |
|
|
irregularPayments |
|
|
paymentToANoneIndividual |
|
|
onStrike |
|
|
apprenticeshipStartDate |
|
|
apprenticeshipEndDate |
|
|
postGraduateLoan |
|
|
previousEmploymentDateOfLeaving |
Mandatory, If HMRCDocType=”1” |
|
workPeriodIntention |
Mandatory, If HMRCDocType=”3” |
|
typeOfPay |
Default "A" as more employees likely to be 0-15 hours, Can be passed as "A", "H", "O" |
|
autoPay |
Mandatory, if typeofPay is H |
|
leaveWorkPattern |
|
|
hourlyRate |
Mandatory, If typeofPay=H |
|
loanStartPeriod |
|
|
eeaCitizen |
Mandatory, If WorkPeriodIntention=I/O |
Supplemental model (This model is Mandatory, If HMRCDocType=”1”)
|
Field Name |
Comment |
|
PreviousEmploymentLeavePeriod |
Mandatory, If HmrcDocType=”1” |
|
PreviousEmploymentWeekMonth |
If passed, then must be M/W |
|
P46Statement |
If HMRCDocType=”1” or “2” then can be passed as A/B/C |
|
PensionerRecordOnly |
If HMRCDocType=”1” or “2” then can be passed as Y or blank |
|
TaxDistrict |
Mandatory, If HmrcDocType=”1” |
|
PensionStartDate |
Format yyyy-mm-dd |
|
PensionLeaveDate |
Format yyyy-mm-dd |
*Fields marked red and bold are mandatory.
Response example:
Response: 200 OK
{ "responseMessage": "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: Revolutionize Your Documentation Output with HelpNDoc's Stunning User Interface