Skip to main content

Timesheets v2

https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema

Timesheets.v2 Import Layout

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Cannot be instantiatedYesUnknown statusUnknown identifiabilityForbiddenAllowednonetimesheets.v2.schema.json

Timesheets.v2 Type​

object[]

Timesheets.v2 Definitions

Definitions group AdHocLineV2​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema#/definitions/AdHocLineV2"}
PropertyTypeRequiredNullableDefined by
InvoiceVATCodeSourcestringOptionalcan be nullTimesheet v2
InvoiceVATCodestringOptionalcan be nullTimesheet v2
IsPaymentbooleanOptionalcan be nullTimesheet v2
IsTaxablebooleanOptionalcan be nullTimesheet v2
IsNIablebooleanOptionalcan be nullTimesheet v2
ReceiptOptionstringOptionalcan be nullTimesheet v2
RateCodestringRequiredcannot be nullTimesheet v2
DescriptionstringOptionalcan be nullTimesheet v2
UnitsnumberOptionalcan be nullTimesheet v2
PayRatenumberOptionalcan be nullTimesheet v2
PayAmountnumberOptionalcan be nullTimesheet v2
BillRatenumberOptionalcan be nullTimesheet v2
BillAmountnumberOptionalcan be nullTimesheet v2
IsWTDAccruedbooleanOptionalcan be nullTimesheet v2
VATCodestringOptionalcan be nullTimesheet v2
IsAWRablebooleanOptionalcan be nullTimesheet v2
IsPensionablebooleanOptionalcan be nullTimesheet v2
VATCodeSourcestringOptionalcan be nullTimesheet v2

InvoiceVATCodeSource​

If DefaultVATRate or DefaultNonVATRate then inherits from employer/system defaults.

InvoiceVATCodeSource

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

InvoiceVATCodeSource Type​

string

InvoiceVATCodeSource Constraints​

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

ValueExplanation
null
"SpecifiedVATRate"
"DefaultVATRate"
"DefaultNonVATRate"

InvoiceVATCode​

InvoiceVATCode

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

InvoiceVATCode Type​

string

InvoiceVATCode 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

IsPayment​

IsPayment

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsPayment Type​

boolean

IsTaxable​

IsTaxable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsTaxable Type​

boolean

IsNIable​

IsNIable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsNIable Type​

boolean

ReceiptOption​

ReceiptOption

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

ReceiptOption Type​

string

ReceiptOption Constraints​

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

ValueExplanation
null
"None"
"Receipt"
"Scanned"

RateCode​

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

RateCode

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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

Description​

Free text value. Defaults from Rate Code specified if not supplied

Description

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

Description Type​

string

Description Constraints​

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

pattern: the string must match the following regular expression:

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

try pattern

Units​

Number of Hours/Days etc.

Units

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

Units Type​

number

Units 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

PayRate​

Rate at which the worker is paid.

PayRate

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

PayRate Type​

number

PayRate Constraints​

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

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

PayAmount​

PayAmount

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

PayAmount Type​

number

PayAmount 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

BillRate​

Rate at which the client is billed.

BillRate

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

BillRate Type​

number

BillRate Constraints​

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

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

BillAmount​

BillAmount

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

BillAmount Type​

number

BillAmount 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

IsWTDAccrued​

IsWTDAccrued

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsWTDAccrued Type​

boolean

VATCode​

Required if VAT Code Source is not supplied or is set to SpecifiedVATRate

VATCode

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

VATCode Type​

string

VATCode 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

IsAWRable​

IsAWRable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsAWRable Type​

boolean

IsPensionable​

IsPensionable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsPensionable Type​

boolean

VATCodeSource​

If DefaultVATRate or DefaultNonVATRate then inherits from employer/system defaults.

VATCodeSource

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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"

Definitions group ClientRequiredField​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema#/definitions/ClientRequiredField"}
PropertyTypeRequiredNullableDefined by
CodestringRequiredcannot be nullTimesheet v2
AlphaValuestringOptionalcan be nullTimesheet v2
NumberValuenumberOptionalcan be nullTimesheet v2
DateValuestringOptionalcan be nullTimesheet v2
TimeValuestringOptionalcan be nullTimesheet v2
RateCodestringOptionalcan be nullTimesheet v2
IsDefaultbooleanOptionalcan be nullTimesheet v2

Code​

Code

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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: Timesheet v2

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: Timesheet v2

NumberValue Type​

number

DateValue​

DateValue

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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: Timesheet v2

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: Timesheet v2

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: Timesheet v2

IsDefault Type​

boolean

Definitions group ConsultantSplit​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema#/definitions/ConsultantSplit"}
PropertyTypeRequiredNullableDefined by
ConsultantRefstringRequiredcannot be nullTimesheet v2
SplitnumberRequiredcannot be nullTimesheet v2

