XeroaccountingSDK 1.0.0

Getting Started with Xero

Introduction

All the endpoints on the Accounting API.

To make requests you'll need a valid access_token and xero-tenant-id in your environment variables. These can be set by following the steps in the Xero OAuth2.0 collection.

Note: access tokens expire after 30 minutes but can be refreshed using the POST Refresh token request in the Xero OAuth2.0 collection.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package XeroaccountingSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/XeroaccountingSDK/1.0.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

using Xero.Standard;
using Xero.Standard.Authentication;

XeroClient client = new XeroClient.Builder()
 .ImplicitAuth(
 new ImplicitAuthModel.Builder(
 "OAuthClientId",
 "OAuthRedirectUri"
 )
 .Build())
 .Environment(Xero.Standard.Environment.Production)
 .Build();

Authorization

This API uses the following authentication schemes.

• oauth2 (OAuth 2 Implicit Grant)

List of APIs

• File Name
• Account ID
• Batch Payment ID History
• Batch Payments
• Bank Transaction ID
• Bank Transactions
• Bank Transfer ID
• Bank Transfers
• Payment Services
• Branding Theme ID
• Branding Themes
• Contact ID
• Contact Group ID
• Contact Groups
• Credit Note ID
• Credit Notes
• Expense Claim ID
• Expense Claims
• Invoice ID
• Item ID
• Linked Transaction ID
• Linked Transactions
• Manual Journal ID
• Manual Journals
• Overpayment ID
• Payment ID
• Prepayment ID
• Purchase Order ID
• Purchase Orders
• Quote ID
• Receipt ID
• Repeating Invoice ID
• Repeating Invoices
• Tax Rates
• Tracking Option ID
• Tracking Category ID
• Tracking Categories
• Attachments
• Accounts
• History
• Contacts
• Currencies
• Employees
• Invoices
• Items
• Journals
• Organisation
• Overpayments
• Payments
• Prepayments
• Quotes
• Receipts
• Reports
• Options
• Users
• Misc

SDK Infrastructure

Configuration

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper