Types and Codes


Below is a detailed list of all the types and codes the Xero Payroll API uses

Earnings Rates

EarningsType

FIXED
ORDINARYTIMEEARNINGS
OVERTIMEEARNINGS
ALLOWANCE
LUMPSUMD
EMPLOYMENTTERMINATIONPAYMENT EarningsRates with EarningsType EMPLOYMENTTERMINATIONPAYMENT can only be used in final pays.

RateType

FIXEDAMOUNT
MULTIPLE Multiple of Employee’s Ordinary Earnings Rate: an earnings rate which is derived from an employee’s ordinary earnings rate
RATEPERUNIT An earnings rate allowing entry of a rate per unit

EmploymentTerminationPaymentType

O
R

Employees

StateAbbreviations

ACT Australian Capital Territory
NSW New South Wales
NT Northern Territory
QLD Queensland
SA South Australia
TAS Tasmania
VIC Victoria
WA Western Australia

Gender

N Not Stated
M Male
F Female
I Non-Binary

Status Codes

ACTIVE Employee with no Termination Date.
TERMINATED Employee with a Termination Date.

LeaveApplications

Leave Period Status Codes

Scheduled The default status
Processed A LeavePeriod is set to the "Processed" status when the Payrun associated with the LeavePeriod is "POSTED"

PayrollCalendars

CalendarType

WEEKLY
FORTNIGHTLY
FOURWEEKLY
MONTHLY
TWICEMONTHLY
QUARTERLY

PayTemplates

EarningsType

ALLOWANCE
BACKPAY
COMMISSION
ORDINARYTIMEEARNINGS
OVERTIMEEARNINGS

EarningsRateCalculationType

USEEARNINGSRATE Use the rate per unit recorded for the earnings rate under Settings
ENTEREARNINGSRATE The rate per unit is be added manually to the earnings line
ANNUALSALARY If the employee receives a salary, the annual salary amount and units of work per week are added to the earnings line

DeductionTypeCalculationType

FIXEDAMOUNT
PRETAX
POSTTAX

SuperannuationContributionType

SGC Mandatory 9% contribution
SALARYSACRIFICE Pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
EMPLOYERADDITIONAL Additional employer superannuation contribution, which is displayed as RESC on payment summaries
EMPLOYEE Post-tax employee superannuation contribution

SuperannuationCalculationType

FIXEDAMOUNT For voluntary superannuation, the contribution amount can be a fixed rate or a percentage of earnings. For SGC contributions it must be a percentage
PERCENTAGEOFEARNINGS
STATUTORY

PaymentFrequencyType

WEEKLY
MONTHLY
FORTNIGHTLY
QUARTERLY
TWICEMONTHLY
FOURWEEKLY
YEARLY

LeaveTypeContributionType

SGC Mandatory 9% contribution
SALARYSACRIFICE Pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
EMPLOYERADDITIONAL Additional employer superannuation contribution, which is displayed as RESC on payment summaries
EMPLOYEE Post-tax employee superannuation contribution

EntitlementFinalPayPayoutType

NOTPAIDOUT
PAIDOUT

PayRun

PayRunStatus

DRAFT
POSTED

PaySlip

ManualTaxType

PAYGMANUAL
ETPOMANUAL
ETPRMANUAL

SuperFund

Type

REGULATED Regulated Superannuation Fund: a super fund regulated by APRA
SMSF Self Managed Super Fund: a super fund managed by you or your company

TaxDeclaration

EmploymentBasis

FULLTIME
PARTTIME
CASUAL
LABOURHIRE
SUPERINCOMESTREAM

TFNExemptionType

NOTQUOTEDEmployee has not provided a TFN.
PENDINGEmployee has made a separate application or Enquiry to the ATO for a new or existing TFN.
PENSIONEREmployee is claiming that they are in receipt of a pension, benefit or allowance.
UNDER18Employee is claiming an exemption as they are under the age of 18 and do not earn enough to pay tax.

ResidencyStatus

AUSTRALIANRESIDENTEmployee is an Australian resident for tax purposes. AustralianResidentForTaxPurposes must be true
FOREIGNRESIDENTEmployee is a foreign resident for tax purposes. AustralianResidentForTaxPurposes must be false.
WORKINGHOLIDAYMAKEREmployee is working holiday maker for tax purposes. AustralianResidentForTaxPurposes must be false.

Timesheets

Status Codes

DRAFT
PROCESSED
APPROVED