Common Types

The common shared data types used across the API domain.

Revision

The revision number of the revisable object. See Revisable Objects

Type	xsd:integer
Mininum Value	0

Postcode

The UK postcode string.

Type	xsd:string
Mininum Length	5
Maximum Length	8
Pattern	[A-Z0-9 ]*

CalculatorRegion

The calculator region (in combination with the calculator territory) determines the calculators to be used.

Type	xsd:string
Enumeration	NotSet England Scotland Wales

CalculatorTerritory

The calculator territory (in combination with the calculator region) determines the calculators to be used. Currently United Kingdom is the only supported calculator territory.

Type	xsd:string
Enumeration	UnitedKingdom

NiNumber

The employee's National Insurance number issued by HMRC. Temporary NI numbers should no longer be used for payroll.

Type	xsd:string
Pattern	([ACEHJLMOPRSWXY][A-CEGHJ-NPR-TW-Z]|B[A-CEHJ-NPR-TW-Z]|G[ACEGHJ-NPR-TW-Z]|[KT][A-CEGHJ-MPR-TW-Z]|N[A-CEGHJL-NPR-SW-Z]|Z[A-CEGHJ-NPR-TW-Y])[0-9]{6}[A-D ]

PaymentMethod

The payment method.

Type	xsd:string
Enumeration	NotSet Cash Cheque BACS

Name

Used for a person's name (first, middle or last).

