Placements v1

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

Placements.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	placements.v1.schema.json

Placements.v1 Type

object[]

Placements.v1 Definitions

Definitions group ConsultantSplit

Reference this group by using

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

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

ConsultantRef

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

ConsultantRef

• is required

• Type: string

• cannot be null

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

Definitions group Placement

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
EmployerRef	string	Required	cannot be null	Placements v1
TaxYear	integer	Optional	can be null	Placements v1
TaxPeriod	integer	Optional	can be null	Placements v1
TaxSession	integer	Optional	can be null	Placements v1
PlacementRef	string	Required	cannot be null	Placements v1
DivisionRef	string	Optional	can be null	Placements v1
DepartmentRef	string	Optional	can be null	Placements v1
ClientRef	string	Required	cannot be null	Placements v1
PersonnelRef	string	Required	can be null	Placements v1
ApplicantName	string	Required	can be null	Placements v1
StartDate	string	Required	can be null	Placements v1
JobTitle	string	Optional	can be null	Placements v1
Salary	number	Optional	can be null	Placements v1
PlacementValue	number	Optional	can be null	Placements v1
CommissionPercentage	number	Optional	can be null	Placements v1
ClientContactName	string	Required	can be null	Placements v1
DebitOrCreditIndicator	string	Optional	can be null	Placements v1
CreditCode	string	Required	can be null	Placements v1
JobCategoryRef	string	Required	can be null	Placements v1
PurchaseOrderNumber	string	Required	can be null	Placements v1
InvoiceDate	string	Required	can be null	Placements v1
ContractEndDate	string	Required	can be null	Placements v1
PlacementCategory	string	Optional	can be null	Placements v1
SettlementDays	integer	Required	can be null	Placements v1
ReportToClientRef	string	Optional	can be null	Placements v1
InvoiceToClientRef	string	Optional	can be null	Placements v1
InvoiceAddressNo	integer	Required	can be null	Placements v1
Comments	string	Required	can be null	Placements v1
ConsultantSplits	array	Optional	can be null	Placements v1
AdHocs	array	Optional	can be null	Placements v1

EmployerRef

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

EmployerRef

• is required

• Type: string

• cannot be null

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

TaxYear

Uses Current Tax Year if not supplied

TaxYear

• is optional

• Type: integer

• can be null

• defined in: Placements v1

TaxYear Type

integer

TaxYear Constraints

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

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

TaxPeriod

Uses Current Tax Period if not supplied

TaxPeriod

• is optional

• Type: integer

• can be null

• defined in: Placements v1

TaxPeriod Type

integer

TaxPeriod 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: 1

TaxSession

Uses Current Session if not supplied

TaxSession

• is optional

• Type: integer

• can be null

• defined in: Placements v1

TaxSession Type

integer

TaxSession 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: 1

PlacementRef

PlacementRef

• is required

• Type: string

• cannot be null

• defined in: Placements v1

PlacementRef Type

string

PlacementRef Constraints

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

pattern: the string must match the following regular expression:

^([A-Z0-9]{1,15})$

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: Placements 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: Placements 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

ClientRef

Client Ref must already exist in the system.

ClientRef

• is required

• Type: string

• cannot be null

• defined in: Placements 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. If not supplied then Applicant Name must be supplied instead

PersonnelRef

• is required

• Type: string

• can be null

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

ApplicantName

If not supplied then Personnel Ref must be supplied instead

ApplicantName

• is required

• Type: string

• can be null

• defined in: Placements v1

ApplicantName Type

string

StartDate

StartDate

• is required

• Type: string

• can be null

• defined in: Placements v1

StartDate Type

string

StartDate Constraints

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

JobTitle

JobTitle

• is optional

• Type: string

• can be null

• defined in: Placements v1

JobTitle Type

string

JobTitle Constraints

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

Salary

Salary

• is optional

• Type: number

• can be null

• defined in: Placements v1

Salary Type

number

Salary 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

PlacementValue

PlacementValue

• is optional

• Type: number

• can be null

• defined in: Placements v1

PlacementValue Type

number

PlacementValue 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

CommissionPercentage

CommissionPercentage

• is optional

• Type: number

• can be null

• defined in: Placements v1

CommissionPercentage Type

number

CommissionPercentage Constraints

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

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

ClientContactName

ClientContactName

• is required

• Type: string

