PaySlipEarnings
Query payslip earning line-items for a Xero organisation.
Table Specific Information
This table supports the following operators server-side: =,IN
INSERT
To insert a single row, set the required fields. The driver adds a new earnings line to the payslip.
INSERT INTO PaySlipEarnings (PaySlipID, EarningsLine_EarningsRateId, EarningsLine_RatePerUnit, EarningsLine_NumberOfUnits) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', 'fc394b8d-ff2e-4f10-992b-2a41390ad2c4', 4, 20)
UPDATE
You can update any field that is not read-only.
Note: UPDATE operations will count as two operations against the Xero API. One is required to retrieve the existing record, and another to update the record with new data.
UPDATE PaySlipEarnings SET EarningsLine_RatePerUnit = 5 WHERE Id = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
DELETE
Supply the Id to delete payslip earnings lines.
DELETE FROM PaySlipEarnings WHERE Id = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Columns
| Name | Type | ReadOnly | Filterable | Description |
| Id [KEY] | String | True |
The earnings line-item combined with the unique Xero identifier of the payslip | |
| PayslipID | String | False |
The unique identifier of the payslip. This field is assigned by Xero. | |
| EmployeeID | String | True |
The unique identifier of the payslip's employee. | |
| EarningsLine_EarningsRateId | String | False |
The unique identifier of the line-item's earnings rate | |
| EarningsLine_RatePerUnit | Decimal | False |
The line-item's wage per time unit (e.g. hours) | |
| EarningsLine_NumberOfUnits | Double | False |
The number of time units in this line-item (e.g. hours) | |
| EarningsLine_FixedAmount | Decimal | False |
The total earnings in this line-item. Only appears if the rate-type is FIXED. | |
| EarningsLine_LumpSumETaxYear | String | False |
The tax year that applies to these earnings. Only appears if the earnings type is LUMPSUME. | |
| TenantId | String | False |
The ID of the tenant to query instead of the connection tenant |