Workers v1

https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema

Workers.v1 Import Layout

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Cannot be instantiated	Yes	Unknown status	Unknown identifiability	Forbidden	Allowed	none	workers.v1.schema.json

Workers.v1 Type

object[]

Workers.v1 Definitions

Definitions group BankDetails

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/BankDetails"}

Property	Type	Required	Nullable	Defined by
BankSortCode	string	Optional	can be null	Workers v1
BankAccountNumber	string	Optional	can be null	Workers v1
BankAccountName	string	Optional	can be null	Workers v1
IBAN	string	Optional	can be null	Workers v1
BIC	string	Optional	can be null	Workers v1

BankSortCode

A record with this Bank Sort Code must already exist in the system ('BACS' Only)

BankSortCode

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankSortCode Type

string

BankSortCode Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^\d{6}$

try pattern

BankAccountNumber

BankAccountNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountNumber Type

string

BankAccountNumber Constraints

maximum length: the maximum number of characters for this string is: 10

minimum length: the minimum number of characters for this string is: 8

pattern: the string must match the following regular expression:

^\d{8}\d{0,2}$

try pattern

BankAccountName

BankAccountName

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountName Type

string

BankAccountName Constraints

maximum length: the maximum number of characters for this string is: 30

IBAN

IBAN

• is optional

• Type: string

• can be null

• defined in: Workers v1

IBAN Type

string

IBAN Constraints

maximum length: the maximum number of characters for this string is: 34

pattern: the string must match the following regular expression:

[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}

try pattern

BIC

BIC

• is optional

• Type: string

• can be null

• defined in: Workers v1

BIC Type

string

BIC Constraints

maximum length: the maximum number of characters for this string is: 11

pattern: the string must match the following regular expression:

^[A-Z]{4}[A-Z]{2}[A-Z1-9]{2}([A-Z\d]{3})?$

try pattern

Definitions group CISDetails

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/CISDetails"}

Property	Type	Required	Nullable	Defined by
CISUniqueTaxReference	string	Optional	can be null	Workers v1
CISLegalStatus	string	Optional	can be null	Workers v1
CISPartnershipName	string	Optional	can be null	Workers v1
CISPartnershipUTR	string	Optional	can be null	Workers v1

CISUniqueTaxReference

CISUniqueTaxReference

• is optional

• Type: string

• can be null

• defined in: Workers v1

CISUniqueTaxReference Type

string

CISUniqueTaxReference Constraints

maximum length: the maximum number of characters for this string is: 10

CISLegalStatus

CISLegalStatus

• is optional

• Type: string

• can be null

• defined in: Workers v1

CISLegalStatus Type

string

CISLegalStatus Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"SelfEmployed"
"LimitedCompany"
"Partnership"

CISPartnershipName

CISPartnershipName

• is optional

• Type: string

• can be null

• defined in: Workers v1

CISPartnershipName Type

string

CISPartnershipName Constraints

maximum length: the maximum number of characters for this string is: 60

CISPartnershipUTR

CISPartnershipUTR

• is optional

• Type: string

• can be null

• defined in: Workers v1

CISPartnershipUTR Type

string

CISPartnershipUTR Constraints

maximum length: the maximum number of characters for this string is: 10

Definitions group Contractor

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/Contractor"}

Property	Type	Required	Nullable	Defined by
RemittanceAddress	string	Optional	can be null	Workers v1
LegalStatus	string	Optional	can be null	Workers v1
BusinessName	string	Required	cannot be null	Workers v1
Address	object	Optional	can be null	Workers v1
IncorporationDate	string	Optional	can be null	Workers v1
CompanyRegNo	string	Optional	can be null	Workers v1
VATNumber	string	Optional	can be null	Workers v1
VATCodeSource	string	Optional	can be null	Workers v1
DefaultVATRate	string	Optional	can be null	Workers v1
DivisionRef	string	Optional	can be null	Workers v1
DepartmentRef	string	Optional	can be null	Workers v1
PurchaseLedgerAccountNumber	string	Optional	can be null	Workers v1
PaymentOption	string	Optional	can be null	Workers v1
PaymentTermsValue	integer	Optional	can be null	Workers v1
PayMethod	string	Optional	can be null	Workers v1
CurrencyRef	string	Optional	can be null	Workers v1
IsSelfBillingEnabled	boolean	Optional	can be null	Workers v1
SelfBillingLogoFilename	string	Optional	can be null	Workers v1
SelfBillingInvoiceBreakLevel	string	Optional	can be null	Workers v1
SupplierNotes	string	Optional	can be null	Workers v1
EmailAddress	string	Optional	can be null	Workers v1
PayslipPrintMethod	string	Optional	can be null	Workers v1
IsPaidWhenPaid	boolean	Optional	can be null	Workers v1
TaxReferenceNumber	string	Optional	can be null	Workers v1
IsOn46GReport	boolean	Optional	can be null	Workers v1
BankDetails	object	Optional	can be null	Workers v1
CISDetails	object	Optional	can be null	Workers v1
Partners	array	Optional	can be null	Workers v1

RemittanceAddress

Defaults if not supplied from Employer's Default for Contractors or to 'Trade' for Managed Agencies and Umbrellas.

RemittanceAddress

• is optional

• Type: string

• can be null

• defined in: Workers v1

RemittanceAddress Type

string

RemittanceAddress Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Trade"
"Home"

LegalStatus

This is mandatory for new suppliers.

LegalStatus

• is optional

• Type: string

• can be null

• defined in: Workers v1

LegalStatus Type

string

LegalStatus Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"LimitedCompany"
"SelfEmployed"
"Partnership"
"CIS"

BusinessName

BusinessName

• is required

• Type: string

• cannot be null

• defined in: Workers v1

BusinessName Type

string

BusinessName Constraints

maximum length: the maximum number of characters for this string is: 60

Address

Address

• is optional

• Type: object

• can be null

• defined in: Workers v1

Address Type

object

IncorporationDate

IncorporationDate

• is optional

• Type: string

• can be null

• defined in: Workers v1

IncorporationDate Type

string

IncorporationDate Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

CompanyRegNo

CompanyRegNo

• is optional

• Type: string

• can be null

• defined in: Workers v1

CompanyRegNo Type

string

CompanyRegNo Constraints