Type	xsd:string
Mininum Length	1
Maximum Length	35
Pattern	[A-Za-z \-\.\']*

Email

An email address.

Type	xsd:string
Mininum Length	3
Maximum Length	129
Pattern	[A-Za-z0-9\.\-_]{1,64}@[A-Za-z0-9\.\-_]{1,64}

Telephone

A UK based telephone number.

Type	xsd:string
Mininum Length	6
Maximum Length	35
Pattern	[0-9\(\)\-\s]{1,35}

Money

A decimal figure rounded to 2 decimal places to represent a currency. Negative values are permitted.

Type	xsd:decimal
Fractional Digits	2

AverageWeeklyEarning

A decimal figure rounded to 5 decimal places to represent the average weekly earnings. Used in statutory parental absence calculations.

Type	xsd:decimal
Fractional Digits	5

FormattedMoney

A formatted monetary value for display only.

Type	xsd:string
Pattern	[0-9\,\-\+\.\(\)R]*

DayOfMonth

An integer value between 1 and 31. Represents a calendar day of the month.

Type	xsd:integer
Mininum Value	1
Maximum Value	31

Percentage

A decimal fraction between 0 and 1. Represents a percentage as a fraction of the number 1.

Type	xsd:decimal
Mininum Value	0
Maximum Value	1

SystemCode

An alpha-numeric system code.

Type	xsd:string
Mininum Length	2
Maximum Length	35
Pattern	[A-Za-z0-9\-]*

SystemCodeType

Indicates the categorisation of SystemCode.

Type	xsd:string
Enumeration	Payment Deduction

RoundingOption

Indicates the rounding option to use.

Type	xsd:string
Enumeration	NotSet PennyUp PennyDown Bankers FiveUp FiveDown Floor Ceiling

RuleExclusionFlags

A list of pre-calculation rules that can excluded by name. See Pre-Calculation Rules

Type

xsd:string

Pattern

(?:(?:None|AutoEnrolmentStatusChangeRule|NiMissingPayInstructionRule|TaxMissingPayInstructionRule|TaxCodeUpliftRule|NiSetExpectedLetterRule|NiDateOfBirthChangeRetrospectiveCRule|NiDefermentStatusChangeRule|NiEndContractedOutTransferRule|PaymentAfterLeavingRule|LeaverEndInstructionsRule|P45StudentLoanInstructionRule|P45TaxInstructionRule|P45YtdTaxRule|YtdInstructionRule|TaxCodeRegionChangeRule|EmployeeDeceasedRule)\s?)+

DirCalculationMethod

The calculation method to use when calculating an employee as a director. See Employees as Directors

Type	xsd:string
Enumeration	OffOff AnnualBasisAnnual Basis AlternativeBasisAlternative Basis

OffAnnual BasisAlternative Basis

PayFrequency

The available pay frequencies.

Type	xsd:string
Enumeration	Weekly Monthly TwoWeekly FourWeekly Yearly

TaxBasis

The tax calculation basis.

Type	xsd:string
Enumeration	Cumulative Week1Month1

TaxCode

The tax code format issued by HMRC.

Type	xsd:string
Mininum Length	2
Maximum Length	7
Pattern	^(CBR|CD0|CD2|SD1|SD2|D1|BR|SBR|SD0|D0|NT)$|^[S|C]?((K{1}[0-9]{1,6})|([0-9]{1,6}[LMNPTYV]{1})$)

BenefitAccountingMethod

The accounting method used for calculating and reporting employee benefits.

Type	xsd:string
Enumeration	P11D PAYE

StudentLoanCalculationMethod

The student loan calculation method.

Type	xsd:string
Enumeration	Off Plan1 Plan2 Plan4

PayeReference

The unique reference issued to the employer by HMRC.

Type	xsd:string
Maximum Length	14
Pattern	([0-9]{3})/([A-Za-z0-9]{1,10})

NiLetter

The National Insurance table code.

Type	xsd:string
Pattern	A|B|C|D|E|I|J|H|K|L|M|X|Z

PensionTaxationMethod

The method used to calculate taxation on pension contributions.

Type	xsd:string
Enumeration	NotSet NetBased ReliefAtSource TaxReliefExcluded

ProRataMethod

The pro-rata method options. See Pro-rata Calculation Methods for more information.

Type	xsd:string
Enumeration	NotSet Annual260Days Annual365Days AnnualQualifyingDays DaysPerCalendarMonth DaysPerTaxPeriod

UomBasicPay

The unit of measure for basic pay payments.

Type	xsd:string
Enumeration	NotSet Minute Hour Day Week Month Year Unit

HolidayUom

The unit of measure for holiday entitlement.

Type	xsd:string
Enumeration	Hour Day

TaxYear

The list of available tax years.

Type	xsd:integer
Enumeration	2015 2016 2017 2018 2019 2020 2021

EarlierTaxYear

The list of available earlier tax years; used when creating an EYU instruction.

Type	xsd:integer
Enumeration	2016 2017

TaxMonth

The list of available tax months; used for reporting only.

Type	xsd:integer
Mininum Value	0
Maximum Value	12

href

The relative URL path to a resource.

Type	xsd:string
Pattern	^\/{1}[a-zA-Z0-9-\/]+$

DpsMessageType

The type of DPS message.

Type	xsd:string
Enumeration	P6 P9 SL1 SL2 AR NOT RTI PGL1 PGL2

SspExclusionReason

The list of reasons why SSP would not be paid.

Type	xsd:string
Enumeration	None HasNeverWorked BelowLel NoWorkingWeekPattern OnMaternity Deceased ContractEnd LegalCustody OnStrike ExceededMaximumSspDuration InsufficientHistoryToCalculateAwe BelowMinimumDuration

SppExclusionReason

The list of reasons why SPP would not be paid.

Type	xsd:string
Enumeration	None InLegalCustody HasDeceased StillbirthBeforeWeek24 NothingToPay AverageWeeklyEarningsBelowLelThreshold WorkedDuringAbsence EmploymentEndedBeforeBabyBorn SspDue CutOffPeriodExceeded

SpbpExclusionReason

The list of reasons why SPBP would not be paid.

Type	xsd:string
Enumeration	None InLegalCustody HasDeceased StillbirthBeforeWeek24 NothingToPay AverageWeeklyEarningsBelowLelThreshold WorkedDuringAbsence EmploymentEndedBeforeDateOfDeath SspDue CutOffPeriodExceeded

SmpExclusionReason

The list of reasons why SMP would not be paid.

Type	xsd:string
Enumeration	None ExceededMaximumKeepInTouchDays InLegalCustody HasDeceased StillbirthBeforeWeek24 NothingToPay AverageWeeklyEarningsBelowLelThreshold

ShppExclusionReason

The list of reasons why ShPP would not be paid.

Type	xsd:string
Enumeration	None NothingToPay AverageWeeklyEarningsBelowLelThreshold SspDue MaxWeeksExceeded SplHasEnded

SapExclusionReason

The list of reasons why SAP would not be paid.

Type	xsd:string
Enumeration	None AverageWeeklyEarningsBelowLelThreshold ExceededMaximumKeepInTouchDays ExceededMaximumWeeks InLegalCustody HasDeceased NothingToPay SspDue EmploymentEndedBeforeMatchingDate

AEAssessmentCode

The list of auto enrolment assessment codes options. Determines the employees worker type.

Type	xsd:string
Enumeration	Excluded EligibleJobHolder NonEligibleJobHolder EntitledWorker

AEAssessmentEvent

The list of auto enrolment assessment event options. Used to describe the type of event triggered by the auto enrolment assessment.

Type	xsd:string
Enumeration	NonEnrolmentEvent AutomaticEnrolment OptIn VoluntaryJoiner ContractualEnrolment

AEAssessmentOverride

The list of auto enrolment assessment override options.

Type	xsd:string
Enumeration	None OptOut OptIn VoluntaryJoiner ContractualPension CeasedMembership Leaver Excluded

AEWorkerExclusionCode

The list of auto enrolment exclusion reasons; see PAPDIS.

Type	xsd:string
Enumeration	OtherNotKnown NotAWorker NotUKWorker TemporaryUKWorker OutsideAgeRange SingleEmployeeDirector CeasedMembershipWithin12Months CeasedMembershipBeyond12Months WorkerWULSWithin12Month WorkerWULSBeyond12Month WorkerInNoticePeriod WorkerTaxProtection

AEAssessmentResult

The list of auto enrolment assessment results. Describes the final result of the auto enrolment assessment.

Type	xsd:string
Enumeration	Inconclusive NoChange Enrol Exit

AoeType

The list of attachment of earning types. Used in AOE pay instructions to indicate the type of earning attachment.

Type	xsd:string
Enumeration	AEO AEOP AEONP CSA1993 CSA CSA2012 DEO CCPRE92 CCPOST92 CTAEO MCAEO EA CMA CAO ISD EA2006 CAPS DEA DEAHIGHER DEAFIXED

UniqueTaxReference

Type	xsd:string
Pattern	[0-9]{10}

CompanyName

Type	xsd:string
Mininum Length	2
Maximum Length	50
Pattern	[A-Za-z0-9\-\/\. '&]*

SubContractorPayFrequency

The sub contractor's tax period pay frequency.

Type	xsd:string
Enumeration	Weekly Monthly

CisTaxTreatment

The CIS tax treatment options.

Type	xsd:string
Enumeration	Taxable NonTaxable Notional Materials

CisLineTypeName

The CIS line type identifier.

Type	xsd:string
Mininum Length	1
Maximum Length	15
Pattern	[A-Z0-9]+

RtiTransactionStatus

The status of the RTI transaction.

Type	xsd:string
Enumeration	New RequestGenerated CompletedWithError CompletedWithSuccess TimeOut

AbsenceDate

The start or end absence date.

Type	xsd:date
Mininum Value	2016-04-06
Maximum Value	2100-01-01

TransactionStatus

The status of the transaction.

Type	xsd:string
Enumeration	Unknown Success Failure

SspType

The statutory sick pay rule type.

Type	xsd:string
Enumeration	Standard Covid19