BREAKING CHANGE

• fix: Following fields are made required for payroll-nz
  • Employee model: firstName, lastName, dateOfBirth, address
  • Employment model: startDate, engagementType, payrollCalendarID
• 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

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

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

What's Changed

Features -

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

Full Changelog: 8.0.0...8.1.0

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

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.1...7.1.0

What's Changed

Build from OAS 7.0.0

Bug Fixes

• Fixes #68: can_refresh_access_token method accepts string as valid token type.

Full Changelog: 7.0.0...7.0.1

Build from OAS 7.0.0

Breaking Changes

• [DataSourceResponse]: Removed the following fields, which were previously marked as deprecated:
  • indirectBankFeed
  • indirectBankFeedPos
  • indirectBankFeedNeg

Deprecations

• [EmployeeLeaveSetup]: The following fields are now deprecated and will be removed in future release:
  • sickLeaveHoursToAccrueAnnually
  • sickLeaveMaximumHoursToAccrue
• [EmployeeLeaveType]: The following fields are now deprecated and will be removed in future release:
  • hoursAccruedAnnually

New Features

• [EmployeeLeaveSetup]: Introduced new fields:
  • SickLeaveToAccrueAnnually
  • SickLeaveMaximumToAccrue
  • AnnualLeaveAnniversaryDate
• [EmployeeLeaveType]: Introduced new fields:
  • UnitsAccruedAnnually
  • typeOfUnitsToAccrue
  • openingBalanceTypeOfUnits
• [LeavePeriod]: Introduced new fields:
  • numberOfUnitsTaken
  • typeOfUnits
  • typeOfUnitsTaken
• [LeaveType]: Introduced new fields:
  • typeOfUnits
  • typeOfUnitsToAccrue

Full Changelog: 6.3.0...7.0.0

Build from OAS 6.3.0

What's Changed

• New optional property got added to the EmployeeLeaveType DTO for scheduleOfAccrualDate.

• Following USST fields have been added to Invoices and Credit Notes endpoints:

  • InvoiceAddresses
  • SalesTaxCodeId
  • Taxability
  • TaxBreakdown

Full Changelog: 6.2.0...6.3.0

• Build from OAS 6.2.0

What's Changed

• Accounting API - Field SentToContact is now writable for credit notes.

Full Changelog: 6.1.0...6.2.0