maximum length: the maximum number of characters for this string is: 30

VATNumber

VATNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

VATNumber Type

string

VATNumber Constraints

maximum length: the maximum number of characters for this string is: 30

VATCodeSource

If DefaultVATRate or DefaultNonVATRate then inherits from employer/system defaults. Only applies to New Suppliers

VATCodeSource

• is optional

• Type: string

• can be null

• defined in: Workers v1

VATCodeSource Type

string

VATCodeSource Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"SpecifiedVATRate"
"DefaultVATRate"
"DefaultNonVATRate"

DefaultVATRate

Required if VAT Code Source is not supplied or is set to SpecifiedVATRate. This value is ignored If VAT Code Source is DefaultVATRate or DefaultNonVATRate

DefaultVATRate

• is optional

• Type: string

• can be null

• defined in: Workers v1

DefaultVATRate Type

string

DefaultVATRate Constraints

maximum length: the maximum number of characters for this string is: 2

pattern: the string must match the following regular expression:

^([^a-z?*]{0,2})$

try pattern

DivisionRef

Defaults from API settings for Employer if not supplied. A record with the Division Ref must already exist in the system.

DivisionRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

DivisionRef Type

string

DivisionRef Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^([^a-z?*]{1,6})$

try pattern

DepartmentRef

Defaults from API settings for Employer if not supplied. A record with the Department Ref must already exist in the system.

DepartmentRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

DepartmentRef Type

string

DepartmentRef Constraints

maximum length: the maximum number of characters for this string is: 10

pattern: the string must match the following regular expression:

^([^a-z?*]{1,10})$

try pattern

PurchaseLedgerAccountNumber

PurchaseLedgerAccountNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

PurchaseLedgerAccountNumber Type

string

PurchaseLedgerAccountNumber Constraints

maximum length: the maximum number of characters for this string is: 10

PaymentOption

Defaults to the Employer's Default Payment Option if not specified.

PaymentOption

• is optional

• Type: string

• can be null

• defined in: Workers v1

PaymentOption Type

string

PaymentOption Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"PaidViaTimesheets"
"PaidViaTimesheetsAccordingToPaymentTerms"
"PaidViaPurchaseInvoice"

PaymentTermsValue

Defaults to the Employer's Default Payment Terms if not specified.

PaymentTermsValue

• is optional

• Type: integer

• can be null

• defined in: Workers v1

PaymentTermsValue Type

integer

PaymentTermsValue Constraints

maximum: the value of this number must smaller than or equal to: 999999

minimum: the value of this number must greater than or equal to: 0

PayMethod

Defaults to the Employer's Usual Payment Method if not specified.A record with the Payment Method must already exist in the system.

PayMethod

• is optional

• Type: string

• can be null

• defined in: Workers v1

PayMethod Type

string

PayMethod Constraints

maximum length: the maximum number of characters for this string is: 10

CurrencyRef

Defaults to Employer's Base Currency if not supplied. Only applies to Multi Currency Employers. A record with the Currency Ref must already exist in the system.

CurrencyRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

CurrencyRef Type

string

CurrencyRef Constraints

maximum length: the maximum number of characters for this string is: 3

IsSelfBillingEnabled

Defaults to false if not supplied.

IsSelfBillingEnabled

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsSelfBillingEnabled Type

boolean

SelfBillingLogoFilename

Specified filename to an image to be printed on various documents in the system.

SelfBillingLogoFilename

• is optional

• Type: string

• can be null

• defined in: Workers v1

SelfBillingLogoFilename Type

string

SelfBillingLogoFilename Constraints

maximum length: the maximum number of characters for this string is: 128

SelfBillingInvoiceBreakLevel

Defaults to Supplier if not specified.

SelfBillingInvoiceBreakLevel

• is optional

• Type: string

• can be null

• defined in: Workers v1

SelfBillingInvoiceBreakLevel Type

string

SelfBillingInvoiceBreakLevel Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Supplier"
"Worker"
"Timesheet"

SupplierNotes

General free format text relating to the supplier.

SupplierNotes

• is optional

• Type: string

• can be null

• defined in: Workers v1

SupplierNotes Type

string

SupplierNotes Constraints

maximum length: the maximum number of characters for this string is: 60

EmailAddress

EmailAddress

• is optional

• Type: string

• can be null

• defined in: Workers v1

EmailAddress Type

string

EmailAddress Constraints

maximum length: the maximum number of characters for this string is: 50

PayslipPrintMethod

Defaults to Paper if not specified.

PayslipPrintMethod

• is optional

• Type: string

• can be null

• defined in: Workers v1

PayslipPrintMethod Type

string

PayslipPrintMethod Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Paper"
"Electronic"
"Both"

IsPaidWhenPaid

Defaults to false if not supplied.

IsPaidWhenPaid

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsPaidWhenPaid Type

boolean

TaxReferenceNumber

Irish Payroll Only.

TaxReferenceNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

TaxReferenceNumber Type

string

TaxReferenceNumber Constraints

maximum length: the maximum number of characters for this string is: 10

IsOn46GReport

Defaults to false if not supplied. Irish Payroll Only.

IsOn46GReport

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsOn46GReport Type

boolean

BankDetails

BankDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

BankDetails Type

object

CISDetails

CISDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

CISDetails Type

object

Partners

Partners

• is optional

• Type: object[]

• can be null

• defined in: Workers v1

Partners Type

object[]

Definitions group Partner

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/Partner"}

Property	Type	Required	Nullable	Defined by
PartnerName	string	Optional	can be null	Workers v1
PartnerDateOfBirth	string	Optional	can be null	Workers v1
PartnerNINumber	string	Optional	can be null	Workers v1

PartnerName

PartnerName

• is optional

• Type: string

• can be null

• defined in: Workers v1

PartnerName Type

string

PartnerName Constraints

maximum length: the maximum number of characters for this string is: 30

PartnerDateOfBirth

PartnerDateOfBirth

• is optional

• Type: string

• can be null

• defined in: Workers v1

PartnerDateOfBirth Type

string

PartnerDateOfBirth Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

PartnerNINumber

PartnerNINumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

PartnerNINumber Type

string

PartnerNINumber Constraints

maximum length: the maximum number of characters for this string is: 9

Definitions group PayrolDetailsROI

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/PayrolDetailsROI"}

