Reference

Table of Contents

Query
Mutation
Objects
Inputs
Enums
Scalars
- Boolean
- Date
- DateTime
- Float
- ID
- Int
- String

Query

Field	Type	Description
employee	Employee!	Find an employee. Will return an error if it is not found.
id	ID!
leaveBalance	[LeaveBalance!]!	Get leave balance.
asOf	Date
employeeId	ID!
leaveRequests	[LeaveRequest!]!	Get leave requests.
approved	Boolean
employeeId	ID
endTime	DateTime
ignoreUnavailability	Boolean
leaveTypeId	String
modifiedSince	DateTime
startTime	DateTime
strictRange	Boolean
payLevel	PayLevel!	Find a pay level. Will return an error if it is not found.
id	ID!
payLevels	[PayLevel!]!	Get pay levels.
includeGlobal	Boolean
payRule	PayRule!	Find a pay rule. Will return an error if it is not found.
id	ID!
payRules	[PayRule!]!	Get pay rules.
includeGlobal	Boolean
payRun	PayRun!	Find a pay run. Will return an error if it is not found.
id	ID!
payRuns	[PayRun!]!	Get pay runs.
showFinalised	Boolean
statuses	[PayRunStatus!]
payTag	PayTag!	Get pay tags.
id	ID!
payTags	[PayTag!]!	Get pay tags.
payTypes	[PayType!]!	Get pay types.
position	Position!	Find a position. Will return an error if it is not found.
id	ID!
positions	[Position!]!	Get positions.
timesheet	Timesheet!	Find a timesheet. Will return an error if it is not found.
id	ID!
userDefinedFieldSettings	[UserDefinedFieldSetting!]!	Lists UserDefinedFieldSettings for a given owner type, and (optionally) available settings only.
available	Boolean
ownerType	String
userDefinedFormId	String
userDefinedFields	[UserDefinedField!]!	Lists UserDefinedFields for a given owner.
ownerId	ID
ownerType	String
workTypes	[WorkType!]!	Get work types.
includeHidden	Boolean
includeRequiresApproval	Boolean

Mutation

Field	Type	Description
addCostCentre	CostCentre!	Add a cost centre.
input	CostCentreInput!
addEmployee	Employee!	Add an employee.
input	AddEmployeeInput!
addLeaveRequest	LeaveRequest!	Add a leave request.
input	AddLeaveRequestInput!
addLeaveType	LeaveType!	Add a leave type.
input	AddLeaveTypeInput!
addLocation	Location!	Add location.
input	AddLocationInput!
addSale	Sale!	Add a sale.
input	AddSaleInput!
addUserDefinedField	UserDefinedField!	Adds a new UserDefinedField for an employee.
input	AddUserDefinedFieldInput!
addUserDefinedFieldSetting	UserDefinedFieldSetting!	Adds a new UserDefinedFieldSetting.
input	AddUserDefinedFieldSettingInput!
deleteLocation	ID!	Delete location.
id	ID!
deletePayRun	Boolean	Delete a pay run.
id	ID!
deleteUserDefinedFieldSetting	ID!	Removes an existing UserDefinedFieldSetting.
id	ID!
processPayRun	PayRun!	Process a pay run.
id	ID!
restoreLocation	ID!	Restore location.
id	ID!
updateEmployee	Employee!	Update an employee.
id	ID
input	UpdateEmployeeInput!
updateLeaveRequest	LeaveRequest!	Update a leave request.
id	ID
input	UpdateLeaveRequestInput!
updateLocation	Location!	Update location.
id	ID
input	UpdateLocationInput!
updateUserDefinedField	UserDefinedField!	Updates an existing UserDefinedField for an employee.
input	UpdateUserDefinedFieldInput!
updateUserDefinedFieldSetting	UserDefinedFieldSetting!	Updates an existing UserDefinedFieldSetting.
input	UpdateUserDefinedFieldSettingInput!
upsertUserDefinedField	UserDefinedField!	Upserts a User-Defined Field for an employee. Creates a new User-Defined Field if it doesn't already exist for the Employee, and User-Defined Field Setting. If the Employee already has a record for the User-Defined Field Setting, the value is updated.
input	AddUserDefinedFieldInput!