ConsultantRef​

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

ConsultantRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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: Timesheet v2

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 TimesheetLineV2​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema#/definitions/TimesheetLineV2"}
PropertyTypeRequiredNullableDefined by
RateFrequencystringOptionalcan be nullTimesheet v2
ActualHoursnumberOptionalcan be nullTimesheet v2
RateCodestringRequiredcannot be nullTimesheet v2
DescriptionstringOptionalcan be nullTimesheet v2
UnitsnumberOptionalcan be nullTimesheet v2
PayRatenumberOptionalcan be nullTimesheet v2
PayAmountnumberOptionalcan be nullTimesheet v2
BillRatenumberOptionalcan be nullTimesheet v2
BillAmountnumberOptionalcan be nullTimesheet v2
IsWTDAccruedbooleanOptionalcan be nullTimesheet v2
VATCodestringOptionalcan be nullTimesheet v2
IsAWRablebooleanOptionalcan be nullTimesheet v2
IsPensionablebooleanOptionalcan be nullTimesheet v2
VATCodeSourcestringOptionalcan be nullTimesheet v2

RateFrequency​

Defaults to Hourly if not specified.

RateFrequency

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

RateFrequency Type​

string

RateFrequency Constraints​

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

ValueExplanation
null
"Hourly"
"Daily"
"Weekly"
"Monthly"

ActualHours​

ActualHours

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

ActualHours Type​

number

ActualHours 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: 0

RateCode​

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

RateCode

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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

Description​

Free text value. Defaults from Rate Code specified if not supplied

Description

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

Description Type​

string

Description Constraints​

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

pattern: the string must match the following regular expression:

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

try pattern

Units​

Number of Hours/Days etc.

Units

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

Units Type​

number

Units 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

PayRate​

Rate at which the worker is paid.

PayRate

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

PayRate Type​

number

PayRate Constraints​

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

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

PayAmount​

PayAmount

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

PayAmount Type​

number

PayAmount 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

BillRate​

Rate at which the client is billed.

BillRate

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

BillRate Type​

number

BillRate Constraints​

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

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

BillAmount​

BillAmount

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

BillAmount Type​

number

BillAmount 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

IsWTDAccrued​

IsWTDAccrued

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsWTDAccrued Type​

boolean

VATCode​

Required if VAT Code Source is not supplied or is set to SpecifiedVATRate

VATCode

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

VATCode Type​

string

VATCode 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

IsAWRable​

IsAWRable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsAWRable Type​

boolean

IsPensionable​

IsPensionable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsPensionable Type​

boolean

VATCodeSource​

If DefaultVATRate or DefaultNonVATRate then inherits from employer/system defaults.

VATCodeSource

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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"

Definitions group TimesheetV2​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v2.schema#/definitions/TimesheetV2"}
PropertyTypeRequiredNullableDefined by
LinesarrayOptionalcan be nullTimesheet v2
AdHocLinesarrayOptionalcan be nullTimesheet v2
TimesheetNumberstringRequiredcannot be nullTimesheet v2
EmployerRefstringRequiredcannot be nullTimesheet v2
PersonnelRefstringRequiredcannot be nullTimesheet v2
ClientRefstringRequiredcannot be nullTimesheet v2
AssignmentRefstringOptionalcan be nullTimesheet v2
DivisionRefstringOptionalcan be nullTimesheet v2
DepartmentRefstringOptionalcan be nullTimesheet v2
JobLocationstringOptionalcan be nullTimesheet v2
TaxYearintegerOptionalcan be nullTimesheet v2
TaxPeriodintegerOptionalcan be nullTimesheet v2
TimesheetDatestringRequiredcannot be nullTimesheet v2
PurchaseOrderNumberstringOptionalcan be nullTimesheet v2
InvoiceRefstringOptionalcan be nullTimesheet v2
WorkLocationstringOptionalcan be nullTimesheet v2
JobDescriptionstringOptionalcan be nullTimesheet v2
BookedBystringOptionalcan be nullTimesheet v2
TIFFilenamestringOptionalcan be nullTimesheet v2
JobCategoryRefstringOptionalcan be nullTimesheet v2
IsAdjustmentbooleanOptionalcan be nullTimesheet v2
IsIgnoredByPayrollbooleanOptionalcan be nullTimesheet v2
CreditCodestringOptionalcan be nullTimesheet v2
ConsultantRefstringOptionalcan be nullTimesheet v2
CostCentrestringOptionalcan be nullTimesheet v2
ReportToClientRefstringOptionalcan be nullTimesheet v2
InvoiceToClientRefstringOptionalcan be nullTimesheet v2
InvoiceAddressNumberintegerOptionalcan be nullTimesheet v2
DeliveryAddressNumberintegerOptionalcan be nullTimesheet v2
SalesTaxAreastringOptionalcan be nullTimesheet v2
HolidayOverrideWeeksnumberOptionalcan be nullTimesheet v2
HolidayOverrideHourPercnumberOptionalcan be nullTimesheet v2
NoOfDaysWorkednumberOptionalcan be nullTimesheet v2
IsReverseChargeVATbooleanOptionalcan be nullTimesheet v2
ConsultantSplitsarrayOptionalcan be nullTimesheet v2
ClientRequiredFieldsarrayOptionalcan be nullTimesheet v2

