Xero: Payroll au schemas

← Payroll au operations · All schemas

Creates a Payroll Calendar — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
CalendarType	string	Optional	One of: WEEKLY, FORTNIGHTLY, FOURWEEKLY, MONTHLY, TWICEMONTHLY, QUARTERLY
Name	string	Optional	Name of the Payroll Calendar
PaymentDate	string	Optional	The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)
PayrollCalendarID	string	Optional	Xero identifier Format: uuid
ReferenceDate	string	Optional	Reference Date (YYYY-MM-DD)
StartDate	string	Optional	The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD)
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a Payroll Calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
PayrollCalendars	array	Optional
PayrollCalendars[]	Model	Each item	Expand Creates a Payroll Calendar — response body — Payroll Calendars item

Referenced models: Creates a Payroll Calendar — response body — Payroll Calendars item

Creates a Payroll Calendar — response body — Payroll Calendars item

Field	Type	Presence	Description and constraints
$	object	Root
CalendarType	string	Optional	Known values: WEEKLY, FORTNIGHTLY, FOURWEEKLY, MONTHLY, TWICEMONTHLY, QUARTERLY
Name	string	Optional	Name of the Payroll Calendar
PaymentDate	string	Optional	The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)
PayrollCalendarID	string	Optional	Xero identifier Format: uuid
ReferenceDate	string	Optional	Reference Date (YYYY-MM-DD)
StartDate	string	Optional	The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD)
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a leave application — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
Description	string	Optional	The Description of the Leave
EmployeeID	string	Optional	The Xero identifier for Payroll Employee Format: uuid
EndDate	string	Optional	End date of the leave (YYYY-MM-DD)
LeaveApplicationID	string	Optional	The Xero identifier for Payroll Employee Format: uuid
LeavePeriods	array	Optional
LeavePeriods[]	Model	Each item	Expand Creates a leave application — request body — body item Leave Periods item
LeaveTypeID	string	Optional	The Xero identifier for Leave Type Format: uuid
PayOutType	string	Optional	How the requested leave will be paid out, e.g. cashed out. One of: DEFAULT, CASHED_OUT
StartDate	string	Optional	Start date of the leave (YYYY-MM-DD)
Title	string	Optional	The title of the leave
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a leave application — request body — body item Leave Periods item, Retrieves journals — response body — Warnings item

Creates a leave application — request body — body item Leave Periods item

Field	Type	Presence	Description and constraints
$	object	Root
LeavePeriodStatus	string	Optional	One of: SCHEDULED, PROCESSED, REQUESTED, REJECTED
NumberOfUnits	number	Optional	The Number of Units for the leave Format: double
PayPeriodEndDate	string	Optional	The Pay Period End Date (YYYY-MM-DD)
PayPeriodStartDate	string	Optional	The Pay Period Start Date (YYYY-MM-DD)

Creates a leave application — response body

Field	Type	Presence	Description and constraints
$	object	Root
LeaveApplications	array	Optional
LeaveApplications[]	Model	Each item	Expand Creates a leave application — response body — Leave Applications item

Referenced models: Creates a leave application — response body — Leave Applications item

Creates a leave application — response body — Leave Applications item

Field	Type	Presence	Description and constraints
$	object	Root
Description	string	Optional	The Description of the Leave
EmployeeID	string	Optional	The Xero identifier for Payroll Employee Format: uuid
EndDate	string	Optional	End date of the leave (YYYY-MM-DD)
LeaveApplicationID	string	Optional	The Xero identifier for Payroll Employee Format: uuid
LeavePeriods	array	Optional
LeavePeriods[]	Model	Each item	Expand Creates a leave application — response body — Leave Applications item Leave Periods item
LeaveTypeID	string	Optional	The Xero identifier for Leave Type Format: uuid
PayOutType	string	Optional	How the requested leave will be paid out, e.g. cashed out. Known values: DEFAULT, CASHED_OUT
StartDate	string	Optional	Start date of the leave (YYYY-MM-DD)
Title	string	Optional	The title of the leave
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a leave application — response body — Leave Applications item Leave Periods item, Retrieves journals — response body — Warnings item

Creates a leave application — response body — Leave Applications item Leave Periods item

Field	Type	Presence	Description and constraints
$	object	Root
LeavePeriodStatus	string	Optional	Known values: SCHEDULED, PROCESSED, REQUESTED, REJECTED
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	The Number of Units for the leave Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PayPeriodEndDate	string	Optional	The Pay Period End Date (YYYY-MM-DD)
PayPeriodStartDate	string	Optional	The Pay Period Start Date (YYYY-MM-DD)

Creates a pay item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
DeductionTypes	array	Optional
DeductionTypes[]	Model	Each item	Expand Creates a pay item — request body — body Deduction Types item
EarningsRates	array	Optional
EarningsRates[]	Model	Each item	Expand Creates a pay item — request body — body Earnings Rates item
LeaveTypes	array	Optional
LeaveTypes[]	Model	Each item	Expand Creates a pay item — request body — body Leave Types item
ReimbursementTypes	array	Optional
ReimbursementTypes[]	Model	Each item	Expand Creates a pay item — request body — body Reimbursement Types item

Referenced models: Creates a pay item — request body — body Deduction Types item, Creates a pay item — request body — body Earnings Rates item, Creates a pay item — request body — body Leave Types item, Creates a pay item — request body — body Reimbursement Types item

Creates a pay item — request body — body Deduction Types item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
CurrentRecord	boolean	Optional	Is the current record
DeductionCategory	string	Optional	One of: NONE, UNIONFEES, WORKPLACEGIVING
DeductionTypeID	string	Optional	Xero identifier Format: uuid
IsExemptFromW1	boolean	Optional	Boolean to determine if the deduction type is reportable or exempt from W1
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
ReducesSuper	boolean	Optional	Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this.
ReducesTax	boolean	Optional	Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee.
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — request body — body Earnings Rates item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccrueLeave	boolean	Optional	Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE
AllowanceCategory	string	Optional	One of: NONDEDUCTIBLE, UNIFORM, PRIVATEVEHICLE, HOMEOFFICE, TRANSPORT, GENERAL, OTHER
AllowanceContributesToAnnualLeaveRate	boolean	Optional	Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
AllowanceContributesToOvertimeRate	boolean	Optional	Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
AllowanceType	string	Optional	One of: CAR, TRANSPORT, LAUNDRY, MEALS, TRAVEL, OTHER, TOOLS, TASKS, QUALIFICATIONS
Amount	number	Optional	Optional Amount for FIXEDAMOUNT RateType EarningsRate Format: double
CurrentRecord	boolean	Optional	Is the current record
EarningsRateID	string	Optional	Xero identifier Format: uuid
EarningsType	string	Optional	One of: FIXED, ORDINARYTIMEEARNINGS, OVERTIMEEARNINGS, ALLOWANCE, LUMPSUMD, EMPLOYMENTTERMINATIONPAYMENT, LUMPSUMA, LUMPSUMB, BONUSESANDCOMMISSIONS, LUMPSUME, LUMPSUMW, DIRECTORSFEES, PAIDPARENTALLEAVE, WORKERSCOMPENSATION
EmploymentTerminationPaymentType	string	Optional	One of: O, R
IsExemptFromSuper	boolean	Optional	See the ATO website for details of which payments are exempt from SGC
IsExemptFromTax	boolean	Optional	Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations
IsReportableAsW1	boolean	Optional	Boolean to determine if the earnings rate is reportable or exempt from W1
Multiplier	number	Optional	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE Format: double
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
RatePerUnit	string	Optional	Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.
RateType	string	Optional	One of: FIXEDAMOUNT, MULTIPLE, RATEPERUNIT
TypeOfUnits	string	Optional	Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT Maximum length: 50
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — request body — body Leave Types item

