xero-openapi's Introduction

Xero-OpenAPI

An OpenAPI (Swagger) specification for the Xero API with OAuth 2.0 security schema.

Description

This repository holds the official Xero OpenAPI descriptions.

OpenAPI spec 3.0

In Development

Fixed Assets - yaml
Payroll AU - yaml
Payroll NZ/UK - yaml
Project - yaml
Xero HQ - yaml

Code Generators

We are using OpenAPI generator along with these OAS yaml files to generate our new SDKs.

Preview

There are lots of tools available for viewing and editing OpenAPI descriptions in a nicely formatted way. A popular tool is SwaggerHub - a version of which is hosted here.

Once you sign up or login, you can create a new API under your account and import a Xero API spec.

Updates

If you find something missing or incorrect please open an issue or send us a pull request.

License

This software is published under the MIT License.

Copyright (c) 2019 Xero Limited

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Recommend Projects