NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist, #1540 most downloaded on Packagist
Xero official PHP SDK for oAuth2 generated with OpenAPI spec 3
Latest stable
16.4.0
Last release 11 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.
ACCOUNTING added validationerror to batchpayment object & remove from batchpayments
Build from OpenAPI spec 2.10.3
ACCOUNTING added validationerror to batchpayment object & remove from batchpayments
FILES API Fix path for uploadFileToFolder method Replaced inline objects with UploadObject for use by both upload methods
NZ PAYROLL Add "history" as a valid status to SalaryAndWage object Add "Requested" as a valid status to Timesheet object
UKPAYROLL GET Employees and GET Timesheets was not passing filter params correctly. Get methods for Employees and Timesheets incorrectly defined params to be passed by name for querying the API. Instead it needs to be a single param called "filter" that has named params and values passed together.
Files API Fixed the base URL in Configuration.php
Build from OAS 2.10.0
Files API Fixed the base URL in Configuration.php
Accounting Change datatype from float to int on several properties of ImportSummaryAccounts model Change datatype from float to int on expires_in in the Identity model
UK Payroll Missing EarningsRate types added
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Build from OpenAPi spec 2.9.3 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.9.3
Build from OpenAPi spec 2.9.3 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.9.3
FILES API Standardized IDs in path and parameters Corrected Response codes where needed from 200 to 201. Corrected responses object for 204 - should be none (void) Added example requests and responses
ACCOUNTING Add BatchPaymentID to Payment object
Resolved issue #189
ACCOUNTING Add Warnings array to CreditNote object
Build from OAS 2.9.0
ACCOUNTING Add Warnings array to CreditNote object
This Organisation object previously used the singular CISOrgSetting component, but that did not match the API response. New CISOrgSettings model with a CISSettings property (array of CISOrgSetting) that matches the API response.
Re-add x-is-money to CreditNote.AppliedAmount
ASSETS filterby parameter for GET assets acts as an keyword search against the AssetName, AssetNumber, Description and AssetTypeName fields
In preparation for use to generate API reference documentation, we've done some clean up of misspellings, add more consistency around summaries and descriptions. Adjusted capitalisations on paths.
ACCOUNTING Add readOnly property to BrandingTheme on Contact object
Build from OpenAPI spec 2.8.4
ACCOUNTING Add readOnly property to BrandingTheme on Contact object
Create, Read, Update, Delete Folders, Files, Associations
Build from OAS 2.8.2
File API support added
NZ PAYROLL SalaryAndWage DaysPerWeek, change from integer to double x-is-money
AU PAYROLL added extra Earnings type LUMPSUME
ACCOUNTING Reports - ReportFields, FieldID from uuid to string Invoice - remove maxlength attribute from reference property
ACCOUNTING Reports - ReportFields, FieldID from uuid to string Invoice - remove maxlength attribute from reference property
Address object will be used by Contact and the DELIVERY enum was removed from AddressType AddressForOrganisation added for use in the Organisation object.
CISDeduction added to CreditNote, CISRate added to both CreditNote and Invoice in Accounting. CISRate has been changed to decimal and set as readOnly.
GET LinkedTransactions query params are strings but not formatted as UUID Add missing format on query params for GET LinkedTransactions
Added format:UUID to the following query params LinkedTransactionID SourceTransactionID ContactID TargetTransactionID
NZ PAYROLL In TaxSettings changed periodunits from int to decimal Move CalendarType into a separate component for reuse by PayRun and PayRunCalendar Add TwiceMonthly value to CalendarType enum
Nothing published for this version
todate param is string - change format to date - breaking change
ACCOUNTING BatchPayment modify reference max length from 12 to 255 for
CreditNote add DueDate property
Balance Sheet Report todate param is string - change format to date - breaking change
ASSETS Asset object add the disposalDate property
Build from OAS version 2.4.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.4.4
Build from OAS version 2.4.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.4.4
ACCOUNTING refactor setup endpoint and components
PROJECTS Change get param chargeType
UK PAYROLL Add employer_tax_lines to payslip object
Build from OAS 2.4.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.4.1
Build from OAS 2.4.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.4.1
Add the Setup endpoint and related components
ACCOUNTING getPurchaseOrdersAttachments getPurchaseOrder≠AttachmentByFileName updatePurchaseOrderAttachmentByFileName createPurchaseOrderAttachmentByF
ACCOUNTING getPurchaseOrdersAttachments getPurchaseOrder≠AttachmentByFileName updatePurchaseOrderAttachmentByFileName createPurchaseOrderAttachmentByFileName History for Manual Journals
Currency rename two problem currencies to TRY_LIRA and EMPTY_CURRENCY Add the Organisation endpoint subresource Action Add two components Actions and Action BatchPaymentDetails remove max length from Details property
NZ PAYROLL Add x-is-money vendor extension for double values that are currency fix casing on tag for PayrollNZ …should be PayrollNz
AU PAYROLL Make EmployeeID not req. for Tax Declaration Add Timesheet Status enum REJECTED and REQUESTED
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.3.3
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.3.3
ACCOUNTING Add QuoteNumber as a query param for getQuotes method Remove getQuoteByNumber method as that did not match implementation of the API
add 2 missing currencies
tracking option length 50 -> 100
added RepeatingInvoiceID to Invoice
Timezone Add enum - UTC+13 Add getQuoteByNumber method
AU PAYROLL Added ManualTaxType and EarningsType enums BONUSESANDCOMMISSIONS SCHEDULE5STSLMANUAL SCHEDULE5MANUAL
Add optional versions for guzzle 6.2 or 7.0
Add optional versions for guzzle 6.2 or 7.0
Build from OpenAPI Spec 2.3.0 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.3.0
ACCOUNTING Account Remove max length on the code field with account. Some orgs already have account codes longer than 10 chars, removing the limit allows the GET call to work correctly.
BatchPayment Remove Max Length from details property as some data returned from API exceeds the previous 18 char limit
AU PAYROLL EmployeeNumber -change from float to string TaxDeclaration - make employment basis not required
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.15
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.15
AU PAYROLL Add missing properties from LeaveLine AnnualNumberOfUnits FullTimeNumberOfUnitsPerPeriod
ACCOUNTING Add Separate scope for 1099 reports
Update version of oauth2-client to 2.5.0 Update README about PHPStorm
Build from OpenAPI Spec 2.2.14 (includes from 2.2.9) https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.14
Build from OpenAPI Spec 2.2.14 (includes from 2.2.9) https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.14
AU PAYROLL Change LeaveLoadingRate from integer to double Remove CalculationType requirement for EarningLine restored the type of AccureLeave in ErarningsRate to boolean
UK PAYROLL remove duplicate deduction enum: PRIVATEUSEPAYMENTS Change method getPayslips to getPaySlips Add missing earningsRates Add missing deduction type enums Add missing deductible category enums
ACCOUNTING Added additional enum for Employee endpoint Remove "Contact" as a req. param for Bank Transactions Add DELETED enum to QuoteStatusCode in Quote schema Added AccountID field on ManulaJournalLine
ALL SPECS Add vendor extension on number properties that are currency related - used in .NET x-is-money: true Add vendor extension to help with generating dynamic language docs for Ruby.
Build from OpenAPI spec 2.2.9 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.9
Build from OpenAPI spec 2.2.9 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.9
UK PAYROLL
ACCOUNTING Remove style:simple property from Statuses Filter Change getQuoteAsPDF method to use QuoteID is path not QuotesID
Adding the 'BatchPayment' object to the response of:
GET /Payments GET /Payments/{PaymentID} GET /BankTransactions GET /BankTransactions/{BankTransactionID}
This will be returned only when a payment/transaction is part of a batch.
Add RepeatingInvoiceID to the get invoices endpoint
Reports Fix typo in report name/path for TenNinetyNineContact
AU PAYROLL PayItem • AccrueLeave change from number to boolean LeaveType • NormalEntitlement change from Int to Double Employee object
ASSETS Remove AssetTypeId from req. property list
extra spaces removed from templates to reduce size of Api class files
extra spaces removed from templates to reduce size of Api class files
Address issue #87
Build from OpenAPI spec 2.2.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.4
Build from OpenAPI spec 2.2.4 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.4
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.3
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.3
Build from OAS 2.2.3 - fix casing on createdDateUtc
Build from version 2.2.2 of OpenAPI spec https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.2
Build from version 2.2.2 of OpenAPI spec https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.2
ACCOUNTING Add proposed ReportTaxType enums for South Africa
ACCOUNTING Add proposed ReportTaxType enums for South Africa
Allocation add Prepayment, Overpayment, CreditNote add StatusAttributeString and ValidationErrors array
Schedule add missing enums
Organisation add EmployerIdentificationNumber
JWTClaims class updated
ASSETS Asset purchase_price, disposal_price, disposal_price floats changed to double Book Deprecation Setting depreciation_rate changed from float to…
Build from 2.2.0 of OpenAPI spec https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.2.0
2.1.2
Changes .....
ACCOUNTING Dates in accounting now have two getter methods to handle MS JSON date format as a string but return a native date object - see README for more details.
Add method getContactByContactNumber Remove method getPrepaymentAsPdf (not supported by API) BankTransfer amount changed from string to double CreditNote added has_errors boolean Item quantity_on_hand changed from float to double Invoice line item quantity and unit_amount changed from float to double Payment has_account boolean, has_validation_errors boolean and validation_errors array added Purchase unit_price changed from float to double getPayments added page param
ASSETS Asset purchase_price, disposal_price, disposal_price floats changed to double Book Deprecation Setting depreciation_rate changed from float to double
IDENTITY auth_event_id filter added to getConnections auth_event_id property added to Connection updated_date_utc changed from string to date-time created_date_utc changed from string to date-time
PAYROLL AU Fix PayrollAU casing to PayrollAu to address issue with Composer 2
Change data type float to double BankAccount
Added property validation_errors array Employees LeaveApplication PayRun Payroll Calendar SuperFund Timesheet ValidationError
New objects PayslipLines Payslips
Build from 2.1.2 of OpenAPI spec https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.1.2
Build from 2.1.2 of OpenAPI spec https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.1.2
ACCOUNTING CurrencyCode: Add x-enum-varnames. This provides alternate variable names for "TRY" and "EMPTY" which were problematic for PHP 5.6
Payments: Add SummarizeErrors
Journals: Change JournalNumber from String to integer
Fix bug with jsonSerialize method in models
Fix bug with jsonSerialize method in models
ArrayIterator fixed for AccountingApi
ArrayIterator fixed for AccountingApi
Rename enum "TRY" to "_TRY" for CurrencyCode
Rename enum "TRY" to "_TRY" for CurrencyCode
The name 'EMPTY' for an enum in currencyCode throws an error in PHP 5.6. Using vendor extension to rename variable to "EMPTY_STRING" with a value of "
The name 'EMPTY' for an enum in currencyCode throws an error in PHP 5.6. Using vendor extension to rename variable to "EMPTY_STRING" with a value of ""
PHP version required lowered to 5.6 after testing successfully #69
PHP version required lowered to 5.6 after testing successfully #69
Objects with a single Array of objects is updated to include interfaces with Countable, IteratorAggregate, JsonSerializable #63 and #92
Build from OpenAPI Spec version 2.1.0 and 2.1.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.1.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.1.0
ASSETS AssetTypeId added
ACCOUNTING IncludeOnline passed as path, now passed as queryParam Add missing getPrepaymentAsPdf UK Reporting Tax Type ENUMs added to Tax rates #109
PAYROLL AU New AllowanceType class added UTC offset added to dates before converting from date to timeInMilliseconds. #106
Build from OpenAPI spec 2.0.9 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.9
Build from OpenAPI spec 2.0.9 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.9
PAYROLL AU add 2 missing ENUMs from EarningsType
ASSETS change example response case for assetStatus
IDENTITY Add tenantName to Get /connections object
Add payroll Host paths to Configuration.php
Add payroll Host paths to Configuration.php
Build from OpenAPI spec 2.0.8 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.8
Build from OpenAPI spec 2.0.8 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.8
ACCOUNTING Add getPurchaseOrderAsPdf method
ASSETS Add Error objects and Validation arrays
GET Assets requires a Status in ALL Caps otherwise you'll recieve a 403 Forbidden.
CREATE or GET Assets deserializes JSON responses into the Assets object where the Status is Init Caps.
For this reason the same component in our OpenAPI spec will not support both use cases without throwing an error for missing enums due to case sensitivity.
Generated from version 2.0.7 of OpenAPI specs
Generated from version 2.0.7 of OpenAPI specs
AU Payroll methods, models and docs added.
New class StringUtil added to convert from MS Dateformat to native date format https://developer.xero.com/documentation/api/requests-and-responses#JSON
Dates have two getter methods i.e. getDateOfBirth() which returns a string in MSDateformat. /Date(1573623306000+0000)/ and getDateofBirthAsDate() that return a native DateTime format.
Build from 2.0.7 (encompasses 2.0.6 and 2.0.5) https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.7
Build from 2.0.7 (encompasses 2.0.6 and 2.0.5) https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.7
2.0.7
ACCOUNTING All date add
All date-time add example -readOnly=true All HasAttachments add
default: "false" example: "false"
CreditNote Add property StatusAttributeString
2.0.6 ACCOUNTING updateEmployee singular not supported by API - removed Add getQuotesAsPDF
ASSETS enums capitalized for assets status AssetStatus component added
IDENTITY Add x-is-datetime:true for use in models mustache templates Allows you to override the default datetime datatype used by a generator.
2.0.5 ACCOUNTING
Update deletePayment method that required a payload when performing a POST. The deletePayment object has a single property "status" with a default value of "DELETED". Simply create a new instance of deletePayment and pass it as an arg to the deletePayment method. Add missing ENUM for Invoice Type BankFeed, Accounting, Projects
Adding ZWK and "" empty strings to currencyCode ENUM list
Built from version 2.0.4 of OAS https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.4
Built from version 2.0.4 of OAS https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.4
Did not bump to version 2.0.0 - found a way to modify the Configuration class so it can be shared by all API endpoints.
Add ProjectApi class includes helper methods for calling endpoints
Add Models/Project folder containing objects related to Projects
Update Configuration class for sharing by AccountingApi, AssetApi, IdentityApi and ProjectApi classes
Add ProjectObjectSerializer for serializing and deserializing project objects.
Add Project Docs and update other docs Update README
Missing AssetApi class Renamed plural "Assets" to "Asset" for file and folder names.
Missing AssetApi class Renamed plural "Assets" to "Asset" for file and folder names.
Built from OAS 2.0.3 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.3
Built from OAS 2.0.3 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.3
PurchaseOrder
AppliedAmount property added to the following models
Fixed Assets support added
Build based on changes to Xero-OpenAPI v 2..0.2 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.2
Build based on changes to Xero-OpenAPI v 2..0.2 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.2
Accounting updates
Quotes
ContactGroups fixed typo in description of Contact Groups
Release reflects changes in OpenAPI spec release 2.0.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.1
Release reflects changes in OpenAPI spec release 2.0.1 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.1
OAS v2.0.0 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.0
OAS v2.0.0 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.0.0
To address the use case where a queryString includes the unitdp=4 param we need to change objects with attributes that support more than two decimal points to to change the number datatype from double to float.
Added missing unitdp to methods ...
Added to the following ..
BankTransactions
getBankTransaction createBankTransactions updateBankTransaction updateOrCreate CreditNotes
getCreditNotes createCreditNotes updateCreditNote updateOrCreateCreditNotes Invoices
getInvoice createInvoices updateInvoice updateOrCreateInvoices Items
getItem createItems updateItem updateOrCreateItems Receipts
getReceipts getReceipt createReceipt updateReceipt Objects that use LineItems are impacted
BankTransations CreditNotes Invoices Receipts the two properties that changed from double to float
Quantity UnitAmount The Purchase object property changed from double to float
UnitPrice The Item object has the property changed from double to float
QuantityOnHand
Batchpayment Enums / TaxRate req. fields Added ARCHIVED Status to Manual Journal object Added SalesTaxPeriod NONE to organisation object Added Reference attribute to Prepayment object Added VOIDED status to Receipt object Added DELETED status to RepeatingInvoice object
Docs updated
Fix setter comments around ENUM objects to display string in hints.
Fix setter comments around ENUM objects to display string in hints.
Model and Method updates - Quotes added …
Model and Method updates - Quotes added …
Improve some of the descriptions of objects
Add "IncludeOnline" boolean param for createCreditNoteAttachmentByFileName and for createInvoiceAttachmentByFileName methods
Quotes methods added
Quote Model updated QuoteLineAmountType added
Invoice model updated
LineItemTracking model updates
Update annotation for enum objects to be type string and not the path to the enum object Fix path for fetching PDF copy of Invoices and CreditNotes
merge of date deserializer didn't make it.
merge of date deserializer didn't make it.
Fix error in date deserializer Update min req version of PHP to 7.2.1
Fix error in date deserializer Update min req version of PHP to 7.2.1
Breaking Change (minor version release) REMOVED
** Breaking Change (minor version release) REMOVED
createBankTransaction createContact createCreditNote createInvoice createItem createPurchaseOrder
ADDED updateOrCreateBankTransactions updateOrCreateContacts updateOrCreateCreditNotes updateOrCreateInvoices updateOrCreatePurchaseOrders
with support for summarizeErrors
Add missing summarizeErrors for BatchPayments
Add missing attribute 'status_attribute_string' to Contacts & Items Add object IDs to Elements
Add missing CIS (UK) Enums
Refactor Date deserializer
Fixing variable name for booleans
Fixing variable name for booleans
Boolean values for query params where not being passed properly and ended up as empty string. Correctly evaluating boolean and converting to proper st
Boolean values for query params where not being passed properly and ended up as empty string. Correctly evaluating boolean and converting to proper string version of boolean values.
Improved the sample code to fix error to token refresh saving data to storage class
README
AccountingApi
This corrects the PUT/POST usage for creating single and multiple objects via the same endpoint. Found they both need to be PUT for summizeErrors to w
This corrects the PUT/POST usage for creating single and multiple objects via the same endpoint. Found they both need to be PUT for summizeErrors to work properly.
Update JWTClaims decoding
change case for Xero-Tenant-Id to xero-tenant-id
TaxRate
AccountingApi
for example createAccounts requires an Accounts (array of account objects) createAccount requires an Account object
TaxRates are the exception and will only have createTaxRates and will accept TaxRates (array of taxrate objects)
Added to createItems and createContacts for bulk create Update default for all summarize error to false. Custom date deserialzer was returning date as
Added to createItems and createContacts for bulk create Update default for all summarize error to false. Custom date deserialzer was returning date as string, now returning datetime.
Add more JWT claims and update README
Add more JWT claims and update README
Date returned is standard date format Update README with JWT decoding
Date returned is standard date format Update README with JWT decoding
accept idTokens from authentication
New dependency added
New class JWTClaims
Identity
Add properties to Identity Connections
Accounting
Branding added attributes logo_url and type
Moving to stable version 1.0.0 Added missing enums from BatchPayments and TaxRates
Moving to stable version 1.0.0 Added missing enums from BatchPayments and TaxRates
Add missing enums from ExpenseClaim and TaxRates
Add missing enums from ExpenseClaim and TaxRates
Fixed date bug in Object serializer Added missing enums for ReportTypes on TaxRate object Added missing enum for Type on Invoice object
Fixed date bug in Object serializer Added missing enums for ReportTypes on TaxRate object Added missing enum for Type on Invoice object
Fixing README and AccountObjectSerializer
Fixing README and AccountObjectSerializer
Add updateTrackingOptions method
Add updateTrackingOptions method
One column per quarter.