XeroaccountingSDK 1.0.0
dotnet add package XeroaccountingSDK --version 1.0.0
NuGet\Install-Package XeroaccountingSDK -Version 1.0.0
<PackageReference Include="XeroaccountingSDK" Version="1.0.0" />
<PackageVersion Include="XeroaccountingSDK" Version="1.0.0" />
<PackageReference Include="XeroaccountingSDK" />
paket add XeroaccountingSDK --version 1.0.0
#r "nuget: XeroaccountingSDK, 1.0.0"
#:package XeroaccountingSDK@1.0.0
#addin nuget:?package=XeroaccountingSDK&version=1.0.0
#tool nuget:?package=XeroaccountingSDK&version=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:
Parameter | Type | Description |
---|---|---|
Environment | Environment |
The API environment. <br> Default: Environment.Production |
Timeout | TimeSpan |
Http client timeout.<br>Default: TimeSpan.FromSeconds(100) |
HttpClientConfiguration | Action<HttpClientConfiguration.Builder> |
Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings.<br>Default: new HttpClient() |
ImplicitAuth | ImplicitAuth |
The Credentials Setter for OAuth 2 Implicit Grant |
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.
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
HTTP
Utilities
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- APIMatic.Core (>= 0.4.10 && < 0.5.0)
- Microsoft.CSharp (>= 4.7.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
1.0.0 | 374 | 8/1/2025 |