Assignments v1

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

Assignments.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	assignments.v1.schema.json

Assignments.v1 Type

object[]

Assignments.v1 Definitions

Definitions group Assignment

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
EmployerRef	string	Required	cannot be null	Assignments v1
AssignmentRef	string	Required	cannot be null	Assignments v1
ClientRef	string	Required	cannot be null	Assignments v1
PersonnelRef	string	Required	cannot be null	Assignments v1
DivisionRef	string	Required	cannot be null	Assignments v1
DepartmentRef	string	Required	cannot be null	Assignments v1
JobTitle	string	Optional	can be null	Assignments v1
WorkLocation	string	Optional	can be null	Assignments v1
StartDate	string	Required	cannot be null	Assignments v1
ExpectedEndDate	string	Required	can be null	Assignments v1
ActualEndDate	string	Required	can be null	Assignments v1
PurchaseOrderNumber	string	Optional	can be null	Assignments v1
BookedBy	string	Optional	can be null	Assignments v1
RateFrequency	string	Optional	can be null	Assignments v1
InvoiceAddressNumber	integer	Optional	can be null	Assignments v1
DeliveryAddressNumber	integer	Optional	can be null	Assignments v1
IsIncludedOnMarginReport	boolean	Optional	can be null	Assignments v1
JobCategoryRef	string	Optional	can be null	Assignments v1
CostCentre	string	Optional	can be null	Assignments v1
ReportToClientRef	string	Optional	can be null	Assignments v1
InvoiceToClientRef	string	Optional	can be null	Assignments v1
ContactName	string	Optional	can be null	Assignments v1
Notes	string	Optional	can be null	Assignments v1
SalesTaxArea	string	Optional	can be null	Assignments v1
ReportsToId	string	Optional	can be null	Assignments v1
BookedById	string	Optional	can be null	Assignments v1
ComparatorTitle	string	Optional	can be null	Assignments v1
HolOverrideWeeks	number	Optional	can be null	Assignments v1
HolOverrideHourPerc	number	Optional	can be null	Assignments v1
PrevAWRWeeks	number	Optional	can be null	Assignments v1
AWRQualificationWeeks	number	Optional	can be null	Assignments v1
ComparatorRef	string	Optional	can be null	Assignments v1
IsCancelled	boolean	Optional	can be null	Assignments v1
EndReason	string	Optional	can be null	Assignments v1
AssignmentType	string	Optional	can be null	Assignments v1
TimesheetFrequency	string	Optional	can be null	Assignments v1
ContractRefPrimaryContract	string	Optional	can be null	Assignments v1
ExternalNotes	string	Optional	can be null	Assignments v1
IsManualInterpretation	boolean	Optional	can be null	Assignments v1
SupplierContact	string	Optional	can be null	Assignments v1
SecondaryContract	string	Optional	can be null	Assignments v1
IsEIRDirectClient	boolean	Optional	can be null	Assignments v1
IsOPWIPSApplicable	boolean	Optional	can be null	Assignments v1
OnlineOptions	object	Optional	can be null	Assignments v1
ConsultantSplits	array	Optional	can be null	Assignments v1
CustomerDefinedFields	object	Optional	can be null	Assignments v1
Rates	array	Optional	can be null	Assignments v1
ClientRequiredFields	array	Optional	can be null	Assignments v1

EmployerRef

Employer Ref must already exist in the system.

EmployerRef

• is required

• Type: string

• cannot be null

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

AssignmentRef

AssignmentRef

• is required

• Type: string

• cannot be null

• defined in: Assignments v1

AssignmentRef Type

string

AssignmentRef 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]{1}[\-\/\^_A-Z0-9 ]{0,9})$

try pattern

ClientRef

Client Ref must already exist in the system.

ClientRef

• is required

• Type: string

• cannot be null

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

PersonnelRef

Personnel Ref must already exist in the system.

PersonnelRef

• is required

• Type: string

• cannot be null

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

DivisionRef

Division Ref must already exist in the system.

DivisionRef

• is required

• Type: string

• cannot be null

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

Department Ref must already exist in the system.

DepartmentRef

• is required

• Type: string