• can be null

• defined in: Placements v1

ClientContactName Type

string

DebitOrCreditIndicator

Enter 'Credit' or Debit'

DebitOrCreditIndicator

• is optional

• Type: string

• can be null

• defined in: Placements v1

DebitOrCreditIndicator Type

string

DebitOrCreditIndicator Constraints

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

Value	Explanation
null
"Credit"
"Debit"

CreditCode

A record with this Credit Code must already exist in the system.

CreditCode

• is required

• Type: string

• can be null

• defined in: Placements v1

CreditCode Type

string

CreditCode Constraints

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

pattern: the string must match the following regular expression:

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

try pattern

JobCategoryRef

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

JobCategoryRef

• is required

• Type: string

• can be null

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

PurchaseOrderNumber

PurchaseOrderNumber

• is required

• Type: string

• can be null

• defined in: Placements v1

PurchaseOrderNumber Type

string

PurchaseOrderNumber Constraints

pattern: the string must match the following regular expression:

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

try pattern

InvoiceDate

InvoiceDate

• is required

• Type: string

• can be null

• defined in: Placements v1

InvoiceDate Type

string

InvoiceDate Constraints

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

ContractEndDate

ContractEndDate

• is required

• Type: string

• can be null

• defined in: Placements v1

ContractEndDate Type

string

ContractEndDate Constraints

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

PlacementCategory

Enter 'PermanentPlacement', 'ContractPlacement' or 'TempToPerm'

PlacementCategory

• is optional

• Type: string

• can be null

• defined in: Placements v1

PlacementCategory Type

string

PlacementCategory Constraints

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

Value	Explanation
null
"PermanentPlacement"
"ContractPlacement"
"TempToPerm"

SettlementDays

Defaulted from Placement Options if not supplied. Ignored if feature switch IGNOREPLCMNTFILESTTLMNTDAYS is turned on.

SettlementDays

• is required

• Type: integer

• can be null

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

ReportToClientRef

Report To Client must already exist in the system.

ReportToClientRef

• is optional

• Type: string

• can be null

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

Invoice To Client must already exist in the system.

InvoiceToClientRef

• is optional

• Type: string

• can be null

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

InvoiceAddressNo

InvoiceAddressNo

• is required

• Type: integer

• can be null

• defined in: Placements v1

InvoiceAddressNo Type

integer

InvoiceAddressNo Constraints

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

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

Comments

Comments

• is required

• Type: string

• can be null

• defined in: Placements v1

Comments Type

string

ConsultantSplits

ConsultantSplits

• is optional

• Type: object[]

• can be null

• defined in: Placements v1

ConsultantSplits Type

object[]

AdHocs

A maximum of 10 AdHocs can be supplied.

AdHocs

• is optional

• Type: object[]

• can be null

• defined in: Placements v1

AdHocs Type

object[]

AdHocs Constraints

maximum number of items: the maximum number of items for this array is: 10

Definitions group PlacementAdhoc

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
SequenceNumber	integer	Required	cannot be null	Placements v1
AdHocCode	string	Required	can be null	Placements v1
Description	string	Required	can be null	Placements v1
Value	number	Required	cannot be null	Placements v1
VATCode	string	Required	can be null	Placements v1

SequenceNumber

A Sequence Number must be specified, and be unique for the AdHocs on the Placement Ref supplied.

SequenceNumber

• is required

• Type: integer

• cannot be null

• defined in: Placements v1

SequenceNumber Type

integer

AdHocCode

The supplied Rate Code must already exist in the system.

AdHocCode

• is required

• Type: string

• can be null

• defined in: Placements v1

AdHocCode Type

string

AdHocCode 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

Description

Description

• is required

• Type: string

• can be null

• defined in: Placements v1

Description Type

string

Description Constraints

pattern: the string must match the following regular expression:

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

try pattern

Value

The value of the AdHoc

Value

• is required

• Type: number

• cannot be null

• defined in: Placements v1

Value Type

number

Value Constraints

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

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

VATCode

The supplied VAT Code must already exist in the system. If not supplied this will default to either the VAT Code from the AdHoc Code (if supplied) else the Default VAT Code on Placement Settings.

VATCode

• is required

• Type: string

• can be null

• defined in: Placements v1

VATCode Type

string

VATCode Constraints

pattern: the string must match the following regular expression:

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

try pattern