Field	Type	Presence	Description and constraints
$	object	Root
CurrentRecord	boolean	Optional	Is the current record
IsPaidLeave	boolean	Optional	Set this to indicate that an employee will be paid when taking this type of leave
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations
LeaveCategoryCode	string	Optional	Code used to identify the Leave Category One of: ANNUALLEAVE, LONGSERVICELEAVE, PERSONALSICKCARERSLEAVE, ROSTEREDDAYOFF, TIMEOFFINLIEU, COMPASSIONATEANDBEREAVEMENTLEAVE, STUDYLEAVE, FAMILYANDDOMESTICVIOLENCELEAVE, SPECIALPAIDLEAVE, COMMUNITYSERVICELEAVE, JURYDUTYLEAVE, DEFENCERESERVELEAVE
LeaveLoadingRate	number	Optional	Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) Format: double
LeaveTypeID	string	Optional	Xero identifier Format: uuid
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
NormalEntitlement	number	Optional	The number of units the employee is entitled to each year Format: double
SGCExempt	boolean	Optional	Set this to indicate that the leave type is exempt from superannuation guarantee contribution
ShowOnPayslip	boolean	Optional	Set this if you want a balance for this leave type to be shown on your employee’s payslips
TypeOfUnits	string	Optional	The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — request body — body Reimbursement Types item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
CurrentRecord	boolean	Optional	Is the current record
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
ReimbursementTypeID	string	Optional	Xero identifier Format: uuid
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — response body

Field	Type	Presence	Description and constraints
$	object	Root
PayItems	Model	Optional	Expand Creates a pay item — response body — Pay Items

Referenced models: Creates a pay item — response body — Pay Items

Creates a pay item — response body — Pay Items

Field	Type	Presence	Description and constraints
$	object	Root
DeductionTypes	array	Optional
DeductionTypes[]	Model	Each item	Expand Creates a pay item — response body — Pay Items Deduction Types item
EarningsRates	array	Optional
EarningsRates[]	Model	Each item	Expand Creates a pay item — response body — Pay Items Earnings Rates item
LeaveTypes	array	Optional
LeaveTypes[]	Model	Each item	Expand Creates a pay item — response body — Pay Items Leave Types item
ReimbursementTypes	array	Optional
ReimbursementTypes[]	Model	Each item	Expand Creates a pay item — request body — body Reimbursement Types item

Referenced models: Creates a pay item — response body — Pay Items Deduction Types item, Creates a pay item — response body — Pay Items Earnings Rates item, Creates a pay item — response body — Pay Items Leave Types item, Creates a pay item — request body — body Reimbursement Types item