• cannot be null

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

JobTitle

JobTitle

• is optional

• Type: string

• can be null

• defined in: Assignments v1

JobTitle Type

string

JobTitle Constraints

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

WorkLocation

WorkLocation

• is optional

• Type: string

• can be null

• defined in: Assignments v1

WorkLocation Type

string

WorkLocation Constraints

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

StartDate

Start Date must be entered.

StartDate

• is required

• Type: string

• cannot be null

• defined in: Assignments v1

StartDate Type

string

StartDate Constraints

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

ExpectedEndDate

ExpectedEndDate

• is required

• Type: string

• can be null

• defined in: Assignments v1

ExpectedEndDate Type

string

ExpectedEndDate Constraints

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

ActualEndDate

ActualEndDate

• is required

• Type: string

• can be null

• defined in: Assignments v1

ActualEndDate Type

string

ActualEndDate Constraints

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

PurchaseOrderNumber

PurchaseOrderNumber

• is optional

• Type: string

• can be null

• defined in: Assignments v1

PurchaseOrderNumber Type

string

PurchaseOrderNumber Constraints

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

BookedBy

BookedBy

• is optional

• Type: string

• can be null

• defined in: Assignments v1

BookedBy Type

string

BookedBy Constraints

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

RateFrequency

RateFrequency

• is optional

• Type: string

• can be null

• defined in: Assignments v1

RateFrequency Type

string

RateFrequency Constraints

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

Value	Explanation
null
"Hourly"
"Daily"
"Weekly"
"Monthly"

InvoiceAddressNumber

InvoiceAddressNumber

• is optional

• Type: integer

• can be null

• defined in: Assignments v1

InvoiceAddressNumber Type

integer

DeliveryAddressNumber

DeliveryAddressNumber

• is optional

• Type: integer

• can be null

• defined in: Assignments v1

DeliveryAddressNumber Type

integer

IsIncludedOnMarginReport

IsIncludedOnMarginReport

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsIncludedOnMarginReport Type

boolean

JobCategoryRef

JobCategoryRef

• is optional

• Type: string

• can be null

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

CostCentre

CostCentre

• is optional

• Type: string

• can be null

• defined in: Assignments v1

CostCentre Type

string

CostCentre Constraints

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

ReportToClientRef

ReportToClientRef

• is optional

• Type: string

• can be null

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

ContactName

ContactName

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ContactName Type

string

ContactName Constraints

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

Notes

Notes

• is optional

• Type: string

• can be null

• defined in: Assignments v1

Notes Type

string

Notes Constraints

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

SalesTaxArea

SalesTaxArea

• is optional

• Type: string

• can be null

• defined in: Assignments v1

SalesTaxArea Type

string

SalesTaxArea 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

ReportsToId

ReportsToId

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ReportsToId Type

string

ReportsToId Constraints

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

BookedById

BookedById

• is optional

• Type: string

• can be null

• defined in: Assignments v1

BookedById Type

string

BookedById Constraints

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

ComparatorTitle

ComparatorTitle

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ComparatorTitle Type

string

ComparatorTitle Constraints

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

HolOverrideWeeks

HolOverrideWeeks

• is optional

• Type: number

• can be null

• defined in: Assignments v1

HolOverrideWeeks Type

number

HolOverrideHourPerc

HolOverrideHourPerc

• is optional

• Type: number

• can be null

• defined in: Assignments v1

HolOverrideHourPerc Type

number

PrevAWRWeeks

PrevAWRWeeks

• is optional

• Type: number

• can be null

• defined in: Assignments v1

PrevAWRWeeks Type

number

AWRQualificationWeeks

AWRQualificationWeeks

• is optional

• Type: number

• can be null

• defined in: Assignments v1

AWRQualificationWeeks Type

number

ComparatorRef

ComparatorRef

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ComparatorRef Type

string

IsCancelled

IsCancelled

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsCancelled Type

boolean

EndReason

EndReason

• is optional

• Type: string

• can be null

• defined in: Assignments v1

EndReason Type

string

AssignmentType

AssignmentType

• is optional

• Type: string

• can be null

• defined in: Assignments v1