Objects

Address

A physical address.

Field	Type	Description
city ⚠️	String	Town/City of the address. ⚠️ DEPRECATED Use Suburb instead. This field maps to suburb.
country	String!	Country of the address, as a ISO 3166-1 alpha-2 letter code.
id	ID!
line1	String!	Line 1 of the address.
line2	String	Line 2 of the address.
line3	String	Line 3 of the address.
postalCode	String	Postal code of the address.
state	String	State/province of the address.
suburb	String	Suburb of the address.

Attachment

Field	Type	Description
expiresAt	DateTime	Expiry date of the attachment.
filename	String!	File name of the attachment.
id	ID!
mimeType	String!	A media type of the attachment.
modifiedAt	DateTime!
modifiedBy	ID!

BankAccount

A bank account to receive an employee's pay.

Field	Type	Description
accountName	String	Account name of the bank account.
accountNumber	String!	Account number of the bank account.
branch	String	Branch of the bank account.
id	ID!

Break

A break for a shift or timesheet.

Field	Type	Description
endTime	DateTime!	End timestamp of the break.
id	ID!
startTime	DateTime!	Start timestamp of the break.
subtracts	Boolean!	Whether the break subtracts from the shift/timesheet's duration.

CostCentre

A cost centre is used to allocate staff costs.

Field	Type	Description
externalId	String	External ID of the cost centre.
hidden	Boolean!	Whether the cost centre is hidden.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the cost centre.

Document

A document for an employee.

Field	Type	Description
completedAt	DateTime
documentSigners	[DocumentSigner!]!	Document signers of the document. In the order of signing.
employee	Employee!	Employee of the document. Usually also a signer. Used for dynamic field substitution.
employeeId	ID!
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the document.
sentAt	DateTime
sentBy	Person
status	DocumentStatus!	Status of the document.
voidedAt	DateTime
voidedBy	Person
voidedReason	String	Voided reason of the document. Why the document was voided.

DocumentSigner

The document signer is someone who signs a document.

Field	Type	Description
document	Document!	Document of the document signer. What document is being signed.
documentId	ID!
employee	Employee!	Employee of the document signer. Who is signing the document.
employeeId	ID!
id	ID!
order	Int!	Order of the document signer. Lower order signers will sign first.
sentAt	DateTime
signedAt	DateTime
status	DocumentSignerStatus!	Status of the document signer.

Employee

An employee is used to link persons to companies. Contains all company-specific details about an employee.

Field	Type	Description
anniversaryDate	Date	Anniversary date of the employee.
bankAccounts	[BankAccount!]!	Bank accounts of the employee.
costCentre	CostCentre	Cost centre of the employee.
employeeRequirements	[EmployeeRequirement!]!	Employee requirements of the employee. This includes licences and qualifications.
hasBiometricConsent	Boolean!	Whether the employee has provided biometric consent.
id	ID!
location	Location!	Primary location of the employee.
modifiedAt	DateTime
modifiedBy	Person
payLevel	PayLevel	Pay level of the employee.
payRule	PayRule	Pay rule of the employee.
person	Person!	Person of the employee. The employee is authorised through their person.
position	Position	Position/role of the employee.
residencyStatus	ResidencyStatus	Residency status of the employee.
rosterable	Boolean!	Whether the employee is rosterable.
startDate	Date	Start date of the employee.
superAccounts	[SuperAccount!]!	Super accounts of the employee.
terminatedAt	DateTime	Termination date of the employee. Can be used to determine if and when the employee has been terminated.
userDefinedFields	[UserDefinedField!]!	User defined fields of the employee.
userDefinedFormFields	[UserDefinedField!]!
visible	Boolean	Whether the employee is visible. Only administrators can see invisible employees.

