4.13.0

Description

Initial release of the finance API specs. https://developer.xero.com/documentation/api/finance/overview/

Access

The Finance API is a closed API that is only available to those that have an established (usually, but not limited to, financial services) partnership with Xero.
If you're an existing partner that wants access, contact your local Partner Manager.
If you're a financial institution or other partner who wants to leverage the Finance API for your business customers, contact us to become a financial services partner.

Release Notes

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 adds

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

Additional changes introduced

-Add EarningsRate enum value DIRECTORSFEES to the Payroll AU SDK spec
-Add API SDK Support for LumpSumW and SCHEDULE4MANUAL tax type to the Payroll AU SDK spec
-fixes GetBudget filtering
-Adding missing params from Timesheets and Employees endpoints
-Timesheets endpoint -> filter, status, startDate, endDate and sort parameters
-Employees endpoint -> filter parameter
-adds missing UK payroll earningsrates: TipsNonDirect, TipsDirect
-adds new properties to bank transfers
-adds missing seatUnit to Product schema in app store spec
-New properties on bank transfers: FromIsReconciled, ToIsReconciled, Reference

Types of Changes

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

4.12.0

Implements the endpoints available in Xero-Java

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)

4.11.1

• A few fixes to the budgets serialization thanks to @rdemarco-xero

• Fixes budgets

  • budgetLines
  • budgetBalances

• Adds TERMINATIONPAY("TerminationPay");

• Adds referenceDate to payrollCalendar

4.11.0

Added small breaking fix to reports for au/nz tax, added budgets endpoints, added the rest of the docs for api sets.. some still don't have body examples but an improvement.

🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨

1. Changes param order of summaryOnly for getInvoices.

*** This was not added as the last param in the spec and was the only SDK released prior to it being fixed in the OpenAPI Spec - We are moving it as the last parameter across all SDKs it is less of a breaking change. Apologies to those users that might have implemented, and have to swap position now again.

2. getReportBASorGSTList -> getReportsList
getReportBasOrGst -> getReportFromId

Changes using previous GST BAS reports specific endpoints to support stable future state of adding reports that are unique to an org and require a uuid to be passed. New function names:

getReportsList
getReportFromId

3) Added missing endpoints:
- GET /Budgets
- GET /Budgets/{BudgetID}

🚨 🚨 🚨 END🚨 🚨 🚨

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)

4.10.0

Build from OpenAPI spec 2.12.0
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.12.0

ACCOUNTING
Add summaryOnly param to getInvoices
Add payments array to Prepayment object

4.9.1

Added method to revoke refresh token to ApiClient class

Build from OAS 2.11.0 https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.11.0

ACCOUNTING
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"

4.8.3

Build from OAS 2.10.4 - https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.10.4

UK PAYROLL
Add missing SalaryAndWage payment type - Hourly

New exception classes added - thank you @evelinasmit

Add API exception types for statuses
501 XeroNotImplementedException
503 XeroNotAvailableException

4.8.2

Build from OpenAPI spec 2.10.3
https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.10.3

FILES API
Fix path for uploadFileToFolder method

Replaced inline objects with UploadObject for use by both upload methods

BANKFEED API
Fix error response and status code for Feedconnections. The API will actually return an overall HTTP 400 but will include a sub-status per connection error in the response body. I removed the 409 from the expected responses, and updated the schema/example for the 400

4.8.1

ACCOUNTING
added validationerror to batchpayment object & remove from batchpayments

BANKFEEDS
Fixed statementId in path for getStament method
Added transactionType to StatementLine
Updated a few method return status from 200 to 201

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.

4.8.0

Merged PR with XeroRateLimitException subtypes
Specific Rate Limit exceptions added

ApiClient - updated connectionTimeout and readTimeout default to 180000 milliseconds (3 min). You can override and set as high as 5 min.

Lots of missing comments added to eliminate warnings during build of JavaDocs