AssignmentType Type

string

TimesheetFrequency

TimesheetFrequency

• is optional

• Type: string

• can be null

• defined in: Assignments v1

TimesheetFrequency Type

string

TimesheetFrequency Constraints

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

pattern: the string must match the following regular expression:

^[^a-z].?$

try pattern

ContractRefPrimaryContract

ContractRefPrimaryContract

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ContractRefPrimaryContract Type

string

ContractRefPrimaryContract Constraints

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

ExternalNotes

ExternalNotes

• is optional

• Type: string

• can be null

• defined in: Assignments v1

ExternalNotes Type

string

IsManualInterpretation

IsManualInterpretation

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsManualInterpretation Type

boolean

SupplierContact

SupplierContact

• is optional

• Type: string

• can be null

• defined in: Assignments v1

SupplierContact Type

string

SupplierContact Constraints

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

SecondaryContract

SecondaryContract

• is optional

• Type: string

• can be null

• defined in: Assignments v1

SecondaryContract Type

string

SecondaryContract Constraints

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

IsEIRDirectClient

IsEIRDirectClient

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsEIRDirectClient Type

boolean

IsOPWIPSApplicable

IsOPWIPSApplicable

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsOPWIPSApplicable Type

boolean

OnlineOptions

OnlineOptions

• is optional

• Type: object

• can be null

• defined in: Assignments v1

OnlineOptions Type

object

ConsultantSplits

ConsultantSplits

• is optional

• Type: object[]

• can be null

• defined in: Assignments v1

ConsultantSplits Type

object[]

CustomerDefinedFields

CustomerDefinedFields

• is optional

• Type: object

• can be null

• defined in: Assignments v1

CustomerDefinedFields Type

object

Rates

Rates

• is optional

• Type: object[]

• can be null

• defined in: Assignments v1

Rates Type

object[]

ClientRequiredFields

ClientRequiredFields

• is optional

• Type: object[]

• can be null

• defined in: Assignments v1

ClientRequiredFields Type

object[]

Definitions group AssignmentCRF

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
DateIndex	string	Optional	can be null	Assignments v1
Code	string	Required	cannot be null	Assignments v1
AlphaValue	string	Optional	can be null	Assignments v1
NumberValue	number	Optional	can be null	Assignments v1
DateValue	string	Optional	can be null	Assignments v1
TimeValue	string	Optional	can be null	Assignments v1
RateCode	string	Optional	can be null	Assignments v1
IsDefault	boolean	Optional	can be null	Assignments v1

DateIndex

DateIndex

• is optional

• Type: string

• can be null

• defined in: Assignments v1

DateIndex Type

string

DateIndex Constraints

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

Code

Code

• is required

• Type: string

• cannot be null

• defined in: Assignments v1

Code Type

string

Code 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

AlphaValue

AlphaValue

• is optional

• Type: string

• can be null

• defined in: Assignments v1

AlphaValue Type

string

AlphaValue Constraints

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

NumberValue

NumberValue

• is optional

• Type: number

• can be null

• defined in: Assignments v1

NumberValue Type

number

DateValue

DateValue

• is optional

• Type: string

• can be null

• defined in: Assignments v1

DateValue Type

string

DateValue Constraints

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

TimeValue

TimeValue

• is optional

• Type: string

• can be null

• defined in: Assignments v1

TimeValue Type

string

TimeValue Constraints

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

RateCode

RateCode

• is optional

• Type: string

• can be null

• defined in: Assignments v1

RateCode Type

string

RateCode 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

IsDefault

IsDefault

• is optional

• Type: boolean

• can be null

• defined in: Assignments v1

IsDefault Type

boolean

Definitions group AssignmentCustomerDefinedFields

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
CustomerDefinedField1	string	Optional	can be null	Assignments v1
CustomerDefinedField2	string	Optional	can be null	Assignments v1
CustomerDefinedField3	number	Optional	can be null	Assignments v1
CustomerDefinedField4	number	Optional	can be null	Assignments v1
CustomerDefinedField5	string	Optional	can be null	Assignments v1
CustomerDefinedField6	string	Optional	can be null	Assignments v1
CustomerDefinedField7	string	Optional	can be null	Assignments v1
CustomerDefinedField8	string	Optional	can be null	Assignments v1

