Clients v1

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

Clients.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	clients.v1.schema.json

Clients.v1 Type

object[]

Clients.v1 Definitions

Definitions group AddressWithCountryRef

Reference this group by using

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

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

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine1 Type

string

AddressLine1 Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine2 Type

string

AddressLine2 Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine3 Type

string

AddressLine3 Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine4 Type

string

AddressLine4 Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine5 Type

string

AddressLine5 Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

• defined in: Clients v1

Postcode Type

string

Postcode Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,10})

try pattern

Country

Country of the Address

Country

• is optional

• Type: string

• can be null

• defined in: Clients v1

Country Type

string

Country Constraints

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

pattern: the string must match the following regular expression:

([^?*]{0,100})

try pattern

CountryRef

If supplied will look up Country Name using this Ref

CountryRef

• is required

• Type: string

• can be null

• defined in: Clients v1

CountryRef Type

string

CountryRef 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

Definitions group Client

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
EmployerRef	string	Required	can be null	Clients v1
ClientRef	string	Required	cannot be null	Clients v1
DivisionRef	string	Optional	can be null	Clients v1
DepartmentRef	string	Optional	can be null	Clients v1
ClientName	string	Optional	can be null	Clients v1
Address	object	Optional	can be null	Clients v1
IsInvoiceToBeProduced	boolean	Optional	can be null	Clients v1
InvoiceFrequency	string	Optional	can be null	Clients v1
InvoiceOrder	integer	Optional	can be null	Clients v1
InvoiceCalculationGroup	integer	Optional	can be null	Clients v1
VATNumber	string	Optional	can be null	Clients v1
CurrencyRef	string	Optional	can be null	Clients v1
IsCreditChecked	boolean	Optional	can be null	Clients v1
SettlementDays	integer	Optional	can be null	Clients v1
IsPORequired	boolean	Optional	can be null	Clients v1
JobCategoryRef	string	Optional	can be null	Clients v1
ReportToClientRef	string	Optional	can be null	Clients v1
InvoiceToClientRef	string	Optional	can be null	Clients v1
TempConsultantRef	string	Optional	can be null	Clients v1
PermConsultantRef	string	Optional	can be null	Clients v1
FixedNIPercentage	number	Optional	can be null	Clients v1
WTRPercentage	number	Optional	can be null	Clients v1
IsWTRMarginAccrualPercentageOverridden	boolean	Required	can be null	Clients v1
WTRMarginAccrualPercentage	number	Optional	can be null	Clients v1
Notes	string	Optional	can be null	Clients v1
DefaultVATCode	string	Optional	can be null	Clients v1
AccountsACRef	string	Optional	can be null	Clients v1
LegalHirerRef	string	Optional	can be null	Clients v1
DefaultAssignmentTypeRef	string	Optional	can be null	Clients v1
FixedPensionPercentage	number	Optional	can be null	Clients v1
TimesheetCRFGroupRef	string	Optional	can be null	Clients v1
PlacementCRFGroupRef	string	Optional	can be null	Clients v1
IsIncludedOnGPreport	boolean	Optional	can be null	Clients v1
IsDocPrintedWithInvoice	boolean	Optional	can be null	Clients v1
VATArea	string	Optional	can be null	Clients v1
IsVATExempt	boolean	Optional	can be null	Clients v1
EUVATExemptionNumber	string	Optional	can be null	Clients v1
IsEIRDirectClient	boolean	Optional	can be null	Clients v1
IsCRFPrintedOnInvoices	boolean	Optional	can be null	Clients v1
SettlementTermsRef	string	Optional	can be null	Clients v1
IsPublicSector	boolean	Optional	can be null	Clients v1
IsAlwaysOPWIPS	boolean	Optional	can be null	Clients v1
AdditionalAddresses	array	Optional	can be null	Clients v1
PersonnelContact	object	Optional	can be null	Clients v1
InvoicingContact	object	Optional	can be null	Clients v1
ClientContact	object	Optional	can be null	Clients v1
CustomerDefinedFields	object	Optional	can be null	Clients v1
OnlineOptions	object	Optional	can be null	Clients v1
AdvancedBilling	object	Optional	can be null	Clients v1

EmployerRef

Please note: This API does not currently support the use of '*' for All Employers as an EmployerRef value.

EmployerRef

• is required

• Type: string

• can be null

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

ClientRef

ClientRef

• is required

• Type: string

• cannot be null

• defined in: Clients v1

ClientRef Type

string