EmployeeRequirement

An employee requirement is used to specify that an employee meets a requirement for rostering. This can include licenses and qualifications.

Field	Type	Description
attachment	Attachment	Attachment of the employee requirement.
employee	Employee	Employee of the employee requirement.
expiresAt	Date	Expiry date of the employee requirement.
id	ID!
name	String	Name of the requirement.
reference	String	Reference of the employee requirement.
requirement	Requirement	Requirement of the employee requirement.
state	String	State of the employee requirement.

EmployeeTermination

An EmployeeTermination is used to get employee termination details.

Field	Type	Description
notes	String	Notes of the EmployeeTermination.
reason	String!	Reason of the EmployeeTermination.
reemployable	Boolean!	Whether the EmployeeTermination is reemployable.

ExpenseRequest

An expense request is used for employees to submit expenses.

Field	Type	Description
amount	Float!	Amount of the expense request.
approved ⚠️	Boolean	Wether the expense request is approved. ⚠️ DEPRECATED Use `status` instead.
attachments	[Attachment]!	Attachments of the expense request.
deletedAt	DateTime
employee	Employee!	Employee of the expense request.
expenseDate	Date!	Date of the expense request.
expenseType	ExpenseType	Expense type of the expense request.
id	ID!
location	Location
modifiedAt	DateTime!
modifiedBy	Person!
notes	String!	Notes of the expense request.
reason	String	Reason for declining the expense request.
units	Float	Number of units of the expense request.

ExpenseType

An expense type is used to specify the type of an expense request.

Field	Type	Description
available	Boolean!	Whether the expense type is available.
id	ID!
name	String!	Name of the expense type.

LeaveBalance

A leave balance is used by an employee to get their available leave balance.

Field	Type	Description
amount	Float	Amount of the leave balance.
leaveType	LeaveType	Leave type of the leave balance.
unit	LeaveUnit	Leave unit of the leave balance.

LeaveRequest

A leave request is used by an employee to apply for leave.

Field	Type	Description
approved	Boolean	Whether the leave request has been approved.
attachments	[Attachment]!	Attachments of the leave request.
employee	Employee!	Employee of the leave request.
endTime	DateTime!	End time of the leave request.
id	ID!
leaveType	LeaveType	Leave type of the leave request. `null` indicates an unavailability request.
leaveTypeId	ID
modifiedAt	DateTime!
modifiedBy	Person!
note	String	Note of the leave request.
reason	String	Reason for declining the leave request.
startTime	DateTime!	Start time of the leave request.
timesheets	[Timesheet!]!	Timesheets of the leave request.

LeaveType

A leave type is used to specify the type of leave an employee is requesting.

Field	Type	Description
autoApprove	Boolean!	Whether the leave type should automatically approve.
available	Boolean!	Whether the leave type is available for selection by the employee.
createTimesheet	Boolean!	Whether the leave type should create timesheets.
displayBalance	Boolean!	Whether the leave type should display its balance to the employee.
id	ID!
minimumBalance	Float	Minimum balance of the leave type. Used to restrict an employee from applying for leave that would lower their balance below this threshold.
name	String!	Name of the leave type.
serviceKey	ID	Service mapping key of the leave type
unit	LeaveUnit	Unit of the leave type.

Location

A location is used as a place to roster on employees. It is usually a physical location.

Field	Type	Description
costCentre	CostCentre	Cost centre of the location.
id	ID!
name	String!	Name of the location.
rosterable	Boolean	Whether the location is rosterable.
timeZone	String!	Time zone of the location.

PayItem

A pay item is used to create line items for an employee's timesheets.

Field	Type	Description
amount	Float!	Total amount of the pay item.
employee	Employee!	Employee of the pay item.
endTime	DateTime	End time of the pay item.
payType	PayType!	Pay type of the pay item.
quantity	Float!	Quantity of the pay item.
startTime	DateTime	Start time of the pay item.
unitAmount	Float!	Calculated unit amount/rate based on the employee and pay type of the pay item.

