Employer

Represents an employer revision. See revisible objects for more information on revisions and how they work.

Employer [Schema]

Name	Type	Required	Description
EffectiveDate	xsd:date	yes	The date the revision will come into effect.
Revision	Revision	no	The revision number of the employer; this is a readonly system generated value.
Name	xsd:string ( min: 1 max: 150) Pattern: [A-Za-z0-9 ~!"@#$%&'\\+,\-\./:;<=>\?\[\\\]^_\{\}£€]	yes	The legal name of the employer.
Region	CalculatorRegion	yes	The employer's region which determines the default calculators to be used.
Territory	CalculatorTerritory	yes	The employer's territory which determines the default calculators to be used in all employee calculations. Currently United Kingdom is the only supported territory.
BacsServiceUserNumber	xsd:integer Pattern: [0-9]{6}	no	The employer's unique identifier making payments throught the BACS network.
ClaimEmploymentAllowance	xsd:boolean	no	Indicates if the employer should claim the Employment Allowance See Claiming the Employment Allowance for more details.
ClaimSmallEmployerRelief	xsd:boolean	no	Indicates if the employer should claim the Small Employer Relief See Claiming Small Employer Relief for more details.
ApprenticeshipLevyAllowance	Money ( min: 0 max: 15000)	no	The employer's annual levy allowance; The apprenticeship levy will only apply to employers with annual paybill in excess of £3 million.
RuleExclusions	RuleExclusionFlags	yes	The list of pre-claculation rules to exclude by default for all employees. See Pre-calculation rules for more information on how they work.
Address	Address	no	The employer's registered address.
HmrcSettings	HmrcSettings	no	The employer's specific HMRC reference numbers and RTI credentials.
BankAccount	BankAccount	no	The employer's bank account; will be used as the originator account in any BACS reporting.
AutoEnrolment	EmployerAutoEnrolment	no	The employer's auto enrolment details; controls the processing of auto enrolment assessments.
MetaData	MetaData	no	The employers optional meta data collection.

HMRC Settings

HmrcSettings [Schema]

Name	Type	Required	Description
TaxOfficeNumber	xsd:string Pattern: [0-9]{3}	yes	The Tax Office Number is the first part of your employer's PAYE reference issued by HMRC; it consists of 3 numbers. Required to make RTI submissions.
TaxOfficeReference	xsd:string ( min: 1 max: 10) Pattern: [A-Za-z0-9]*	yes	The Tax Office Reference is the second part of your employer's PAYE reference issued by HMRC; it consists of up to 10 apha-numeric charaters. Required to make RTI submissions.
AccountingOfficeRef	xsd:string Pattern: [0-9]{3}P[A-Z][0-9]{7}[0-9X]	yes	The Accounting Office Reference is issued by HMRC; typically it is found on employer's P30BC Employer Payment Booklet. Required to make RTI submissions.
SAUTR	xsd:string Pattern: [0-9]{10}	no	The Self Assessment Unique Tax reference; only applicable to sole proprietors or partnerships.
COTAXRef	xsd:string Pattern: [0-9]{10}	no	The Corporation Tax reference; applicable to limited companies.
Sender	xsd:string (enumeration) Individual Company Agent Bureau Partnership Trust Employer Government ActingInCapacity Other	no	The entity type that is making the RTI submission on behalf of the employer. Required to make RTI submissions.
SenderId	xsd:string ( min: 1 max: 35) Pattern: [A-Za-z0-9 ~!"@#$%&'\\+,\-\./:;<=>\?\[\\\]^_\{\}£€]	no	The government gateway username issued to the employer by HMRC. Required to make RTI submissions.
Password	xsd:string ( min: 1 max: 35) Pattern: [A-Za-z0-9 ~!"@#$%&'\\+,\-\./:;<=>\?\[\\\]^_\{\}£€]	no	The government gateway password issued to the employer by HMRC. Required to make RTI submissions.
ContactFirstName	Name	no	The designated HMRC contact person's first name.
ContactLastName	Name	no	The designated HMRC contact person's last name.
ContactEmail	Email	no	The designated HMRC contact person's email address; RTI submission acknowledgements will be sent to this address.
ContactTelephone	Telephone	no	The designated HMRC contact person's telephone number.
ContactFax	Telephone	no	The designated HMRC contact person's fax number.

Employer Auto Enrolment

EmployerAutoEnrolment [Schema]

Name	Type	Required	Description
StagingDate	xsd:date ( min: 2012-10-01)	yes	The employers auto enrolment staging date.
PostponementDate	xsd:date ( min: 2012-10-01)	no	The optional employers auto enrolment deferment date.
ReEnrolmentDayOffset	xsd:integer ( min: -31 max: 31)	no	The optional employers auto enrolment re-enrolment day offset. Allows the tri-annual re-enrolment to be offset by a number of days. Supports positive and negative integers.
ReEnrolmentMonthOffset	xsd:integer ( min: -3 max: 3)	no	The optional employers auto enrolment re-enrolment month offset. Allows the tri-annual re-enrolment to be offset by a number of months. Supports positive and negative integers.
PrimaryFirstName	Name	no	The employers auto enrolment primary contact first name.
PrimaryLastName	Name	no	The employers auto enrolment primary contact last name.
PrimaryEmail	Email	no	The employers auto enrolment primary contact email address.
PrimaryTelephone	Telephone	no	The employers auto enrolment primary contact telephone number.
PrimaryJobTitle	xsd:string ( min: 0 max: 50)	no	The employers auto enrolment primary contact telephone number.
SecondaryFirstName	Name	no	The employers auto enrolment secondary contact first name.
SecondaryLastName	Name	no	The employers auto enrolment secondary contact last name.
SecondaryEmail	Email	no	The employers auto enrolment secondary contact email address.
SecondaryTelephone	Telephone	no	The employers auto enrolment secondary contact telephone number.
SecondaryJobTitle	xsd:string ( min: 0 max: 50)	no	The employers auto enrolment secondary contact telephone number.
Pension	Link	no	The link to the employers auto enrolment pension scheme.

Example

<?xml version="1.0"?>
<Employer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EffectiveDate>2019-12-05</EffectiveDate>
  <Revision>123</Revision>
  <Name>string</Name>
  <Region>NotSet</Region>
  <Territory>NotSet</Territory>
  <BacsServiceUserNumber>string</BacsServiceUserNumber>
  <RuleExclusions>None</RuleExclusions>
  <ClaimEmploymentAllowance>true</ClaimEmploymentAllowance>
  <ClaimSmallEmployerRelief>true</ClaimSmallEmployerRelief>
  <ApprenticeshipLevyAllowance>123.99</ApprenticeshipLevyAllowance>
  <Address>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <Address3>string</Address3>
    <Address4>string</Address4>
    <Postcode>string</Postcode>
    <Country>string</Country>
  </Address>
  <HmrcSettings>
    <TaxOfficeNumber>string</TaxOfficeNumber>
    <TaxOfficeReference>string</TaxOfficeReference>
    <AccountingOfficeRef>string</AccountingOfficeRef>
    <SAUTR>string</SAUTR>
    <COTAXRef>string</COTAXRef>
    <Sender>Employer</Sender>
    <SenderId>string</SenderId>
    <Password>string</Password>
    <ContactFirstName>string</ContactFirstName>
    <ContactLastName>string</ContactLastName>
    <ContactEmail>string</ContactEmail>
    <ContactTelephone>string</ContactTelephone>
    <ContactFax>string</ContactFax>
  </HmrcSettings>
  <BankAccount>
    <AccountName>string</AccountName>
    <AccountNumber>string</AccountNumber>
    <SortCode>string</SortCode>
    <Reference>string</Reference>
  </BankAccount>
  <AutoEnrolment>
    <StagingDate>2019-12-05</StagingDate>
    <PostponementDate>2019-12-05</PostponementDate>
    <ReEnrolmentDayOffset>123</ReEnrolmentDayOffset>
    <ReEnrolmentMonthOffset>123</ReEnrolmentMonthOffset>
    <PrimaryFirstName>string</PrimaryFirstName>
    <PrimaryLastName>string</PrimaryLastName>
    <PrimaryEmail>string</PrimaryEmail>
    <PrimaryTelephone>string</PrimaryTelephone>
    <PrimaryJobTitle>string</PrimaryJobTitle>
    <SecondaryFirstName>string</SecondaryFirstName>
    <SecondaryLastName>string</SecondaryLastName>
    <SecondaryEmail>string</SecondaryEmail>
    <SecondaryTelephone>string</SecondaryTelephone>
    <SecondaryJobTitle>string</SecondaryJobTitle>
    <Pension title="string" href="string" rel="string" />
  </AutoEnrolment>
  <MetaData>
    <Item Name="string">string</Item>
  </MetaData>
</Employer>

{
  "Employer": {
    "EffectiveDate": "2019-12-05",
    "Revision": "123",
    "Name": "string",
    "Region": "NotSet",
    "Territory": "NotSet",
    "BacsServiceUserNumber": "string",
    "RuleExclusions": "None",
    "ClaimEmploymentAllowance": "true",
    "ClaimSmallEmployerRelief": "true",
    "ApprenticeshipLevyAllowance": "123.99",
    "Address": {
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "Postcode": "string",
      "Country": "string"
    },
    "HmrcSettings": {
      "TaxOfficeNumber": "string",
      "TaxOfficeReference": "string",
      "AccountingOfficeRef": "string",
      "SAUTR": "string",
      "COTAXRef": "string",
      "Sender": "Employer",
      "SenderId": "string",
      "Password": "string",
      "ContactFirstName": "string",
      "ContactLastName": "string",
      "ContactEmail": "string",
      "ContactTelephone": "string",
      "ContactFax": "string"
    },
    "BankAccount": {
      "AccountName": "string",
      "AccountNumber": "string",
      "SortCode": "string",
      "Reference": "string"
    },
    "AutoEnrolment": {
      "StagingDate": "2019-12-05",
      "PostponementDate": "2019-12-05",
      "ReEnrolmentDayOffset": "123",
      "ReEnrolmentMonthOffset": "123",
      "PrimaryFirstName": "string",
      "PrimaryLastName": "string",
      "PrimaryEmail": "string",
      "PrimaryTelephone": "string",
      "PrimaryJobTitle": "string",
      "SecondaryFirstName": "string",
      "SecondaryLastName": "string",
      "SecondaryEmail": "string",
      "SecondaryTelephone": "string",
      "SecondaryJobTitle": "string",
      "Pension": {
        "@title": "string",
        "@href": "string",
        "@rel": "string"
      }
    },
    "MetaData": {
      "Item": [
        {
          "@Name": "string",
          "#text": "string"
        }
      ]
    }
  }
}