ClientRef 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

DivisionRef

For new records, if a value is not specified then the value will default to the API default value configured for the specified EmployerRef.

DivisionRef

• is optional

• Type: string

• can be null

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

For new records, if a value is not specified then the value will default to the API default value configured for the specified EmployerRef.

DepartmentRef

• is optional

• Type: string

• can be null

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

ClientName

ClientName

• is optional

• Type: string

• can be null

• defined in: Clients v1

ClientName Type

string

ClientName Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,100})$

try pattern

Address

Address

• is optional

• Type: object

• can be null

• defined in: Clients v1

Address Type

object

IsInvoiceToBeProduced

IsInvoiceToBeProduced

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsInvoiceToBeProduced Type

boolean

InvoiceFrequency

InvoiceFrequency

• is optional

• Type: string

• can be null

• defined in: Clients v1

InvoiceFrequency Type

string

InvoiceFrequency 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

InvoiceOrder

InvoiceOrder

• is optional

• Type: integer

• can be null

• defined in: Clients v1

InvoiceOrder Type

integer

InvoiceCalculationGroup

InvoiceCalculationGroup

• is optional

• Type: integer

• can be null

• defined in: Clients v1

InvoiceCalculationGroup Type

integer

VATNumber

VATNumber

• is optional

• Type: string

• can be null

• defined in: Clients v1

VATNumber Type

string

VATNumber Constraints

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

CurrencyRef

CurrencyRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

CurrencyRef Type

string

CurrencyRef Constraints

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

IsCreditChecked

IsCreditChecked

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsCreditChecked Type

boolean

SettlementDays

SettlementDays

• is optional

• Type: integer

• can be null

• defined in: Clients v1

SettlementDays Type

integer

SettlementDays Constraints

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

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

IsPORequired

IsPORequired

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsPORequired Type

boolean

JobCategoryRef

JobCategoryRef

• is optional

• Type: string

• can be null

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

ReportToClientRef

ReportToClientRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

ReportToClientRef Type

string

ReportToClientRef 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

InvoiceToClientRef

InvoiceToClientRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

InvoiceToClientRef Type

string

InvoiceToClientRef 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

TempConsultantRef

TempConsultantRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

TempConsultantRef Type

string

TempConsultantRef 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

PermConsultantRef

PermConsultantRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

PermConsultantRef Type

string

PermConsultantRef 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

FixedNIPercentage

FixedNIPercentage

• is optional

• Type: number

• can be null

• defined in: Clients v1

FixedNIPercentage Type

number

WTRPercentage

WTRPercentage

• is optional

• Type: number

• can be null

• defined in: Clients v1

WTRPercentage Type

number

IsWTRMarginAccrualPercentageOverridden

IsWTRMarginAccrualPercentageOverridden

• is required

• Type: boolean

• can be null

• defined in: Clients v1

IsWTRMarginAccrualPercentageOverridden Type

boolean

WTRMarginAccrualPercentage

WTRMarginAccrualPercentage

• is optional

• Type: number

• can be null

• defined in: Clients v1

WTRMarginAccrualPercentage Type

number

Notes

Notes

• is optional

• Type: string

• can be null

• defined in: Clients v1

Notes Type

string

Notes Constraints

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

DefaultVATCode

DefaultVATCode

• is optional

• Type: string

• can be null

• defined in: Clients v1

DefaultVATCode Type

string

DefaultVATCode Constraints

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

AccountsACRef

AccountsACRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

AccountsACRef Type

string

AccountsACRef Constraints

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

LegalHirerRef

LegalHirerRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

LegalHirerRef Type

string

LegalHirerRef 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

DefaultAssignmentTypeRef

DefaultAssignmentTypeRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

DefaultAssignmentTypeRef Type

string

DefaultAssignmentTypeRef Constraints

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

pattern: the string must match the following regular expression:

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

try pattern

FixedPensionPercentage

FixedPensionPercentage

• is optional

• Type: number

• can be null

• defined in: Clients v1

FixedPensionPercentage Type

number

TimesheetCRFGroupRef

TimesheetCRFGroupRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

TimesheetCRFGroupRef Type

string

TimesheetCRFGroupRef Constraints

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

pattern: the string must match the following regular expression:

^([^a-z]{0,10})$

try pattern

PlacementCRFGroupRef

PlacementCRFGroupRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

PlacementCRFGroupRef Type

string

PlacementCRFGroupRef Constraints

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

pattern: the string must match the following regular expression:

^([^a-z]{0,10})$

try pattern

IsIncludedOnGPreport

IsIncludedOnGPreport

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsIncludedOnGPreport Type

boolean

IsDocPrintedWithInvoice

IsDocPrintedWithInvoice

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsDocPrintedWithInvoice Type

boolean

VATArea

VATArea

• is optional

• Type: string

• can be null

• defined in: Clients v1

VATArea Type

string

VATArea Constraints

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

IsVATExempt

Replaces 'Is VATable' flag used in legacy CSV Imports

IsVATExempt

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsVATExempt Type

boolean

EUVATExemptionNumber

Replaces 'Euro VAT Number' field used in legacy CSV Imports

EUVATExemptionNumber

• is optional

• Type: string

• can be null

• defined in: Clients v1

EUVATExemptionNumber Type

string

EUVATExemptionNumber Constraints

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

IsEIRDirectClient

IsEIRDirectClient

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsEIRDirectClient Type

boolean

IsCRFPrintedOnInvoices

IsCRFPrintedOnInvoices

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsCRFPrintedOnInvoices Type

boolean

SettlementTermsRef

SettlementTermsRef

• is optional

• Type: string

• can be null

• defined in: Clients v1

SettlementTermsRef Type

string

SettlementTermsRef Constraints

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

IsPublicSector

IsPublicSector

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsPublicSector Type

boolean

IsAlwaysOPWIPS

This value will be ignore unless IsPublicSector is true

IsAlwaysOPWIPS

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsAlwaysOPWIPS Type

boolean

AdditionalAddresses

AdditionalAddresses

• is optional

• Type: object[]

• can be null

• defined in: Clients v1

AdditionalAddresses Type

object[]

PersonnelContact

PersonnelContact

• is optional

• Type: object

• can be null

• defined in: Clients v1

PersonnelContact Type

object

InvoicingContact

InvoicingContact

• is optional

• Type: object

• can be null

• defined in: Clients v1

InvoicingContact Type

object

ClientContact

ClientContact

• is optional

• Type: object

• can be null

• defined in: Clients v1

ClientContact Type

object

CustomerDefinedFields

CustomerDefinedFields

• is optional

• Type: object

• can be null

• defined in: Clients v1

CustomerDefinedFields Type

object

OnlineOptions

OnlineOptions

• is optional

• Type: object

• can be null

• defined in: Clients v1

OnlineOptions Type

object

AdvancedBilling

AdvancedBilling

• is optional

• Type: object

• can be null

• defined in: Clients v1

AdvancedBilling Type

object

Definitions group ClientAddress

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
AddressNumber	integer	Required	cannot be null	Clients v1
Name	string	Required	can be null	Clients v1
Contact	string	Required	can be null	Clients v1
Department	string	Required	can be null	Clients v1
Telephone	string	Required	can be null	Clients v1
Fax	string	Required	can be null	Clients v1
IsInvoiceAddress	boolean	Required	can be null	Clients v1
IsSiteAddress	boolean	Required	can be null	Clients v1
EmailAddress	string	Required	can be null	Clients v1
AddressLine1	string	Optional	can be null	Clients v1
AddressLine2	string	Optional	can be null	Clients v1
AddressLine3	string	Optional	can be null	Clients v1
AddressLine4	string	Optional	can be null	Clients v1
AddressLine5	string	Optional	can be null	Clients v1
Postcode	string	Optional	can be null	Clients v1
Country	string	Optional	can be null	Clients v1

AddressNumber

AddressNumber

• is required

• Type: integer

• cannot be null

• defined in: Clients v1

AddressNumber Type

integer

Name

Name

• is required

• Type: string

• can be null

• defined in: Clients v1

Name Type

string

Name Constraints

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

Contact

Contact

• is required

• Type: string

• can be null

• defined in: Clients v1

Contact Type

string

Contact Constraints

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

Department

Department

• is required

• Type: string

• can be null

• defined in: Clients v1

Department Type

string

Department Constraints

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

Telephone

Telephone

• is required

• Type: string

• can be null

• defined in: Clients v1

Telephone Type

string

Telephone Constraints

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

Fax

Fax

• is required

• Type: string

• can be null

• defined in: Clients v1

Fax Type

string

Fax Constraints

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

IsInvoiceAddress

IsInvoiceAddress

• is required

• Type: boolean

• can be null

• defined in: Clients v1

IsInvoiceAddress Type

boolean

IsSiteAddress

IsSiteAddress

