PayItemsEarnings
Used to query, insert, and update earnings that are part of the employee's pay items, such as regular wages, bonuses, and other forms of compensation.
Columns
| Name | Type | ReadOnly | Filterable | Description |
| EarningsRateID [KEY] | String | True |
The unique identifier assigned by Xero to the earnings rate PayItem. This ID ensures that each earnings rate is distinct and can be easily referenced in payroll calculations. | |
| Name | String | False |
The name of the earnings rate, such as 'Hourly Rate' or 'Salary'. This field helps identify the type of earnings rate applied to an employee's pay. | |
| DisplayName | String | False |
The display name of the earnings rate that will appear on the employee's payslips. This field allows you to provide a more human-readable name for the earnings rate that is shown to the employee. | |
| AccountCode | String | False |
A customer-defined alphanumeric account code that links the earnings rate to a specific financial account in the accounting system. This ensures the proper accounting treatment of earnings. | |
| TypeOfUnits | String | False |
The unit type used to measure earnings, such as 'hours', 'days', or 'units'. This determines how the earnings rate is recorded and calculated based on time worked or output produced. | |
| IsExemptFromTax | String | False |
Indicates whether the earnings are exempt from PAYG (Pay As You Go) withholding tax. This should only be set for earnings that are explicitly exempt from tax according to tax laws. | |
| IsExemptFromSuper | String | False |
Specifies whether the earnings are exempt from Superannuation Guarantee Contributions (SGC). Some types of income may be exempt from superannuation contributions under certain conditions. | |
| IsReportableAsW1 | Bool | False |
Specifies whether the earnings are subject to W1 (Withholding Tax Type 1) withholding. This is relevant for certain tax reporting purposes. | |
| EarningsType | String | False |
The type of earnings represented by the earnings rate. Possible values include 'FIXED' (fixed amount), 'ORDINARYTIMEEARNINGS' (normal work hours), 'OVERATIMEEARNINGS' (overtime), 'ALLOWANCE' (additional payment), and 'LUMPSUMD' (lump sum payment). | |
| AllowanceType | String | False |
Describes what the allowance is paid for when the EarningsType is 'ALLOWANCE'. Examples include 'Meal Allowance' or 'Travel Allowance'. | |
| AllowanceCategory | String | False |
Specifies the category of the allowance when the AllowanceType is 'OTHER'. This allows for customization and categorization of allowances based on business needs. | |
| RateType | String | False |
The rate type for the earnings. Valid options include 'FIXEDAMOUNT' (fixed amount per pay period), 'MULTIPLE' (multiple times the base rate), and 'RATEPERUNIT' (rate per unit of time or work). | |
| RatePerUnit | String | False |
The rate per unit of time or work. This field is used only when RateType is 'RATEPERUNIT', and it specifies the amount earned for each unit worked. | |
| Multiplier | Double | False |
The multiplier used to calculate the earnings based on the employee's ordinary earnings type. This is only applicable when RateType is 'MULTIPLE' and is used to adjust the earnings rate. | |
| AccrueLeave | String | False |
Indicates whether leave should be accrued for this earnings rate. This is relevant when employees earn leave based on their work hours or salary, and applies only when RateType is 'MULTIPLE'. | |
| Amount | String | False |
The fixed amount paid for earnings with a FIXEDAMOUNT RateType. This represents the total amount to be paid for the earnings rate regardless of other factors. | |
| CurrentRecord | Bool | False |
Indicates whether this earnings rate is still active and available for use. If the value is set to 'false', the earnings rate may have been discontinued and should no longer be applied to new payroll records. | |
| UpdatedDateUTC | Datetime | True |
The timestamp indicating when the earnings rate record was last modified. This helps track changes and ensures that the most up-to-date rate is being applied. | |
| TenantId | String | False |
The unique identifier of the tenant (organization) to query instead of the connection tenant. This ensures the data is retrieved from the correct organization within Xero, especially useful for managing multiple tenants or companies. |