CustomerDefinedField1

CustomerDefinedField1

• is optional

• Type: string

• can be null

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

CustomerDefinedField3 Type

number

CustomerDefinedField4

CustomerDefinedField4

• is optional

• Type: number

• can be null

• defined in: Assignments v1

CustomerDefinedField4 Type

number

CustomerDefinedField5

CustomerDefinedField5

• is optional

• Type: string

• can be null

• defined in: Assignments v1

CustomerDefinedField5 Type

string

CustomerDefinedField5 Constraints

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

CustomerDefinedField6

CustomerDefinedField6

• is optional

• Type: string

• can be null

• defined in: Assignments v1

CustomerDefinedField6 Type

string

CustomerDefinedField6 Constraints

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

CustomerDefinedField7

CustomerDefinedField7

• is optional

• Type: string

• can be null

• defined in: Assignments v1

CustomerDefinedField7 Type

string

CustomerDefinedField7 Constraints

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

CustomerDefinedField8

CustomerDefinedField8

• is optional

• Type: string

• can be null

• defined in: Assignments v1

CustomerDefinedField8 Type

string

CustomerDefinedField8 Constraints

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

Definitions group AssignmentOnlineOptions

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
WorkflowDescription	string	Required	can be null	Assignments v1
GroupCode	string	Required	can be null	Assignments v1
ConsultantSTiUserLogon	string	Required	can be null	Assignments v1
TimesheetAuthoriserUserRef	string	Required	can be null	Assignments v1
STiTimesheetType	integer	Required	can be null	Assignments v1
EscalationTypeOverride	string	Required	cannot be null	Assignments v1
IsOnlineExpenseAllowed	boolean	Required	can be null	Assignments v1

WorkflowDescription

WorkflowDescription

• is required

• Type: string

• can be null

• defined in: Assignments v1

WorkflowDescription Type

string

WorkflowDescription Constraints

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

GroupCode

GroupCode

• is required

• Type: string

• can be null

• defined in: Assignments v1

GroupCode Type

string

GroupCode Constraints

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

ConsultantSTiUserLogon

ConsultantSTiUserLogon

• is required

• Type: string

• can be null

• defined in: Assignments v1

ConsultantSTiUserLogon Type

string

ConsultantSTiUserLogon Constraints

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

TimesheetAuthoriserUserRef

TimesheetAuthoriserUserRef

• is required

• Type: string

• can be null

• defined in: Assignments v1

TimesheetAuthoriserUserRef Type

string

TimesheetAuthoriserUserRef Constraints

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

STiTimesheetType

STiTimesheetType

• is required

• Type: integer

• can be null

• defined in: Assignments v1

STiTimesheetType Type

integer

EscalationTypeOverride

EscalationTypeOverride

• is required

• Type: string

• cannot be null

• defined in: Assignments v1

EscalationTypeOverride Type

string

EscalationTypeOverride Constraints

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

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

IsOnlineExpenseAllowed

IsOnlineExpenseAllowed

• is required

• Type: boolean

• can be null

• defined in: Assignments v1

IsOnlineExpenseAllowed Type

boolean

Definitions group AssignmentRate

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
RateType	string	Required	can be null	Assignments v1
RateCode	string	Required	cannot be null	Assignments v1
SequenceNumber	integer	Required	can be null	Assignments v1
PayRate	number	Required	can be null	Assignments v1
BillRate	number	Required	can be null	Assignments v1
BillingTaxCode	string	Required	can be null	Assignments v1
IsDefaultRate	boolean	Required	can be null	Assignments v1
RateDescription	string	Required	can be null	Assignments v1
RateFrequency	string	Required	can be null	Assignments v1
IsAWRable	boolean	Required	can be null	Assignments v1
ParityPayRate	number	Required	can be null	Assignments v1
ParityBillRate	number	Required	can be null	Assignments v1
IsPensionable	boolean	Required	can be null	Assignments v1
ReceiptOption	string	Required	can be null	Assignments v1
BillingGroup	string	Required	can be null	Assignments v1
RateEffectiveDate	string	Required	can be null	Assignments v1
RateExpiryDate	string	Required	can be null	Assignments v1
PayAmount	number	Required	can be null	Assignments v1
BillAmount	number	Required	can be null	Assignments v1
PayrollTaxCode	string	Required	can be null	Assignments v1

