Skip to main content

Timesheets v1

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

Timesheets.v1 Import Layout

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

Timesheets.v1 Type​

object[]

Timesheets.v1 Definitions

Definitions group AdHocLine​

Reference this group by using

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

InvoiceVATCodeSource​

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

InvoiceVATCodeSource

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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 v1

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 v1

IsPayment Type​

boolean

IsTaxable​

IsTaxable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

IsTaxable Type​

boolean

IsNIable​

IsNIable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

IsNIable Type​

boolean

ReceiptOption​

ReceiptOption

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

Description​

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

Description

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

  • cannot be null

  • defined in: Timesheet v1

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

  • cannot be null

  • defined in: Timesheet v1

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 v1

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

  • cannot be null

  • defined in: Timesheet v1

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 v1

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 v1

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 v1

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 v1

IsAWRable Type​

boolean

IsPensionable​

IsPensionable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

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 v1

VATCodeSource Type​

string

VATCodeSource Constraints​

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

ValueExplanation
null
"SpecifiedVATRate"
"DefaultVATRate"
"DefaultNonVATRate"

Definitions group ClientRequiredField​

Reference this group by using

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

Code​

Code

  • is required

  • Type: string

  • cannot be null

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

NumberValue Type​

number

DateValue​

DateValue

  • is optional

  • Type: string

  • can be null

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

IsDefault Type​

boolean

Definitions group ConsultantSplit​

Reference this group by using

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

ConsultantRef​

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

ConsultantRef

  • is required

  • Type: string

  • cannot be null

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

Reference this group by using

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

Lines​

Lines

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v1

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 v1

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 v1

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

PersonnelRef​

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

PersonnelRef

  • is required

  • Type: string

  • cannot be null

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

ClientRef​

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

ClientRef

  • is required

  • Type: string

  • cannot be null

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

AssignmentRef​

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

AssignmentRef

  • is optional

  • Type: string

  • can be null

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

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

JobLocation​

Free text value.

JobLocation

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

Calculated if not supplied.

TaxPeriod

  • is optional

  • Type: integer

  • can be null

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

TimesheetDate​

TimesheetDate

  • is required

  • Type: string

  • cannot be null

  • defined in: Timesheet v1

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 v1

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 v1

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 v1

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 v1

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 v1

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 v1

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

IsAdjustment​

Defaults to false if not supplied.

IsAdjustment

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

IsAdjustment Type​

boolean

IsIgnoredByPayroll​

Defaults to false if not supplied.

IsIgnoredByPayroll

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

IsIgnoredByPayroll Type​

boolean

CreditCode​

CreditCode

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

CostCentre​

CostCentre

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

Defaults if not supplied.

InvoiceToClientRef

  • is optional

  • Type: string

  • can be null

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

InvoiceAddressNumber​

InvoiceAddressNumber

  • is optional

  • Type: integer

  • can be null

  • defined in: Timesheet v1

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 v1

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

HolidayOverrideWeeks​

HolidayOverrideWeeks

  • is optional

  • Type: number

  • can be null

  • defined in: Timesheet v1

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 v1

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 v1

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 v1

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 v1

ConsultantSplits Type​

object[]

ClientRequiredFields​

ClientRequiredFields

  • is optional

  • Type: object[]

  • can be null

  • defined in: Timesheet v1

ClientRequiredFields Type​

object[]

Definitions group TimesheetLine​

Reference this group by using

{"$ref":"https://access-payandbill-cloud-api-preprod.azurewebsites.net/api/import/timesheets.v1.schema#/definitions/TimesheetLine"}
PropertyTypeRequiredNullableDefined by
RateFrequencystringOptionalcan be nullTimesheet v1
ActualHoursnumberOptionalcan be nullTimesheet v1
RateCodestringRequiredcannot be nullTimesheet v1
DescriptionstringOptionalcan be nullTimesheet v1
UnitsnumberOptionalcannot be nullTimesheet v1
PayRatenumberOptionalcannot be nullTimesheet v1
PayAmountnumberOptionalcan be nullTimesheet v1
BillRatenumberOptionalcannot be nullTimesheet v1
BillAmountnumberOptionalcan be nullTimesheet v1
IsWTDAccruedbooleanOptionalcan be nullTimesheet v1
VATCodestringOptionalcan be nullTimesheet v1
IsAWRablebooleanOptionalcan be nullTimesheet v1
IsPensionablebooleanOptionalcan be nullTimesheet v1
VATCodeSourcestringOptionalcan be nullTimesheet v1

RateFrequency​

Defaults to Hourly if not specified.

RateFrequency

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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 v1

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

Description​

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

Description

  • is optional

  • Type: string

  • can be null

  • defined in: Timesheet v1

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

  • cannot be null

  • defined in: Timesheet v1

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

  • cannot be null

  • defined in: Timesheet v1

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 v1

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

  • cannot be null

  • defined in: Timesheet v1

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 v1

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 v1

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 v1

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 v1

IsAWRable Type​

boolean

IsPensionable​

IsPensionable

  • is optional

  • Type: boolean

  • can be null

  • defined in: Timesheet v1

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 v1

VATCodeSource Type​

string

VATCodeSource Constraints​

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

ValueExplanation
null
"SpecifiedVATRate"
"DefaultVATRate"
"DefaultNonVATRate"