• is required

• Type: boolean

• can be null

• defined in: Clients v1

IsSiteAddress Type

boolean

EmailAddress

EmailAddress

• is required

• Type: string

• can be null

• defined in: Clients v1

EmailAddress Type

string

EmailAddress Constraints

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

AddressLine1

Address Line 1 of the Address

AddressLine1

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine1 Type

string

AddressLine1 Constraints

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

AddressLine2

Address Line 2 of the Address

AddressLine2

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine2 Type

string

AddressLine2 Constraints

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

AddressLine3

Address Line 3 of the Address

AddressLine3

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine3 Type

string

AddressLine3 Constraints

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

AddressLine4

Address Line 4 of the Address

AddressLine4

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine4 Type

string

AddressLine4 Constraints

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

AddressLine5

Address Line 5 of the Address

AddressLine5

• is optional

• Type: string

• can be null

• defined in: Clients v1

AddressLine5 Type

string

AddressLine5 Constraints

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

Postcode

Post Code of the Address

Postcode

• is optional

• Type: string

• can be null

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

Country Type

string

Country Constraints

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

Definitions group ClientAdvancedBilling

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
IsEmailGenerationDisabled	boolean	Optional	can be null	Clients v1
IsClientSelfBillingEnabled	boolean	Optional	can be null	Clients v1
IsPreBillingEnabled	boolean	Optional	can be null	Clients v1
IsVATPrintedOnPreBill	boolean	Optional	can be null	Clients v1
IsNegativeTimesheetShownOnPreBill	boolean	Optional	can be null	Clients v1
InvoiceDeliveryMethod	string	Optional	can be null	Clients v1
MasterDocument	string	Optional	can be null	Clients v1

IsEmailGenerationDisabled

IsEmailGenerationDisabled

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsEmailGenerationDisabled Type

boolean

IsClientSelfBillingEnabled

IsClientSelfBillingEnabled

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsClientSelfBillingEnabled Type

boolean

IsPreBillingEnabled

IsPreBillingEnabled

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsPreBillingEnabled Type

boolean

IsVATPrintedOnPreBill

IsVATPrintedOnPreBill

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsVATPrintedOnPreBill Type

boolean

IsNegativeTimesheetShownOnPreBill

IsNegativeTimesheetShownOnPreBill

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsNegativeTimesheetShownOnPreBill Type

boolean

InvoiceDeliveryMethod

InvoiceDeliveryMethod

• is optional

• Type: string

• can be null

• defined in: Clients v1

InvoiceDeliveryMethod Type

string

InvoiceDeliveryMethod Constraints

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

Value	Explanation
null
"Print"
"Electronic"
"Both"

MasterDocument

If InvoiceDeliveryMethod is 'Both', either 'Print' or 'PDF' is a valid choice for this field. If InvoiceDeliveryMethod is 'Print', only 'Print' is valid. If InvoiceDeliveryMethod is 'Electronic', only 'PDF' is valid.

MasterDocument

• is optional

• Type: string

• can be null

• defined in: Clients v1

MasterDocument Type

string

MasterDocument Constraints

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

Value	Explanation
null
"Print"
"PDF"

Definitions group ClientContactDetail

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
Fax	string	Optional	can be null	Clients v1
Telephone	string	Optional	can be null	Clients v1
Mobile	string	Optional	can be null	Clients v1
EmailAddress	string	Optional	can be null	Clients v1

Fax

Fax

• is optional

• Type: string

• can be null

• defined in: Clients v1

Fax Type

string

Fax Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

Telephone

Telephone

• is optional

• Type: string

• can be null

• defined in: Clients v1

Telephone Type

string

Telephone Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

Mobile

Mobile

• is optional

• Type: string

• can be null

• defined in: Clients v1

Mobile Type

string

Mobile Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

EmailAddress

EmailAddress

• is optional

• Type: string

• can be null

• defined in: Clients v1

EmailAddress Type

string

EmailAddress Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,50})$

try pattern

Definitions group ClientOnlineOptions

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
IsOnlineAuthorisation	boolean	Optional	can be null	Clients v1
IsOnlineExpenseAllowed	boolean	Optional	can be null	Clients v1
IsClientToAuthoriseOnlineExpenses	boolean	Optional	can be null	Clients v1
WorkflowDescription	string	Optional	can be null	Clients v1
OnlineTimesheetTypeRef	integer	Optional	can be null	Clients v1
OnlineEscalationType	string	Optional	can be null	Clients v1