RateType

RateType

• is required

• Type: string

• can be null

• defined in: Assignments v1

RateType Type

string

RateType Constraints

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

Value	Explanation
null
"Fixed"
"Salary"
"Adhoc"
"ERCost"
"PayAndBill"

RateCode

RateCode

• is required

• Type: string

• cannot be null

• defined in: Assignments v1

RateCode Type

string

RateCode Constraints

pattern: the string must match the following regular expression:

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

try pattern

SequenceNumber

SequenceNumber

• is required

• Type: integer

• can be null

• defined in: Assignments v1

SequenceNumber Type

integer

PayRate

PayRate

• is required

• Type: number

• can be null

• defined in: Assignments v1

PayRate Type

number

BillRate

BillRate

• is required

• Type: number

• can be null

• defined in: Assignments v1

BillRate Type

number

BillingTaxCode

BillingTaxCode

• is required

• Type: string

• can be null

• defined in: Assignments v1

BillingTaxCode Type

string

BillingTaxCode Constraints

pattern: the string must match the following regular expression:

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

try pattern

IsDefaultRate

IsDefaultRate

• is required

• Type: boolean

• can be null

• defined in: Assignments v1

IsDefaultRate Type

boolean

RateDescription

RateDescription

• is required

• Type: string

• can be null

• defined in: Assignments v1

RateDescription Type

string

RateFrequency

RateFrequency

• is required

• Type: string

• can be null

• defined in: Assignments v1

RateFrequency Type

string

RateFrequency Constraints

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

Value	Explanation
null
"Hourly"
"Daily"
"Weekly"
"Monthly"

IsAWRable

IsAWRable

• is required

• Type: boolean

• can be null

• defined in: Assignments v1

IsAWRable Type

boolean

ParityPayRate

ParityPayRate

• is required

• Type: number

• can be null

• defined in: Assignments v1

ParityPayRate Type

number

ParityBillRate

ParityBillRate

• is required

• Type: number

• can be null

• defined in: Assignments v1

ParityBillRate Type

number

IsPensionable

IsPensionable

• is required

• Type: boolean

• can be null

• defined in: Assignments v1

IsPensionable Type

boolean

ReceiptOption

ReceiptOption

• is required

• Type: string

• can be null

• defined in: Assignments v1

ReceiptOption Type

string

ReceiptOption Constraints

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

Value	Explanation
null
"None"
"Receipt"
"Scanned"

BillingGroup

BillingGroup

• is required

• Type: string

• can be null

• defined in: Assignments v1

BillingGroup Type

string

RateEffectiveDate

RateEffectiveDate

• is required

• Type: string

• can be null

• defined in: Assignments v1

RateEffectiveDate Type

string

RateEffectiveDate Constraints

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

RateExpiryDate

RateExpiryDate

• is required

• Type: string

• can be null

• defined in: Assignments v1

RateExpiryDate Type

string

RateExpiryDate Constraints

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

PayAmount

PayAmount

• is required

• Type: number

• can be null

• defined in: Assignments v1

PayAmount Type

number

BillAmount

BillAmount

• is required

• Type: number

• can be null

• defined in: Assignments v1

BillAmount Type

number

PayrollTaxCode

PayrollTaxCode

• is required

• Type: string

• can be null

• defined in: Assignments v1

PayrollTaxCode Type

string

PayrollTaxCode Constraints

pattern: the string must match the following regular expression:

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

try pattern

Definitions group ConsultantSplit

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
ConsultantRef	string	Required	cannot be null	Assignments v1
Split	number	Required	cannot be null	Assignments v1

ConsultantRef

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

ConsultantRef

• is required

• Type: string

• cannot be null

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

Split

Split

• is required

• Type: number

• cannot be null

• defined in: Assignments v1

Split Type

number

Split Constraints

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

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