PayLevel

A pay level is used to determines an employee's pay rate.

Field	Type	Description
alias	String
deletedAt	DateTime
description	String	Description of the pay level.
externalId	String
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay level.
versions	[PayLevelVersion!]!	Versions of the pay level.

PayLevelVersion

A pay level version is a date-driven version of a pay level.

Field	Type	Description
commencedAt	Date!	Commenced date of the pay run version.
deletedAt	DateTime
description	String	Description of the pay level.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay level.
payLevel	PayLevel!	Parent pay level of the pay level version.

PayRule

A pay rule is used by the calculate engine to convert timesheets to pay types.

Field	Type	Description
deletedAt	DateTime
description	String	Description of the pay rule.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay rule.
versions	[PayRuleVersion!]!	Versions of the pay rule.

PayRuleVersion

A pay rule version is a date-driven version of a pay rule.

Field	Type	Description
commencedAt	Date!	Commenced date of the pay run version.
deletedAt	DateTime
description	String	Description of the pay run version.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay run version.
payRule	PayRule!	Parent pay rule of the pay rule version.

PayRun

A pay run is used to calculate pay items for the employees and timesheets added to it.

Field	Type	Description
createdAt	DateTime!
description	String	Description of the pay run.
endDate	Date	End date of the pay run. Timesheets auto-selected should start before this date.
errors	[PayRunError!]!	Calculation errors for employee in the pay run.
finalisedAt	DateTime	Finalised date of the pay run. Only set if the pay run has been finalised.
finalisedBy	Person	Person who finalised the pay run.
id	ID!
includePreviousTimesheets	Boolean!	Whether the pay run will include associated timesheets when processing with the rules engine
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay run.
payItems	[PayItem!]!	Pay items in the pay run.
processedAt	DateTime	Processed date of the pay run. Only set if the pay run has been processed.
processedBy	Person	Person who processed the pay run.
startDate	Date	Start date of the pay run. Timesheets auto-selected should start after this date.
status	PayRunStatus!	Status of the pay run.
timesheets	[Timesheet!]!	Timesheets in the pay run.
timesheetsSelectedAt	DateTime	The date at which timesheets were selected for the pay run.
timesheetsSelectedBy	Person	The person who selected timesheets for the pay run.

PayRunError

A pay run error is used to communicate calculation errors for an employee.

Field	Argument	Type	Description
employee		Employee!	Employee who caused the pay run error.
message		String!	Message of the pay run error.

PayTag

A pay tag is used to tag against employees for costing and sending to payroll.

Field	Type	Description
appliedFromId	ID
deletedAt	DateTime
description	String	Description of the pay tag.
externalId	String	External identifier of the pay tag.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay tag.
templateId	ID

PayType

A pay type is used as the output from the calculation engine.

Field	Type	Description
description	String	Description of the pay type.
externalId	String	External identifier of the pay type.
id	ID!
modifiedAt	DateTime!
modifiedBy	Person!
name	String!	Name of the pay type.

Person

A person is used to authenticate and hold person-specific profile information.

Field	Type	Description
dateOfBirth	Date	Date of birth of the person.
firstName	String!	First name of the person.
fullName	String!	Full name of the person. Uses preferred name instead of first name if one is set.
id	ID!
lastName	String!	Last name of the person.
postalAddress	Address	Postal address of the person.
preferredName	String	Preferred name of the person.
regionalAU	PersonRegionalAU	Australian regional fields of the person.
regionalGB	PersonRegionalGB	Great British regional fields of the person.
regionalNZ	PersonRegionalNZ	New Zealand regional fields of the person.
regionalSG	PersonRegionalSG	Singaporean regional fields of the person.
regionalZA	PersonRegionalZA	South African regional fields of the person.
residentialAddress	Address	Residential address of the person.

PersonRegionalAU