Creates a pay item — response body — Pay Items Deduction Types item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
CurrentRecord	boolean	Optional	Is the current record
DeductionCategory	string	Optional	Known values: NONE, UNIONFEES, WORKPLACEGIVING
DeductionTypeID	string	Optional	Xero identifier Format: uuid
IsExemptFromW1	boolean	Optional	Boolean to determine if the deduction type is reportable or exempt from W1
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
ReducesSuper	boolean	Optional	Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this.
ReducesTax	boolean	Optional	Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee.
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — response body — Pay Items Earnings Rates item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccrueLeave	boolean	Optional	Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE
AllowanceCategory	string	Optional	Known values: NONDEDUCTIBLE, UNIFORM, PRIVATEVEHICLE, HOMEOFFICE, TRANSPORT, GENERAL, OTHER
AllowanceContributesToAnnualLeaveRate	boolean	Optional	Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
AllowanceContributesToOvertimeRate	boolean	Optional	Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
AllowanceType	string	Optional	Known values: CAR, TRANSPORT, LAUNDRY, MEALS, TRAVEL, OTHER, TOOLS, TASKS, QUALIFICATIONS
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Optional Amount for FIXEDAMOUNT RateType EarningsRate Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CurrentRecord	boolean	Optional	Is the current record
EarningsRateID	string	Optional	Xero identifier Format: uuid
EarningsType	string	Optional	Known values: FIXED, ORDINARYTIMEEARNINGS, OVERTIMEEARNINGS, ALLOWANCE, LUMPSUMD, EMPLOYMENTTERMINATIONPAYMENT, LUMPSUMA, LUMPSUMB, BONUSESANDCOMMISSIONS, LUMPSUME, LUMPSUMW, DIRECTORSFEES, PAIDPARENTALLEAVE, WORKERSCOMPENSATION
EmploymentTerminationPaymentType	string	Optional	Known values: O, R
IsExemptFromSuper	boolean	Optional	See the ATO website for details of which payments are exempt from SGC
IsExemptFromTax	boolean	Optional	Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations
IsReportableAsW1	boolean	Optional	Boolean to determine if the earnings rate is reportable or exempt from W1
Multiplier	JSON	Optional
Multiplier (anyOf 1)	number	Alternative	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE Format: double
Multiplier (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
RatePerUnit	string	Optional	Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.
RateType	string	Optional	Known values: FIXEDAMOUNT, MULTIPLE, RATEPERUNIT
TypeOfUnits	string	Optional	Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT Maximum length: 50
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay item — response body — Pay Items Leave Types item

Field	Type	Presence	Description and constraints
$	object	Root
CurrentRecord	boolean	Optional	Is the current record
IsPaidLeave	boolean	Optional	Set this to indicate that an employee will be paid when taking this type of leave
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations
LeaveCategoryCode	string	Optional	Code used to identify the Leave Category Known values: ANNUALLEAVE, LONGSERVICELEAVE, PERSONALSICKCARERSLEAVE, ROSTEREDDAYOFF, TIMEOFFINLIEU, COMPASSIONATEANDBEREAVEMENTLEAVE, STUDYLEAVE, FAMILYANDDOMESTICVIOLENCELEAVE, SPECIALPAIDLEAVE, COMMUNITYSERVICELEAVE, JURYDUTYLEAVE, DEFENCERESERVELEAVE
LeaveLoadingRate	JSON	Optional
LeaveLoadingRate (anyOf 1)	number	Alternative	Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%) Format: double
LeaveLoadingRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
LeaveTypeID	string	Optional	Xero identifier Format: uuid
Name	string	Optional	Name of the earnings rate (max length = 100) Maximum length: 100
NormalEntitlement	JSON	Optional
NormalEntitlement (anyOf 1)	number	Alternative	The number of units the employee is entitled to each year Format: double
NormalEntitlement (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SGCExempt	boolean	Optional	Set this to indicate that the leave type is exempt from superannuation guarantee contribution
ShowOnPayslip	boolean	Optional	Set this if you want a balance for this leave type to be shown on your employee’s payslips
TypeOfUnits	string	Optional	The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a pay run — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
Deductions	number	Optional	The total Deductions for the Payrun Format: double
NetPay	number	Optional	The total NetPay for the Payrun Format: double
PayRunID	string	Optional	Xero identifier for pay run Format: uuid
PayRunPeriodEndDate	string	Optional	Period End Date for the PayRun (YYYY-MM-DD)
PayRunPeriodStartDate	string	Optional	Period Start Date for the PayRun (YYYY-MM-DD)
PayRunStatus	string	Optional	One of: DRAFT, POSTED
PaymentDate	string	Optional	Payment Date for the PayRun (YYYY-MM-DD)
PayrollCalendarID	string	Required within parent	Xero identifier for pay run Format: uuid
PayslipMessage	string	Optional	Payslip message for the PayRun
Payslips	array	Optional	The payslips in the payrun
Payslips[]	Model	Each item	Expand Creates a pay run — request body — body item Payslips item
Reimbursement	number	Optional	The total Reimbursements for the Payrun Format: double
Super	number	Optional	The total Super for the Payrun Format: double
Tax	number	Optional	The total Tax for the Payrun Format: double
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Wages	number	Optional	The total Wages for the Payrun Format: double

Referenced models: Retrieves journals — response body — Warnings item, Creates a pay run — request body — body item Payslips item

Creates a pay run — request body — body item Payslips item

Field	Type	Presence	Description and constraints
$	object	Root
Deductions	number	Optional	The Deductions for the Payslip Format: double
EmployeeGroup	string	Optional	Employee group name
EmployeeID	string	Optional	The Xero identifier for an employee Format: uuid
FirstName	string	Optional	First name of employee
LastName	string	Optional	Last name of employee
NetPay	number	Optional	The NetPay for the Payslip Format: double
PayslipID	string	Optional	Xero identifier for the payslip Format: uuid
Reimbursements	number	Optional	The Reimbursements for the Payslip Format: double
Super	number	Optional	The Super for the Payslip Format: double
Tax	number	Optional	The Tax for the Payslip Format: double
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
Wages	number	Optional	The Wages for the Payslip Format: double

Creates a pay run — response body

Field	Type	Presence	Description and constraints
$	object	Root
PayRuns	array	Optional
PayRuns[]	Model	Each item	Expand Creates a pay run — response body — Pay Runs item

Referenced models: Creates a pay run — response body — Pay Runs item

Creates a pay run — response body — Pay Runs item

Field	Type	Presence	Description and constraints
$	object	Root
Deductions	JSON	Optional
Deductions (anyOf 1)	number	Alternative	The total Deductions for the Payrun Format: double
Deductions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
NetPay	JSON	Optional
NetPay (anyOf 1)	number	Alternative	The total NetPay for the Payrun Format: double
NetPay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PayRunID	string	Optional	Xero identifier for pay run Format: uuid
PayRunPeriodEndDate	string	Optional	Period End Date for the PayRun (YYYY-MM-DD)
PayRunPeriodStartDate	string	Optional	Period Start Date for the PayRun (YYYY-MM-DD)
PayRunStatus	string	Optional	Known values: DRAFT, POSTED
PaymentDate	string	Optional	Payment Date for the PayRun (YYYY-MM-DD)
PayrollCalendarID	string	Required within parent	Xero identifier for pay run Format: uuid
PayslipMessage	string	Optional	Payslip message for the PayRun
Payslips	array	Optional	The payslips in the payrun
Payslips[]	Model	Each item	Expand Creates a pay run — response body — Pay Runs item Payslips item
Reimbursement	JSON	Optional
Reimbursement (anyOf 1)	number	Alternative	The total Reimbursements for the Payrun Format: double
Reimbursement (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Super	JSON	Optional
Super (anyOf 1)	number	Alternative	The total Super for the Payrun Format: double
Super (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Tax	JSON	Optional
Tax (anyOf 1)	number	Alternative	The total Tax for the Payrun Format: double
Tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Wages	JSON	Optional
Wages (anyOf 1)	number	Alternative	The total Wages for the Payrun Format: double
Wages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Creates a pay run — response body — Pay Runs item Payslips item, Retrieves journals — response body — Warnings item

Creates a pay run — response body — Pay Runs item Payslips item

Field	Type	Presence	Description and constraints
$	object	Root
Deductions	JSON	Optional
Deductions (anyOf 1)	number	Alternative	The Deductions for the Payslip Format: double
Deductions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EmployeeGroup	string	Optional	Employee group name
EmployeeID	string	Optional	The Xero identifier for an employee Format: uuid
FirstName	string	Optional	First name of employee
LastName	string	Optional	Last name of employee
NetPay	JSON	Optional
NetPay (anyOf 1)	number	Alternative	The NetPay for the Payslip Format: double
NetPay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PayslipID	string	Optional	Xero identifier for the payslip Format: uuid
Reimbursements	JSON	Optional
Reimbursements (anyOf 1)	number	Alternative	The Reimbursements for the Payslip Format: double
Reimbursements (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Super	JSON	Optional
Super (anyOf 1)	number	Alternative	The Super for the Payslip Format: double
Super (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Tax	JSON	Optional
Tax (anyOf 1)	number	Alternative	The Tax for the Payslip Format: double
Tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
Wages	JSON	Optional
Wages (anyOf 1)	number	Alternative	The Wages for the Payslip Format: double
Wages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates a payroll employee — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
BankAccounts	array	Optional
BankAccounts[]	Model	Each item	Expand Creates a payroll employee — request body — body item Bank Accounts item
Classification	string	Optional	Employees classification
CountryOfResidence	Model	Optional	Expand Creates a payroll employee — request body — body item Country Of Residence
DateOfBirth	string	Required within parent	Date of birth of the employee (YYYY-MM-DD)
Email	string	Optional	The email address for the employee
EmployeeGroupName	string	Optional	The Employee Group allows you to report on payroll expenses and liabilities for each group of employees
EmployeeID	string	Optional	Xero unique identifier for an Employee Format: uuid
EmploymentType	string	Optional	One of: EMPLOYEE, CONTRACTOR
FirstName	string	Required within parent	First name of employee
Gender	string	Optional	The employee’s gender. See Employee Gender One of: N, M, F, I
HomeAddress	Model	Optional	Expand Creates a payroll employee — request body — body item Home Address
IncomeType	string	Optional	One of: SALARYANDWAGES, WORKINGHOLIDAYMAKER, NONEMPLOYEE, CLOSELYHELDPAYEES, LABOURHIRE
IsAuthorisedToApproveLeave	boolean	Optional	Authorised to approve other employees' leave requests
IsAuthorisedToApproveTimesheets	boolean	Optional	Authorised to approve timesheets
IsSTP2Qualified	boolean	Optional	Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable.
JobTitle	string	Optional	JobTitle of the employee
LastName	string	Required within parent	Last name of employee
LeaveBalances	array	Optional
LeaveBalances[]	Model	Each item	Expand Creates a payroll employee — request body — body item Leave Balances item
MiddleNames	string	Optional	Middle name(s) of the employee
Mobile	string	Optional	Employee mobile number
OpeningBalances	Model	Optional	Expand Creates a payroll employee — request body — body item Opening Balances
OrdinaryEarningsRateID	string	Optional	Xero unique identifier for earnings rate Format: uuid
PayTemplate	Model	Optional	Expand Creates a payroll employee — request body — body item Pay Template
PayrollCalendarID	string	Optional	Xero unique identifier for payroll calendar for the employee Format: uuid
Phone	string	Optional	Employee phone number
StartDate	string	Optional	Start date for an employee (YYYY-MM-DD)
Status	string	Optional	Employee Status Types One of: ACTIVE, TERMINATED
SuperMemberships	array	Optional
SuperMemberships[]	Model	Each item	Expand Creates a payroll employee — request body — body item Super Memberships item
TaxDeclaration	Model	Optional	Expand Creates a payroll employee — request body — body item Tax Declaration
TerminationDate	string	Optional	Employee Termination Date (YYYY-MM-DD)
TerminationReason	string	Optional	* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities. One of: V, I, D, R, F, C, T
Title	string	Optional	Title of the employee
TwitterUserName	string	Optional	Employee’s twitter name
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a payroll employee — request body — body item Bank Accounts item, Creates a payroll employee — request body — body item Country Of Residence, Creates a payroll employee — request body — body item Home Address, Creates a payroll employee — request body — body item Leave Balances item, Creates a payroll employee — request body — body item Opening Balances, Creates a payroll employee — request body — body item Super Memberships item, Retrieves journals — response body — Warnings item, Creates a payroll employee — request body — body item Pay Template, Creates a payroll employee — request body — body item Tax Declaration

Creates a payroll employee — request body — body item Bank Accounts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountName	string	Optional	The name of the account
AccountNumber	string	Optional	The account number
Amount	number	Optional	Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) Format: double
BSB	string	Optional	The BSB number of the account
Remainder	boolean	Optional	If this account is the Remaining bank account
StatementText	string	Optional	The text that will appear on your employee's bank statement when they receive payment

Creates a payroll employee — request body — body item Country Of Residence

Field	Type	Presence	Description and constraints
$	string	Root	Country of residence as a valid ISO 3166-1 alpha-2 country code e.g. "AU", "NZ", "CA". Only applicable, and mandatory if income type is WORKINGHOLIDAYMAKER. One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, BQ, CW, SX, SS

Creates a payroll employee — request body — body item Home Address

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Required within parent	Address line 1 for employee home address
AddressLine2	string	Optional	Address line 2 for employee home address
City	string	Optional	Suburb for employee home address
Country	string	Optional	Country of HomeAddress
PostalCode	string	Optional	PostCode for employee home address
Region	string	Optional	State abbreviation for employee home address One of: ACT, NSW, NT, QLD, SA, TAS, VIC, WA

Creates a payroll employee — request body — body item Leave Balances item

Field	Type	Presence	Description and constraints
$	object	Root
LeaveName	string	Optional	The name of the leave type
LeaveTypeID	string	Optional	Identifier of the leave type (see PayItems)
NumberOfUnits	number	Optional	The balance of the leave available Format: double
TypeOfUnits	string	Optional	The type of units as specified by the LeaveType (see PayItems)

Creates a payroll employee — request body — body item Opening Balances

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Updates a payslip — request body — body item Deduction Lines item
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Updates a payslip — request body — body item Earnings Lines item
LeaveLines	array	Optional
LeaveLines[]	Model	Each item	Expand Creates a payroll employee — request body — body item Opening Balances Leave Lines item
OpeningBalanceDate	string	Optional	Opening Balance Date. (YYYY-MM-DD)
PaidLeaveEarningsLines	array	Optional
PaidLeaveEarningsLines[]	Model	Each item	Expand Creates a payroll employee — request body — body item Opening Balances Paid Leave Earnings Lines item
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Updates a payslip — request body — body item Reimbursement Lines item
SuperLines	array	Optional
SuperLines[]	Model	Each item	Expand Creates a payroll employee — request body — body item Pay Template Super Lines item
Tax	string	Optional	Opening Balance tax

Referenced models: Updates a payslip — request body — body item Deduction Lines item, Updates a payslip — request body — body item Earnings Lines item, Creates a payroll employee — request body — body item Opening Balances Leave Lines item, Creates a payroll employee — request body — body item Opening Balances Paid Leave Earnings Lines item, Updates a payslip — request body — body item Reimbursement Lines item, Creates a payroll employee — request body — body item Pay Template Super Lines item

Creates a payroll employee — request body — body item Opening Balances Leave Lines item

Field	Type	Presence	Description and constraints
$	object	Root
LeaveTypeID	string	Optional	Xero leave type identifier Format: uuid
NumberOfUnits	number	Optional	Number of units for leave line. Format: double

Creates a payroll employee — request body — body item Opening Balances Paid Leave Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Required within parent	Paid leave amount Format: double
LeaveTypeID	string	Required within parent	Xero leave type identifier Format: uuid
ResetSTPCategorisation	boolean	Optional	Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories
SGCAppliedLeaveLoadingAmount	number	Optional	The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories Format: double
SGCExemptedLeaveLoadingAmount	number	Optional	The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories Format: double

Creates a payroll employee — request body — body item Pay Template

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Updates a payslip — request body — body item Deduction Lines item
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Updates a payslip — request body — body item Earnings Lines item
LeaveLines	array	Optional
LeaveLines[]	Model	Each item	Expand Creates a payroll employee — request body — body item Pay Template Leave Lines item
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Updates a payslip — request body — body item Reimbursement Lines item
SuperLines	array	Optional
SuperLines[]	Model	Each item	Expand Creates a payroll employee — request body — body item Pay Template Super Lines item

Referenced models: Updates a payslip — request body — body item Deduction Lines item, Updates a payslip — request body — body item Earnings Lines item, Creates a payroll employee — request body — body item Pay Template Leave Lines item, Updates a payslip — request body — body item Reimbursement Lines item, Creates a payroll employee — request body — body item Pay Template Super Lines item

Creates a payroll employee — request body — body item Pay Template Leave Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AnnualNumberOfUnits	number	Optional	Hours of leave accrued each year Format: double
CalculationType	string	Optional	Calculation type for leave line for Opening Balance on Employee One of: NOCALCULATIONREQUIRED, FIXEDAMOUNTEACHPERIOD, ENTERRATEINPAYTEMPLATE, BASEDONORDINARYEARNINGS
EmploymentTerminationPaymentType	string	Optional	One of: O, R
EntitlementFinalPayPayoutType	string	Optional	One of: NOTPAIDOUT, PAIDOUT
FullTimeNumberOfUnitsPerPeriod	number	Optional	Normal ordinary earnings number of units for leave line. Format: double
IncludeSuperannuationGuaranteeContribution	boolean	Optional	amount of leave line
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations
LeaveTypeID	string	Optional	Xero leave type identifier Format: uuid
NumberOfUnits	number	Optional	Number of units for leave line. Format: double

Creates a payroll employee — request body — body item Pay Template Super Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	Super membership amount Format: double
CalculationType	string	Optional	One of: FIXEDAMOUNT, PERCENTAGEOFEARNINGS, STATUTORY
ContributionType	string	Optional	One of: SGC, SALARYSACRIFICE, EMPLOYERADDITIONAL, EMPLOYEE
ExpenseAccountCode	string	Optional	expense account code
LiabilityAccountCode	string	Optional	liabilty account code
MinimumMonthlyEarnings	number	Optional	amount of minimum earnings Format: double
Percentage	number	Optional	percentage for super line Format: double
SuperMembershipID	string	Optional	Xero super membership ID Format: uuid

Creates a payroll employee — request body — body item Super Memberships item

Field	Type	Presence	Description and constraints
$	object	Root
EmployeeNumber	string	Required within parent	The membership number assigned to the employee by the super fund.
SuperFundID	string	Required within parent	Xero identifier for super fund Format: uuid
SuperMembershipID	string	Optional	Xero unique identifier for Super membership Format: uuid

Creates a payroll employee — request body — body item Tax Declaration

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	11-digit Australian Business Number e.g 21006819692 or an empty string ("") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE.
ApprovedWithholdingVariationPercentage	number	Optional	If the employee has approved withholding variation. e.g (0 - 100) Format: int
AustralianResidentForTaxPurposes	boolean	Optional	If the employee is Australian resident for tax purposes. e.g true or false
EligibleToReceiveLeaveLoading	boolean	Optional	If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false
EmployeeID	string	Optional	Address line 1 for employee home address Format: uuid
EmploymentBasis	string	Optional	One of: FULLTIME, PARTTIME, CASUAL, LABOURHIRE, SUPERINCOMESTREAM, NONEMPLOYEE
HasHELPDebt	boolean	Optional	If employee has HECS or HELP debt. e.g true or false
HasLoanOrStudentDebt	boolean	Optional	If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)
HasSFSSDebt	boolean	Optional	If employee has financial supplement debt. e.g true or false
HasStudentStartupLoan	boolean	Optional	If the employee is eligible for student startup loan rules
HasTradeSupportLoanDebt	boolean	Optional	If employee has trade support loan. e.g true or false
IncludeLeaveLoadingInQualifyingEarnings	boolean	Optional	Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload
ResidencyStatus	string	Optional	One of: AUSTRALIANRESIDENT, FOREIGNRESIDENT, WORKINGHOLIDAYMAKER
SeniorMaritalStatus	string	Optional	One of: MEMBEROFCOUPLE, MEMBEROFILLNESSSEPARATEDCOUPLE, SINGLE
TFNExemptionType	string	Optional	One of: NOTQUOTED, PENDING, PENSIONER, UNDER18
TaxFileNumber	string	Optional	The tax file number e.g 123123123.
TaxFreeThresholdClaimed	boolean	Optional	If tax free threshold claimed. e.g true or false
TaxOffsetEstimatedAmount	number	Optional	If has tax offset estimated then the tax offset estimated amount. e.g 100 Format: int
TaxScaleType	string	Optional	One of: REGULAR, ACTORSARTISTSENTERTAINERS, HORTICULTURISTORSHEARER, SENIORORPENSIONER, WORKINGHOLIDAYMAKER, FOREIGN
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
UpwardVariationTaxWithholdingAmount	number	Optional	If the employee has requested that additional tax be withheld each pay run. e.g 50 Format: int
WorkCondition	string	Optional	One of: PROMOTIONAL, THREELESSPERFORMANCESPERWEEK, NONE

Creates a payroll employee — response body

Field	Type	Presence	Description and constraints
$	object	Root
Employees	array	Optional
Employees[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item

Referenced models: Creates a payroll employee — response body — Employees item

Creates a payroll employee — response body — Employees item

Field	Type	Presence	Description and constraints
$	object	Root
BankAccounts	array	Optional
BankAccounts[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Bank Accounts item
Classification	string	Optional	Employees classification
CountryOfResidence	Model	Optional	Expand Creates a payroll employee — response body — Employees item Country Of Residence
DateOfBirth	string	Required within parent	Date of birth of the employee (YYYY-MM-DD)
Email	string	Optional	The email address for the employee
EmployeeGroupName	string	Optional	The Employee Group allows you to report on payroll expenses and liabilities for each group of employees
EmployeeID	string	Optional	Xero unique identifier for an Employee Format: uuid
EmploymentType	string	Optional	Known values: EMPLOYEE, CONTRACTOR
FirstName	string	Required within parent	First name of employee
Gender	string	Optional	The employee’s gender. See Employee Gender Known values: N, M, F, I
HomeAddress	Model	Optional	Expand Creates a payroll employee — response body — Employees item Home Address
IncomeType	string	Optional	Known values: SALARYANDWAGES, WORKINGHOLIDAYMAKER, NONEMPLOYEE, CLOSELYHELDPAYEES, LABOURHIRE
IsAuthorisedToApproveLeave	boolean	Optional	Authorised to approve other employees' leave requests
IsAuthorisedToApproveTimesheets	boolean	Optional	Authorised to approve timesheets
IsSTP2Qualified	boolean	Optional	Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable.
JobTitle	string	Optional	JobTitle of the employee
LastName	string	Required within parent	Last name of employee
LeaveBalances	array	Optional
LeaveBalances[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Leave Balances item
MiddleNames	string	Optional	Middle name(s) of the employee
Mobile	string	Optional	Employee mobile number
OpeningBalances	Model	Optional	Expand Creates a payroll employee — response body — Employees item Opening Balances
OrdinaryEarningsRateID	string	Optional	Xero unique identifier for earnings rate Format: uuid
PayTemplate	Model	Optional	Expand Creates a payroll employee — response body — Employees item Pay Template
PayrollCalendarID	string	Optional	Xero unique identifier for payroll calendar for the employee Format: uuid
Phone	string	Optional	Employee phone number
StartDate	string	Optional	Start date for an employee (YYYY-MM-DD)
Status	string	Optional	Employee Status Types Known values: ACTIVE, TERMINATED
SuperMemberships	array	Optional
SuperMemberships[]	Model	Each item	Expand Creates a payroll employee — request body — body item Super Memberships item
TaxDeclaration	Model	Optional	Expand Creates a payroll employee — response body — Employees item Tax Declaration
TerminationDate	string	Optional	Employee Termination Date (YYYY-MM-DD)
TerminationReason	string	Optional	* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities. Known values: V, I, D, R, F, C, T
Title	string	Optional	Title of the employee
TwitterUserName	string	Optional	Employee’s twitter name
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a payroll employee — response body — Employees item Bank Accounts item, Creates a payroll employee — response body — Employees item Country Of Residence, Creates a payroll employee — response body — Employees item Home Address, Creates a payroll employee — response body — Employees item Leave Balances item, Creates a payroll employee — response body — Employees item Opening Balances, Creates a payroll employee — response body — Employees item Pay Template, Creates a payroll employee — request body — body item Super Memberships item, Creates a payroll employee — response body — Employees item Tax Declaration, Retrieves journals — response body — Warnings item

Creates a payroll employee — response body — Employees item Bank Accounts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountName	string	Optional	The name of the account
AccountNumber	string	Optional	The account number
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Fixed amounts (for example, if an employee wants to have $100 of their salary transferred to one account, and the remaining amount to another) Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BSB	string	Optional	The BSB number of the account
Remainder	boolean	Optional	If this account is the Remaining bank account
StatementText	string	Optional	The text that will appear on your employee's bank statement when they receive payment

Creates a payroll employee — response body — Employees item Country Of Residence

Field	Type	Presence	Description and constraints
$	string	Root	Country of residence as a valid ISO 3166-1 alpha-2 country code e.g. "AU", "NZ", "CA". Only applicable, and mandatory if income type is WORKINGHOLIDAYMAKER. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, BQ, CW, SX, SS

Creates a payroll employee — response body — Employees item Home Address

Field	Type	Presence	Description and constraints
$	object	Root
AddressLine1	string	Required within parent	Address line 1 for employee home address
AddressLine2	string	Optional	Address line 2 for employee home address
City	string	Optional	Suburb for employee home address
Country	string	Optional	Country of HomeAddress
PostalCode	string	Optional	PostCode for employee home address
Region	string	Optional	State abbreviation for employee home address Known values: ACT, NSW, NT, QLD, SA, TAS, VIC, WA

Creates a payroll employee — response body — Employees item Leave Balances item

Field	Type	Presence	Description and constraints
$	object	Root
LeaveName	string	Optional	The name of the leave type
LeaveTypeID	string	Optional	Identifier of the leave type (see PayItems)
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	The balance of the leave available Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TypeOfUnits	string	Optional	The type of units as specified by the LeaveType (see PayItems)

Creates a payroll employee — response body — Employees item Opening Balances

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item
LeaveLines	array	Optional
LeaveLines[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Opening Balances Leave Lines item
OpeningBalanceDate	string	Optional	Opening Balance Date. (YYYY-MM-DD)
PaidLeaveEarningsLines	array	Optional
PaidLeaveEarningsLines[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Opening Balances Paid Leave Earnings Lines item
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item
SuperLines	array	Optional
SuperLines[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Pay Template Super Lines item
Tax	string	Optional	Opening Balance tax

Referenced models: Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item, Creates a payroll employee — response body — Employees item Opening Balances Leave Lines item, Creates a payroll employee — response body — Employees item Opening Balances Paid Leave Earnings Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item, Creates a payroll employee — response body — Employees item Pay Template Super Lines item

Creates a payroll employee — response body — Employees item Opening Balances Leave Lines item

Field	Type	Presence	Description and constraints
$	object	Root
LeaveTypeID	string	Optional	Xero leave type identifier Format: uuid
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Number of units for leave line. Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates a payroll employee — response body — Employees item Opening Balances Paid Leave Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Required within parent
Amount (anyOf 1)	number	Alternative	Paid leave amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
LeaveTypeID	string	Required within parent	Xero leave type identifier Format: uuid
ResetSTPCategorisation	boolean	Optional	Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories
SGCAppliedLeaveLoadingAmount	JSON	Optional
SGCAppliedLeaveLoadingAmount (anyOf 1)	number	Alternative	The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories Format: double
SGCAppliedLeaveLoadingAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SGCExemptedLeaveLoadingAmount	JSON	Optional
SGCExemptedLeaveLoadingAmount (anyOf 1)	number	Alternative	The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories Format: double
SGCExemptedLeaveLoadingAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates a payroll employee — response body — Employees item Pay Template

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item
LeaveLines	array	Optional
LeaveLines[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Pay Template Leave Lines item
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item
SuperLines	array	Optional
SuperLines[]	Model	Each item	Expand Creates a payroll employee — response body — Employees item Pay Template Super Lines item

Referenced models: Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item, Creates a payroll employee — response body — Employees item Pay Template Leave Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item, Creates a payroll employee — response body — Employees item Pay Template Super Lines item

Creates a payroll employee — response body — Employees item Pay Template Leave Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AnnualNumberOfUnits	JSON	Optional
AnnualNumberOfUnits (anyOf 1)	number	Alternative	Hours of leave accrued each year Format: double
AnnualNumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CalculationType	string	Optional	Calculation type for leave line for Opening Balance on Employee Known values: NOCALCULATIONREQUIRED, FIXEDAMOUNTEACHPERIOD, ENTERRATEINPAYTEMPLATE, BASEDONORDINARYEARNINGS
EmploymentTerminationPaymentType	string	Optional	Known values: O, R
EntitlementFinalPayPayoutType	string	Optional	Known values: NOTPAIDOUT, PAIDOUT
FullTimeNumberOfUnitsPerPeriod	JSON	Optional
FullTimeNumberOfUnitsPerPeriod (anyOf 1)	number	Alternative	Normal ordinary earnings number of units for leave line. Format: double
FullTimeNumberOfUnitsPerPeriod (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
IncludeSuperannuationGuaranteeContribution	boolean	Optional	amount of leave line
IsQualifyingEarnings	boolean	Required within parent	Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations
LeaveTypeID	string	Optional	Xero leave type identifier Format: uuid
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Number of units for leave line. Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates a payroll employee — response body — Employees item Pay Template Super Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Super membership amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CalculationType	string	Optional	Known values: FIXEDAMOUNT, PERCENTAGEOFEARNINGS, STATUTORY
ContributionType	string	Optional	Known values: SGC, SALARYSACRIFICE, EMPLOYERADDITIONAL, EMPLOYEE
ExpenseAccountCode	string	Optional	expense account code
LiabilityAccountCode	string	Optional	liabilty account code
MinimumMonthlyEarnings	JSON	Optional
MinimumMonthlyEarnings (anyOf 1)	number	Alternative	amount of minimum earnings Format: double
MinimumMonthlyEarnings (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Percentage	JSON	Optional
Percentage (anyOf 1)	number	Alternative	percentage for super line Format: double
Percentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SuperMembershipID	string	Optional	Xero super membership ID Format: uuid

Creates a payroll employee — response body — Employees item Tax Declaration

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	11-digit Australian Business Number e.g 21006819692 or an empty string ("") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE.
ApprovedWithholdingVariationPercentage	JSON	Optional
ApprovedWithholdingVariationPercentage (anyOf 1)	number	Alternative	If the employee has approved withholding variation. e.g (0 - 100) Format: int
ApprovedWithholdingVariationPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AustralianResidentForTaxPurposes	boolean	Optional	If the employee is Australian resident for tax purposes. e.g true or false
EligibleToReceiveLeaveLoading	boolean	Optional	If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false
EmployeeID	string	Optional	Address line 1 for employee home address Format: uuid
EmploymentBasis	string	Optional	Known values: FULLTIME, PARTTIME, CASUAL, LABOURHIRE, SUPERINCOMESTREAM, NONEMPLOYEE
HasHELPDebt	boolean	Optional	If employee has HECS or HELP debt. e.g true or false
HasLoanOrStudentDebt	boolean	Optional	If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)
HasSFSSDebt	boolean	Optional	If employee has financial supplement debt. e.g true or false
HasStudentStartupLoan	boolean	Optional	If the employee is eligible for student startup loan rules
HasTradeSupportLoanDebt	boolean	Optional	If employee has trade support loan. e.g true or false
IncludeLeaveLoadingInQualifyingEarnings	boolean	Optional	Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload
ResidencyStatus	string	Optional	Known values: AUSTRALIANRESIDENT, FOREIGNRESIDENT, WORKINGHOLIDAYMAKER
SeniorMaritalStatus	string	Optional	Known values: MEMBEROFCOUPLE, MEMBEROFILLNESSSEPARATEDCOUPLE, SINGLE
TFNExemptionType	string	Optional	Known values: NOTQUOTED, PENDING, PENSIONER, UNDER18
TaxFileNumber	string	Optional	The tax file number e.g 123123123.
TaxFreeThresholdClaimed	boolean	Optional	If tax free threshold claimed. e.g true or false
TaxOffsetEstimatedAmount	JSON	Optional
TaxOffsetEstimatedAmount (anyOf 1)	number	Alternative	If has tax offset estimated then the tax offset estimated amount. e.g 100 Format: int
TaxOffsetEstimatedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxScaleType	string	Optional	Known values: REGULAR, ACTORSARTISTSENTERTAINERS, HORTICULTURISTORSHEARER, SENIORORPENSIONER, WORKINGHOLIDAYMAKER, FOREIGN
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
UpwardVariationTaxWithholdingAmount	JSON	Optional
UpwardVariationTaxWithholdingAmount (anyOf 1)	number	Alternative	If the employee has requested that additional tax be withheld each pay run. e.g 50 Format: int
UpwardVariationTaxWithholdingAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
WorkCondition	string	Optional	Known values: PROMOTIONAL, THREELESSPERFORMANCESPERWEEK, NONE

Creates a superfund — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	ABN of the self managed super fund
AccountName	string	Optional	The account name for the self managed super fund.
AccountNumber	string	Optional	The account number for the self managed super fund.
BSB	string	Optional	BSB of the self managed super fund
ElectronicServiceAddress	string	Optional	The electronic service address for the self managed super fund.
EmployerNumber	string	Optional	Some funds assign a unique number to each employer
Name	string	Optional	Name of the super fund
SPIN	string	Optional	The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN.
SuperFundID	string	Optional	Xero identifier for a super fund Format: uuid
Type	string	Required within parent	One of: REGULATED, SMSF
USI	string	Optional	The USI of the Regulated SuperFund
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a superfund — response body

Field	Type	Presence	Description and constraints
$	object	Root
SuperFunds	array	Optional
SuperFunds[]	Model	Each item	Expand Creates a superfund — response body — Super Funds item

Referenced models: Creates a superfund — response body — Super Funds item

Creates a superfund — response body — Super Funds item

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	ABN of the self managed super fund
AccountName	string	Optional	The account name for the self managed super fund.
AccountNumber	string	Optional	The account number for the self managed super fund.
BSB	string	Optional	BSB of the self managed super fund
ElectronicServiceAddress	string	Optional	The electronic service address for the self managed super fund.
EmployerNumber	string	Optional	Some funds assign a unique number to each employer
Name	string	Optional	Name of the super fund
SPIN	string	Optional	The SPIN of the Regulated SuperFund. This field has been deprecated. It will only be present for legacy superfunds. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN.
SuperFundID	string	Optional	Xero identifier for a super fund Format: uuid
Type	string	Required within parent	Known values: REGULATED, SMSF
USI	string	Optional	The USI of the Regulated SuperFund
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item

Creates a timesheet — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
EmployeeID	string	Required within parent	The Xero identifier for an employee Format: uuid
EndDate	string	Required within parent	Period end date (YYYY-MM-DD)
Hours	number	Optional	Timesheet total hours Format: double
StartDate	string	Required within parent	Period start date (YYYY-MM-DD)
Status	string	Optional	One of: DRAFT, PROCESSED, APPROVED, REJECTED, REQUESTED
TimesheetID	string	Optional	The Xero identifier for a Payroll Timesheet Format: uuid
TimesheetLines	Model	Optional	Expand Creates a timesheet — request body — body item Timesheet Lines
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves journals — response body — Warnings item, Creates a timesheet — request body — body item Timesheet Lines

Creates a timesheet — request body — body item Timesheet Lines

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Creates a timesheet — request body — body item Timesheet Lines item

Referenced models: Creates a timesheet — request body — body item Timesheet Lines item

Creates a timesheet — request body — body item Timesheet Lines item

Field	Type	Presence	Description and constraints
$	object	Root
EarningsRateID	string	Optional	The Xero identifier for an Earnings Rate Format: uuid
NumberOfUnits	array	Optional	The number of units on a timesheet line
NumberOfUnits[]	number	Each item	Number of units of a Timesheet line Format: double
TrackingItemID	string	Optional	The Xero identifier for a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. Format: uuid
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Creates a timesheet — response body

Field	Type	Presence	Description and constraints
$	object	Root
Timesheets	array	Optional
Timesheets[]	Model	Each item	Expand Retrieves a timesheet by using a unique timesheet id — response body — Timesheet

Referenced models: Retrieves a timesheet by using a unique timesheet id — response body — Timesheet

Retrieves a timesheet by using a unique timesheet id — response body

Field	Type	Presence	Description and constraints
$	object	Root
Timesheet	Model	Optional	Expand Retrieves a timesheet by using a unique timesheet id — response body — Timesheet

Referenced models: Retrieves a timesheet by using a unique timesheet id — response body — Timesheet

Retrieves a timesheet by using a unique timesheet id — response body — Timesheet

Field	Type	Presence	Description and constraints
$	object	Root
EmployeeID	string	Required within parent	The Xero identifier for an employee Format: uuid
EndDate	string	Required within parent	Period end date (YYYY-MM-DD)
Hours	JSON	Optional
Hours (anyOf 1)	number	Alternative	Timesheet total hours Format: double
Hours (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
StartDate	string	Required within parent	Period start date (YYYY-MM-DD)
Status	string	Optional	Known values: DRAFT, PROCESSED, APPROVED, REJECTED, REQUESTED
TimesheetID	string	Optional	The Xero identifier for a Payroll Timesheet Format: uuid
TimesheetLines	Model	Optional	Expand Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines, Retrieves journals — response body — Warnings item

Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines item

Referenced models: Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines item

Retrieves a timesheet by using a unique timesheet id — response body — Timesheet Timesheet Lines item

Field	Type	Presence	Description and constraints
$	object	Root
EarningsRateID	string	Optional	The Xero identifier for an Earnings Rate Format: uuid
NumberOfUnits	array	Optional	The number of units on a timesheet line
NumberOfUnits[]	JSON	Each item
NumberOfUnits[] (anyOf 1)	number	Alternative	Number of units of a Timesheet line Format: double
NumberOfUnits[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TrackingItemID	string	Optional	The Xero identifier for a Tracking Category. The TrackingOptionID must belong to the TrackingCategory selected as TimesheetCategories under Payroll Settings. Format: uuid
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true

Retrieves for a payslip by a unique payslip id — response body

Field	Type	Presence	Description and constraints
$	object	Root
Payslip	Model	Optional	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip

Referenced models: Retrieves for a payslip by a unique payslip id — response body — Payslip

Retrieves for a payslip by a unique payslip id — response body — Payslip

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item
Deductions	JSON	Optional
Deductions (anyOf 1)	number	Alternative	The Deductions for the Payslip Format: double
Deductions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item
EmployeeID	string	Optional	The Xero identifier for an employee Format: uuid
FirstName	string	Optional	First name of employee
LastName	string	Optional	Last name of employee
LeaveAccrualLines	array	Optional
LeaveAccrualLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Accrual Lines item
LeaveEarningsLines	array	Optional
LeaveEarningsLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Earnings Lines item
NetPay	JSON	Optional
NetPay (anyOf 1)	number	Alternative	The NetPay for the Payslip Format: double
NetPay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PayslipID	string	Optional	Xero identifier for the payslip Format: uuid
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item
Reimbursements	JSON	Optional
Reimbursements (anyOf 1)	number	Alternative	The Reimbursements for the Payslip Format: double
Reimbursements (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Super	JSON	Optional
Super (anyOf 1)	number	Alternative	The Super for the Payslip Format: double
Super (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SuperannuationLines	array	Optional
SuperannuationLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Superannuation Lines item
Tax	JSON	Optional
Tax (anyOf 1)	number	Alternative	The Tax for the Payslip Format: double
Tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxLines	array	Optional
TaxLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Tax Lines item
TimesheetEarningsLines	array	Optional
TimesheetEarningsLines[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item
UpdatedDateUTC	string	Optional	Last modified timestamp Read only: true
Wages	JSON	Optional
Wages (anyOf 1)	number	Alternative	The Wages for the Payslip Format: double
Wages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Accrual Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Earnings Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Superannuation Lines item, Retrieves for a payslip by a unique payslip id — response body — Payslip Tax Lines item

Retrieves for a payslip by a unique payslip id — response body — Payslip Deduction Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Deduction type amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CalculationType	string	Optional	Known values: FIXEDAMOUNT, PRETAX, POSTTAX
DeductionTypeID	string	Required within parent	Xero deduction type identifier Format: uuid
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Deduction number of units Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Percentage	JSON	Optional
Percentage (anyOf 1)	number	Alternative	The Percentage of the Deduction Format: double
Percentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves for a payslip by a unique payslip id — response body — Payslip Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Earnings rate amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
AnnualSalary	JSON	Optional
AnnualSalary (anyOf 1)	number	Alternative	Annual salary for earnings line Format: double
AnnualSalary (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CalculationType	string	Optional	Known values: USEEARNINGSRATE, ENTEREARNINGSRATE, ANNUALSALARY
EarningsRateID	string	Required within parent	Xero unique id for earnings rate Format: uuid
FixedAmount	JSON	Optional
FixedAmount (anyOf 1)	number	Alternative	Earnings rate amount. Only applicable if the EarningsRate RateType is Fixed Format: double
FixedAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
NormalNumberOfUnits	JSON	Optional
NormalNumberOfUnits (anyOf 1)	number	Alternative	Normal number of units for EarningsLine. Applicable when RateType is "MULTIPLE" Format: double
NormalNumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Earnings rate number of units. Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
NumberOfUnitsPerWeek	JSON	Optional
NumberOfUnitsPerWeek (anyOf 1)	number	Alternative	number of units for earning line Format: double
NumberOfUnitsPerWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
RatePerUnit	JSON	Optional
RatePerUnit (anyOf 1)	number	Alternative	Rate per unit of the EarningsLine. Format: double
RatePerUnit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Accrual Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AutoCalculate	boolean	Optional	If you want to auto calculate leave.
LeaveTypeID	string	Optional	Xero identifier for the Leave type. Format: uuid
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Leave Accrual number of units Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves for a payslip by a unique payslip id — response body — Payslip Leave Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
EarningsRateID	string	Optional	Xero identifier Format: uuid
NumberOfUnits	JSON	Optional
NumberOfUnits (anyOf 1)	number	Alternative	Earnings rate number of units. Format: double
NumberOfUnits (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PayOutType	string	Optional	How the requested leave will be paid out, e.g. cashed out. Known values: DEFAULT, CASHED_OUT
RatePerUnit	JSON	Optional
RatePerUnit (anyOf 1)	number	Alternative	Rate per unit of the EarningsLine. Format: double
RatePerUnit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves for a payslip by a unique payslip id — response body — Payslip Reimbursement Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Reimbursement type amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Description	string	Optional	Reimbursement lines description (max length 50) Maximum length: 50
ExpenseAccount	string	Optional	Reimbursement expense account. For posted pay run you should be able to see expense account code.
ReimbursementTypeID	string	Optional	Xero reimbursement type identifier Format: uuid

Retrieves for a payslip by a unique payslip id — response body — Payslip Superannuation Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	Superannuation amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
CalculationType	string	Optional	Known values: FIXEDAMOUNT, PERCENTAGEOFEARNINGS, STATUTORY
ContributionType	string	Optional	Known values: SGC, SALARYSACRIFICE, EMPLOYERADDITIONAL, EMPLOYEE
ExpenseAccountCode	string	Optional	Superannuation expense account code.
LiabilityAccountCode	string	Optional	Superannuation liability account code
MinimumMonthlyEarnings	JSON	Optional
MinimumMonthlyEarnings (anyOf 1)	number	Alternative	Superannuation minimum monthly earnings. Format: double
MinimumMonthlyEarnings (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
PaymentDateForThisPeriod	string	Optional	Superannuation payment date for the current period (YYYY-MM-DD)
Percentage	JSON	Optional
Percentage (anyOf 1)	number	Alternative	Superannuation percentage Format: double
Percentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
SuperMembershipID	string	Optional	Xero identifier for payroll super fund membership ID. Format: uuid

Retrieves for a payslip by a unique payslip id — response body — Payslip Tax Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	JSON	Optional
Amount (anyOf 1)	number	Alternative	The tax line amount Format: double
Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Description	string	Optional	Description of the tax line.
LiabilityAccount	string	Optional	The tax line liability account code. For posted pay run you should be able to see liability account code
ManualTaxType	string	Optional	Known values: PAYGMANUAL, ETPOMANUAL, ETPRMANUAL, SCHEDULE5MANUAL, SCHEDULE5STSLMANUAL, SCHEDULE4MANUAL
PayslipTaxLineID	string	Optional	Xero identifier for payslip tax line ID. Format: uuid
TaxTypeName	string	Optional	Name of the tax type.

Retrieves payroll settings — response body

Field	Type	Presence	Description and constraints
$	object	Root
Settings	Model	Optional	Expand Retrieves payroll settings — response body — Settings

Referenced models: Retrieves payroll settings — response body — Settings

Retrieves payroll settings — response body — Settings

Field	Type	Presence	Description and constraints
$	object	Root
Accounts	array	Optional	Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable.
Accounts[]	Model	Each item	Expand Retrieves payroll settings — response body — Settings Accounts item
DaysInPayrollYear	JSON	Optional
DaysInPayrollYear (anyOf 1)	integer	Alternative	Number of days in the Payroll year Format: int32
DaysInPayrollYear (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
EmployeesAreSTP2	boolean	Optional	Indicates if the organisation has been enabled for STP Phase 2 editing of employees.
TrackingCategories	Model	Optional	Expand Retrieves payroll settings — response body — Settings Tracking Categories

Referenced models: Retrieves payroll settings — response body — Settings Accounts item, Retrieves payroll settings — response body — Settings Tracking Categories

Retrieves payroll settings — response body — Settings Accounts item

Field	Type	Presence	Description and constraints
$	object	Root
AccountID	string	Optional	Xero identifier for accounts Format: uuid
Code	string	Optional	Customer defined account code
Name	string	Optional	Name of account
Type	string	Optional	See Account Types Known values: BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, EXPENSE, FIXED, INVENTORY, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYGLIABILITY, PAYG, SUPERANNUATIONEXPENSE, SUPERANNUATIONLIABILITY, WAGESEXPENSE, WAGESPAYABLELIABILITY

Retrieves payroll settings — response body — Settings Tracking Categories

Field	Type	Presence	Description and constraints
$	object	Root	Tracking categories for Employees and Timesheets
EmployeeGroups	object	Optional	The tracking category used for employees
EmployeeGroups.TrackingCategoryID	string	Optional	The identifier for the tracking category Format: uuid
EmployeeGroups.TrackingCategoryName	string	Optional	Name of the tracking category
TimesheetCategories	object	Optional	The tracking category used for timesheets
TimesheetCategories.TrackingCategoryID	string	Optional	The identifier for the tracking category Format: uuid
TimesheetCategories.TrackingCategoryName	string	Optional	Name of the tracking category

Retrieves superfund products — response body

Field	Type	Presence	Description and constraints
$	object	Root
SuperFundProducts	array	Optional
SuperFundProducts[]	Model	Each item	Expand Retrieves superfund products — response body — Super Fund Products item

Referenced models: Retrieves superfund products — response body — Super Fund Products item

Retrieves superfund products — response body — Super Fund Products item

Field	Type	Presence	Description and constraints
$	object	Root
ABN	string	Optional	The ABN of the Regulated SuperFund
ProductName	string	Optional	The name of the Regulated SuperFund
SPIN	string	Optional	The SPIN of the Regulated SuperFund. This field has been deprecated. New superfunds will not have a SPIN value. The USI field should be used instead of SPIN
USI	string	Optional	The USI of the Regulated SuperFund

Updates a payslip — request body — body item

Field	Type	Presence	Description and constraints
$	object	Root
DeductionLines	array	Optional
DeductionLines[]	Model	Each item	Expand Updates a payslip — request body — body item Deduction Lines item
EarningsLines	array	Optional
EarningsLines[]	Model	Each item	Expand Updates a payslip — request body — body item Earnings Lines item
LeaveAccrualLines	array	Optional
LeaveAccrualLines[]	Model	Each item	Expand Updates a payslip — request body — body item Leave Accrual Lines item
LeaveEarningsLines	array	Optional
LeaveEarningsLines[]	Model	Each item	Expand Updates a payslip — request body — body item Leave Earnings Lines item
ReimbursementLines	array	Optional
ReimbursementLines[]	Model	Each item	Expand Updates a payslip — request body — body item Reimbursement Lines item
SuperannuationLines	array	Optional
SuperannuationLines[]	Model	Each item	Expand Updates a payslip — request body — body item Superannuation Lines item
TaxLines	array	Optional
TaxLines[]	Model	Each item	Expand Updates a payslip — request body — body item Tax Lines item
TimesheetEarningsLines	array	Optional
TimesheetEarningsLines[]	Model	Each item	Expand Updates a payslip — request body — body item Earnings Lines item

Referenced models: Updates a payslip — request body — body item Deduction Lines item, Updates a payslip — request body — body item Earnings Lines item, Updates a payslip — request body — body item Leave Accrual Lines item, Updates a payslip — request body — body item Leave Earnings Lines item, Updates a payslip — request body — body item Reimbursement Lines item, Updates a payslip — request body — body item Superannuation Lines item, Updates a payslip — request body — body item Tax Lines item

Updates a payslip — request body — body item Deduction Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	Deduction type amount Format: double
CalculationType	string	Optional	One of: FIXEDAMOUNT, PRETAX, POSTTAX
DeductionTypeID	string	Required within parent	Xero deduction type identifier Format: uuid
NumberOfUnits	number	Optional	Deduction number of units Format: double
Percentage	number	Optional	The Percentage of the Deduction Format: double

Updates a payslip — request body — body item Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	Earnings rate amount Format: double
AnnualSalary	number	Optional	Annual salary for earnings line Format: double
CalculationType	string	Optional	One of: USEEARNINGSRATE, ENTEREARNINGSRATE, ANNUALSALARY
EarningsRateID	string	Required within parent	Xero unique id for earnings rate Format: uuid
FixedAmount	number	Optional	Earnings rate amount. Only applicable if the EarningsRate RateType is Fixed Format: double
NormalNumberOfUnits	number	Optional	Normal number of units for EarningsLine. Applicable when RateType is "MULTIPLE" Format: double
NumberOfUnits	number	Optional	Earnings rate number of units. Format: double
NumberOfUnitsPerWeek	number	Optional	number of units for earning line Format: double
RatePerUnit	number	Optional	Rate per unit of the EarningsLine. Format: double

Updates a payslip — request body — body item Leave Accrual Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AutoCalculate	boolean	Optional	If you want to auto calculate leave.
LeaveTypeID	string	Optional	Xero identifier for the Leave type. Format: uuid
NumberOfUnits	number	Optional	Leave Accrual number of units Format: double

Updates a payslip — request body — body item Leave Earnings Lines item

Field	Type	Presence	Description and constraints
$	object	Root
EarningsRateID	string	Optional	Xero identifier Format: uuid
NumberOfUnits	number	Optional	Earnings rate number of units. Format: double
PayOutType	string	Optional	How the requested leave will be paid out, e.g. cashed out. One of: DEFAULT, CASHED_OUT
RatePerUnit	number	Optional	Rate per unit of the EarningsLine. Format: double

Updates a payslip — request body — body item Reimbursement Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	Reimbursement type amount Format: double
Description	string	Optional	Reimbursement lines description (max length 50) Maximum length: 50
ExpenseAccount	string	Optional	Reimbursement expense account. For posted pay run you should be able to see expense account code.
ReimbursementTypeID	string	Optional	Xero reimbursement type identifier Format: uuid

Updates a payslip — request body — body item Superannuation Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	Superannuation amount Format: double
CalculationType	string	Optional	One of: FIXEDAMOUNT, PERCENTAGEOFEARNINGS, STATUTORY
ContributionType	string	Optional	One of: SGC, SALARYSACRIFICE, EMPLOYERADDITIONAL, EMPLOYEE
ExpenseAccountCode	string	Optional	Superannuation expense account code.
LiabilityAccountCode	string	Optional	Superannuation liability account code
MinimumMonthlyEarnings	number	Optional	Superannuation minimum monthly earnings. Format: double
PaymentDateForThisPeriod	string	Optional	Superannuation payment date for the current period (YYYY-MM-DD)
Percentage	number	Optional	Superannuation percentage Format: double
SuperMembershipID	string	Optional	Xero identifier for payroll super fund membership ID. Format: uuid

Updates a payslip — request body — body item Tax Lines item

Field	Type	Presence	Description and constraints
$	object	Root
Amount	number	Optional	The tax line amount Format: double
Description	string	Optional	Description of the tax line.
LiabilityAccount	string	Optional	The tax line liability account code. For posted pay run you should be able to see liability account code
ManualTaxType	string	Optional	One of: PAYGMANUAL, ETPOMANUAL, ETPRMANUAL, SCHEDULE5MANUAL, SCHEDULE5STSLMANUAL, SCHEDULE4MANUAL
PayslipTaxLineID	string	Optional	Xero identifier for payslip tax line ID. Format: uuid
TaxTypeName	string	Optional	Name of the tax type.

Updates a payslip — response body

Field	Type	Presence	Description and constraints
$	object	Root
Payslips	array	Optional
Payslips[]	Model	Each item	Expand Retrieves for a payslip by a unique payslip id — response body — Payslip

Referenced models: Retrieves for a payslip by a unique payslip id — response body — Payslip