action payrun_get_employee_from_employer { label: "Get employee from employer" description: "Gets the specified employee from employer by employee code." provider: payrun method: GET path: "/Employer/{EmployerId}/Employee/{EmployeeId}" encoding: json input: { type: "object" properties: { "Api-Version": { type: "string" format: "string" } Authorization: { type: "string" format: "string" } EmployeeId: { type: "string" } EmployerId: { type: "string" } } required: ["Api-Version", "Authorization", "EmployeeId", "EmployerId"] additionalProperties: false } output: { type: "object" properties: { Employee: { type: "object" properties: { AEAssessmentOverride: { type: "string" description: "The employees' a e assessment override" enum: ["None", "OptOut", "OptIn", "VoluntaryJoiner", "ContractualPension", "CeasedMembership", "Leaver", "Excluded"] } AEAssessmentOverrideDate: { type: "string" format: "date" description: "The employees' a e assessment override date" } AEExclusionReasonCode: { type: "string" description: "The employees' a e exclusion reason code" enum: ["OtherNotKnown", "NotAWorker", "NotUKWorker", "TemporaryUKWorker", "OutsideAgeRange", "SingleEmployeeDirector", "CeasedMembershipWithin12Months", "CeasedMembershipBeyond12Months", "WorkerWULSWithin12Month", "WorkerWULSBeyond12Month", "WorkerInNoticePeriod", "WorkerTaxProtection"] } AEPostponementDate: { type: "string" format: "date" description: "The employees' a e postponement date" } Address: { type: "object" description: "The employees' address" properties: { Address1: { type: "string" description: "The addresss' line 1" } Address2: { type: "string" description: "The addresss' line 2" } Address3: { type: "string" description: "The addresss' line 3" } Address4: { type: "string" description: "The addresss' line 4" } Country: { type: "string" description: "The addresss' country" } Postcode: { type: "string" description: "The addresss' postcode" } } } BankAccount: { type: "object" description: "The employees' bank account" properties: { AccountName: { type: "string" description: "The bank accounts' account name" } AccountNumber: { type: "string" description: "The bank accounts' account number" } BranchName: { type: "string" description: "The bank accounts' branch name" } Reference: { type: "string" description: "The bank accounts' reference" } SortCode: { type: "string" description: "The bank accounts' sort code" } } } Code: { type: "string" description: "The employees' code" } DateOfBirth: { type: "string" format: "date" description: "The employees' date of birth" } Deactivated: { type: "boolean" description: "The employees' deactivated" } DirectorshipAppointmentDate: { type: "string" format: "date" description: "The employees' directorship appointment date" } EEACitizen: { type: "boolean" description: "The employees' e e a citizen" } EPM6: { type: "boolean" description: "The employees' e p m6" } EffectiveDate: { type: "string" format: "date" description: "The employees' effective date" } EmployeePartner: { type: "object" description: "The employees' employee partner" properties: { FirstName: { type: "string" description: "The employee partners' first name" } Initials: { type: "string" description: "The employee partners' initials" } LastName: { type: "string" description: "The employee partners' last name" } MiddleName: { type: "string" description: "The employee partners' middle name" } NiNumber: { type: "string" description: "The employee partners' ni number" } } } FirstName: { type: "string" description: "The employees' the first name" } Gender: { type: "string" description: "The employees' gender" enum: ["Unknown", "Male", "Female"] } HoursPerWeek: { type: "number" format: "double" description: "The employees' hours per week" } Initials: { type: "string" description: "The employees' initials" } IrregularEmployment: { type: "boolean" description: "The employees' irregular employment" } IsAgencyWorker: { type: "boolean" description: "The employees' is agency worker" } LastName: { type: "string" description: "The employees' last name" } LeaverReason: { type: "string" description: "The employees' leaver reason" enum: ["Resigned", "Dismissed", "Redundant", "Retired", "Deceased", "LegalCustody", "Other"] } LeavingDate: { type: "string" format: "date" description: "The employees' leaving date" } MaritalStatus: { type: "string" description: "The employees' marital status" enum: ["NotSet", "Single", "Married", "Divorced", "Widowed"] } MetaData: { type: "object" description: "The employees' meta data" properties: {} } MiddleName: { type: "string" description: "The employees' middle name" } NextRevisionDate: { type: "string" format: "date" description: "The employees' next revision date" } NiNumber: { type: "string" description: "The employees' ni number" } NicLiability: { type: "string" description: "The employees' nic liability" enum: ["HasOtherJob", "IsFemaleEntitledToReducedRate", "IsNotLiable", "IsContractedOut", "IsFullyLiable", "IsApprentice", "LeaverBeyond6Weeks", "PaymentAfterLeavingIrregular", "IsFreePortWorker", "IsNotLiableForEmployerNi"] } OffPayrollWorker: { type: "boolean" description: "The employees' off payroll worker" } OnStrike: { type: "boolean" description: "The employees' on strike" } P45IssuedDate: { type: "string" format: "date" description: "The employees' p45 issued date" } PassportNumber: { type: "string" description: "The employees' passport number" } PaySchedule: { type: "object" description: "The employees' pay schedule" properties: { "@href": { type: "string" description: "The links' href" } "@rel": { type: "string" description: "The links' target type" } "@title": { type: "string" description: "The links' title" } } } PaymentMethod: { type: "string" description: "The employees' payment method" enum: ["NotSet", "Cash", "Cheque", "BACS", "FasterPayments", "Other"] } PaymentToANonIndividual: { type: "boolean" description: "The employees' payment to a non individual" } Region: { type: "string" description: "The employees' region" enum: ["NotSet", "England", "Scotland", "Wales"] } Revision: { type: "integer" format: "int32" description: "The employees' revision" } RuleExclusions: { type: "string" description: "The employees' rule exclusions" enum: ["None", "NiMissingPayInstructionRule", "TaxMissingPayInstructionRule", "TaxCodeUpliftRule", "NiSetExpectedLetterRule", "NiDateOfBirthChangeRetrospectiveCRule", "NiDefermentStatusChangeRule", "NiEndContractedOutTransferRule", "PaymentAfterLeavingTaxCodeRule", "LeaverEndInstructionsRule", "P45StudentLoanInstructionRule", "P45TaxInstructionRule", "P45YtdTaxRule", "YtdInstructionRule", "TaxCodeRegionChangeRule", "AutoEnrolmentStatusChangeRule", "EmployeeDeceasedRule", "BenefitInstructionAutoEndRule"] } Seconded: { type: "string" description: "The employees' seconded" enum: ["NotSet", "Stay183DaysOrMore", "StayLessThan183Days", "InOutUk"] } StartDate: { type: "string" format: "date" description: "The employees' start date" } StarterDeclaration: { type: "string" description: "The employees' starter declaration" enum: ["PreviouslyReported", "A", "B", "C"] } Territory: { type: "string" description: "The employees' territory" enum: ["UnitedKingdom"] } Title: { type: "string" description: "The employees' title" } VeteranPeriodStartDate: { type: "string" format: "date" description: "The employees' veteran period start date" } WorkingWeek: { type: "string" description: "The employees' working week" enum: ["None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "AllWeekDays", "Saturday", "Sunday", "AllDays"] } } } } } }