action payrun_get_employer_revision_by_number { label: "Gets the employer by revision number" description: "Get the employer revision matching the specified revision number" provider: payrun method: GET path: "/Employer/{EmployerId}/Revision/{RevisionNumber}" encoding: json input: { type: "object" properties: { "Api-Version": { type: "string" format: "string" } Authorization: { type: "string" format: "string" } EmployerId: { type: "string" } RevisionNumber: { type: "string" format: "int32" } } required: ["Api-Version", "Authorization", "EmployerId", "RevisionNumber"] additionalProperties: false } output: { type: "object" properties: { Employer: { type: "object" properties: { Address: { type: "object" description: "The employers' 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" } } } ApprenticeshipLevyAllowance: { type: "number" format: "double" description: "The employers' apprenticeship levy allowance" } AutoEnrolment: { type: "object" description: "The employers' auto enrolment" properties: { Pension: { type: "object" description: "The employer auto enrolments' pension" properties: { "@href": { type: "string" description: "The links' href" } "@rel": { type: "string" description: "The links' target type" } "@title": { type: "string" description: "The links' title" } } } PostponementDate: { type: "string" format: "date" description: "The employer auto enrolments' postponement date" } PrimaryAddress: { type: "object" description: "The employer auto enrolments' primary 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" } } } PrimaryEmail: { type: "string" description: "The employer auto enrolments' primary email" } PrimaryFirstName: { type: "string" description: "The employer auto enrolments' primary first name" } PrimaryJobTitle: { type: "string" description: "The employer auto enrolments' primary job title" } PrimaryLastName: { type: "string" description: "The employer auto enrolments' primary last name" } PrimaryTelephone: { type: "string" description: "The employer auto enrolments' primary telephone" } ReEnrolmentDayOffset: { type: "integer" format: "int32" description: "The employer auto enrolments' re enrolment day offset" } ReEnrolmentMonthOffset: { type: "integer" format: "int32" description: "The employer auto enrolments' re enrolment month offset" } RecentOptOutReEnrolmentExcluded: { type: "boolean" description: "The employer auto enrolments' recent opt out re enrolment excluded" } SecondaryAddress: { type: "object" description: "The employer auto enrolments' secondary 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" } } } SecondaryEmail: { type: "string" description: "The employer auto enrolments' secondary email" } SecondaryFirstName: { type: "string" description: "The employer auto enrolments' secondary first name" } SecondaryJobTitle: { type: "string" description: "The employer auto enrolments' secondary job title" } SecondaryLastName: { type: "string" description: "The employer auto enrolments' secondary last name" } SecondaryTelephone: { type: "string" description: "The employer auto enrolments' secondary telephone" } StagingDate: { type: "string" format: "date" description: "The employer auto enrolments' staging date" } } } BacsServiceUserNumber: { type: "string" description: "The employers' bacs service user number" } BankAccount: { type: "object" description: "The employers' 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" } } } CalculateApprenticeshipLevy: { type: "boolean" description: "The employers' calculate apprenticeship levy" } ClaimEmploymentAllowance: { type: "boolean" description: "The employers' claim employment allowance" } ClaimSmallEmployerRelief: { type: "boolean" description: "The employers' claim small employer relief" } EffectiveDate: { type: "string" format: "date" description: "The employers' effective date" } HmrcSettings: { type: "object" description: "The employers' hmrc settings" properties: { AccountingOfficeRef: { type: "string" description: "The hmrc settingss' accounting office ref" } COTAXRef: { type: "string" description: "The hmrc settingss' c o t a x ref" } ContactEmail: { type: "string" description: "The hmrc settingss' contact email" } ContactFax: { type: "string" description: "The hmrc settingss' contact fax" } ContactFirstName: { type: "string" description: "The hmrc settingss' contact first name" } ContactLastName: { type: "string" description: "The hmrc settingss' contact last name" } ContactTelephone: { type: "string" description: "The hmrc settingss' contact telephone" } EmploymentAllowanceOverride: { type: "number" format: "double" description: "The hmrc settingss' employment allowance override" } Password: { type: "string" format: "password" description: "The hmrc settingss' password" } SAUTR: { type: "string" description: "The hmrc settingss' s a u t r" } Sender: { type: "string" description: "The hmrc settingss' sender" enum: ["Employer", "Individual", "Company", "Agent", "Bureau", "Partnership", "Trust", "Government", "ActingInCapacity", "Other"] } SenderId: { type: "string" description: "The hmrc settingss' sender id" } StateAidSector: { type: "string" description: "The hmrc settingss' state aid sector" enum: ["Agriculture", "FisheriesAquaculture", "RoadTransport", "Industrial", "NotApplicable"] } TaxOfficeNumber: { type: "string" description: "The hmrc settingss' tax office number" } TaxOfficeReference: { type: "string" description: "The hmrc settingss' tax office reference" } } } MetaData: { type: "object" description: "The employers' meta data" properties: {} } Name: { type: "string" description: "The employers' name" } NextRevisionDate: { type: "string" format: "date" description: "The employers' next revision date" } Region: { type: "string" description: "The employers' region" enum: ["NotSet", "England", "Scotland", "Wales"] } Revision: { type: "integer" format: "int32" description: "The employers' revision" } RuleExclusions: { type: "string" description: "The employers' rule exclusions" enum: ["None", "NiMissingPayInstructionRule", "TaxMissingPayInstructionRule", "TaxCodeUpliftRule", "NiSetExpectedLetterRule", "NiDateOfBirthChangeRetrospectiveCRule", "NiDefermentStatusChangeRule", "NiEndContractedOutTransferRule", "PaymentAfterLeavingTaxCodeRule", "LeaverEndInstructionsRule", "P45StudentLoanInstructionRule", "P45TaxInstructionRule", "P45YtdTaxRule", "YtdInstructionRule", "TaxCodeRegionChangeRule", "AutoEnrolmentStatusChangeRule", "EmployeeDeceasedRule", "BenefitInstructionAutoEndRule"] } Territory: { type: "string" description: "The employers' territory" enum: ["UnitedKingdom"] } } } } } }