Release Notes - Payroll API

To be notified as we release new features, subscribe to the Xero Developer mailing list.

Version 1.97

Date: March 14th, 2018

New Features
  • Allow Employment Termination Payments in payslips..

Version 1.96

Date: August 8th, 2017

New Features
  • IsReportableAsW1 and IsExemptFromW1 are now available for GETs and POSTs on PayItems.

Version 1.95

Date: March 20th, 2017

New Features
  • To support the working holiday makers scheme we've added ResidencyStatus to the TaxDeclaration details on Employees.

Version 1.94

Date: November 10th, 2015

New Features

Version 1.93

Date: June 26th, 2015

New Features

Version 1.92

Date: June 23rd, 2015

New Features

Version 1.91

Date: January 27th, 2015

  • The "Percentage" element of the Employees BankAccounts has been deprecated to keep the API in line with the Xero Application. POST Employees calls that include the Percentage element with a BankAccount will receive a validation error. The "Amount" element can be used with an employee to split payment between bank accounts.

Version 1.9

Date: November 11th, 2014

New features and improvements
  • USI (Unique superannuation identifier) field for Regulated Superfunds has been added to the SuperFunds & SuperFundProducts endpoints. More information about the USI field can be found on the Xero blog.
  • SPIN field has been deprecated on the SuperFunds & SuperFundProducts endpoints. SPIN will be still be shown for existing SuperFunds & SuperFundProducts, but new entries will only include a USI.
  • GET SuperFundProducts SPIN parameter has been removed and replaced with a USI parameter. SuperFundProducts can only be retrieved by ABN & USI, not SPIN.
  • POST SuperFunds requires a USI. A validation error will be raised if the USI field is not provided.
  • POST SuperFunds no longer accepts a SPIN field. Providing a SPIN field will result in a validation error.

Version 1.8

Date: October 15, 2014

New features and improvements
  • POST Employees - DateOfBirth and HomeAddress are now required to submit a POST request. Creating an employee without FirstName, LastName, DateOfBirth & HomeAddress will result in a validation error.
  • AddressLine3 and AddressLine4 are now deprecated on Employee HomeAddress. POST requests containing these fields will return a 200 response, but data provided for Addressline3 & AddressLine4 will not be stored. Existing data for AddressLine3 & AddressLine4 will be migrated into AddressLine1 & AddressLine2.
  • The maximum length of AddressLine1 & AddressLine2 on Employee Homeaddress has decreased from 100 characters to 50 characters.

Version 1.7

Date: August 18, 2014

New features and improvements
  • Payroll is now integrated with the general ledger. Find out all the details on the Xero blog.
  • As part of the GL integration, there is a new Wages Payable Account setting on the Setting endpoint.
  • A new account type has been created, called "WAGESPAYABLELIABILITY", has been added. It will appear in all Xero Orgs by default with account code 804, it has also been created for all existing Xero Orgs and set as the default in the Payroll settings. If a Xero Org is already using account code 804 they will receive a validation error when posting a Payrun prompting them to update their Payroll settings.
Bug fixes
  • An issue involving Employee PayTemplates & FixedAmount has been resolved. You can now set the Amount of a FixedAmount EarningsRate via the Employee endpoint.

Version 1.6

Date: June 25, 2014

New features and improvements
  • Improved how the LeaveApplications endpoint handles POST /LeaveApplications requests. POST /LeaveApplication requests that specify <LeavePeriods> with an incorrect <PayPeriodEndDate> will now raise a validation error "Invalid LeavePeriod provided".

Version 1.5

Date: April 30, 2014

New features and improvements
  • The PayRuns endpoint has been updated to provide a more comprehensive response to POST /PayRuns requests

Version 1.4

Date: February 24, 2014

Bug fixes
  • Resolves an issue related to JSON requests that result in a 400 validation error being returned as 500 errors.
  • Approved timesheets can no longer be created against a POSTED Payrun.
  • Resolves being updated on the LeaveApplications endpoint.
  • Resolves changing Employees BankAccounts fixed & percentage values.

Version 1.3

Date: October 15, 2013

New features and improvements
  • Added TaxTypeName to TaxLines on the Payslip endpoint.
  • Improved handling of duplicate timesheets when in draft mode.
Bug fixes
  • Resolves issue related to providing the ABN when requesting a Superfund.

Version 1.2

Date: September 12, 2013

New features and improvements

Version 1.1

Date: August 5, 2013

New features and improvements
  • Changes to TFN Exemption handling via the Employees endpoint.
There has been a breaking change to the employee's endpoint. TFNPendingOrExemptionHeld has been deprecated and replaced with a TFNExemptionType.

Version 1.0

Date: May 28, 2013

New features and improvements
  • Public release of the Xero Payroll API
  • API Previewer support

Version 0.2

Date: March 25, 2013

New features and improvements
  • Added support for private applications
  • New endpoints for
    • LeaveApplications
    • Timesheets

Version 0.1

Date: Dec 10, 2012

New features and improvements
  • Initial support for public and partner applications
  • Endpoints for
    • Employees
    • PayItems
    • PayrollCalendars
    • Payruns
    • Payslip
    • Superfunds
    • TaxDeclaration