Field	Type	Description
australiaHomeAddress	String	Australian home address of the person.
doesWantToClaimCarerTax	Boolean	Whether the person wants to claim carer tax.
doesWantToClaimSeniorPensionerTax	Boolean	Whether the person wants to claim senior pensioner tax.
hasFsDebt	Boolean	Whether the person has FS debt.
hasHelpSslTsl	Boolean	Whether the person has HELP.
hasWithholdingVariation	Boolean	Whether the person has approved withholding variation
hasWorkingHolidayVisa	Boolean	Whether the person has a working holiday visa
isAustralianForTaxPurposes	Boolean	Whether the person is an Australian for tax purposes.
paidBasis	String	On what basis are you paid? (from the AU tax declaration)
previousFamilyName	String	Previous family name of the person.
previousResidentialCountry	String	Previous country of residence of the employee for tax purposes when holding a working holiday visa
taxDeclaration	AUTaxDeclaration	Tax declaration of the person.
taxFileNumber	String	Tax file number of the person.
taxVariation	Float	withholding variation percentages of the person
title	String	Title of the person.

PersonRegionalGB

Field	Type	Description
hasPostgradLoan	Boolean	Whether the person has a postgrad loan.
hasStudentLoan	Boolean	Whether the person has a student loan.
niCategory	NiCategoryOptionsGB	NI category of the person.
niNumber	String	NI number of the person.
studentLoanType	StudentLoanTypeOptionsGB	Student loan type of the person.

PersonRegionalNZ

Field	Type	Description
eligibleForSdr	Boolean	Whether the person is eligible for SDR.
hasOverseasSuperOrPension	Boolean	Whether the person has an overseas super.
hasStudentLoan	Boolean	Whether the person has a student loan.
irdNumber	String	IRD number of the person.
isNzTaxResident	Boolean	Whether the person is a NZ tax resident.
studentLoanRate	Float	Student loan rate of the person.
studentLoanRateEndDate	Date	Student loan rate end date of the of person.

PersonRegionalSG

Field	Type	Description
cpfExempt	Boolean	CBF Excempt of the person.
fin	String	FIN of the person.
identificationExpiryDate	Date	Identification expiry date.
identificationIssueDate	Date	Identification issue date.
legalStatus	LegalStatusOptionsSG	Legal status of the person.
malaysianIc	String	Malaysian IC of the person.
nationality	String	Nationality (except Citizen and Foreign Director - Malaysia)
nric	String	NRIC of the person.
prDate	Date	PR date of the person.
race	RaceOptionsSG	Race of the person.
religion	ReligionOptionsSG	Religion of the person.

PersonRegionalZA

Field	Type	Description
idNumber	String	ID number of the person.
identificationType	IdentificationTypeOptionsZA	ID type of the person.
incomeTaxNumber	String	Income tax number of the person.
nationality	String	Nationality (for Passport identification types)

Position

A position is used for rostering and specifying an employee's role.

Field	Type	Description
description	String	Description of the position.
id	ID!
name	String!	Name of the position.

Requirement

Field	Type	Description
abbreviation	String!	Abbreviation of the requirement.
evidence	Boolean!	Whether the requirement needs evidence.
expires	Boolean!	Whether the requirement needs an expiry.
id	ID!
name	String!	Name of the requirement.

Sale

Field	Type	Description
externalId	ID
id	ID!
total	Int!	Total amount in cents

Shift

A shift is used to roster on an employee.

Field	Type	Description
breaks	[Break!]!	Breaks of the shift.
costCentre	CostCentre	Cost Centre of the shift.
employee	Employee	Employee of the shift.
employeeId	ID	Employee ID of the shift.
endTime	DateTime!	End timestamp of the shift.
hours	Float	Total hours of the shift. Subtracts unpaid breaks.
id	ID!
location	Location!	Location of the shift.
locationId	ID	Location ID of the shift.
notes	String	Notes of the shift. Can be used to provide extra information to the employee about this particular shift.
position	Position	Position of the shift.
positionId	ID	Position ID of the shift.
published	Boolean!	Whether the shift is published
requirements	[Requirement!]!	Requirements of the shift. An employee rostered on this shift must have these requirements met.
startTime	DateTime!	Start timestamp of the shift.

