NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #1616 most downloaded on Packagist
Xero official PHP SDK for oAuth2 generated with OpenAPI spec 3
Latest stable
16.4.0
Last release 12 days ago
10 Nov 2026
Ships fairly regularly
a new release about every 4 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
130 releases · first in 2019
Drag across the ruler to compare, or tap a release to open it.
accountdata: Adds the Account Data API (beta) to PHP SDK (same commits as the previous release)
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/16.3.0...16.4.0
feat!: add payments webhook endpoint and schema
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/16.2.0...16.3.0
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Releasing 16.2.0 (OAS: 19.0.0) by @xero-public-bot[bot] in https://github.com/XeroAPI/xero-php-oauth2/pull/434
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/16.1.0...16.2.0
accounting: Adds spec for invoice backorders and backorder-specific item fields
Releasing 16.0.0 (OAS: 16.1.0) by @xero-public-bot[bot] in https://github.com/XeroAPI/xero-php-oauth2/pull/426
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/15.0.0...16.0.0
…Breaking Change
Accounting: BudgetLines, GetBankTransactionsResponse, GetContactsResponse, GetCreditNotesResponse, GetInvoicesResponse, GetManualJournalsResponse, GetOverpaymentsResponse, GetPaymentsResponse, GetPrepaymentsResponse, GetPurchaseOrdersResponse
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/14.0.0...15.0.0
add BASICLITE to Organisation Class enum (24d0d20) (Breaking Change)
feat!: Delete deprecated employee management endpoints
Update the OrganisationType with possible values
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/12.0.0...12.0.1
Add StatutoryBereavementPayNorthernIreland and BereavementNire enums https://github.com/XeroAPI/Xero-OpenAPI/pull/798
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/11.0.0...12.0.0
Add 2.0 endpoints for Timesheets in AU Payroll https://github.com/XeroAPI/Xero-OpenAPI/pull/778
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/10.4.0...11.0.0
add credit notes webhooks schema
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/10.3.0...10.4.0
SDK update for adding contracts to employee and employment object and its relevant endpoints
Add missing accounting.budgets.read scope and ratchet up lint validation on security scopes
Please migrate to the supported alternatives before deprecation on April 28, 2026.
The following Accounting API endpoints have been marked [Obsolete] and will be removed in a future release.
Please migrate to the supported alternatives before deprecation on April 28, 2026.
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/10.0.0...10.1.0
Minimum required PHP version is now 8.1 or greater
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/9.2.0...10.0.0
New leave type NeonatalCare has been added to EmployeeStatutoryLeaveBalance and EmployeeStatutoryLeaveSummary responses for UK.
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.REMOVED has been added to getUsers endpoint.direction has been added to getFiles endpoint.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/9.1.0...9.3.0
Adds Leave type Bereavement to the EmployeeStatutoryLeaveBalance and EmployeeStatutoryLeaveSummary responses for payroll UK.
Bereavement to the EmployeeStatutoryLeaveBalance and EmployeeStatutoryLeaveSummary responses for payroll UK.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/9.1.0...9.2.0
New organisation plan `SIMPLE has been added to Organisation` API response.
SIMPLE has been added to Organisation API response.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/9.0.0...9.1.0
`NICategoryLetter has been marked as deprecated and NICategories` added as a new property.
NICategoryLetter and NICategory.
Freeport and Investment zone NI category letters added.Employee entity.
NICategoryLetter has been marked as deprecated and NICategories added as a new property.NICategory entity.
workplacePostcode and dateFirstEmployedAsCivilian.Employment POST endpoint.
NI Categories and removed deprecated niCategory property.Employee 200 response example updated and NI Categories added.Employee POST success response example.This change reflects the current functionality available in the public API and as shown in Xero documentation.
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/8.1.0...9.0.0
`StatutoryNeonatalCarePay and StatutoryNeonatalCarePayNonPensionable` earnings types has been added to earnings rates component.
StatutoryNeonatalCarePay and StatutoryNeonatalCarePayNonPensionable earnings types has been added to earnings rates component.
EarningsRates, and the GET response for endpoint EarningsRates/{id}Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/8.0.0...8.1.0
[DataSourceResponse]: Removed the following fields, which were previously marked as deprecated:
Build from OAS 7.0.0
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/7.3.0...8.0.0
Nothing published for this version
New optional property got added to the EmployeeLeaveType DTO for scheduleOfAccrualDate.
Build from OAS 6.3.0
New optional property got added to the EmployeeLeaveType DTO for scheduleOfAccrualDate.
Following USST fields have been added to Invoices and Credit Notes endpoints:
GitHub Actions workflow has been added for validation of PRs.
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/7.2.0...7.3.0
Nothing published for this version
Accounting API - Field SentToContact is now writable for credit notes.
SentToContact is now writable for credit notes.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/7.1.0...7.2.0
Added NZ Payroll Working Pattern changes
Build from OAS 6.1.1
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/7.0.1...7.1.0
JSON serialization response will contain an associative array instead of holding the domain object directly
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/7.0.0...7.0.1
Removed PageInfo metadata object and added pagination metadata object for select Api.Accounting endpoints
GET /invoice endpoint.GET /Overpayments and GET /Prepayments endpoints.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/6.0.0...7.0.0
PageInfo object has been added to the HTTP response for following endpoints & the response schema name has been changed.
Build from OAS 5.0.0
PageInfo object has been added to the HTTP response for following endpoints & the response schema name has been changed.
page size query parameter has been added to "get all" endpoints for bank transactions, contacts, credit notes, invoices, manual journals, payments and purchase orders
Following properties are 'no longer in use' for "DataSourceResponse" schema -
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/5.0.0...6.0.0
Adds 'Name', 'Size', 'SendWithObject' to object association endpoint.
Build from OAS 4.0.0
Files API
Accounting API
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/4.0.0...5.0.0
Add a new spec for TaxRates/{TaxTypes}
Build from OAS 3.0.3
Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/3.0.0...4.0.0
Update method definitions to position idempotency_key as last optional parameter.
idempotency_key as last optional parameter.Full Changelog: https://github.com/XeroAPI/xero-php-oauth2/compare/2.23.3...3.0.0
Removes empty enum values from the specifications of Accounting, Bankfeeds, Payroll_AU, and Projects
Build from OAS 2.40.3
Removes empty enum values from the specifications of Accounting, Bankfeeds, Payroll_AU, and Projects
Added Idempotency-Key as optional header param for all PUT, POST, PATCH requests
Build from OAS 2.40.1
All APIs
Accounting API
Payroll AU
Finance
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.23.1 from Xero-OpenAPI 2.38.0
Resolves bug #330
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
<!--- Describe your changes in detail --> Generates Xero-PHP 2.23.0 from [Xero-OpenAPI 2.38.0]
<!--- Describe your changes in detail --> Generates Xero-PHP 2.23.0 from Xero-OpenAPI 2.38.0
New endpoints added for expanding Leave functionality for AU Payroll
Create compliance tax rates
[ ] Bug fix (non-breaking change that fixes an issue)
<!--- Describe your changes in detail --> Generates Xero-PHP 2.22.0 from Xero-OpenAPI 2.37.0
Accounting API
JWTClaims
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[ ] Bug fix (non-breaking change that fixes an issue)
<!--- Describe your changes in detail --> Generates Xero-PHP 2.21.0 from Xero-OpenAPI 2.36.0
Files API
getAssociationsCount method to the Files APIPayroll AU API
PaidLeaveEarnings to the OpeningBalance schema definitionPayOutType to the LeaveApplication and LeaveEarningsLine schema definitions<!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. -->
getAssociationsCount enables developers to fetch a count of associations for a list of objects. Previously, developers had to call separately for each object.<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP 2.20.0 from Xero-OpenAPI 2.35.0
AllowanceContributesToAnnualLeaveRate and AllowanceContributesToOvertimeRate booleans to EarningsRate modelBackPay property of earningsType<!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. -->
This will result in a small breaking change where any projects currently using the CreateBrandingThemePaymentServices method will need to wrap their P…
Generates Xero-PHP 2.19.0 from Xero-OpenAPI 2.33.1
BatchPayment property in Payment modelCreateBrandingThemePaymentServices method to accept an array of PaymentService objects instead of just one PaymentService object to match API functionalityIsReconciled property of BatchPayment to boolean.TotalAmount property of BatchPayment to decimal<!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. -->
This will result in a small breaking change where any projects currently using the CreateBrandingThemePaymentServices method will need to wrap their PaymentService object in a PaymentServices object like so:
{ "PaymentServices": [ { "PaymentServiceID": "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55", "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PaymentServiceType": "Custom", "PayNowText": "Time To Pay" } ] }
[ ] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP 2.18.0 from Xero-OpenAPI 2.31.0
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.17.0 from Xero-OpenAPI 2.30.2
LITE to Class modelgetBatchPayment which takes batchPaymentID as a parameterAdds the following missing timezones:
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[ ] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.15.0 from Xero-OpenAPI 2.25.0
createRepeatingInvoices, updateOrCreateRepeatingInvoices, and updateRepeatingInvoicedeleteBatchPaymentEarningsType enum values PAIDPARENTALLEAVE and WORKERSCOMPENSATIONHasLoanOrStudentDebt<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.14.1 from Xero-OpenAPI 2.23.0
Resolves bug #286
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.14.0 from Xero-OpenAPI 2.23.0
New ReportTaxtType / TaxType TXRCTSINPUT added
New methods createTask, updateTask, deleteTask added
Add support for firebase/php-jwt version 6.0 Resolves \SPLObjectFile bug #280
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[ ] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.13.0 from Xero-OpenAPI 2.22.4
Organisation model Class enum updated to include ULTIMATE
New method getJournalByNumber added
BADDEBTRELIEF , IGDSINPUT3, SROVR, TOURISTREFUND, TXRCN33INPUT, TXRCREINPUT, TXRCESSINPUT have been added as both a TaxType and ReportTaxType
Product model updated to include usageUnit property
Product model TypeEnum enum updated to include METERED
SubscriptionItem model updates to include quantity property
StatementResponse model updated to include startBalance and endBalance properties
Updates Employment model NiCategoryEnum to support new NI Category values (F, I, S, L, V)
Adds support for PHP 8.1.
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.12.1 from Xero-OpenAPI 2.19.3
Organisation model OrganisationType enum updated to include INDIVIDUAL
Some fields were set to 'date-time' when they are actually 'date'.
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[ ] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.12.0 from Xero-OpenAPI 2.18.0
LineItem model updated to include item object that is returned in BankTransactions, Invoices, Credit Notes - new model is LineItemItem
Adds Bank Statements Plus endpoint via getBankStatementAccounting method and associated models
Employee model update to include is_off_payroll_worker boolean property
Adds is_off_payroll_worker as an available query param for GET /Employees
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[X] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 2.11.0 from Xero-OpenAPI 2.17.4
Plan.status enum updated to include CANCELED, available options are:
ACTIVE, CANCELED, PENDINGACTIVATION
Subscription.status type corrected from string to Subscription.StatusEnum, available options are:
ACTIVE, CANCELED, PASTDUE
SubscriptionItem updated to include status enum, available options are:
ACTIVE, CANCELED, PENDINGACTIVATION
Quote added to ObjectGroup enum
SalesQuote added to ObjectType enum
AllowanceCategory enum added to EarningsRate, available options are:
NONDEDUCTIBLE, UNIFORM, PRIVATEVEHICLE, HOMEOFFICE, TRANSPORT, GENERAL, OTHER
AllowanceType enum updated to include TOOLS, TASKS, QUALIFICATIONS, available options are:
CAR, TRANSPORT, LAUNDRY, MEALS, TRAVEL, JOBKEEPER, TOOLS, TASKS, QUALIFICATIONS, OTHER
Refactored to use GuzzleHttp/psr7/Query::build() instead of deprecated GuzzleHttp/psr7/build_query()
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[x] New feature (non-breaking change that adds functionality)
Implements the endpoints available in Xero's Finance API Spec.
Also updates the Contact model to match Xero's Accounting API Spec.
https://developer.xero.com/documentation/api/finance/overview
The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
FinanceAPI methods added:
getAccountingActivityAccountUsagegetAccountingActivityLockHistorygetAccountingActivityReportHistorygetAccountingActivityUserActivitiesgetCashValidationgetFinancialStatementBalanceSheetgetFinancialStatementCashflowgetFinancialStatementProfitAndLossgetFinancialStatementTrialBalancegetFinancialStatementContactsExpensegetFinancialStatementContactsRevenueFinance models added
Accounting Contact model updated:
[ ] Bug fix (non-breaking change that fixes an issue)
Generates Xero-PHP-OAuth2 from OAS 2.17.1 minus Finance API.
AccountingAPI.get_budget() added query params:
date_to
date_from
AccountingAPI.get_contacts() added query param:
search_term
PayrollAUAPI if_modified_sInce query param type corrected:
was string --> now Date
PayrollNZAPI.get_employess() replaced query params:
was 'first_name and 'last_name --> now filter
PayrollNZAPI.get_timesheets() replaced query params:
was 'employee_idandpayroll_calendar_id--> nowfilter`
PayrollNZAPI.get_timesheets() added query params:
status
start_date
end_date
sort
PayrollUKAPI.get_timesheets() added query params:
status
start_date
end_date
sort
AccountingAPI BankTransfer model added fields:
from_is_reconciled
to_is_reconciled
reference
AppStoreAPI Product model added field:
seat_unit
PayrollAUAPI EarningsType added enum:
LUMPSUMW
PayrollAUAPI ManualTaxType added enum:
SCHEDULE4MANUAL
PayrollUKAPI EarningsRate model corrected enums:
was Tips(Direct) and Tips(Non-Direct) --> now TipsDirect and TipsNonDirect
<!--- What types of changes does your code introduce? Put an x in all the boxes that apply: -->
[x] New feature (non-breaking change that adds functionality)
Implements the endpoints available in Xero's API spec.
https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/
https://developer.xero.com/documentation/api/xero-app-store/subscriptions
Subscriptions endpoints enable you to query data about the users who have paid to subscribe to your application through Xero.
AppStoreAPI adds
getSubscription
AppStore:: adds
PayrollAU Employee adds termination_reason
V Voluntary cessation
I Ill health
D Deceased
R Redundancy
F Dismissal
C Contract cessation
T Transfer
PayrollAu::PayrollCalendar adds reference_date
Payment adds bank_amount
[x] New feature (non-breaking change that adds functionality)
Implements the endpoints available in Xero's API spec.
https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/
https://developer.xero.com/documentation/api/xero-app-store/subscriptions
Subscriptions endpoints enable you to query data about the users who have paid to subscribe to your application through Xero.
AppStoreAPI adds
getSubscription
AppStore:: adds
PayrollAU Employee adds termination_reason
V Voluntary cessation
I Ill health
D Deceased
R Redundancy
F Dismissal
C Contract cessation
T Transfer
PayrollAu::PayrollCalendar adds reference_date
Payment adds bank_amount
adds budgetbalance & budgetline
"guzzlehttp/psr7": "^1.8", https://github.com/XeroAPI/xero-php-oauth2/issues/240🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨
Release for last few OAS releases: https://github.com/XeroAPI/Xero-OpenAPI/releases
🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨
summaryOnly?: boolean added to the getInvoices function
Future proofing GST and BAS Reports endpoints for NZ and AU orgs, or any orgs that get introduced reports without a restful endpoint and require /Reports/{uuid}
getReportBASorGSTList -> getReportsList
getReportBasOrGst -> getReportFromId
🚨 🚨 🚨 MINOR BREAKING CHANGE - END 🚨 🚨 🚨
Code sample docs for the 3 payroll api sets 🚀
Added Budgets endpoints
getBudget(xeroTenantId: string, budgetID: string, options: {headers: {...}})
getBudgets(xeroTenantId: string, iDs?: Array[string], dateTo?: string, dateFrom?: string, options: {headers: {...}})
Build from OAS 2.11.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.11.1
Build from OAS 2.11.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.11.1
ACCOUNTING Add payments array to Prepayment object Add summaryOnly param to getContacts Remove readonly property from Manual Journal Line TaxAmount
PROJECTS Missing ENUM for Time entry status "INVOICED"
BANKFEEDS Add missing ENUM for bank feed error "feed-not-found-or-already-deleted"
PAYROLL AU Make CalculationType optional on deduction line
Update JWT decoding and verification methods
Update JWT decoding and verification methods
See README for how to use https://github.com/XeroAPI/xero-php-oauth2#jwt-decoding-and-signup-with-xero
Build from OpenAPI spec 2.10.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.10.4
Build from OpenAPI spec 2.10.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.10.4
UK PAYROLL Add missing SalaryAndWage payment type - Hourly
New look to SDK reference docs
One column per quarter.