Employee Payroll Details endpoint

In this article we are going to take a closer look at the Contact/EmployeePayrollDetails endpoint and some of the fields that are used. 

This endpoint supports only two HTTP Methods, GET and PUT.

Note: When using the PUT method to update any data, you need to return the whole of the response body that is received in your GET request and only edit the data that you need to update.

This endpoint relates to the Payroll Details tab of the employee card in product (with the exception of the Standard Pay section)

Field meanings

This first section of fields corresponds to the Personal Details Tab in the Payroll Details tab of the employee card in product. Updating the below fields is pretty straight forward.

"DateOfBirth": null,
"Gender": null,
"StartDate": "2021-04-01T00:00:00",
"TerminationDate": null,
"EmploymentBasis": "Individual",
"EmploymentCategory": "Permanent",
"EmploymentStatus": "FullTime",
"EmploymentClassification": null,
"PaySlipDelivery": "ToBePrinted",
"PaySlipEmail": "",

The next section of fields relate to the Wages tab in the Payroll Details tab. Updating/Editing information in these fields can effect information that is returned on other endpoints in relation to the particular employee.

"Wage": {
"PayBasis": "Hourly",
"AnnualSalary": 62400.000,
"HourlyRate": 40.000000,
"PayFrequency": "Weekly",
"HoursInWeeklyPayPeriod": 30.000,
"WagesExpenseAccount": {
"UID": "dbe3a64d-7238-4b3f-9fea-77417d9f5ee0",
"Name": "Wages & Salaries",
"DisplayID": "6-5100",
"URI": "{cf_uri}/GeneralLedger/Account/dbe3a64d-7238-4b3f-9fea-77417d9f5ee0"
},
"WageCategories": [
{
"UID": "9a225943-c852-44bc-8bc2-7cf21e78f317",
"Name": "Base Hourly",
"Type": "Wage",
"URI": "{cf_uri}/Payroll/PayrollCategory/Wage/9a225943-c852-44bc-8bc2-7cf21e78f317"
},
{
"UID": "fa0bf158-a017-4623-8081-271d4e8faa2d",
"Name": "API - Other Income",
"Type": "Wage",
"URI": "{cf_uri}/Payroll/PayrollCategory/Wage/fa0bf158-a017-4623-8081-271d4e8faa2d"
}
]
},

Note: When updating/editing data for the fields PayBasis, AnnualSalary, HourleyRate, PayFrequency and HoursInWeeklyPayPeriod, these can change data that is returned on the Contact/EmployeeStandardPay endpoint.

The following section of fields relates to the Superannuation information for the employee.

This information can be found in the Superannuation tab of the Employee Payroll details tab on the Employee card in product. 

"Superannuation": {
"SuperannuationFund": {
"UID": "7c61d12d-870b-4b2a-b793-52172ff156c6",
"Name": "AMP Life",
"URI": "{cf_uri}/Payroll/SuperannuationFund/7c61d12d-870b-4b2a-b793-52172ff156c6"
},
"EmployeeMembershipNumber": null,
"SuperannuationCategories": [
{
"UID": "75945d5d-0510-4a8e-bb40-7a5ab66f664d",
"Name": "Superannuation Guarantee",
"Type": "Superannuation",
"URI": "{cf_uri}/Payroll/PayrollCategory/Superannuation/75945d5d-0510-4a8e-bb40-7a5ab66f664d"
}
]
},

The section below relates to Entitlements. This is where an employee's leave balance is shown.

This information can be found in the Entitlements tab of the Employee Payroll details tab on the Employee card in product.

"Entitlements": [
{
"EntitlementCategory": {
"UID": "2b1d052f-6484-4472-8a5c-2097738a4d18",
"Name": "Sick Leave Accrual",
"Type": "Entitlement",
"URI": "{cf_uri}/Payroll/PayrollCategory/Entitlement/2b1d052f-6484-4472-8a5c-2097738a4d18"
},
"IsAssigned": false,
"CarryOver": 0.000000,
"YearToDate": 0.0,
"Total": 0.000000
},
{
"EntitlementCategory": {
"UID": "aeaaa640-20ac-42a8-a5a9-cb527efb10b6",
"Name": "Holiday Leave Accrual",
"Type": "Entitlement",
"URI": "{cf_uri}/Payroll/PayrollCategory/Entitlement/aeaaa640-20ac-42a8-a5a9-cb527efb10b6"
},
"IsAssigned": false,
"CarryOver": 0.000000,
"YearToDate": 0.0,
"Total": 0.000000
}
],

The following two sections relate to the Employer Expenses and Deductions for a particular employee. If the employee has any payroll categories attached that relate to Employer Expenses and Deductions, these will be found here.

This information can be found in the Employer Expenses and Deductions tabs of the Employee Payroll details tab on the Employee card in product.

 "Deductions": [
{
"UID": "c1d62301-e61d-4b45-a76f-322c8dfbac0d",
"Name": "Employee Purchase",
"Type": "Deduction",
"URI": "{cf_uri}/Payroll/PayrollCategory/Deduction/c1d62301-e61d-4b45-a76f-322c8dfbac0d"
}
],
"EmployerExpenses": [
{
"UID": "01be231b-b4ad-437f-a6f3-b75c5c3f4457",
"Name": "WorkCover",
"Type": "Expense",
"URI": "{cf_uri}/Payroll/PayrollCategory/Expense/01be231b-b4ad-437f-a6f3-b75c5c3f4457"
}
],

 The remainder of this endpoint is made up of the Payroll Tax information and Timebilling rate for the Employee. This where you will find what tax table the employee is linked to and if it needs to be updated, this can be done using the PUT method. 

This information can be found in the Taxes and TimeBilling tabs of the Employee Payroll details tab on the Employee card in product.

"Tax": {
"TaxFileNumber": "xxx xxx xxx",
"TaxTable": {
"UID": "ffcc72bc-28c4-44b1-a776-9df75db34df3",
"Name": "Tax Free Threshold",
"URI": "{cf_uri}/Payroll/PayrollCategory/TaxTable/ffcc72bc-28c4-44b1-a776-9df75db34df3"
},
"WithholdingVariationRate": 0.000000,
"TotalRebatesPerYear": 0.000,
"ExtraTaxPerPay": 0.000,
"TaxCategory": {
"UID": "3d86356e-bc19-4c8e-80cb-cc0eacfb2d1e",
"Name": "PAYG Withholding",
"Type": "Tax",
"URI": "{cf_uri}/Payroll/PayrollCategory/Tax/3d86356e-bc19-4c8e-80cb-cc0eacfb2d1e"
}
},
"TimeBilling": {
"EmployeeBillingRateExcludingTax": 0.000000,
"CostPerHour": 0.000000
},

Note: The Employees tax file number is masked via the API in order to comply with the ATO operational framework.