SuperAccount

Field	Argument	Type	Description
employee		Employee!
id		ID!

SupportRequest

A support request is used by support staff to request access for a company.

Field	Argument	Type	Description
id		ID!
location		Location!	Location of the support request.

Timesheet

A timesheet is used to record the hour an employee worked.

Field	Type	Description
breaks	[Break!]!	Breaks of the timesheet.
cost	Int	Cost of the timesheet.
costCentre	CostCentre	Cost centre of the timesheet.
employee	Employee!	Employee who worked the timesheet.
endTime	DateTime!	End timestamp of the timesheet.
id	ID!
location	Location!	Location of the timesheet.
modifiedAt	DateTime!
modifiedBy	Person!
startTime	DateTime!	Start timestamp of the timesheet.
statusModifiedAt	DateTime
statusModifiedBy	Person
workType ⚠️	WorkType	Work type of the timesheet. ⚠️ DEPRECATED Use `workTypes` instead
workTypes	[WorkType!]!	Work types of the timesheet.

UserDefinedField

A user-defined field is used to record the value of a custom field, for a given owner. An owner is an extensible type represented by the ownerId, and ownerType fields - only employees are currently supported as an ownerType. Each field is linked to a setting via the UserDefinedFieldSetting. The combination of ownerId, ownerType, and UserDefinedFieldSetting should be unqiue, to ensure that the owner has a single value for each type of field.

Field	Type	Description
id	ID!
owner	Employee	Reference to the Employee (or other entity in the future) that owns the field.
ownerId	ID!	ID of the UserDefinedField's owner.
userDefinedFieldSetting	UserDefinedFieldSetting!	ID of the UserDefinedFieldSetting that this value belongs to.
value	String!	Value of the UserDefinedField.

UserDefinedFieldSetting

A UserDefinedFieldSetting defines a type of custom field that can be added to the system for a given owner type. Owner type is an extensible field - currently only employees are supported for using UserDefinedFieldSettings. We can define the type of custom field, which governs the type of input for the field, and the label, tooltip, and placeholder for display. Fields can be marked as required or optional.

Field	Type	Description
available	Boolean!	Indicates whether this UserDefinedFieldSetting is available in the list of UserDefinedFields. True: UserDefinedFieldSetting appears in the list. False: UserDefinedFieldSetting does not appear in the list.
dataType	DataType!	Data type of the UserDefinedField.
fieldLevel	FieldLevel!	Indicates whether the UserDefinedField is a required field, or an optional field.
id	ID!
label	String!	Label of the input control when displaying the UserDefinedField.
name	String!	Name of the UserDefinedFieldSetting.
order	Int!	Number value used to determine display order of the UserDefinedFields when listed.
placeholder	String	A placeholder value of the input control when displaying the UserDefinedField.
tooltip	String	Tooltip text of the input control when displaying the UserDefinedField.
userDefinedFormId	ID	The id of the UserDefinedForm that this UserDefinedFieldSetting is attached to (if any)

WorkType

A Work Type is used to determine an employee's work type.

Field	Argument	Type	Description
id		ID!
name		String!	Name of the work type.

Inputs

AddEmployeeInput

Field	Type	Description
anniversaryDate	Date
bankAccounts	[BankAccountInput!]	Replaces bank accounts of the employee.
locationId	ID!
onboardedAt	Date
payLevelId	ID
payRuleId	ID
permissionGroupId	ID!
person	AddEmployeePersonInput
positionId	ID
visible	Boolean

AddEmployeePersonInput

