2.12.0

Generates Xero-PHP-OAuth2 2.12.0 from Xero-OpenAPI 2.18.0

Accounting API

LineItem model updated to include item object that is returned in BankTransactions, Invoices, Credit Notes - new model is LineItemItem

Finance API

Adds Bank Statements Plus endpoint via getBankStatementAccounting method and associated models

UK Payroll API

Employee model update to include is_off_payroll_worker boolean property

Adds is_off_payroll_worker as an available query param for GET /Employees

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

2.11.0

Generates Xero-PHP-OAuth2 2.11.0 from Xero-OpenAPI 2.17.4

App Store API

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

Files API

Quote added to ObjectGroup enum
SalesQuote added to ObjectType enum

AU Payroll API

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

Additional Changes

Refactored to use GuzzleHttp/psr7/Query::build() instead of deprecated GuzzleHttp/psr7/build_query()

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

2.10.0

Implements the endpoints available in Xero's Finance API Spec.

Also updates the Contact model to match Xero's Accounting API Spec.

Description

https://developer.xero.com/documentation/api/finance/overview

Release Notes

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:

• getAccountingActivityAccountUsage
• getAccountingActivityLockHistory
• getAccountingActivityReportHistory
• getAccountingActivityUserActivities
• getCashValidation
• getFinancialStatementBalanceSheet
• getFinancialStatementCashflow
• getFinancialStatementProfitAndLoss
• getFinancialStatementTrialBalance
• getFinancialStatementContactsExpense
• getFinancialStatementContactsRevenue

Finance models added

• AccountUsage
• AccountUsageResponse
• BalanceSheetAccountDetail
• BalanceSheetAccountGroup
• BalanceSheetAccountType
• BalanceSheetResponse
• BankStatementResponse
• CashAccountResponse
• CashBalance
• CashValidationResponse
• CashflowAccount
• CashflowActivity
• CashflowResponse
• CashflowType
• ContactDetail
• ContactTotalDetail
• ContactTotalOther
• CurrentStatementResponse
• DataSourceResponse
• HistoryRecordResponse
• IncomeByContactResponse
• LockHistoryModel
• LockHistoryResponse
• ManualJournalTotal
• PnlAccount
• PnlAccountClass
• PnlAccountType
• PracticeResponse
• Problem
• ProfitAndLossResponse
• ReportHistoryModel
• ReportHistoryResponse
• StatementBalanceResponse
• StatementLinesResponse
• TotalDetail
• TotalOther
• TrialBalanceAccount
• TrialBalanceEntry
• TrialBalanceMovement
• TrialBalanceResponse
• UserActivitiesResponse
• UserResponse

---

Accounting Contact model updated:

• CompanyNumber - setting and retrieving Registration Number for a company/Business
• MergedToContactId - retrieving the ID for the destination of a merged contact
• SalesDefaultLineAmountType - retrieving the default sales line amount types for a contact
• PurchasesDefaultLineAmountType - retrieving the default purchases line amount types for a contact

---

Types of Changes

• New feature (non-breaking change that adds functionality)

2.9.0

Description

Generates Xero-PHP-OAuth2 from OAS 2.17.1 minus Finance API.

Release Notes

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

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

2.8.1

2.8.1 + Fix base path for app store

Implements the endpoints available in Xero's API spec.

Description

https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/

https://developer.xero.com/documentation/api/xero-app-store/subscriptions

Release Notes

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

  • Subscription
  • SubscriptionItem
  • Plan
  • Product
  • Price
  • ProblemDetails

• 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

Types of Changes

• New feature (non-breaking change that adds functionality)

2.8.0

Implements the endpoints available in Xero's API spec.

Description

https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/

https://developer.xero.com/documentation/api/xero-app-store/subscriptions

Release Notes

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

  • Subscription
  • SubscriptionItem
  • Plan
  • Product
  • Price
  • ProblemDetails

• 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

Types of Changes

• New feature (non-breaking change that adds functionality)

2.7.0

• fix budgets endpoints
  • adds budgetbalance & budgetline
• payments
  • adds bank_amount & reference
• payroll calendar reference date
• PayrollUk Earnings rate EARNINGS_TYPE_TERMINATION_PAY

• ---

• new readme examples for HTTP info
• removed old docs
• downgrades dependency for guzzle psr7 "guzzlehttp/psr7": "^1.8", #240

2.6.0

Release for last few OAS releases: https://github.com/XeroAPI/Xero-OpenAPI/releases

🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨

1. summaryOnly?: boolean added to the getInvoices function

2. 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 🚨 🚨 🚨

3. Code sample docs for the 3 payroll api sets 🚀

4. Added Budgets endpoints

getBudget(xeroTenantId: string, budgetID: string, options: {headers: {...}})
getBudgets(xeroTenantId: string, iDs?: Array[string], dateTo?: string, dateFrom?: string, options: {headers: {...}})

5. removed a legacy param reportID on a few endpoints

2.5.4

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

2.5.3

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