Property	Type	Required	Nullable	Defined by
OptIn	boolean	Optional	can be null	Workers v1
OptInNoticeReceivedDate	string	Optional	can be null	Workers v1
PRSIBaseClass	string	Optional	can be null	Workers v1
PPSNumber	string	Optional	can be null	Workers v1
IrishTaxStatus	string	Required	can be null	Workers v1
EmergencyStartPeriod	integer	Optional	can be null	Workers v1
SRCOPPerPayPeriod	number	Optional	can be null	Workers v1
TaxCreditPerPayPeriod	number	Optional	can be null	Workers v1
PRSILock	boolean	Optional	can be null	Workers v1

OptIn

Defaults to false if not specified.

OptIn

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

OptIn Type

boolean

OptInNoticeReceivedDate

OptInNoticeReceivedDate

• is optional

• Type: string

• can be null

• defined in: Workers v1

OptInNoticeReceivedDate Type

string

OptInNoticeReceivedDate Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

PRSIBaseClass

A record with this PRSI Base Class must already exist in the system.

PRSIBaseClass

• is optional

• Type: string

• can be null

• defined in: Workers v1

PRSIBaseClass Type

string

PRSIBaseClass Constraints

maximum length: the maximum number of characters for this string is: 2

PPSNumber

PPS Numbers must match the specified pattern and also pass the PPSN Mod 23 checksum. (see https://www.revenue.ie/en/tax-professionals/tdm/income-tax-capital-gains-tax-corporation-tax/part-42/42-04-35a.pdf section 15.3, and https://en.wikipedia.org/wiki/Personal_Public_Service_Number#Calculation for more information on the checksum)

PPSNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

PPSNumber Type

string

PPSNumber Constraints

maximum length: the maximum number of characters for this string is: 9

pattern: the string must match the following regular expression:

^\d{7}[A-Z]{1}[A-Z ]{0,1}$

try pattern

IrishTaxStatus

Defaults to Emergency if not specified.

IrishTaxStatus

• is required

• Type: string

• can be null

• defined in: Workers v1

IrishTaxStatus Type

string

IrishTaxStatus Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Emergency"
"Normal"
"Week1Month1"
"Exempt"

EmergencyStartPeriod

EmergencyStartPeriod

• is optional

• Type: integer

• can be null

• defined in: Workers v1

EmergencyStartPeriod Type

integer

EmergencyStartPeriod Constraints

maximum: the value of this number must smaller than or equal to: 999

minimum: the value of this number must greater than or equal to: 0

SRCOPPerPayPeriod

SRCOPPerPayPeriod

• is optional

• Type: number

• can be null

• defined in: Workers v1

SRCOPPerPayPeriod Type

number

SRCOPPerPayPeriod Constraints

maximum: the value of this number must smaller than or equal to: 999999999.99

minimum: the value of this number must greater than or equal to: -999999999.99

TaxCreditPerPayPeriod

TaxCreditPerPayPeriod

• is optional

• Type: number

• can be null

• defined in: Workers v1

TaxCreditPerPayPeriod Type

number

TaxCreditPerPayPeriod Constraints

maximum: the value of this number must smaller than or equal to: 999999999.99

minimum: the value of this number must greater than or equal to: -999999999.99

PRSILock

Defaults to false if not specified.

PRSILock

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

PRSILock Type

boolean

Definitions group PayrollDetailsUK

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/PayrollDetailsUK"}

Property	Type	Required	Nullable	Defined by
NINumber	string	Optional	can be null	Workers v1
NITableLetter	string	Optional	can be null	Workers v1
IsContractedOut	boolean	Optional	can be null	Workers v1
PAYECode	string	Optional	can be null	Workers v1
PAYEMethod	integer	Optional	can be null	Workers v1
TaxRegime	string	Optional	can be null	Workers v1
IsExcludedFromRegPension	boolean	Optional	can be null	Workers v1
StartingDecCategory	string	Optional	can be null	Workers v1
HasStudentLoan	boolean	Optional	can be null	Workers v1
StartingDecByEmployee	boolean	Optional	can be null	Workers v1
OptIn	boolean	Optional	can be null	Workers v1
OptInNoticeReceivedDate	string	Optional	can be null	Workers v1
StudentLoanPlanType	string	Optional	can be null	Workers v1
IsStudentFinishedStudies	boolean	Optional	can be null	Workers v1
IsStudentLoanPaidExternally	boolean	Optional	can be null	Workers v1
HasPostgradLoan	boolean	Optional	can be null	Workers v1
PostgradLoanPlanType	string	Optional	can be null	Workers v1
IsPostgradFinishedStudies	boolean	Optional	can be null	Workers v1
IsPostgradLoanPaidExternally	boolean	Optional	can be null	Workers v1
UKRegion	string	Optional	can be null	Workers v1

NINumber

NINumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

NINumber Type

string

NINumber Constraints

maximum length: the maximum number of characters for this string is: 9

pattern: the string must match the following regular expression:

[0-9]{6}[A-D ]

try pattern

NITableLetter

NITableLetter

• is optional

• Type: string

• can be null

• defined in: Workers v1

NITableLetter Type

string

NITableLetter Constraints

maximum length: the maximum number of characters for this string is: 1

IsContractedOut

Defaults to false if not specified.

IsContractedOut

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsContractedOut Type

boolean

PAYECode

PAYECode

• is optional

• Type: string

• can be null

• defined in: Workers v1

PAYECode Type

string

PAYECode Constraints

maximum length: the maximum number of characters for this string is: 7

PAYEMethod

PAYEMethod

• is optional

• Type: integer

• can be null

• defined in: Workers v1

PAYEMethod Type

integer

PAYEMethod Constraints

maximum: the value of this number must smaller than or equal to: 2

minimum: the value of this number must greater than or equal to: 0

TaxRegime

Defaults to None if not specified.

TaxRegime

• is optional

• Type: string

• can be null

• defined in: Workers v1

TaxRegime Type

string

TaxRegime Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"None"
"Scottish"
"Welsh"

IsExcludedFromRegPension

Defaults to false if not specified.

IsExcludedFromRegPension

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsExcludedFromRegPension Type

boolean

StartingDecCategory

StartingDecCategory

• is optional

• Type: string

• can be null

• defined in: Workers v1

StartingDecCategory Type

string

StartingDecCategory Constraints

maximum length: the maximum number of characters for this string is: 1

HasStudentLoan

Defaults to false if not specified.

HasStudentLoan

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

HasStudentLoan Type

boolean

StartingDecByEmployee

Defaults to false if not specified.

StartingDecByEmployee

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

StartingDecByEmployee Type

boolean

OptIn

Defaults to false if not specified.

OptIn

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

OptIn Type

boolean

OptInNoticeReceivedDate

OptInNoticeReceivedDate

• is optional

• Type: string

• can be null

• defined in: Workers v1

OptInNoticeReceivedDate Type

string

OptInNoticeReceivedDate Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

StudentLoanPlanType

StudentLoanPlanType

• is optional

• Type: string

• can be null

• defined in: Workers v1

StudentLoanPlanType Type

string

StudentLoanPlanType Constraints

maximum length: the maximum number of characters for this string is: 2

IsStudentFinishedStudies

Defaults to false if not specified.

IsStudentFinishedStudies

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsStudentFinishedStudies Type

boolean

IsStudentLoanPaidExternally

Defaults to false if not specified.

IsStudentLoanPaidExternally

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsStudentLoanPaidExternally Type

boolean

HasPostgradLoan

Defaults to false if not specified.

HasPostgradLoan

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

HasPostgradLoan Type

boolean

PostgradLoanPlanType

PostgradLoanPlanType

• is optional

• Type: string

• can be null

• defined in: Workers v1

PostgradLoanPlanType Type

string

PostgradLoanPlanType Constraints

maximum length: the maximum number of characters for this string is: 2

IsPostgradFinishedStudies

Defaults to false if not specified.

IsPostgradFinishedStudies

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsPostgradFinishedStudies Type

boolean

IsPostgradLoanPaidExternally

Defaults to false if not specified.

IsPostgradLoanPaidExternally

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsPostgradLoanPaidExternally Type

boolean

UKRegion

Defaults to Blank if not specified.

UKRegion

• is optional

• Type: string

• can be null

• defined in: Workers v1

UKRegion Type

string

UKRegion Constraints

pattern: the string must match the following regular expression:

^$

try pattern

Definitions group Worker

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/Worker"}

Property	Type	Required	Nullable	Defined by
EmployerRef	string	Required	cannot be null	Workers v1
PersonnelRef	string	Required	cannot be null	Workers v1
Surname	string	Optional	can be null	Workers v1
FirstForename	string	Optional	can be null	Workers v1
SecondForename	string	Optional	can be null	Workers v1
ThirdForename	string	Optional	can be null	Workers v1
Title	string	Optional	can be null	Workers v1
KnownAs	string	Optional	can be null	Workers v1
WorkerAddress	object	Optional	can be null	Workers v1
TelephoneNumber	string	Optional	can be null	Workers v1
Gender	string	Optional	can be null	Workers v1
DateOfBirth	string	Optional	can be null	Workers v1
MaritalStatus	string	Optional	can be null	Workers v1
PreviousSurname	string	Optional	can be null	Workers v1
Nationality	string	Optional	can be null	Workers v1
Citizenship	string	Optional	can be null	Workers v1
PassportHeld	string	Optional	can be null	Workers v1
NextOfKin	string	Optional	can be null	Workers v1
NextOfKinRelation	string	Optional	can be null	Workers v1
NextOfKinAddress	object	Optional	can be null	Workers v1
NextOfKinTelephone	string	Optional	can be null	Workers v1
EmergencyContact	string	Optional	can be null	Workers v1
EmergencyContactTelephone	string	Optional	can be null	Workers v1
LastAddress	object	Optional	can be null	Workers v1
DateOfAddressChange	string	Optional	can be null	Workers v1
StartDate	string	Optional	can be null	Workers v1
LeavingDate	string	Optional	can be null	Workers v1
LeavingCode	string	Optional	can be null	Workers v1
UserIndex	string	Optional	can be null	Workers v1
PersonnelNotes	string	Optional	can be null	Workers v1
WorkTelephone	string	Optional	can be null	Workers v1
WorkFax	string	Optional	can be null	Workers v1
MobileTelephone	string	Optional	can be null	Workers v1
PrimaryEmailAddress	string	Optional	can be null	Workers v1
SecondaryEmailAddress	string	Optional	can be null	Workers v1
PrimaryPayMethod	string	Optional	can be null	Workers v1
SecondaryPayMethod	string	Optional	can be null	Workers v1
PrimaryBankDetails	object	Optional	can be null	Workers v1
SecondaryBankDetails	object	Optional	can be null	Workers v1
PayrollNotes	string	Optional	can be null	Workers v1
IsStudent	boolean	Optional	can be null	Workers v1
AnalysisCode	string	Optional	can be null	Workers v1
DivisionRef	string	Optional	can be null	Workers v1
DepartmentRef	string	Optional	can be null	Workers v1
JobCategoryRef	string	Optional	can be null	Workers v1
EmploymentType	string	Optional	can be null	Workers v1
CurrencyRef	string	Optional	can be null	Workers v1
ConsultantRef	string	Optional	can be null	Workers v1
SupplierRef	string	Optional	can be null	Workers v1
PayslipPrintMethod	string	Required	can be null	Workers v1
IsWorkerAlertedBySMS	boolean	Optional	can be null	Workers v1
IsWorkerAlertedByEmail	boolean	Optional	can be null	Workers v1
AWRType	string	Required	can be null	Workers v1
PassportNumber	string	Optional	can be null	Workers v1
AnalysisCode3	string	Optional	can be null	Workers v1
AnalysisCode4	string	Optional	can be null	Workers v1
AnalysisCode5	string	Optional	can be null	Workers v1
IsExpat	boolean	Optional	can be null	Workers v1
ExternalWorkerRef	string	Optional	can be null	Workers v1
EIREngagementStatus	string	Optional	can be null	Workers v1
UTRNonCIS	string	Optional	can be null	Workers v1
IsApprentice	boolean	Optional	can be null	Workers v1
eP45PrintMethod	string	Optional	can be null	Workers v1
IsExcludedFromWTR	boolean	Optional	can be null	Workers v1
HasOnlineAccess	boolean	Optional	can be null	Workers v1
STITemplate	string	Optional	can be null	Workers v1
STIUserRef	string	Optional	can be null	Workers v1
ContractorDetails	object	Optional	can be null	Workers v1
UKPayrollDetails	object	Optional	can be null	Workers v1
ROIPayrollDetails	object	Optional	can be null	Workers v1

EmployerRef

A record with this Employer Ref must already exist in the system.

EmployerRef

• is required

• Type: string

• cannot be null

• defined in: Workers v1

EmployerRef Type

string

EmployerRef Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^([^(*?a-z)]{1,6})$

try pattern

PersonnelRef

A record with this Personnel Ref may or may not already exist in the system.

PersonnelRef

• is required

• Type: string

• cannot be null

• defined in: Workers v1

PersonnelRef Type

string

PersonnelRef Constraints

maximum length: the maximum number of characters for this string is: 10

pattern: the string must match the following regular expression:

^([A-Z0-9\-\/][A-Z0-9\-\/ ]{0,9})$

try pattern

Surname

Surname

• is optional

• Type: string

• can be null

• defined in: Workers v1

Surname Type

string

Surname Constraints

maximum length: the maximum number of characters for this string is: 20

FirstForename

FirstForename

• is optional

• Type: string

• can be null

• defined in: Workers v1

FirstForename Type

string

FirstForename Constraints

maximum length: the maximum number of characters for this string is: 20

SecondForename

SecondForename

• is optional

• Type: string

• can be null

• defined in: Workers v1

SecondForename Type

string

SecondForename Constraints

maximum length: the maximum number of characters for this string is: 20

ThirdForename

ThirdForename

• is optional

• Type: string

• can be null

• defined in: Workers v1

ThirdForename Type

string

ThirdForename Constraints

maximum length: the maximum number of characters for this string is: 20

Title

Title

• is optional

• Type: string

• can be null

• defined in: Workers v1

Title Type

string

Title Constraints

maximum length: the maximum number of characters for this string is: 4

KnownAs

KnownAs

• is optional

• Type: string

• can be null

• defined in: Workers v1

KnownAs Type

string

KnownAs Constraints

maximum length: the maximum number of characters for this string is: 20

WorkerAddress

WorkerAddress

• is optional

• Type: object

• can be null

• defined in: Workers v1

WorkerAddress Type

object

TelephoneNumber

TelephoneNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

TelephoneNumber Type

string

TelephoneNumber Constraints

maximum length: the maximum number of characters for this string is: 20

Gender

Defaults to Unknown if not specified.

Gender

• is optional

• Type: string

• can be null

• defined in: Workers v1

Gender Type

string

Gender Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Male"
"M"
"Female"
"F"
"Unknown"
"U"

DateOfBirth

DateOfBirth

• is optional

• Type: string

• can be null

• defined in: Workers v1

DateOfBirth Type

string

DateOfBirth Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

MaritalStatus

Defaults to Unknown if not specified.

MaritalStatus

• is optional

• Type: string

• can be null

• defined in: Workers v1

MaritalStatus Type

string

MaritalStatus Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Unknown"
"Single"
"Widow"
"Divorced"
"Married"

PreviousSurname

PreviousSurname

• is optional

• Type: string

• can be null

• defined in: Workers v1

PreviousSurname Type

string

PreviousSurname Constraints

maximum length: the maximum number of characters for this string is: 20

Nationality

Nationality

• is optional

• Type: string

• can be null

• defined in: Workers v1

Nationality Type

string

Nationality Constraints

maximum length: the maximum number of characters for this string is: 30

Citizenship

Citizenship

• is optional

• Type: string

• can be null

• defined in: Workers v1

Citizenship Type

string

Citizenship Constraints

maximum length: the maximum number of characters for this string is: 30

PassportHeld

Defaults to None if not specified.

PassportHeld

• is optional

• Type: string

• can be null

• defined in: Workers v1

PassportHeld Type

string

PassportHeld Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Full"
"Visitor"
"None"

NextOfKin

NextOfKin

• is optional

• Type: string

• can be null

• defined in: Workers v1

NextOfKin Type

string

NextOfKin Constraints

maximum length: the maximum number of characters for this string is: 30

NextOfKinRelation

NextOfKinRelation

• is optional

• Type: string

• can be null

• defined in: Workers v1

NextOfKinRelation Type

string

NextOfKinRelation Constraints

maximum length: the maximum number of characters for this string is: 30

NextOfKinAddress

NextOfKinAddress

• is optional

• Type: object

• can be null

• defined in: Workers v1

NextOfKinAddress Type

object

NextOfKinTelephone

NextOfKinTelephone

• is optional

• Type: string

• can be null

• defined in: Workers v1

NextOfKinTelephone Type

string

NextOfKinTelephone Constraints

maximum length: the maximum number of characters for this string is: 20

EmergencyContact

EmergencyContact

• is optional

• Type: string

• can be null

• defined in: Workers v1

EmergencyContact Type

string

EmergencyContact Constraints

maximum length: the maximum number of characters for this string is: 30

EmergencyContactTelephone

EmergencyContactTelephone

• is optional

• Type: string

• can be null

• defined in: Workers v1

EmergencyContactTelephone Type

string

EmergencyContactTelephone Constraints

maximum length: the maximum number of characters for this string is: 20

LastAddress

LastAddress

• is optional

• Type: object

• can be null

• defined in: Workers v1

LastAddress Type

object

DateOfAddressChange

DateOfAddressChange

• is optional

• Type: string

• can be null

• defined in: Workers v1

DateOfAddressChange Type

string

DateOfAddressChange Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

StartDate

StartDate

• is optional

• Type: string

• can be null

• defined in: Workers v1

StartDate Type

string

StartDate Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

LeavingDate

LeavingDate

• is optional

• Type: string

• can be null

• defined in: Workers v1

LeavingDate Type

string

LeavingDate Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

LeavingCode

A record with the Leaving Code must already exist in the system.

LeavingCode

• is optional

• Type: string

• can be null

• defined in: Workers v1

LeavingCode Type

string

LeavingCode Constraints

maximum length: the maximum number of characters for this string is: 6

UserIndex

UserIndex

• is optional

• Type: string

• can be null

• defined in: Workers v1

UserIndex Type

string

UserIndex Constraints

maximum length: the maximum number of characters for this string is: 6

PersonnelNotes

PersonnelNotes

• is optional

• Type: string

• can be null

• defined in: Workers v1

PersonnelNotes Type

string

PersonnelNotes Constraints

maximum length: the maximum number of characters for this string is: 300

WorkTelephone

WorkTelephone

• is optional

• Type: string

• can be null

• defined in: Workers v1

WorkTelephone Type

string

WorkTelephone Constraints

maximum length: the maximum number of characters for this string is: 20

WorkFax

WorkFax

• is optional

• Type: string

• can be null

• defined in: Workers v1

WorkFax Type

string

WorkFax Constraints

maximum length: the maximum number of characters for this string is: 20

MobileTelephone

MobileTelephone

• is optional

• Type: string

• can be null

• defined in: Workers v1

MobileTelephone Type

string

MobileTelephone Constraints

maximum length: the maximum number of characters for this string is: 20

PrimaryEmailAddress

PrimaryEmailAddress

• is optional

• Type: string

• can be null

• defined in: Workers v1

PrimaryEmailAddress Type

string

PrimaryEmailAddress Constraints

maximum length: the maximum number of characters for this string is: 50

SecondaryEmailAddress

SecondaryEmailAddress

• is optional

• Type: string

• can be null

• defined in: Workers v1

SecondaryEmailAddress Type

string

SecondaryEmailAddress Constraints

maximum length: the maximum number of characters for this string is: 50

PrimaryPayMethod

A record with the Primary Pay Method must already exist in the system.

PrimaryPayMethod

• is optional

• Type: string

• can be null

• defined in: Workers v1

PrimaryPayMethod Type

string

PrimaryPayMethod Constraints

maximum length: the maximum number of characters for this string is: 10

SecondaryPayMethod

A record with the Secondary Pay Method must already exist in the system.

SecondaryPayMethod

• is optional

• Type: string

• can be null

• defined in: Workers v1

SecondaryPayMethod Type

string

SecondaryPayMethod Constraints

maximum length: the maximum number of characters for this string is: 10

PrimaryBankDetails

PrimaryBankDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

PrimaryBankDetails Type

object

SecondaryBankDetails

SecondaryBankDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

SecondaryBankDetails Type

object

PayrollNotes

PayrollNotes

• is optional

• Type: string

• can be null

• defined in: Workers v1

PayrollNotes Type

string

PayrollNotes Constraints

maximum length: the maximum number of characters for this string is: 300

IsStudent

Defaults to false if not supplied.

IsStudent

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsStudent Type

boolean

AnalysisCode

AnalysisCode

• is optional

• Type: string

• can be null

• defined in: Workers v1

AnalysisCode Type

string

AnalysisCode Constraints

maximum length: the maximum number of characters for this string is: 10

DivisionRef

Defaults from API settings for Employer if not supplied. A record with the Division Ref must already exist in the system.

DivisionRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

DivisionRef Type

string

DivisionRef Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^([^a-z?*]{1,6})$

try pattern

DepartmentRef

Defaults from API settings for Employer if not supplied. A record with the Department Ref must already exist in the system.

DepartmentRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

DepartmentRef Type

string

DepartmentRef Constraints

maximum length: the maximum number of characters for this string is: 10

pattern: the string must match the following regular expression:

^([^a-z?*]{1,10})$

try pattern

JobCategoryRef

JobCategoryRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

JobCategoryRef Type

string

JobCategoryRef Constraints

maximum length: the maximum number of characters for this string is: 8

pattern: the string must match the following regular expression:

^([^a-z?*]{0,8})$

try pattern

EmploymentType

Defaults to PAYE if not specified.

EmploymentType

• is optional

• Type: string

• can be null

• defined in: Workers v1

EmploymentType Type

string

EmploymentType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"PAYE"
"Contractor"
"ManagedAgencyWorker"
"UmbrellaCompositeWorker"

CurrencyRef

Defaults to Employer's Base Currency if not supplied. A record with the Currency Ref must already exist in the system.

CurrencyRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

CurrencyRef Type

string

CurrencyRef Constraints

maximum length: the maximum number of characters for this string is: 3

ConsultantRef

A record with the Consultant Ref must already exist in the system.

ConsultantRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

ConsultantRef Type

string

ConsultantRef Constraints

maximum length: the maximum number of characters for this string is: 10

pattern: the string must match the following regular expression:

^([^(*?a-z)]{1,10})$

try pattern

SupplierRef

A record with the Supplier Ref must already exist in the system. Mandatory for Managed Agency & Umbrella Workers.

SupplierRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

SupplierRef Type

string

SupplierRef Constraints

maximum length: the maximum number of characters for this string is: 10

pattern: the string must match the following regular expression:

^([A-Z0-9\-\/][A-Z0-9\-\/ ]{0,9})$

try pattern

PayslipPrintMethod

Defaults to Paper if not specified.

PayslipPrintMethod

• is required

• Type: string

• can be null

• defined in: Workers v1

PayslipPrintMethod Type

string

PayslipPrintMethod Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Paper"
"Electronic"
"Both"

IsWorkerAlertedBySMS

Defaults to false if not supplied.

IsWorkerAlertedBySMS

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsWorkerAlertedBySMS Type

boolean

IsWorkerAlertedByEmail

Defaults to false if not supplied.

IsWorkerAlertedByEmail

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsWorkerAlertedByEmail Type

boolean

AWRType

Defaults to Parity for PAYE Workers, else Excluded for all others.

AWRType

• is required

• Type: string

• can be null

• defined in: Workers v1

AWRType Type

string

AWRType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Parity"
"Derogated"
"Excluded"

PassportNumber

PassportNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

PassportNumber Type

string

PassportNumber Constraints

maximum length: the maximum number of characters for this string is: 35

AnalysisCode3

A record with the Analysis Code 3 must already exist in the system.

AnalysisCode3

• is optional

• Type: string

• can be null

• defined in: Workers v1

AnalysisCode3 Type

string

AnalysisCode3 Constraints

maximum length: the maximum number of characters for this string is: 6

AnalysisCode4

A record with the Analysis Code 4 must already exist in the system.

AnalysisCode4

• is optional

• Type: string

• can be null

• defined in: Workers v1

AnalysisCode4 Type

string

AnalysisCode4 Constraints

maximum length: the maximum number of characters for this string is: 6

AnalysisCode5

A record with the Analysis Code 5 must already exist in the system.

AnalysisCode5

• is optional

• Type: string

• can be null

• defined in: Workers v1

AnalysisCode5 Type

string

AnalysisCode5 Constraints

maximum length: the maximum number of characters for this string is: 6

IsExpat

Defaults to false if not supplied.

IsExpat

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsExpat Type

boolean

ExternalWorkerRef

ExternalWorkerRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

ExternalWorkerRef Type

string

ExternalWorkerRef Constraints

maximum length: the maximum number of characters for this string is: 40

EIREngagementStatus

EIREngagementStatus

• is optional

• Type: string

• can be null

• defined in: Workers v1

EIREngagementStatus Type

string

EIREngagementStatus Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"SelfEmployed"
"Partnership"
"LtdCompany"
"NonUK"
"PAYE"

UTRNonCIS

UTRNonCIS

• is optional

• Type: string

• can be null

• defined in: Workers v1

UTRNonCIS Type

string

UTRNonCIS Constraints

maximum length: the maximum number of characters for this string is: 10

IsApprentice

Defaults to false if not supplied.

IsApprentice

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsApprentice Type

boolean

eP45PrintMethod

Defaults to Paper if not specified.

eP45PrintMethod

• is optional

• Type: string

• can be null

• defined in: Workers v1

eP45PrintMethod Type

string

eP45PrintMethod Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
null
"Paper"
"Electronic"

IsExcludedFromWTR

Defaults to false if not supplied.

IsExcludedFromWTR

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

IsExcludedFromWTR Type

boolean

HasOnlineAccess

Defaults to false if not supplied.

HasOnlineAccess

• is optional

• Type: boolean

• can be null

• defined in: Workers v1

HasOnlineAccess Type

boolean

STITemplate

STITemplate

• is optional

• Type: string

• can be null

• defined in: Workers v1

STITemplate Type

string

STITemplate Constraints

maximum length: the maximum number of characters for this string is: 100

STIUserRef

STIUserRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

STIUserRef Type

string

STIUserRef Constraints

maximum length: the maximum number of characters for this string is: 100

ContractorDetails

Supplier Import Layout

ContractorDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

ContractorDetails Type

object

UKPayrollDetails

UKPayrollDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

UKPayrollDetails Type

object

ROIPayrollDetails

ROIPayrollDetails

• is optional

• Type: object

• can be null

• defined in: Workers v1

ROIPayrollDetails Type

object

Definitions group WorkerAddress

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerAddress"}

Property	Type	Required	Nullable	Defined by
AddressLine1	string	Optional	can be null	Workers v1
AddressLine2	string	Optional	can be null	Workers v1
AddressLine3	string	Optional	can be null	Workers v1
AddressLine4	string	Optional	can be null	Workers v1
AddressLine5	string	Optional	can be null	Workers v1
Postcode	string	Optional	can be null	Workers v1
Country	string	Optional	can be null	Workers v1

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine1 Type

string

AddressLine1 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine2 Type

string

AddressLine2 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine3 Type

string

AddressLine3 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine4 Type

string

AddressLine4 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine5 Type

string

AddressLine5 Constraints

maximum length: the maximum number of characters for this string is: 40

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

• defined in: Workers v1

Postcode Type

string

Postcode Constraints

maximum length: the maximum number of characters for this string is: 10

Country

Country of the Address

Country

• is optional

• Type: string

• can be null

• defined in: Workers v1

Country Type

string

Country Constraints

maximum length: the maximum number of characters for this string is: 40

Definitions group WorkerAddress-1

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerAddress-1"}

Property	Type	Required	Nullable	Defined by
AddressLine1	string	Optional	can be null	Workers v1
AddressLine2	string	Optional	can be null	Workers v1
AddressLine3	string	Optional	can be null	Workers v1
AddressLine4	string	Optional	can be null	Workers v1
AddressLine5	string	Optional	can be null	Workers v1
Postcode	string	Optional	can be null	Workers v1
Country	string	Optional	can be null	Workers v1

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine1 Type

string

AddressLine1 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine2 Type

string

AddressLine2 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine3 Type

string

AddressLine3 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine4 Type

string

AddressLine4 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine5 Type

string

AddressLine5 Constraints

maximum length: the maximum number of characters for this string is: 40

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

• defined in: Workers v1

Postcode Type

string

Postcode Constraints

maximum length: the maximum number of characters for this string is: 10

Country

Country of the Address

Country

• is optional

• Type: string

• can be null

• defined in: Workers v1

Country Type

string

Country Constraints

maximum length: the maximum number of characters for this string is: 40

Definitions group WorkerAddress-2

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerAddress-2"}

Property	Type	Required	Nullable	Defined by
AddressLine1	string	Optional	can be null	Workers v1
AddressLine2	string	Optional	can be null	Workers v1
AddressLine3	string	Optional	can be null	Workers v1
AddressLine4	string	Optional	can be null	Workers v1
AddressLine5	string	Optional	can be null	Workers v1
Postcode	string	Optional	can be null	Workers v1
Country	string	Optional	can be null	Workers v1

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine1 Type

string

AddressLine1 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine2 Type

string

AddressLine2 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine3 Type

string

AddressLine3 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine4 Type

string

AddressLine4 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine5 Type

string

AddressLine5 Constraints

maximum length: the maximum number of characters for this string is: 40

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

• defined in: Workers v1

Postcode Type

string

Postcode Constraints

maximum length: the maximum number of characters for this string is: 10

Country

Country of the Address

Country

• is optional

• Type: string

• can be null

• defined in: Workers v1

Country Type

string

Country Constraints

maximum length: the maximum number of characters for this string is: 40

Definitions group WorkerAddress-3

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerAddress-3"}

Property	Type	Required	Nullable	Defined by
AddressLine1	string	Optional	can be null	Workers v1
AddressLine2	string	Optional	can be null	Workers v1
AddressLine3	string	Optional	can be null	Workers v1
AddressLine4	string	Optional	can be null	Workers v1
AddressLine5	string	Optional	can be null	Workers v1
Postcode	string	Optional	can be null	Workers v1
Country	string	Optional	can be null	Workers v1

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine1 Type

string

AddressLine1 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine2 Type

string

AddressLine2 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine3 Type

string

AddressLine3 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine4 Type

string

AddressLine4 Constraints

maximum length: the maximum number of characters for this string is: 40

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Workers v1

AddressLine5 Type

string

AddressLine5 Constraints

maximum length: the maximum number of characters for this string is: 40

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

• defined in: Workers v1

Postcode Type

string

Postcode Constraints

maximum length: the maximum number of characters for this string is: 10

Country

Country of the Address

Country

• is optional

• Type: string

• can be null

• defined in: Workers v1

Country Type

string

Country Constraints

maximum length: the maximum number of characters for this string is: 40

Definitions group WorkerBankDetails

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerBankDetails"}

Property	Type	Required	Nullable	Defined by
BankAccountType	integer	Optional	can be null	Workers v1
BankRef	string	Optional	can be null	Workers v1
BuildingSocietyName	string	Optional	can be null	Workers v1
BuildingSocietyNumber	string	Optional	can be null	Workers v1
BankSortCode	string	Optional	can be null	Workers v1
BankAccountNumber	string	Optional	can be null	Workers v1
BankAccountName	string	Optional	can be null	Workers v1
IBAN	string	Optional	can be null	Workers v1
BIC	string	Optional	can be null	Workers v1

BankAccountType

BankAccountType

• is optional

• Type: integer

• can be null

• defined in: Workers v1

BankAccountType Type

integer

BankAccountType Constraints

maximum: the value of this number must smaller than or equal to: 9

minimum: the value of this number must greater than or equal to: 0

BankRef

BankRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankRef Type

string

BankRef Constraints

maximum length: the maximum number of characters for this string is: 20

BuildingSocietyName

BuildingSocietyName

• is optional

• Type: string

• can be null

• defined in: Workers v1

BuildingSocietyName Type

string

BuildingSocietyName Constraints

maximum length: the maximum number of characters for this string is: 20

BuildingSocietyNumber

BuildingSocietyNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

BuildingSocietyNumber Type

string

BuildingSocietyNumber Constraints

maximum length: the maximum number of characters for this string is: 20

BankSortCode

A record with this Bank Sort Code must already exist in the system ('BACS' Only)

BankSortCode

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankSortCode Type

string

BankSortCode Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^\d{6}$

try pattern

BankAccountNumber

BankAccountNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountNumber Type

string

BankAccountNumber Constraints

maximum length: the maximum number of characters for this string is: 10

minimum length: the minimum number of characters for this string is: 8

pattern: the string must match the following regular expression:

^\d{8}\d{0,2}$

try pattern

BankAccountName

BankAccountName

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountName Type

string

BankAccountName Constraints

maximum length: the maximum number of characters for this string is: 30

IBAN

IBAN

• is optional

• Type: string

• can be null

• defined in: Workers v1

IBAN Type

string

IBAN Constraints

maximum length: the maximum number of characters for this string is: 34

pattern: the string must match the following regular expression:

[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}

try pattern

BIC

BIC

• is optional

• Type: string

• can be null

• defined in: Workers v1

BIC Type

string

BIC Constraints

maximum length: the maximum number of characters for this string is: 11

pattern: the string must match the following regular expression:

^[A-Z]{4}[A-Z]{2}[A-Z1-9]{2}([A-Z\d]{3})?$

try pattern

Definitions group WorkerBankDetails-1

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/workers.v1.schema#/definitions/WorkerBankDetails-1"}

Property	Type	Required	Nullable	Defined by
BankAccountType	integer	Optional	can be null	Workers v1
BankRef	string	Optional	can be null	Workers v1
BuildingSocietyName	string	Optional	can be null	Workers v1
BuildingSocietyNumber	string	Optional	can be null	Workers v1
BankSortCode	string	Optional	can be null	Workers v1
BankAccountNumber	string	Optional	can be null	Workers v1
BankAccountName	string	Optional	can be null	Workers v1
IBAN	string	Optional	can be null	Workers v1
BIC	string	Optional	can be null	Workers v1

BankAccountType

BankAccountType

• is optional

• Type: integer

• can be null

• defined in: Workers v1

BankAccountType Type

integer

BankAccountType Constraints

maximum: the value of this number must smaller than or equal to: 9

minimum: the value of this number must greater than or equal to: 0

BankRef

BankRef

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankRef Type

string

BankRef Constraints

maximum length: the maximum number of characters for this string is: 20

BuildingSocietyName

BuildingSocietyName

• is optional

• Type: string

• can be null

• defined in: Workers v1

BuildingSocietyName Type

string

BuildingSocietyName Constraints

maximum length: the maximum number of characters for this string is: 20

BuildingSocietyNumber

BuildingSocietyNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

BuildingSocietyNumber Type

string

BuildingSocietyNumber Constraints

maximum length: the maximum number of characters for this string is: 20

BankSortCode

A record with this Bank Sort Code must already exist in the system ('BACS' Only)

BankSortCode

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankSortCode Type

string

BankSortCode Constraints

maximum length: the maximum number of characters for this string is: 6

pattern: the string must match the following regular expression:

^\d{6}$

try pattern

BankAccountNumber

BankAccountNumber

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountNumber Type

string

BankAccountNumber Constraints

maximum length: the maximum number of characters for this string is: 10

minimum length: the minimum number of characters for this string is: 8

pattern: the string must match the following regular expression:

^\d{8}\d{0,2}$

try pattern

BankAccountName

BankAccountName

• is optional

• Type: string

• can be null

• defined in: Workers v1

BankAccountName Type

string

BankAccountName Constraints

maximum length: the maximum number of characters for this string is: 30

IBAN

IBAN

• is optional

• Type: string

• can be null

• defined in: Workers v1

IBAN Type

string

IBAN Constraints

maximum length: the maximum number of characters for this string is: 34

pattern: the string must match the following regular expression:

[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}

try pattern

BIC

BIC

• is optional

• Type: string

• can be null

• defined in: Workers v1

BIC Type

string

BIC Constraints

maximum length: the maximum number of characters for this string is: 11

pattern: the string must match the following regular expression:

^[A-Z]{4}[A-Z]{2}[A-Z1-9]{2}([A-Z\d]{3})?$

try pattern