Lines​

Lines

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v2

Lines Type​

object[]

Lines Constraints​

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

AdHocLines​

AdHocLines

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v2

AdHocLines Type​

object[]

AdHocLines Constraints​

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

TimesheetNumber​

A record with this Timesheet Number must NOT already exist in the system.

TimesheetNumber

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

TimesheetNumber Type​

string

TimesheetNumber Constraints​

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

pattern: the string must match the following regular expression:

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

try pattern

EmployerRef​

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

EmployerRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

EmployerRef Type​

string

EmployerRef Constraints​

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

pattern: the string must match the following regular expression:

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

try pattern

PersonnelRef​

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

PersonnelRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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

ClientRef​

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

ClientRef

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

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

AssignmentRef​

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

AssignmentRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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

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: Timesheet v2

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: Timesheet v2

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

JobLocation​

Free text value.

JobLocation

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

JobLocation Type​

string

JobLocation 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

TaxYear​

Calculated if not supplied.

TaxYear

  • is optional

  • Type: integer

  • can be null

  • defined in: Timesheet v2

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​

Calculated if not supplied.

TaxPeriod

  • is optional

  • Type: integer

  • can be null

  • defined in: Timesheet v2

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

TimesheetDate​

TimesheetDate

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v2

TimesheetDate Type​

string

TimesheetDate 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: Timesheet v2

PurchaseOrderNumber Type​

string

PurchaseOrderNumber Constraints​

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

InvoiceRef​

InvoiceRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

InvoiceRef Type​

string

InvoiceRef Constraints​

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

WorkLocation​

Free text value.

WorkLocation

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

WorkLocation Type​

string

WorkLocation Constraints​

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

JobDescription​

Free text value.

JobDescription

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

JobDescription Type​

string

JobDescription Constraints​

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

BookedBy​

Free text value.

BookedBy

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

BookedBy Type​

string

BookedBy Constraints​

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

TIFFilename​

TIFFilename

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

TIFFilename Type​

string

TIFFilename Constraints​

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

JobCategoryRef​

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

JobCategoryRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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

IsAdjustment​

Defaults to false if not supplied.

IsAdjustment

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsAdjustment Type​

boolean

IsIgnoredByPayroll​

Defaults to false if not supplied.

IsIgnoredByPayroll

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsIgnoredByPayroll Type​

boolean

CreditCode​

CreditCode

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

CreditCode Type​

string

CreditCode Constraints​

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

ConsultantRef​

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

ConsultantRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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

CostCentre​

CostCentre

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

CostCentre Type​

string

CostCentre Constraints​

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

ReportToClientRef​

Defaults if not supplied.

ReportToClientRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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​

Defaults if not supplied.

InvoiceToClientRef

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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

InvoiceAddressNumber​

InvoiceAddressNumber

  • is optional

  • Type: integer

  • can be null

  • defined in: Timesheet v2

InvoiceAddressNumber Type​

integer

InvoiceAddressNumber 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

DeliveryAddressNumber​

DeliveryAddressNumber

  • is optional

  • Type: integer

  • can be null

  • defined in: Timesheet v2

DeliveryAddressNumber Type​

integer

DeliveryAddressNumber 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

SalesTaxArea​

Used to validate VAT Codes.

SalesTaxArea

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v2

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

HolidayOverrideWeeks​

HolidayOverrideWeeks

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

HolidayOverrideWeeks Type​

number

HolidayOverrideWeeks 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: 0

HolidayOverrideHourPerc​

HolidayOverrideHourPerc

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

HolidayOverrideHourPerc Type​

number

HolidayOverrideHourPerc Constraints​

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

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

NoOfDaysWorked​

NoOfDaysWorked

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v2

NoOfDaysWorked Type​

number

NoOfDaysWorked 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: 0

IsReverseChargeVAT​

Only applies to CIS Suppliers. Defaults to false if not supplied.

IsReverseChargeVAT

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v2

IsReverseChargeVAT Type​

boolean

ConsultantSplits​

If supplied, the total split percentage amount must add up to 100%.

ConsultantSplits

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v2

ConsultantSplits Type​

object[]

ClientRequiredFields​

ClientRequiredFields

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v2

ClientRequiredFields Type​

object[]