Field		Type	Description
dateOfBirth		Date
email		String!
firstName		String!
lastName		String!
postalAddress		AddressInput
preferredName		String
regionalAU		PersonRegionalAuInput
regionalGB		PersonRegionalGbInput
regionalNZ		PersonRegionalNzInput
regionalSG		PersonRegionalSgInput
regionalZA		PersonRegionalZaInput
residentialAddress		AddressInput

AddLeaveRequestInput

Field		Type	Description
approved		Boolean
attachmentId		ID
employeeId		String!
endTime		DateTime!
leaveTypeId		ID
notes		String!
startTime		DateTime!

AddLeaveTypeInput

Field		Type	Description
appliedFromId		ID
autoApprove		Boolean!
available		Boolean!
createTimesheet		Boolean!
displayBalance		Boolean!
minimumBalance		Float
name		String!
serviceKey		ID
templateId		ID
unit		LeaveUnit

AddLocationInput

Field		Type	Description
name		String!
rosterable		Boolean

AddPayGroupInput

Field		Type	Description
display		Boolean!
name		String!
serviceId		ID

AddSaleInput

Field		Type	Description
externalId		ID
total		Int

AddUserDefinedFieldInput

Field		Type	Description
ownerId		ID!
userDefinedFieldSettingId		ID!
value		String!

AddUserDefinedFieldSettingInput

Field		Type	Description
available		Boolean!
dataType		DataType!
fieldLevel		FieldLevel!
label		String!
name		String!
order		Int!
placeholder		String
tooltip		String
userDefinedFormId		ID

AddressInput

Field	Type	Description
city	String	@deprecated(reason: "Use Suburb instead")
country	String
line1	String
line2	String
line3	String
postalCode	String
state	String
suburb	String

BankAccountInput

Field		Type	Description
accountName		String
accountNumber		String!
branch		String

BreakInput

Field		Type	Description
endTime		DateTime!
startTime		DateTime!
subtracts		Boolean!

CostCentreInput

Field		Type	Description
alias		String
appliedFromId		ID
externalId		String
hidden		Boolean
name		String!
templateId		ID

PersonRegionalAuInput

Field		Type	Description
australiaHomeAddress		String
doesWantToClaimCarerTax		Boolean
doesWantToClaimSeniorPensionerTax		Boolean
hasClaimExemptionPension		Boolean
hasClaimExemptionUnderEighteen		Boolean
hasFsDebt		Boolean
hasHelpSslTsl		Boolean
hasMadeSeparateApplicationToAto		Boolean
hasWithholdingVariation		Boolean
hasWorkingHolidayVisa		Boolean
isAustralianForTaxPurposes		Boolean
paidBasis		String
previousFamilyName		String
previousResidentialCountry		String
taxDeclaration		AUTaxDeclaration
taxFileNumber		String
taxVariation		Float
title		String

PersonRegionalGbInput

Field		Type	Description
hasPostgradLoan		Boolean
hasStudentLoan		Boolean
niCategory		NiCategoryOptionsGB
niNumber		String
studentLoanType		StudentLoanTypeOptionsGB

PersonRegionalNzInput

Field		Type	Description
eligibleForSdr		Boolean
hasOverseasSuperOrPension		Boolean
hasStudentLoan		Boolean
irdNumber		String
isNzTaxResident		Boolean
studentLoanRate		Float
studentLoanRateEndDate		Date

PersonRegionalSgInput

Field		Type	Description
cpfExempt		Boolean
fin		String
identificationExpiryDate		Date
identificationIssueDate		Date
legalStatus		LegalStatusOptionsSG
malaysianIc		String
nationality		String
nric		String
prDate		Date
race		RaceOptionsSG
religion		ReligionOptionsSG

PersonRegionalZaInput

Field		Type	Description
idNumber		String
identificationType		IdentificationTypeOptionsZA
incomeTaxNumber		String
nationality		String

UpdateEmployeeInput

Field	Type	Description
anniversaryDate	Date
bankAccounts	[BankAccountInput!]	Replaces bank accounts of the employee.
locationId	ID
payLevelId	ID
payRuleId	ID
person	UpdateEmployeePersonInput
positionId	ID
rosterable	Boolean
startDate	Date

