Xero · Schema

EarningsRate

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
Name string Name of the earnings rate (max length = 100)
AccountCode string See Accounts
TypeOfUnits string Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT
IsExemptFromTax boolean 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
IsExemptFromSuper boolean See the ATO website for details of which payments are exempt from SGC
IsReportableAsW1 boolean Boolean to determine if the earnings rate is reportable or exempt from W1
IsQualifyingEarnings boolean Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and sup
AllowanceContributesToAnnualLeaveRate boolean 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 Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
EarningsType object
EarningsRateID string Xero identifier
RateType object
RatePerUnit string Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.
Multiplier number 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
AccrueLeave boolean Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE
Amount number Optional Amount for FIXEDAMOUNT RateType EarningsRate
EmploymentTerminationPaymentType object
UpdatedDateUTC string Last modified timestamp
CurrentRecord boolean Is the current record
AllowanceType object
AllowanceCategory object
View JSON Schema on GitHub

JSON Schema

xero-earningsrate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EarningsRate",
  "title": "EarningsRate",
  "type": "object",
  "properties": {
    "Name": {
      "description": "Name of the earnings rate (max length = 100)",
      "type": "string",
      "example": "PTO",
      "maxLength": 100
    },
    "AccountCode": {
      "description": "See Accounts",
      "type": "string",
      "example": 720
    },
    "TypeOfUnits": {
      "description": "Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT",
      "type": "string",
      "example": "Fixed",
      "maxLength": 50
    },
    "IsExemptFromTax": {
      "description": "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",
      "type": "boolean",
      "example": false
    },
    "IsExemptFromSuper": {
      "description": "See the ATO website for details of which payments are exempt from SGC",
      "type": "boolean",
      "example": false
    },
    "IsReportableAsW1": {
      "description": "Boolean to determine if the earnings rate is reportable or exempt from W1",
      "type": "boolean",
      "example": false
    },
    "IsQualifyingEarnings": {
      "description": "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings",
      "type": "boolean",
      "example": true
    },
    "AllowanceContributesToAnnualLeaveRate": {
      "description": "Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT",
      "type": "boolean",
      "example": false
    },
    "AllowanceContributesToOvertimeRate": {
      "description": "Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT",
      "type": "boolean",
      "example": false
    },
    "EarningsType": {
      "$ref": "#/components/schemas/EarningsType"
    },
    "EarningsRateID": {
      "description": "Xero identifier",
      "type": "string",
      "format": "uuid",
      "example": "e0eb6747-7c17-4075-b804-989f8d4e5d39"
    },
    "RateType": {
      "$ref": "#/components/schemas/RateType"
    },
    "RatePerUnit": {
      "description": "Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.",
      "type": "string",
      "example": 10
    },
    "Multiplier": {
      "description": "This is the multiplier used to calculate the rate per unit, based on the employee\u2019s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 1.5
    },
    "AccrueLeave": {
      "description": "Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE",
      "type": "boolean",
      "example": false
    },
    "Amount": {
      "description": "Optional Amount for FIXEDAMOUNT RateType EarningsRate",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 50.3
    },
    "EmploymentTerminationPaymentType": {
      "$ref": "#/components/schemas/EmploymentTerminationPaymentType"
    },
    "UpdatedDateUTC": {
      "description": "Last modified timestamp",
      "type": "string",
      "readOnly": true,
      "x-is-msdate-time": true,
      "example": "/Date(1583967733054+0000)/"
    },
    "CurrentRecord": {
      "description": "Is the current record",
      "type": "boolean",
      "example": true
    },
    "AllowanceType": {
      "$ref": "#/components/schemas/AllowanceType"
    },
    "AllowanceCategory": {
      "$ref": "#/components/schemas/AllowanceCategory"
    }
  }
}