Xero OpenAPI Versions Save

An OpenAPI description of the Xero API

2.20.1

2 years ago

Corrects version number mismatch

2.20.0

2 years ago

Description

  • Updates spec files to support generating python docs
  • Corrects PUT /Contacts sample JSON
  • Updates UK Payroll spec to support new NI Category values (F, I, S, L, V)

Release Notes

Screenshots (if appropriate):

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.19.3

2 years ago

Added new organisation type and new organisation entity type of INDIVIDUAL as this is now an option in the organisation settings in AU Xero

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.19.2

2 years ago

Some fields were set to 'date-time' when they are actually 'date'. This leads to a parser error in the Java SDK so needed to be updated.

Types of Changes

  • [x ] 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.19.1

2 years ago

Corrects version number mismatch

2.19.0

2 years ago

Description

Finance API

  • Allows the Finance API to be accessed via API Explorer

Release Notes

Finance API

  • Updates the manifest.json to set canPreview to be true

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.18.0

2 years ago

Description

Accounting API

  • Updates LineItem to include the Item object that is returned in BankTransactions, Invoices, and CreditNotes

Finance API

  • Adds Bank Statements Plus endpoint to the Finance API

UK Payroll API

  • Adds the isOffPayrollWorker property to the Employee schema as well as to the affected example requests and responses.

Release Notes

Accounting API

  • A new Item object will now be returned inside of the line items object for Invoices, Credit Notes and BankTransactions with further details about the item: ItemId, Name and Code.

Finance API

  • For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures.

UK Payroll API

  • Allow creation and management of off-payroll workers

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.17.4

2 years ago

Description

AU Payroll API Updates allowance type Adds allowance category type

Updates are in relation to new STP-2 functionality. We are introducing an allowance category and we are updating the allowance type enum to include three new allowance types.

 AllowanceType: 
      type: string
      enum: 
      - CAR
      - TRANSPORT
      - LAUNDRY
      - MEALS
      - TRAVEL
      - OTHER
      - JOBKEEPER
      - TOOLS
      - TASKS
      - QUALIFICATIONS
AllowanceCategory:
      type: string
      enum:
      - NONDEDUCTIBLE
      - UNIFORM
      - PRIVATEVEHICLE
      - HOMEOFFICE
      - TRANSPORT
      - GENERAL
      - OTHER

Release Notes

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.17.3

2 years ago

Description

App Store API Adds status to SubscriptionItem and updates available enums

Files API Adds Quote as an available ObjectGroup and SalesQuote as an available ObjectType

Release Notes

https://developer.xero.com/documentation/api/xero-app-store/subscriptions https://developer.xero.com/documentation/api/files/types/#object-groups https://developer.xero.com/documentation/api/files/types/#object-types

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.17.2

2 years ago

Description

Adding ContactNumber, SalesDefaultLineAmountType, PurchasesDefaultLineAmountType and MergedToContactID to OAS for contacts endpoint.

Release Notes

There have been some recent changes to the Contract for contacts endpoint, adding those new fields to OAS here https://developer.xero.com/documentation/api/accounting/releasenotes/#15-oct-2021

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)