Skip to main content

Suppliers v1

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

Suppliers.v1 Import Layout

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Cannot be instantiatedYesUnknown statusUnknown identifiabilityForbiddenAllowednonesuppliers.v1.schema.json

Suppliers.v1 Type​

object[]

Suppliers.v1 Definitions

Definitions group BankDetails​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/suppliers.v1.schema#/definitions/BankDetails"}
PropertyTypeRequiredNullableDefined by
BankSortCodestringOptionalcan be nullSuppliers v1
BankAccountNumberstringOptionalcan be nullSuppliers v1
BankAccountNamestringOptionalcan be nullSuppliers v1
IBANstringOptionalcan be nullSuppliers v1
BICstringOptionalcan be nullSuppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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/suppliers.v1.schema#/definitions/CISDetails"}
PropertyTypeRequiredNullableDefined by
CISUniqueTaxReferencestringOptionalcan be nullSuppliers v1
CISLegalStatusstringOptionalcan be nullSuppliers v1
CISPartnershipNamestringOptionalcan be nullSuppliers v1
CISPartnershipUTRstringOptionalcan be nullSuppliers v1

CISUniqueTaxReference​

CISUniqueTaxReference

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers v1

CISLegalStatus Type​

string

CISLegalStatus Constraints​

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

ValueExplanation
null
"SelfEmployed"
"LimitedCompany"
"Partnership"

CISPartnershipName​

CISPartnershipName

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers v1

CISPartnershipUTR Type​

string

CISPartnershipUTR Constraints​

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

Definitions group Partner​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/suppliers.v1.schema#/definitions/Partner"}
PropertyTypeRequiredNullableDefined by
PartnerNamestringOptionalcan be nullSuppliers v1
PartnerDateOfBirthstringOptionalcan be nullSuppliers v1
PartnerNINumberstringOptionalcan be nullSuppliers v1

PartnerName​

PartnerName

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers 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: Suppliers v1

PartnerNINumber Type​

string

PartnerNINumber Constraints​

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

Definitions group Supplier​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/suppliers.v1.schema#/definitions/Supplier"}
PropertyTypeRequiredNullableDefined by
EmployerRefstringRequiredcannot be nullSuppliers v1
SupplierRefstringRequiredcannot be nullSuppliers v1
LegalStatusstringOptionalcan be nullSuppliers v1
SupplierTypestringOptionalcan be nullSuppliers v1
BusinessNamestringRequiredcannot be nullSuppliers v1
AddressobjectOptionalcan be nullSuppliers v1
IncorporationDatestringOptionalcan be nullSuppliers v1
CompanyRegNostringOptionalcan be nullSuppliers v1
VATNumberstringOptionalcan be nullSuppliers v1
VATCodeSourcestringOptionalcan be nullSuppliers v1
DefaultVATRatestringOptionalcan be nullSuppliers v1
DivisionRefstringOptionalcan be nullSuppliers v1
DepartmentRefstringOptionalcan be nullSuppliers v1
PurchaseLedgerAccountNumberstringOptionalcan be nullSuppliers v1
PaymentOptionstringOptionalcan be nullSuppliers v1
PaymentTermsValueintegerOptionalcan be nullSuppliers v1
PayMethodstringOptionalcan be nullSuppliers v1
CurrencyRefstringOptionalcan be nullSuppliers v1
IsSelfBillingEnabledbooleanOptionalcan be nullSuppliers v1
SelfBillingLogoFilenamestringOptionalcan be nullSuppliers v1
SelfBillingInvoiceBreakLevelstringOptionalcan be nullSuppliers v1
SupplierNotesstringOptionalcan be nullSuppliers v1
EmailAddressstringOptionalcan be nullSuppliers v1
PayslipPrintMethodstringOptionalcan be nullSuppliers v1
IsPaidWhenPaidbooleanOptionalcan be nullSuppliers v1
TaxReferenceNumberstringOptionalcan be nullSuppliers v1
IsOn46GReportbooleanOptionalcan be nullSuppliers v1
BankDetailsobjectOptionalcan be nullSuppliers v1
CISDetailsobjectOptionalcan be nullSuppliers v1
PartnersarrayOptionalcan be nullSuppliers v1

EmployerRef​

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

EmployerRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Suppliers 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

SupplierRef​

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

SupplierRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Suppliers 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

LegalStatus​

This is mandatory for new suppliers.

LegalStatus

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers v1

LegalStatus Type​

string

LegalStatus Constraints​

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

ValueExplanation
null
"LimitedCompany"
"SelfEmployed"
"Partnership"
"CIS"

SupplierType​

Defaults to the Employer's Default Supplier Type if not specified.

SupplierType

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers v1

SupplierType Type​

string

SupplierType Constraints​

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

ValueExplanation
null
"Contractor"
"Umbrella"
"ManagedAgency"

BusinessName​

BusinessName

  • is required

  • Type: string

  • cannot be null

  • defined in: Suppliers 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: Suppliers v1

Address Type​

object

IncorporationDate​

IncorporationDate

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers v1

VATCodeSource Type​

string

VATCodeSource Constraints​

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

ValueExplanation
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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers v1

PaymentOption Type​

string

PaymentOption Constraints​

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

ValueExplanation
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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers v1

SelfBillingInvoiceBreakLevel Type​

string

SelfBillingInvoiceBreakLevel Constraints​

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

ValueExplanation
null
"Supplier"
"Worker"
"Timesheet"

SupplierNotes​

General free format text relating to the supplier.

SupplierNotes

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers 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: Suppliers v1

PayslipPrintMethod Type​

string

PayslipPrintMethod Constraints​

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

ValueExplanation
null
"Paper"
"Electronic"
"Both"

IsPaidWhenPaid​

Defaults to false if not supplied.

IsPaidWhenPaid

  • is optional

  • Type: boolean

  • can be null

  • defined in: Suppliers v1

IsPaidWhenPaid Type​

boolean

TaxReferenceNumber​

Irish Payroll Only.

TaxReferenceNumber

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers v1

IsOn46GReport Type​

boolean

BankDetails​

BankDetails

  • is optional

  • Type: object

  • can be null

  • defined in: Suppliers v1

BankDetails Type​

object

CISDetails​

CISDetails

  • is optional

  • Type: object

  • can be null

  • defined in: Suppliers v1

CISDetails Type​

object

Partners​

Partners

  • is optional

  • Type: object[]

  • can be null

  • defined in: Suppliers v1

Partners Type​

object[]

Definitions group WorkerAddress​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/suppliers.v1.schema#/definitions/WorkerAddress"}
PropertyTypeRequiredNullableDefined by
AddressLine1stringOptionalcan be nullSuppliers v1
AddressLine2stringOptionalcan be nullSuppliers v1
AddressLine3stringOptionalcan be nullSuppliers v1
AddressLine4stringOptionalcan be nullSuppliers v1
AddressLine5stringOptionalcan be nullSuppliers v1
PostcodestringOptionalcan be nullSuppliers v1
CountrystringOptionalcan be nullSuppliers v1

AddressLine1​

Address Line 1 of the Address

AddressLine1

  • is optional

  • Type: string

  • can be null

  • defined in: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers 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: Suppliers v1

Country Type​

string

Country Constraints​

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