IsOnlineAuthorisation

IsOnlineAuthorisation

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsOnlineAuthorisation Type

boolean

IsOnlineExpenseAllowed

This Field is only relevant when IsOnlineAuthorisation is set to true.

IsOnlineExpenseAllowed

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsOnlineExpenseAllowed Type

boolean

IsClientToAuthoriseOnlineExpenses

This Field is only relevant when IsOnlineAuthorisation is set to true.

IsClientToAuthoriseOnlineExpenses

• is optional

• Type: boolean

• can be null

• defined in: Clients v1

IsClientToAuthoriseOnlineExpenses Type

boolean

WorkflowDescription

This Field is only relevant when IsOnlineAuthorisation is set to true. A Workkflow with this description must already exist in the system.

WorkflowDescription

• is optional

• Type: string

• can be null

• defined in: Clients v1

WorkflowDescription Type

string

WorkflowDescription Constraints

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

OnlineTimesheetTypeRef

This Field is only relevant when IsOnlineAuthorisation is set to true.

OnlineTimesheetTypeRef

• is optional

• Type: integer

• can be null

• defined in: Clients v1

OnlineTimesheetTypeRef Type

integer

OnlineEscalationType

This Field is only relevant when IsOnlineAuthorisation is set to true.

OnlineEscalationType

• is optional

• Type: string

• can be null

• defined in: Clients v1

OnlineEscalationType Type

string

OnlineEscalationType Constraints

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

Value	Explanation
null
"None"
"WorkerPrintsOnly"
"OnlineAuthorisationGroup"
"OnlineAuthorisationHierarchy"
"OnlineAuthorisationAssignmentLevel"

Definitions group ContactDetail

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
Name	string	Optional	can be null	Clients v1
Telephone	string	Optional	can be null	Clients v1
Mobile	string	Optional	can be null	Clients v1
EmailAddress	string	Optional	can be null	Clients v1

Name

Name

• is optional

• Type: string

• can be null

• defined in: Clients v1

Name Type

string

Name Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,30})$

try pattern

Telephone

Telephone

• is optional

• Type: string

• can be null

• defined in: Clients v1

Telephone Type

string

Telephone Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

Mobile

Mobile

• is optional

• Type: string

• can be null

• defined in: Clients v1

Mobile Type

string

Mobile Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

EmailAddress

EmailAddress

• is optional

• Type: string

• can be null

• defined in: Clients v1

EmailAddress Type

string

EmailAddress Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,50})$

try pattern

Definitions group ContactDetail-1

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
Name	string	Optional	can be null	Clients v1
Telephone	string	Optional	can be null	Clients v1
Mobile	string	Optional	can be null	Clients v1
EmailAddress	string	Optional	can be null	Clients v1

Name

Name

• is optional

• Type: string

• can be null

• defined in: Clients v1

Name Type

string

Name Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,30})$

try pattern

Telephone

Telephone

• is optional

• Type: string

• can be null

• defined in: Clients v1

Telephone Type

string

Telephone Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

Mobile

Mobile

• is optional

• Type: string

• can be null

• defined in: Clients v1

Mobile Type

string

Mobile Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,20})$

try pattern

EmailAddress

EmailAddress

• is optional

• Type: string

• can be null

• defined in: Clients v1

EmailAddress Type

string

EmailAddress Constraints

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

pattern: the string must match the following regular expression:

^([^?*]{0,50})$

try pattern

Definitions group CustomerDefinedFields

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
CustomerDefinedField1	string	Optional	can be null	Clients v1
CustomerDefinedField2	string	Optional	can be null	Clients v1
CustomerDefinedField3	number	Optional	can be null	Clients v1
CustomerDefinedField4	number	Optional	can be null	Clients v1

CustomerDefinedField1

CustomerDefinedField1

• is optional

• Type: string

• can be null

• defined in: Clients v1

CustomerDefinedField1 Type

string

CustomerDefinedField1 Constraints

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

CustomerDefinedField2

CustomerDefinedField2

• is optional

• Type: string

• can be null

• defined in: Clients v1

CustomerDefinedField2 Type

string

CustomerDefinedField2 Constraints

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

CustomerDefinedField3

CustomerDefinedField3

• is optional

• Type: number

• can be null

• defined in: Clients v1

CustomerDefinedField3 Type

number

CustomerDefinedField4

CustomerDefinedField4

• is optional

• Type: number

• can be null

• defined in: Clients v1

CustomerDefinedField4 Type

number