Skip to content

Releases: XeroAPI/Xero-OpenAPI

10.0.0

25 Nov 23:20

Choose a tag to compare

What's changed

Features

  • Removed deprecated NZ fields (e03ee93)

BREAKING CHANGES:

Remove deprecated fields:

  • SickLeaveHoursToAccrueAnnually -> SickLeaveToAccrueAnnually
  • SickLeaveMaximumHoursToAccrue -> SickLeaveMaximumToAccrue
  • HoursAccruedAnnually -> UnitsAccruedAnnually

These fields have been disconnected in the backend for some time so safe to remove.

Full Changelog:9.3.0...10.0.0

9.3.0

17 Nov 01:28

Choose a tag to compare

What's changed

Features

  • SDK update for adding contracts to employee and employment object and its relevant endpoints (6cdd7c6)

Full Changelog: 9.2.0...9.3.0

9.2.0

02 Nov 20:45

Choose a tag to compare

What's changed

  • Add missing accounting.budgets.read scope and ratchet up lint validation on security scopes
  • remove invalid type: string from Contact property in Quote schema
  • Update BookDepreciationDetail
  • Add TaxNumberType for Contacts
  • Remove unused PUT for NZ and UK pay runs
  • fix: typo in getReportsList summary
  • Add webhooks Open API Specification

Full Changelog:9.1.0...9.2.0

9.1.0

12 Aug 19:48
1625fdf

Choose a tag to compare

What's Changed

Accounting API - Following endpoints have been marked deprecated and will be removed on April 28, 2026

  • getEmployees
  • createEmployees
  • updateOrCreateEmployees
  • getEmployee

9.0.0

28 Jun 11:29
c854148

Choose a tag to compare

What's Changed

  • Replacing postman test with prism mock server
    • Response in code examples changed from string to object
    • Linted yaml files

BREAKING CHANGE

  • Bug fix: Following fields are made required for payroll-nz
    • Employee model: firstName, lastName, dateOfBirth, address
    • Employment model: startDate, engagementType, payrollCalendarID
  • Bug fix: Following fields are made required for payroll-uk
    • Employee model: firstName, lastName, dateOfBirth, address, gender and title
    • Employment model: startDate, payrollCalendarID, employeeNumber, and niCategories

Full Changelog: 8.3.0...9.0.0

8.3.0

24 Jun 06:33
3555c22

Choose a tag to compare

What's Changed

  • New leave type NeonatalCare has been added to EmployeeStatutoryLeaveBalance and EmployeeStatutoryLeaveSummary responses for UK.
  • SIMPLE product enum value has been added for GetSubscription response for xero app store.
  • New organisation role REMOVED has been added to getUsers endpoint.
  • New query parameter direction has been added to getFiles endpoint.

Full Changelog: 8.2.0...8.3.0

8.2.0

09 Jun 11:56
a233375

Choose a tag to compare

What's Changed

Features -

  • Adds Leave type Bereavement to the EmployeeStatutoryLeaveBalance and EmployeeStatutoryLeaveSummary responses for payroll UK.

Full Changelog: 8.1.0...8.2.0

8.1.0

23 Apr 05:34
98066c6

Choose a tag to compare

What's Changed

Features -

  • New organisation plan SIMPLE has been added to Organisation API response.

Full Changelog: 8.0.0...8.1.0

8.0.0

10 Apr 09:28
dbbb58a

Choose a tag to compare

What's Changed

Features -

  • Added new entities for NICategoryLetter and NICategory.
    • Freeport and Investment zone NI category letters added.
  • [BREAKING_CHANGE] Updated Employee entity.
    • NICategoryLetter has been marked as deprecated and NICategories added as a new property.
  • Validation added to NICategory entity.
    • Validation added for workplacePostcode and dateFirstEmployedAsCivilian.
  • [BREAKING_CHANGE] Updated Employment POST endpoint.
    • Added NI Categories and removed deprecated niCategory property.
  • GET Employee 200 response example updated and NI Categories added.
  • Added missing comma to Employee POST success response example.

Notes:

This change reflects the current functionality available in the public API and as shown in Xero documentation.

GET Employee
POST Employment

Full Changelog: 7.1.0...8.0.0

7.1.0

07 Apr 14:26
21c286e

Choose a tag to compare

What's Changed

Features

  • StatutoryNeonatalCarePay and StatutoryNeonatalCarePayNonPensionable earnings types has been added to earnings rates component.
    • This will affect the request and response bodies for the POST and GET endpoints for EarningsRates, and the GET response for endpoint EarningsRates/{id}

Full Changelog: 7.0.0...7.1.0