Xero Payroll (Australia) Endpoint: PayItemsEarningsRates
Jump to navigation
Jump to search
Overview
The Xero PayItemEarningsRates endpoint provides the list of earnings rate pay items that can be used on payslips.
The full list of pay items can be access from the PayItems endpoint.
To make full use of the data in this endpoint may require using endpoints belonging to a Xero Accounting Model.
Fields
The following fields are available for the PayItemEarningsRates endpoint.
- EarningsRateID
- A guid field that provides the id of the pay item.
- Name
- A text field that provides the name of the pay item.
- EarningsType
- A text field that provides the type of earnings rate for ATO purposes.
- Possible values are
- ORDINARYTIMEEARNINGS: Indicates it is an ordinary rate.
- OVERTIMEEARNINGS: Indicates it is an overtime rate.
- ALLOWANCE: Indicates it is an allowance.
- LUMPSUMA: Indicates it is a lump sum A used for final pays.
- LUMPSUMB: Indicates it is lump sum B used for final pays.
- LUMPSUMD: Indicates it is lump sum D used for final pays.
- LUMPSUME: Indicates it is lump sum E used for final pays.
- EMPLOYMENTTERMINATIONPAYMENT: Indicates it is termination payment.
- BONUSESANDCOMMISSIONS: Indicates it is a bpnus and/or commission.
- RateType
- A text field that provides the calculation type of the earnings rate.
- Possible values are
- FIXEDAMOUNT: Indicates the rate is a fixed amount.
- MULTIPLE: Indicates the rate is a multiple of the employees ordinary rate (e.g. time and a half, double time, etc.)
- RATEPERUNIT: Indicates the rate is a rate per unit amount.
- TypeOfUnits
- A text field that provides the textual type of units.
- RatePerUnit
- A decimal field that provides the actual rate for rates whose RateType is set to RATEPERUNIT.
- Multiplier
- A decimal field that provides the multipler (time and half, double time, etc.) for rates whose RateType is set to MULTIPLE.
- Amount
- A decimal field that provides the fixed amount for rates whose RateType is set to FIXEDAMOUNT.
- AccountCode
- A text field that provides the account code linked to the pay item.
- This field links with the Accounts endpoint of the Xero Accounting Model.
- IsExemptFromTax
- A true/false field that indicates if the pay item is exempt from tax.
- IsExemptFromSuper
- A true/false field that indicates if the pay item is exempt from super.
- IsReportableAsW1
- A true/false field that indicates if the pay item is reported in field W1 on the BAS.
- AccrueLeave
- A true/false field that indicates if the pay item accrues leave.
- CurrentRecord
- A true/false field that indicates if the pay item is active or not.
- EmploymentTerminationPaymentType
- A text field that provides the termination type.
- Possible values are:
- O
- R
- UpdatedDateUTC
- A date time field that indicates the last time this record was updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints