Common Types



The common shared data types used across the API domain.

Revision

The revision number of the revisible object. See Revisible 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

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 ]

Name

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

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

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

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

RuleExclusionFlags

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

Type xsd:string
Pattern (?:(?:None|NiMissingPayInstructionRule|TaxMissingPayInstructionRule|TaxCodeUpliftRule|NiSetExpectedLetterRule|NiDateOfBirthChangeRetrospectiveCRule|NiDefermentStatusChangeRule|NiEndContractedOutTransferRule|PaymentAfterLeavingRule|LeaverEndInstructionsRule|P45StudentLoanInstructionRule|P45TaxInstructionRule|P45YtdTaxRule|YtdInstructionRule|TaxCodeRegionChangeRule)\s?){1,4}

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 ^(SD1|D1|BR|SBR|SD0|D0|NT)$|^[S]?((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

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|K|L|M|X|Z

PensionTaxationMethod

The method used to calculate taxation on pension contributions.

Type xsd:string
Enumeration
  • NotSet
  • NetBased
  • ReliefAtSourceIncluded
  • ReliefAtSourceExcluded

ProRataMethod

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

Type xsd:string
Enumeration
  • NotSet
  • Annual260Days
  • Annual365Days
  • AnnualQualifyingDays

UomBasicPay

The unit of measure for basic pay payments.

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

TaxYear

The list of available tax years.

Type xsd:integer
Enumeration
  • 2015
  • 2016
  • 2017

EarlierTaxYear

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

Type xsd:integer
Enumeration
  • 2016

TaxMonth

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

Type xsd:integer
Mininum Value 1
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

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

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

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