UpdateEmployeePersonInput

Field		Type	Description
dateOfBirth		Date
email		String
firstName		String
lastName		String
postalAddress		AddressInput
preferredName		String
regionalAU		PersonRegionalAuInput
regionalGB		PersonRegionalGbInput
regionalNZ		PersonRegionalNzInput
regionalSG		PersonRegionalSgInput
regionalZA		PersonRegionalZaInput
residentialAddress		AddressInput

UpdateLeaveRequestInput

Field		Type	Description
attachmentId		ID
employeeId		String
endTime		DateTime
leaveTypeId		ID
notes		String
startTime		DateTime

UpdateLocationInput

Field		Type	Description
name		String
rosterable		Boolean

UpdateUserDefinedFieldInput

Field		Type	Description
id		ID!
value		String!

UpdateUserDefinedFieldSettingInput

Field		Type	Description
available		Boolean!
dataType		DataType!
fieldLevel		FieldLevel!
id		ID!
label		String!
name		String!
order		Int!
placeholder		String
tooltip		String
userDefinedFormId		ID

Enums

AUTaxDeclaration

Value	Description
ClaimExceptionPensionBenefitAllowance
ClaimExceptionUnder18
NotClaimingException
SeparateATOApplication

DataType

Enumeration of the possible data types supported by UserDefinedFieldSettings.

Value	Description
checkbox
currency
date
datetime
decimal
email
integer
tel
text
url

DocumentSignerStatus

Value	Description
Pending	The document signer is waiting their turn to sign.
Sent	The document signer has been sent to document to sign.
Signed	The document signer has signed the document.

DocumentStatus

Value	Description
Completed	The document has been completed. All signers have signed the document.
Draft	The document is a draft.
InProgress	The document is in the process of signing.
Voided	The document has been voided.

EmployeeStatus

Value	Description
Active
Draft
Invited
Onboarding
Terminated

EmploymentType

Value	Description
Casual
FullTime
IndependentContractor
PartTime

FieldLevel

Enumeration of the field levels supported by the UserDefinedFieldSettings.

Value	Description
optional
required

IdentificationTypeOptionsZA

Value	Description
AsylumSeeker
None
Passport
Refugee
RsaId

LeaveUnit

A leave unit is used to define in what format leave balance should be displayed to employee.

Value	Description
Days
Hours
Weeks

LegalStatusOptionsSG

Value	Description
Citizen
ContractNoCpfNoSdl
ContractWithSdlNoCpfwsdl
EPass
EntrePass
ForeignDirectorMalaysia
ForeignDirectorOther
Foreigner
ForeignerWorkPermit
Intern
LetterOfConsent
PassportOverseaDirector
PermanentResident
PersonalisedEmploymentPass
SPass
StudentVisaNoCpfNoSdl
WorkHolidayPassNoCpf

NiCategoryOptionsGB

Value	Description
A
B
C
H
J
M
V
X
Z

PayBasis

Value	Description
PerAnnum
PerDay
PerHour
PerMonth

PayRunStatus

Value	Description
Draft
Finalised
Processed

RaceOptionsSG

Value	Description
African
AfricanAmerican
Bidayuh
Bumiputra
Caucasian
Chinese
Eurasian
Filipino
Iban
Indian
Japanese
Korean
Malay
Other
Thai
Vietnam

ReligionOptionsSG

Value	Description
BahaiFaith
Buddhist
Catholicism
Christian
Confucianism
Hindu
Jainism
Judaism
Muslim
NoReligion
Other
Sikhism
Taoism

ResidencyStatus

Value	Description
Citizen
HasVisa
PermanentResident

StudentLoanTypeOptionsGB

Value	Description
Plan1
Plan2
Plan4
Plan5

Scalars

Boolean

The Boolean scalar type represents true or false.

Date

DateTime

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.