Xero Accounting API

Accounting

createAccount

Creates a new chart of accounts


/Accounts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateAccountExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var account = new Account();
            account.Code = "123456";
            account.Name = "FooBar";
            account.Type = AccountType.EXPENSE;
            account.Description = "Hello World";
            
            try {
                var result = await apiInstance.CreateAccountAsync(accessToken, xeroTenantId, account, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateAccount: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
account *
Account 
      Account object in body of request
Required

createAccountAttachmentByFileName

Creates an attachment on a specific account


/Accounts/{AccountID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateAccountAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateAccountAttachmentByFileNameAsync(accessToken, xeroTenantId, accountID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateAccountAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createBankTransactionAttachmentByFileName

Creates an attachment for a specific bank transaction by filename


/BankTransactions/{BankTransactionID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransactionAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateBankTransactionAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransactionID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransactionAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createBankTransactionHistoryRecord

Creates a history record for a specific bank transactions


/BankTransactions/{BankTransactionID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransactionHistoryRecordExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateBankTransactionHistoryRecordAsync(accessToken, xeroTenantId, bankTransactionID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransactionHistoryRecord: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createBankTransactions

Creates one or more spent or received money transaction


/BankTransactions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransactionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var bankAccount = new Account();
            bankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var bankTransaction = new BankTransaction();
            bankTransaction.Type = BankTransaction.TypeEnum.RECEIVE;
            bankTransaction.Contact = contact;
            bankTransaction.LineItems = lineItems;
            bankTransaction.BankAccount = bankAccount;

            var bankTransactions = new BankTransactions();
            var bankTransactionsList = new List<BankTransaction>();
            bankTransactionsList.Add(bankTransaction); 
            bankTransactions._BankTransactions = bankTransactionsList;
            
            try {
                var result = await apiInstance.CreateBankTransactionsAsync(accessToken, xeroTenantId, bankTransactions, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransactions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
bankTransactions *
BankTransactions 
      BankTransactions with an array of BankTransaction objects in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

createBankTransfer

Creates a bank transfer


/BankTransfers

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransferExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var fromBankAccount = new Account();
            fromBankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var toBankAccount = new Account();
            toBankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var bankTransfer = new BankTransfer();
            bankTransfer.FromBankAccount = fromBankAccount;
            bankTransfer.ToBankAccount = toBankAccount;
            bankTransfer.Amount = new decimal(1.0);

            var bankTransfers = new BankTransfers();
            var bankTransfersList = new List<BankTransfer>();
            bankTransfersList.Add(bankTransfer); 
            bankTransfers._BankTransfers = bankTransfersList;
            
            try {
                var result = await apiInstance.CreateBankTransferAsync(accessToken, xeroTenantId, bankTransfers, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransfer: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
bankTransfers *
BankTransfers 
      BankTransfers with array of BankTransfer objects in request body
Required

createBankTransferAttachmentByFileName


/BankTransfers/{BankTransferID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransferAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateBankTransferAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransferID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransferAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createBankTransferHistoryRecord

Creates a history record for a specific bank transfer


/BankTransfers/{BankTransferID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBankTransferHistoryRecordExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateBankTransferHistoryRecordAsync(accessToken, xeroTenantId, bankTransferID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBankTransferHistoryRecord: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createBatchPayment

Creates one or many batch payments for invoices


/BatchPayments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBatchPaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var paymentAccount = new Account();
            paymentAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var bankAccount = new Account();
            bankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var payment = new Payment();
            payment.Account = bankAccount;
            payment.Date = currDate;
            payment.Amount = new decimal(1.0);
            payment.Invoice = invoice;
            var payments = new List<Payment>();
            payments.Add(payment);

            var batchPayment = new BatchPayment();
            batchPayment.Account = paymentAccount;
            batchPayment.Reference = "hello foobar";
            batchPayment.Date = currDate;
            batchPayment.Payments = payments;

            var batchPayments = new BatchPayments();
            var batchPaymentsList = new List<BatchPayment>();
            batchPaymentsList.Add(batchPayment); 
            batchPayments._BatchPayments = batchPaymentsList;
            
            try {
                var result = await apiInstance.CreateBatchPaymentAsync(accessToken, xeroTenantId, batchPayments, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBatchPayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
batchPayments *
BatchPayments 
      BatchPayments with an array of Payments in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createBatchPaymentHistoryRecord

Creates a history record for a specific batch payment


/BatchPayments/{BatchPaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBatchPaymentHistoryRecordExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var batchPaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateBatchPaymentHistoryRecordAsync(accessToken, xeroTenantId, batchPaymentID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBatchPaymentHistoryRecord: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
BatchPaymentID*
UUID (uuid)

Unique identifier for BatchPayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createBrandingThemePaymentServices

Creates a new custom payment service for a specific branding theme


/BrandingThemes/{BrandingThemeID}/PaymentServices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateBrandingThemePaymentServicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var brandingThemeID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var paymentService = new PaymentService();
            paymentService.PaymentServiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            paymentService.PaymentServiceName = "ACME Payments";
            paymentService.PaymentServiceUrl = "https://www.payupnow.com/";
            paymentService.PayNowText = "Pay Now";

            var paymentServices = new PaymentServices();
            var paymentServicesList = new List<PaymentService>();
            paymentServicesList.Add(paymentService); 
            paymentServices._PaymentServices = paymentServicesList;
            
            try {
                var result = await apiInstance.CreateBrandingThemePaymentServicesAsync(accessToken, xeroTenantId, brandingThemeID, paymentServices, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateBrandingThemePaymentServices: " + e.Message );
            }
        }
    }
}

Scopes

paymentservices Grant read-write access to payment services

Parameters

Path parameters
Name Description
BrandingThemeID*
UUID (uuid)

Unique identifier for a Branding Theme

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
paymentServices *
PaymentServices 
      PaymentServices array with PaymentService object in body of request
Required

createContactAttachmentByFileName


/Contacts/{ContactID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateContactAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateContactAttachmentByFileNameAsync(accessToken, xeroTenantId, contactID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateContactAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createContactGroup

Creates a contact group


/ContactGroups

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateContactGroupExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var contactGroup = new ContactGroup();
            contactGroup.Name = "VIPs";

            var contactGroups = new ContactGroups();
            var contactGroupsList = new List<ContactGroup>();
            contactGroupsList.Add(contactGroup); 
            contactGroups._ContactGroups = contactGroupsList;
            
            try {
                var result = await apiInstance.CreateContactGroupAsync(accessToken, xeroTenantId, contactGroups, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateContactGroup: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contactGroups *
ContactGroups 
      ContactGroups with an array of names in request body
Required

createContactGroupContacts

Creates contacts to a specific contact group


/ContactGroups/{ContactGroupID}/Contacts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateContactGroupContactsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactGroupID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var contacts = new Contacts();
            var contactsList = new List<Contact>();
            contactsList.Add(contact); 
            contacts._Contacts = contactsList;
            
            try {
                var result = await apiInstance.CreateContactGroupContactsAsync(accessToken, xeroTenantId, contactGroupID, contacts, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateContactGroupContacts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactGroupID*
UUID (uuid)

Unique identifier for a Contact Group

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contacts *
Contacts 
      Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request
Required

createContactHistory

Creates a new history record for a specific contact


/Contacts/{ContactID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateContactHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateContactHistoryAsync(accessToken, xeroTenantId, contactID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateContactHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createContacts

Creates multiple contacts (bulk) in a Xero organisation


/Contacts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateContactsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";

            var phone = new Phone();
            phone.PhoneNumber = "555-1212";
            phone.PhoneType = Phone.PhoneTypeEnum.MOBILE;
            var phones = new List<Phone>();
            phones.Add(phone);

            var contact = new Contact();
            contact.Name = "Bruce Banner";
            contact.EmailAddress = "hulk@avengers.com";
            contact.Phones = phones;

            var contacts = new Contacts();
            var contactsList = new List<Contact>();
            contactsList.Add(contact); 
            contacts._Contacts = contactsList;
            
            try {
                var result = await apiInstance.CreateContactsAsync(accessToken, xeroTenantId, contacts, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateContacts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contacts *
Contacts 
      Contacts with an array of Contact objects to create in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createCreditNoteAllocation

Creates allocation for a specific credit note


/CreditNotes/{CreditNoteID}/Allocations

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateCreditNoteAllocationExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var allocation = new Allocation();
            allocation.Amount = new decimal(1.0);
            allocation.Date = currDate;
            allocation.Invoice = invoice;

            var allocations = new Allocations();
            var allocationsList = new List<Allocation>();
            allocationsList.Add(allocation); 
            allocations._Allocations = allocationsList;
            
            try {
                var result = await apiInstance.CreateCreditNoteAllocationAsync(accessToken, xeroTenantId, creditNoteID, allocations, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateCreditNoteAllocation: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
allocations *
Allocations 
      Allocations with array of Allocation object in body of request.
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createCreditNoteAttachmentByFileName

Creates an attachment for a specific credit note


/CreditNotes/{CreditNoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateCreditNoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var includeOnline = true;
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateCreditNoteAttachmentByFileNameAsync(accessToken, xeroTenantId, creditNoteID, fileName, body, includeOnline, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateCreditNoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required
Query parameters
Name Description
IncludeOnline
Boolean

Allows an attachment to be seen by the end customer within their online invoice

createCreditNoteHistory

Retrieves history records of a specific credit note


/CreditNotes/{CreditNoteID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateCreditNoteHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateCreditNoteHistoryAsync(accessToken, xeroTenantId, creditNoteID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateCreditNoteHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createCreditNotes

Creates a new credit note


/CreditNotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateCreditNotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var creditNote = new CreditNote();
            creditNote.Type = CreditNote.TypeEnum.ACCPAYCREDIT;
            creditNote.Contact = contact;
            creditNote.Date = currDate;
            creditNote.LineItems = lineItems;

            var creditNotes = new CreditNotes();
            var creditNotesList = new List<CreditNote>();
            creditNotesList.Add(creditNote); 
            creditNotes._CreditNotes = creditNotesList;
            
            try {
                var result = await apiInstance.CreateCreditNotesAsync(accessToken, xeroTenantId, creditNotes, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateCreditNotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
creditNotes *
CreditNotes 
      Credit Notes with array of CreditNote object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

createCurrency

Create a new currency for a Xero organisation


/Currencies

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateCurrencyExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var currency = new Currency();
            currency.Code = CurrencyCode.USD;
            currency.Description = "United States Dollar";
            
            try {
                var result = await apiInstance.CreateCurrencyAsync(accessToken, xeroTenantId, currency, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateCurrency: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
currency *
Currency 
      Currency object in the body of request
Required

createEmployees

Creates new employees used in Xero payrun


/Employees

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateEmployeesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";

            var employee = new Employee();
            employee.FirstName = "Nick";
            employee.LastName = "Fury";

            var employees = new Employees();
            var employeesList = new List<Employee>();
            employeesList.Add(employee); 
            employees._Employees = employeesList;
            
            try {
                var result = await apiInstance.CreateEmployeesAsync(accessToken, xeroTenantId, employees, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateEmployees: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
employees *
Employees 
      Employees with array of Employee object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createExpenseClaimHistory

Creates a history record for a specific expense claim


/ExpenseClaims/{ExpenseClaimID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateExpenseClaimHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var expenseClaimID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateExpenseClaimHistoryAsync(accessToken, xeroTenantId, expenseClaimID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateExpenseClaimHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ExpenseClaimID*
UUID (uuid)

Unique identifier for a ExpenseClaim

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createExpenseClaims

Creates expense claims


/ExpenseClaims

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateExpenseClaimsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var user = new User();
            user.UserID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var receipt = new Receipt();
            receipt.ReceiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            receipt.Date = currDate;
            var receipts = new List<Receipt>();
            receipts.Add(receipt);

            var expenseClaim = new ExpenseClaim();
            expenseClaim.Status = ExpenseClaim.StatusEnum.SUBMITTED;
            expenseClaim.User = user;
            expenseClaim.Receipts = receipts;

            var expenseClaims = new ExpenseClaims();
            var expenseClaimsList = new List<ExpenseClaim>();
            expenseClaimsList.Add(expenseClaim); 
            expenseClaims._ExpenseClaims = expenseClaimsList;
            
            try {
                var result = await apiInstance.CreateExpenseClaimsAsync(accessToken, xeroTenantId, expenseClaims, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateExpenseClaims: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
expenseClaims *
ExpenseClaims 
      ExpenseClaims with array of ExpenseClaim object in body of request
Required

createInvoiceAttachmentByFileName

Creates an attachment for a specific invoice or purchase bill by filename


/Invoices/{InvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var includeOnline = true;
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, invoiceID, fileName, body, includeOnline, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required
Query parameters
Name Description
IncludeOnline
Boolean

Allows an attachment to be seen by the end customer within their online invoice

createInvoiceHistory

Creates a history record for a specific invoice


/Invoices/{InvoiceID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateInvoiceHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateInvoiceHistoryAsync(accessToken, xeroTenantId, invoiceID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateInvoiceHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createInvoices

Creates one or more sales invoices or purchase bills


/Invoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = new DateTime(2020, 10, 10);
            var dueDateValue = new DateTime(2020, 10, 10);

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItemTracking = new LineItemTracking();
            lineItemTracking.TrackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            lineItemTracking.TrackingOptionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var lineItemTrackings = new List<LineItemTracking>();
            lineItemTrackings.Add(lineItemTracking);

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            lineItem.Tracking = lineItemTrackings;
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var invoice = new Invoice();
            invoice.Type = Invoice.TypeEnum.ACCREC;
            invoice.Contact = contact;
            invoice.Date = dateValue;
            invoice.DueDate = dueDateValue;
            invoice.LineItems = lineItems;
            invoice.Reference = "Website Design";
            invoice.Status = Invoice.StatusEnum.DRAFT;

            var invoices = new Invoices();
            var invoicesList = new List<Invoice>();
            invoicesList.Add(invoice); 
            invoices._Invoices = invoicesList;
            
            try {
                var result = await apiInstance.CreateInvoicesAsync(accessToken, xeroTenantId, invoices, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
invoices *
Invoices 
      Invoices with an array of invoice objects in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

createItemHistory

Creates a history record for a specific item


/Items/{ItemID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateItemHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var itemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateItemHistoryAsync(accessToken, xeroTenantId, itemID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateItemHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
ItemID*
UUID (uuid)

Unique identifier for an Item

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createItems

Creates one or more items


/Items

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateItemsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var purchaseDetails = new Purchase();
            purchaseDetails.COGSAccountCode = "500";

            var item = new Item();
            item.Code = "abcXYZ123";
            item.Name = "HelloWorld";
            item.Description = "Foobar";
            item.InventoryAssetAccountCode = "140";
            item.PurchaseDetails = purchaseDetails;

            var items = new Items();
            var itemsList = new List<Item>();
            itemsList.Add(item); 
            items._Items = itemsList;
            
            try {
                var result = await apiInstance.CreateItemsAsync(accessToken, xeroTenantId, items, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateItems: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
items *
Items 
      Items with an array of Item objects in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

createLinkedTransaction

Creates linked transactions (billable expenses)


/LinkedTransactions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateLinkedTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var linkedTransaction = new LinkedTransaction();
            linkedTransaction.SourceTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            linkedTransaction.SourceLineItemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.CreateLinkedTransactionAsync(accessToken, xeroTenantId, linkedTransaction, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateLinkedTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
linkedTransaction *
LinkedTransaction 
      LinkedTransaction object in body of request
Required

createManualJournalAttachmentByFileName

Creates a specific attachment for a specific manual journal by file name


/ManualJournals/{ManualJournalID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateManualJournalAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateManualJournalAttachmentByFileNameAsync(accessToken, xeroTenantId, manualJournalID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateManualJournalAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createManualJournalHistoryRecord

Creates a history record for a specific manual journal


/ManualJournals/{ManualJournalID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateManualJournalHistoryRecordExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateManualJournalHistoryRecordAsync(accessToken, xeroTenantId, manualJournalID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateManualJournalHistoryRecord: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createManualJournals

Creates one or more manual journals


/ManualJournals

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateManualJournalsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = new DateTime(2020, 10, 10);
            var manualJournalLines = new List<ManualJournalLine>();

            var credit = new ManualJournalLine();
            credit.LineAmount = new decimal(-100.0);
            credit.AccountCode = "400";
            credit.Description = "Hello there";
            manualJournalLines.Add(credit);

            var debit = new ManualJournalLine();
            debit.LineAmount = new decimal(100.0);
            debit.AccountCode = "120";
            debit.Description = "Hello there";
            manualJournalLines.Add(debit);

            var manualJournal = new ManualJournal();
            manualJournal.Narration = "Foobar";
            manualJournal.Date = dateValue;
            manualJournal.JournalLines = manualJournalLines;

            var manualJournals = new ManualJournals();
            var manualJournalsList = new List<ManualJournal>();
            manualJournalsList.Add(manualJournal); 
            manualJournals._ManualJournals = manualJournalsList;
            
            try {
                var result = await apiInstance.CreateManualJournalsAsync(accessToken, xeroTenantId, manualJournals, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateManualJournals: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
manualJournals *
ManualJournals 
      ManualJournals array with ManualJournal object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createOverpaymentAllocations

Creates a single allocation for a specific overpayment


/Overpayments/{OverpaymentID}/Allocations

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateOverpaymentAllocationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var overpaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var allocation = new Allocation();
            allocation.Amount = new decimal(1.0);
            allocation.Date = currDate;
            allocation.Invoice = invoice;

            var allocations = new Allocations();
            var allocationsList = new List<Allocation>();
            allocationsList.Add(allocation); 
            allocations._Allocations = allocationsList;
            
            try {
                var result = await apiInstance.CreateOverpaymentAllocationsAsync(accessToken, xeroTenantId, overpaymentID, allocations, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateOverpaymentAllocations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
OverpaymentID*
UUID (uuid)

Unique identifier for a Overpayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
allocations *
Allocations 
      Allocations array with Allocation object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createOverpaymentHistory

Creates a history record for a specific overpayment


/Overpayments/{OverpaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateOverpaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var overpaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateOverpaymentHistoryAsync(accessToken, xeroTenantId, overpaymentID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateOverpaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
OverpaymentID*
UUID (uuid)

Unique identifier for a Overpayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createPayment

Creates a single payment for invoice or credit notes


/Payments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var account = new Account();
            account.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var payment = new Payment();
            payment.Invoice = invoice;
            payment.Account = account;
            payment.Amount = new decimal(1.0);
            payment.Date = dateValue;

            var payments = new Payments();
            var paymentsList = new List<Payment>();
            paymentsList.Add(payment); 
            payments._Payments = paymentsList;
            
            try {
                var result = await apiInstance.CreatePaymentAsync(accessToken, xeroTenantId, payment, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payment *
Payment 
      Request body with a single Payment object
Required

createPaymentHistory

Creates a history record for a specific payment


/Payments/{PaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var paymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreatePaymentHistoryAsync(accessToken, xeroTenantId, paymentID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PaymentID*
UUID (uuid)

Unique identifier for a Payment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createPaymentService

Creates a payment service


/PaymentServices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePaymentServiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var paymentService = new PaymentService();
            paymentService.PaymentServiceName = "ACME Payments";
            paymentService.PaymentServiceUrl = "https://www.payupnow.com/";
            paymentService.PayNowText = "Pay Now";

            var paymentServices = new PaymentServices();
            var paymentServicesList = new List<PaymentService>();
            paymentServicesList.Add(paymentService); 
            paymentServices._PaymentServices = paymentServicesList;
            
            try {
                var result = await apiInstance.CreatePaymentServiceAsync(accessToken, xeroTenantId, paymentServices, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePaymentService: " + e.Message );
            }
        }
    }
}

Scopes

paymentservices Grant read-write access to payment services

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
paymentServices *
PaymentServices 
      PaymentServices array with PaymentService object in body of request
Required

createPayments

Creates multiple payments for invoices or credit notes


/Payments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePaymentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var account = new Account();
            account.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var payment = new Payment();
            payment.Invoice = invoice;
            payment.Account = account;
            payment.Amount = new decimal(1.0);
            payment.Date = dateValue;

            var payments = new Payments();
            var paymentsList = new List<Payment>();
            paymentsList.Add(payment); 
            payments._Payments = paymentsList;
            
            try {
                var result = await apiInstance.CreatePaymentsAsync(accessToken, xeroTenantId, payments, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePayments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
payments *
Payments 
      Payments array with Payment object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createPrepaymentAllocations

Allows you to create an Allocation for prepayments


/Prepayments/{PrepaymentID}/Allocations

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePrepaymentAllocationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var prepaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var invoice = new Invoice();
            invoice.InvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var allocation = new Allocation();
            allocation.Invoice = invoice;
            allocation.Amount = new decimal(1.0);
            allocation.Date = currDate;

            var allocations = new Allocations();
            var allocationsList = new List<Allocation>();
            allocationsList.Add(allocation); 
            allocations._Allocations = allocationsList;
            
            try {
                var result = await apiInstance.CreatePrepaymentAllocationsAsync(accessToken, xeroTenantId, prepaymentID, allocations, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePrepaymentAllocations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PrepaymentID*
UUID (uuid)

Unique identifier for a PrePayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
allocations *
Allocations 
      Allocations with an array of Allocation object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createPrepaymentHistory

Creates a history record for a specific prepayment


/Prepayments/{PrepaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePrepaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var prepaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreatePrepaymentHistoryAsync(accessToken, xeroTenantId, prepaymentID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePrepaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PrepaymentID*
UUID (uuid)

Unique identifier for a PrePayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createPurchaseOrderAttachmentByFileName

Creates attachment for a specific purchase order


/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePurchaseOrderAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreatePurchaseOrderAttachmentByFileNameAsync(accessToken, xeroTenantId, purchaseOrderID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePurchaseOrderAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createPurchaseOrderHistory

Creates a history record for a specific purchase orders


/PurchaseOrders/{PurchaseOrderID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePurchaseOrderHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreatePurchaseOrderHistoryAsync(accessToken, xeroTenantId, purchaseOrderID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePurchaseOrderHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createPurchaseOrders

Creates one or more purchase orders


/PurchaseOrders

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreatePurchaseOrdersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var purchaseOrder = new PurchaseOrder();
            purchaseOrder.Contact = contact;
            purchaseOrder.LineItems = lineItems;
            purchaseOrder.Date = dateValue;

            var purchaseOrders = new PurchaseOrders();
            var purchaseOrdersList = new List<PurchaseOrder>();
            purchaseOrdersList.Add(purchaseOrder); 
            purchaseOrders._PurchaseOrders = purchaseOrdersList;
            
            try {
                var result = await apiInstance.CreatePurchaseOrdersAsync(accessToken, xeroTenantId, purchaseOrders, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreatePurchaseOrders: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
purchaseOrders *
PurchaseOrders 
      PurchaseOrders with an array of PurchaseOrder object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createQuoteAttachmentByFileName

Creates attachment for a specific quote


/Quotes/{QuoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateQuoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateQuoteAttachmentByFileNameAsync(accessToken, xeroTenantId, quoteID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateQuoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createQuoteHistory

Creates a history record for a specific quote


/Quotes/{QuoteID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateQuoteHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateQuoteHistoryAsync(accessToken, xeroTenantId, quoteID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateQuoteHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createQuotes

Create one or more quotes


/Quotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateQuotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var quote = new Quote();
            quote.Contact = contact;
            quote.LineItems = lineItems;
            quote.Date = dateValue;

            var quotes = new Quotes();
            var quotesList = new List<Quote>();
            quotesList.Add(quote); 
            quotes._Quotes = quotesList;
            
            try {
                var result = await apiInstance.CreateQuotesAsync(accessToken, xeroTenantId, quotes, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateQuotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
quotes *
Quotes 
      Quotes with an array of Quote object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createReceipt

Creates draft expense claim receipts for any user


/Receipts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateReceiptExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var user = new User();
            user.UserID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var receipt = new Receipt();
            receipt.Contact = contact;
            receipt.User = user;
            receipt.LineItems = lineItems;
            receipt.LineAmountTypes = LineAmountTypes.Exclusive;
            receipt.Status = Receipt.StatusEnum.DRAFT;

            var receipts = new Receipts();
            var receiptsList = new List<Receipt>();
            receiptsList.Add(receipt); 
            receipts._Receipts = receiptsList;
            
            try {
                var result = await apiInstance.CreateReceiptAsync(accessToken, xeroTenantId, receipts, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateReceipt: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
receipts *
Receipts 
      Receipts with an array of Receipt object in body of request
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

createReceiptAttachmentByFileName

Creates an attachment on a specific expense claim receipts by file name


/Receipts/{ReceiptID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateReceiptAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateReceiptAttachmentByFileNameAsync(accessToken, xeroTenantId, receiptID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateReceiptAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createReceiptHistory

Creates a history record for a specific receipt


/Receipts/{ReceiptID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateReceiptHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateReceiptHistoryAsync(accessToken, xeroTenantId, receiptID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateReceiptHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createRepeatingInvoiceAttachmentByFileName

Creates an attachment from a specific repeating invoices by file name


/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateRepeatingInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateRepeatingInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, repeatingInvoiceID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateRepeatingInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

createRepeatingInvoiceHistory

Creates a history record for a specific repeating invoice


/RepeatingInvoices/{RepeatingInvoiceID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateRepeatingInvoiceHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var historyRecord = new HistoryRecord();
            historyRecord.Details = "Hello World";

            var historyRecords = new HistoryRecords();
            var historyRecordsList = new List<HistoryRecord>();
            historyRecordsList.Add(historyRecord); 
            historyRecords._HistoryRecords = historyRecordsList;
            
            try {
                var result = await apiInstance.CreateRepeatingInvoiceHistoryAsync(accessToken, xeroTenantId, repeatingInvoiceID, historyRecords, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateRepeatingInvoiceHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
historyRecords *
HistoryRecords 
      HistoryRecords containing an array of HistoryRecord objects in body of request
Required

createRepeatingInvoices

Creates one or more repeating invoice templates


/RepeatingInvoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateRepeatingInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.CreateRepeatingInvoicesAsync(accessToken, xeroTenantId, repeatingInvoices, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateRepeatingInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
repeatingInvoices *
RepeatingInvoices 
      RepeatingInvoices with an array of repeating invoice objects in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

createTaxRates

Creates one or more tax rates


/TaxRates

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateTaxRatesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var taxComponent = new TaxComponent();
            taxComponent.Name = "State Tax";
            taxComponent.Rate = new decimal(2.25);
            var taxComponent = new List<TaxComponent>();
            taxComponents.Add(taxComponent);

            var taxRate = new TaxRate();
            taxRate.Name = "CA State Tax";
            taxRate.TaxComponents = taxComponents;

            var taxRates = new TaxRates();
            var taxRatesList = new List<TaxRate>();
            taxRatesList.Add(taxRate); 
            taxRates._TaxRates = taxRatesList;
            
            try {
                var result = await apiInstance.CreateTaxRatesAsync(accessToken, xeroTenantId, taxRates, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateTaxRates: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
taxRates *
TaxRates 
      TaxRates array with TaxRate object in body of request
Required

createTrackingCategory

Create tracking categories


/TrackingCategories

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateTrackingCategoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var trackingCategory = new TrackingCategory();
            trackingCategory.Name = "Foobar";
            
            try {
                var result = await apiInstance.CreateTrackingCategoryAsync(accessToken, xeroTenantId, trackingCategory, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateTrackingCategory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
trackingCategory *
TrackingCategory 
      TrackingCategory object in body of request
Required

createTrackingOptions

Creates options for a specific tracking category


/TrackingCategories/{TrackingCategoryID}/Options

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class CreateTrackingOptionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var trackingOption = new TrackingOption();
            trackingOption.Name = "Foobar";
            
            try {
                var result = await apiInstance.CreateTrackingOptionsAsync(accessToken, xeroTenantId, trackingCategoryID, trackingOption, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.CreateTrackingOptions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
trackingOption *
TrackingOption 
      TrackingOption object in body of request
Required

deleteAccount

Deletes a chart of accounts


/Accounts/{AccountID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteAccountExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteAccountAsync(accessToken, xeroTenantId, accountID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteAccount: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteBatchPayment

Updates a specific batch payment for invoices and credit notes


/BatchPayments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteBatchPaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var batchPaymentDelete = new BatchPaymentDelete();
            batchPaymentDelete.Status = "DELETED";
            batchPaymentDelete.BatchPaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteBatchPaymentAsync(accessToken, xeroTenantId, batchPaymentDelete, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteBatchPayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
batchPaymentDelete *
BatchPaymentDelete
Required

deleteBatchPaymentByUrlParam

Updates a specific batch payment for invoices and credit notes


/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteBatchPaymentByUrlParamExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var batchPaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.DeleteBatchPaymentByUrlParamAsync(accessToken, xeroTenantId, batchPaymentID, batchPaymentDeleteByUrlParam, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteBatchPaymentByUrlParam: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
BatchPaymentID*
UUID (uuid)

Unique identifier for BatchPayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
batchPaymentDeleteByUrlParam *
BatchPaymentDeleteByUrlParam
Required

deleteContactGroupContact

Deletes a specific contact from a contact group using a unique contact Id


/ContactGroups/{ContactGroupID}/Contacts/{ContactID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteContactGroupContactExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactGroupID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                await apiInstance.DeleteContactGroupContactAsync(accessToken, xeroTenantId, contactGroupID, contactID);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteContactGroupContact: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactGroupID*
UUID (uuid)

Unique identifier for a Contact Group

Required
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteContactGroupContacts

Deletes all contacts from a specific contact group


/ContactGroups/{ContactGroupID}/Contacts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteContactGroupContactsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactGroupID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                await apiInstance.DeleteContactGroupContactsAsync(accessToken, xeroTenantId, contactGroupID);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteContactGroupContacts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactGroupID*
UUID (uuid)

Unique identifier for a Contact Group

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteCreditNoteAllocations

Deletes an Allocation from a Credit Note


/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteCreditNoteAllocationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var allocationID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteCreditNoteAllocationsAsync(accessToken, xeroTenantId, creditNoteID, allocationID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteCreditNoteAllocations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
AllocationID*
UUID (uuid)

Unique identifier for Allocation object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteItem

Deletes a specific item


/Items/{ItemID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteItemExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var itemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                await apiInstance.DeleteItemAsync(accessToken, xeroTenantId, itemID);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteItem: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
ItemID*
UUID (uuid)

Unique identifier for an Item

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteLinkedTransaction

Deletes a specific linked transactions (billable expenses)


/LinkedTransactions/{LinkedTransactionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteLinkedTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var linkedTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                await apiInstance.DeleteLinkedTransactionAsync(accessToken, xeroTenantId, linkedTransactionID);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteLinkedTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
LinkedTransactionID*
UUID (uuid)

Unique identifier for a LinkedTransaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteOverpaymentAllocations

Deletes an Allocation from an overpayment


/Overpayments/{OverpaymentID}/Allocations/{AllocationID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteOverpaymentAllocationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var overpaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var allocationID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteOverpaymentAllocationsAsync(accessToken, xeroTenantId, overpaymentID, allocationID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteOverpaymentAllocations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
OverpaymentID*
UUID (uuid)

Unique identifier for a Overpayment

Required
AllocationID*
UUID (uuid)

Unique identifier for Allocation object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deletePayment

Updates a specific payment for invoices and credit notes


/Payments/{PaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeletePaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var paymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var paymentDelete = new PaymentDelete();
            paymentDelete.Status = "DELETED";
            
            try {
                var result = await apiInstance.DeletePaymentAsync(accessToken, xeroTenantId, paymentID, paymentDelete, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeletePayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PaymentID*
UUID (uuid)

Unique identifier for a Payment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
paymentDelete *
PaymentDelete
Required

deletePrepaymentAllocations

Deletes an Allocation from a Prepayment


/Prepayments/{PrepaymentID}/Allocations/{AllocationID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeletePrepaymentAllocationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var prepaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var allocationID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeletePrepaymentAllocationsAsync(accessToken, xeroTenantId, prepaymentID, allocationID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeletePrepaymentAllocations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PrepaymentID*
UUID (uuid)

Unique identifier for a PrePayment

Required
AllocationID*
UUID (uuid)

Unique identifier for Allocation object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteTrackingCategory

Deletes a specific tracking category


/TrackingCategories/{TrackingCategoryID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteTrackingCategoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteTrackingCategoryAsync(accessToken, xeroTenantId, trackingCategoryID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteTrackingCategory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

deleteTrackingOptions

Deletes a specific option for a specific tracking category


/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class DeleteTrackingOptionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var trackingOptionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.DeleteTrackingOptionsAsync(accessToken, xeroTenantId, trackingCategoryID, trackingOptionID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.DeleteTrackingOptions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
TrackingOptionID*
UUID (uuid)

Unique identifier for a Tracking Option

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

emailInvoice

Sends a copy of a specific invoice to related contact via email


/Invoices/{InvoiceID}/Email

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class EmailInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var requestEmpty = new RequestEmpty();
            
            try {
                await apiInstance.EmailInvoiceAsync(accessToken, xeroTenantId, invoiceID, requestEmpty, idempotencyKey);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.EmailInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
requestEmpty *
RequestEmpty
Required

getAccount

Retrieves a single chart of accounts by using a unique account Id


/Accounts/{AccountID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetAccountExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetAccountAsync(accessToken, xeroTenantId, accountID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetAccount: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getAccountAttachmentByFileName

Retrieves an attachment for a specific account by filename


/Accounts/{AccountID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetAccountAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetAccountAttachmentByFileNameAsync(accessToken, xeroTenantId, accountID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetAccountAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getAccountAttachmentById

Retrieves a specific attachment from a specific account using a unique attachment Id


/Accounts/{AccountID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetAccountAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetAccountAttachmentByIdAsync(accessToken, xeroTenantId, accountID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetAccountAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getAccountAttachments

Retrieves attachments for a specific accounts by using a unique account Id


/Accounts/{AccountID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetAccountAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetAccountAttachmentsAsync(accessToken, xeroTenantId, accountID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetAccountAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getAccounts

Retrieves the full chart of accounts


/Accounts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetAccountsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"ACTIVE\"";
            var order = "Name ASC";
            
            try {
                var result = await apiInstance.GetAccountsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetAccounts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getBankTransaction

Retrieves a single spent or received money transaction by using a unique bank transaction Id


/BankTransactions/{BankTransactionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetBankTransactionAsync(accessToken, xeroTenantId, bankTransactionID, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getBankTransactionAttachmentByFileName

Retrieves a specific attachment from a specific bank transaction by filename


/BankTransactions/{BankTransactionID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetBankTransactionAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransactionID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransactionAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getBankTransactionAttachmentById

Retrieves specific attachments from a specific BankTransaction using a unique attachment Id


/BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetBankTransactionAttachmentByIdAsync(accessToken, xeroTenantId, bankTransactionID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransactionAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getBankTransactionAttachments

Retrieves any attachments from a specific bank transactions


/BankTransactions/{BankTransactionID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBankTransactionAttachmentsAsync(accessToken, xeroTenantId, bankTransactionID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransactionAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBankTransactions

Retrieves any spent or received money transactions


/BankTransactions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"AUTHORISED\"";
            var order = "Type ASC";
            var page = 1;
            var unitdp = 4;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetBankTransactionsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransactions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

Up to 100 bank transactions will be returned in a single API call with line items details
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
pageSize
Integer

Number of records to retrieve per page

getBankTransactionsHistory

Retrieves history from a specific bank transaction using a unique bank transaction Id


/BankTransactions/{BankTransactionID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransactionsHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBankTransactionsHistoryAsync(accessToken, xeroTenantId, bankTransactionID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransactionsHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBankTransfer

Retrieves specific bank transfers by using a unique bank transfer Id


/BankTransfers/{BankTransferID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransferExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBankTransferAsync(accessToken, xeroTenantId, bankTransferID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransfer: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBankTransferAttachmentByFileName

Retrieves a specific attachment on a specific bank transfer by file name


/BankTransfers/{BankTransferID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransferAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetBankTransferAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransferID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransferAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getBankTransferAttachmentById

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID


/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransferAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetBankTransferAttachmentByIdAsync(accessToken, xeroTenantId, bankTransferID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransferAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getBankTransferAttachments

Retrieves attachments from a specific bank transfer


/BankTransfers/{BankTransferID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransferAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBankTransferAttachmentsAsync(accessToken, xeroTenantId, bankTransferID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransferAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBankTransferHistory

Retrieves history from a specific bank transfer using a unique bank transfer Id


/BankTransfers/{BankTransferID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransferHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBankTransferHistoryAsync(accessToken, xeroTenantId, bankTransferID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransferHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBankTransfers

Retrieves all bank transfers


/BankTransfers

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBankTransfersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "HasAttachments==true";
            var order = "Amount ASC";
            
            try {
                var result = await apiInstance.GetBankTransfersAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBankTransfers: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getBatchPayment

Retrieves a specific batch payment using a unique batch payment Id


/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBatchPaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var batchPaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBatchPaymentAsync(accessToken, xeroTenantId, batchPaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBatchPayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BatchPaymentID*
UUID (uuid)

Unique identifier for BatchPayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBatchPaymentHistory

Retrieves history from a specific batch payment


/BatchPayments/{BatchPaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBatchPaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var batchPaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBatchPaymentHistoryAsync(accessToken, xeroTenantId, batchPaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBatchPaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
BatchPaymentID*
UUID (uuid)

Unique identifier for BatchPayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBatchPayments

Retrieves either one or many batch payments for invoices


/BatchPayments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBatchPaymentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"AUTHORISED\"";
            var order = "Date ASC";
            
            try {
                var result = await apiInstance.GetBatchPaymentsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBatchPayments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getBrandingTheme

Retrieves a specific branding theme using a unique branding theme Id


/BrandingThemes/{BrandingThemeID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBrandingThemeExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var brandingThemeID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBrandingThemeAsync(accessToken, xeroTenantId, brandingThemeID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBrandingTheme: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
BrandingThemeID*
UUID (uuid)

Unique identifier for a Branding Theme

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBrandingThemePaymentServices

Retrieves the payment services for a specific branding theme


/BrandingThemes/{BrandingThemeID}/PaymentServices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBrandingThemePaymentServicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var brandingThemeID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetBrandingThemePaymentServicesAsync(accessToken, xeroTenantId, brandingThemeID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBrandingThemePaymentServices: " + e.Message );
            }
        }
    }
}

Scopes

paymentservices Grant read-write access to payment services

Parameters

Path parameters
Name Description
BrandingThemeID*
UUID (uuid)

Unique identifier for a Branding Theme

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBrandingThemes

Retrieves all the branding themes


/BrandingThemes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBrandingThemesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetBrandingThemesAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBrandingThemes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getBudget

Retrieves a specific budget, which includes budget lines


/Budgets/{BudgetID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBudgetExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var budgetID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var dateTo = DateTime.Parse("2019-10-31");
            var dateFrom = DateTime.Parse("2019-10-31");
            
            try {
                var result = await apiInstance.GetBudgetAsync(accessToken, xeroTenantId, budgetID, dateTo, dateFrom);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBudget: " + e.Message );
            }
        }
    }
}

Scopes

accounting.budgets.read

Parameters

Path parameters
Name Description
BudgetID*
UUID (uuid)

Unique identifier for Budgets

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
DateTo
date (date)

Filter by start date
DateFrom
date (date)

Filter by end date

getBudgets

Retrieve a list of budgets


/Budgets

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetBudgetsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var iDs = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var dateTo = DateTime.Parse("2019-10-31");
            var dateFrom = DateTime.Parse("2019-10-31");
            
            try {
                var result = await apiInstance.GetBudgetsAsync(accessToken, xeroTenantId, iDs, dateTo, dateFrom);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetBudgets: " + e.Message );
            }
        }
    }
}

Scopes

accounting.budgets.read

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
IDs
array[UUID] (uuid)

Filter by BudgetID. Allows you to retrieve a specific individual budget.
DateTo
date (date)

Filter by start date
DateFrom
date (date)

Filter by end date

getContact

Retrieves a specific contacts in a Xero organisation using a unique contact Id


/Contacts/{ContactID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetContactAsync(accessToken, xeroTenantId, contactID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContact: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContactAttachmentByFileName

Retrieves a specific attachment from a specific contact by file name


/Contacts/{ContactID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetContactAttachmentByFileNameAsync(accessToken, xeroTenantId, contactID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getContactAttachmentById

Retrieves a specific attachment from a specific contact using a unique attachment Id


/Contacts/{ContactID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetContactAttachmentByIdAsync(accessToken, xeroTenantId, contactID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getContactAttachments

Retrieves attachments for a specific contact in a Xero organisation


/Contacts/{ContactID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetContactAttachmentsAsync(accessToken, xeroTenantId, contactID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContactByContactNumber

Retrieves a specific contact by contact number in a Xero organisation


/Contacts/{ContactNumber}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactByContactNumberExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactNumber = "SB2";
            
            try {
                var result = await apiInstance.GetContactByContactNumberAsync(accessToken, xeroTenantId, contactNumber);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactByContactNumber: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactNumber*
String

This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContactCISSettings

Retrieves CIS settings for a specific contact in a Xero organisation


/Contacts/{ContactID}/CISSettings

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactCISSettingsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetContactCISSettingsAsync(accessToken, xeroTenantId, contactID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactCISSettings: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContactGroup

Retrieves a specific contact group by using a unique contact group Id


/ContactGroups/{ContactGroupID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactGroupExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactGroupID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetContactGroupAsync(accessToken, xeroTenantId, contactGroupID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactGroup: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactGroupID*
UUID (uuid)

Unique identifier for a Contact Group

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContactGroups

Retrieves the contact Id and name of each contact group


/ContactGroups

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactGroupsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var where = "Status==\"ACTIVE\"";
            var order = "Name ASC";
            
            try {
                var result = await apiInstance.GetContactGroupsAsync(accessToken, xeroTenantId, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactGroups: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getContactHistory

Retrieves history records for a specific contact


/Contacts/{ContactID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetContactHistoryAsync(accessToken, xeroTenantId, contactID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContactHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getContacts

Retrieves all contacts in a Xero organisation


/Contacts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetContactsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "ContactStatus==\"ACTIVE\"";
            var order = "Name ASC";
            var iDs = new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
            var page = 1;
            var includeArchived = true;
            var summaryOnly = true;
            var searchTerm = "Joe Bloggs";
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetContactsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, iDs, page, includeArchived, summaryOnly, searchTerm, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetContacts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups
accounting.contacts.read Grant read-only access to contacts and contact groups

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
IDs
array[UUID] (uuid)

Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
page
Integer

e.g. page=1 - Up to 100 contacts will be returned in a single API call.
includeArchived
Boolean

e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
summaryOnly
Boolean

Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
searchTerm
String

Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
pageSize
Integer

Number of records to retrieve per page

getCreditNote

Retrieves a specific credit note using a unique credit note Id


/CreditNotes/{CreditNoteID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetCreditNoteAsync(accessToken, xeroTenantId, creditNoteID, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNote: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getCreditNoteAsPdf

Retrieves credit notes as PDF files


/CreditNotes/{CreditNoteID}/pdf

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteAsPdfExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetCreditNoteAsPdfAsync(accessToken, xeroTenantId, creditNoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAsPdf: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getCreditNoteAttachmentByFileName

Retrieves a specific attachment on a specific credit note by file name


/CreditNotes/{CreditNoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetCreditNoteAttachmentByFileNameAsync(accessToken, xeroTenantId, creditNoteID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getCreditNoteAttachmentById

Retrieves a specific attachment from a specific credit note using a unique attachment Id


/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetCreditNoteAttachmentByIdAsync(accessToken, xeroTenantId, creditNoteID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getCreditNoteAttachments

Retrieves attachments for a specific credit notes


/CreditNotes/{CreditNoteID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetCreditNoteAttachmentsAsync(accessToken, xeroTenantId, creditNoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getCreditNoteHistory

Retrieves history records of a specific credit note


/CreditNotes/{CreditNoteID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNoteHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetCreditNoteHistoryAsync(accessToken, xeroTenantId, creditNoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNoteHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getCreditNotes

Retrieves any credit notes


/CreditNotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCreditNotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"DRAFT\"";
            var order = "CreditNoteNumber ASC";
            var page = 1;
            var unitdp = 4;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetCreditNotesAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCreditNotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
pageSize
Integer

Number of records to retrieve per page

getCurrencies

Retrieves currencies for your Xero organisation


/Currencies

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetCurrenciesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var where = "Code==\"USD\"";
            var order = "Code ASC";
            
            try {
                var result = await apiInstance.GetCurrenciesAsync(accessToken, xeroTenantId, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetCurrencies: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getEmployee

Retrieves a specific employee used in Xero payrun using a unique employee Id


/Employees/{EmployeeID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetEmployeeExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var employeeID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetEmployeeAsync(accessToken, xeroTenantId, employeeID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetEmployee: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
EmployeeID*
UUID (uuid)

Unique identifier for a Employee

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getEmployees

Retrieves employees used in Xero payrun


/Employees

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetEmployeesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"ACTIVE\"";
            var order = "LastName ASC";
            
            try {
                var result = await apiInstance.GetEmployeesAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetEmployees: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getExpenseClaim

Retrieves a specific expense claim using a unique expense claim Id


/ExpenseClaims/{ExpenseClaimID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetExpenseClaimExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var expenseClaimID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetExpenseClaimAsync(accessToken, xeroTenantId, expenseClaimID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetExpenseClaim: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ExpenseClaimID*
UUID (uuid)

Unique identifier for a ExpenseClaim

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getExpenseClaimHistory

Retrieves history records of a specific expense claim


/ExpenseClaims/{ExpenseClaimID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetExpenseClaimHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var expenseClaimID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetExpenseClaimHistoryAsync(accessToken, xeroTenantId, expenseClaimID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetExpenseClaimHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ExpenseClaimID*
UUID (uuid)

Unique identifier for a ExpenseClaim

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getExpenseClaims

Retrieves expense claims


/ExpenseClaims

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetExpenseClaimsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"SUBMITTED\"";
            var order = "Status ASC";
            
            try {
                var result = await apiInstance.GetExpenseClaimsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetExpenseClaims: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getInvoice

Retrieves a specific sales invoice or purchase bill using a unique invoice Id


/Invoices/{InvoiceID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetInvoiceAsync(accessToken, xeroTenantId, invoiceID, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getInvoiceAsPdf

Retrieves invoices or purchase bills as PDF files


/Invoices/{InvoiceID}/pdf

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceAsPdfExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetInvoiceAsPdfAsync(accessToken, xeroTenantId, invoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceAsPdf: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getInvoiceAttachmentByFileName

Retrieves an attachment from a specific invoice or purchase bill by filename


/Invoices/{InvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, invoiceID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getInvoiceAttachmentById

Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id


/Invoices/{InvoiceID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetInvoiceAttachmentByIdAsync(accessToken, xeroTenantId, invoiceID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getInvoiceAttachments

Retrieves attachments for a specific invoice or purchase bill


/Invoices/{InvoiceID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetInvoiceAttachmentsAsync(accessToken, xeroTenantId, invoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getInvoiceHistory

Retrieves history records for a specific invoice


/Invoices/{InvoiceID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetInvoiceHistoryAsync(accessToken, xeroTenantId, invoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getInvoiceReminders

Retrieves invoice reminder settings


/InvoiceReminders/Settings

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoiceRemindersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetInvoiceRemindersAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoiceReminders: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getInvoices

Retrieves sales invoices or purchase bills


/Invoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"DRAFT\"";
            var order = "InvoiceNumber ASC";
            var iDs = new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
            var invoiceNumbers = new List<string>{"INV-001","INV-002"};
            var contactIDs = new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
            var statuses = new List<string>{"DRAFT","SUBMITTED"};
            var page = 1;
            var includeArchived = true;
            var createdByMyApp = false;
            var unitdp = 4;
            var summaryOnly = true;
            var pageSize = 100;
            var searchTerm = "SearchTerm=REF12";
            
            try {
                var result = await apiInstance.GetInvoicesAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, iDs, invoiceNumbers, contactIDs, statuses, page, includeArchived, createdByMyApp, unitdp, summaryOnly, pageSize, searchTerm);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
IDs
array[UUID] (uuid)

Filter by a comma-separated list of InvoicesIDs.
InvoiceNumbers
array[String]

Filter by a comma-separated list of InvoiceNumbers.
ContactIDs
array[UUID] (uuid)

Filter by a comma-separated list of ContactIDs.
Statuses
array[String]

Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
page
Integer

e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
includeArchived
Boolean

e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
createdByMyApp
Boolean

When set to true you'll only retrieve Invoices created by your app
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
summaryOnly
Boolean

Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
pageSize
Integer

Number of records to retrieve per page
searchTerm
String

Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference.

getItem

Retrieves a specific item using a unique item Id


/Items/{ItemID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetItemExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var itemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetItemAsync(accessToken, xeroTenantId, itemID, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetItem: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
ItemID*
UUID (uuid)

Unique identifier for an Item

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getItemHistory

Retrieves history for a specific item


/Items/{ItemID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetItemHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var itemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetItemHistoryAsync(accessToken, xeroTenantId, itemID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetItemHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
ItemID*
UUID (uuid)

Unique identifier for an Item

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getItems

Retrieves items


/Items

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetItemsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "IsSold==true";
            var order = "Code ASC";
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetItemsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetItems: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getJournal

Retrieves a specific journal using a unique journal Id.


/Journals/{JournalID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetJournalExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var journalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetJournalAsync(accessToken, xeroTenantId, journalID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetJournal: " + e.Message );
            }
        }
    }
}

Scopes

accounting.journals.read Grant read-only access to journals

Parameters

Path parameters
Name Description
JournalID*
UUID (uuid)

Unique identifier for a Journal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getJournalByNumber

Retrieves a specific journal using a unique journal number.


/Journals/{JournalNumber}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetJournalByNumberExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var journalNumber = 1000;
            
            try {
                var result = await apiInstance.GetJournalByNumberAsync(accessToken, xeroTenantId, journalNumber);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetJournalByNumber: " + e.Message );
            }
        }
    }
}

Scopes

accounting.journals.read Grant read-only access to journals

Parameters

Path parameters
Name Description
JournalNumber*
Integer

Number of a Journal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getJournals

Retrieves journals


/Journals

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetJournalsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var offset = 10;
            var paymentsOnly = true;
            
            try {
                var result = await apiInstance.GetJournalsAsync(accessToken, xeroTenantId, ifModifiedSince, offset, paymentsOnly);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetJournals: " + e.Message );
            }
        }
    }
}

Scopes

accounting.journals.read Grant read-only access to journals

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
offset
Integer

Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
paymentsOnly
Boolean

Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

getLinkedTransaction

Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id


/LinkedTransactions/{LinkedTransactionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetLinkedTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var linkedTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetLinkedTransactionAsync(accessToken, xeroTenantId, linkedTransactionID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetLinkedTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
LinkedTransactionID*
UUID (uuid)

Unique identifier for a LinkedTransaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getLinkedTransactions

Retrieves linked transactions (billable expenses)


/LinkedTransactions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetLinkedTransactionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var page = 1;
            var linkedTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var sourceTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var status = "APPROVED";
            var targetTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetLinkedTransactionsAsync(accessToken, xeroTenantId, page, linkedTransactionID, sourceTransactionID, contactID, status, targetTransactionID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetLinkedTransactions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
page
Integer

Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
LinkedTransactionID
UUID (uuid)

The Xero identifier for an Linked Transaction
SourceTransactionID
UUID (uuid)

Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice
ContactID
UUID (uuid)

Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
Status
String

Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status
TargetTransactionID
UUID (uuid)

Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

getManualJournal

Retrieves a specific manual journal


/ManualJournals/{ManualJournalID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetManualJournalAsync(accessToken, xeroTenantId, manualJournalID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournal: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getManualJournalAttachmentByFileName

Retrieves a specific attachment from a specific manual journal by file name


/ManualJournals/{ManualJournalID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetManualJournalAttachmentByFileNameAsync(accessToken, xeroTenantId, manualJournalID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournalAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getManualJournalAttachmentById

Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id


/ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetManualJournalAttachmentByIdAsync(accessToken, xeroTenantId, manualJournalID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournalAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getManualJournalAttachments

Retrieves attachment for a specific manual journal


/ManualJournals/{ManualJournalID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetManualJournalAttachmentsAsync(accessToken, xeroTenantId, manualJournalID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournalAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getManualJournals

Retrieves manual journals


/ManualJournals

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"DRAFT\"";
            var order = "Date ASC";
            var page = 1;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetManualJournalsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournals: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
pageSize
Integer

Number of records to retrieve per page

getManualJournalsHistory

Retrieves history for a specific manual journal


/ManualJournals/{ManualJournalID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetManualJournalsHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetManualJournalsHistoryAsync(accessToken, xeroTenantId, manualJournalID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetManualJournalsHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOnlineInvoice

Retrieves a URL to an online invoice


/Invoices/{InvoiceID}/OnlineInvoice

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOnlineInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetOnlineInvoiceAsync(accessToken, xeroTenantId, invoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOnlineInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOrganisationActions

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.


/Organisation/Actions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOrganisationActionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetOrganisationActionsAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOrganisationActions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOrganisationCISSettings

Retrieves the CIS settings for the Xero organistaion.


/Organisation/{OrganisationID}/CISSettings

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOrganisationCISSettingsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var organisationID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetOrganisationCISSettingsAsync(accessToken, xeroTenantId, organisationID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOrganisationCISSettings: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
OrganisationID*
UUID (uuid)

The unique Xero identifier for an organisation

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOrganisations

Retrieves Xero organisation details


/Organisation

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOrganisationsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetOrganisationsAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOrganisations: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOverpayment

Retrieves a specific overpayment using a unique overpayment Id


/Overpayments/{OverpaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOverpaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var overpaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetOverpaymentAsync(accessToken, xeroTenantId, overpaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOverpayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
OverpaymentID*
UUID (uuid)

Unique identifier for a Overpayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOverpaymentHistory

Retrieves history records of a specific overpayment


/Overpayments/{OverpaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOverpaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var overpaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetOverpaymentHistoryAsync(accessToken, xeroTenantId, overpaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOverpaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
OverpaymentID*
UUID (uuid)

Unique identifier for a Overpayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getOverpayments

Retrieves overpayments


/Overpayments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetOverpaymentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"AUTHORISED\"";
            var order = "Status ASC";
            var page = 1;
            var unitdp = 4;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetOverpaymentsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetOverpayments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
pageSize
Integer

Number of records to retrieve per page

getPayment

Retrieves a specific payment for invoices and credit notes using a unique payment Id


/Payments/{PaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var paymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPaymentAsync(accessToken, xeroTenantId, paymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PaymentID*
UUID (uuid)

Unique identifier for a Payment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPaymentHistory

Retrieves history records of a specific payment


/Payments/{PaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var paymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPaymentHistoryAsync(accessToken, xeroTenantId, paymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PaymentID*
UUID (uuid)

Unique identifier for a Payment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPaymentServices

Retrieves payment services


/PaymentServices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPaymentServicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetPaymentServicesAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPaymentServices: " + e.Message );
            }
        }
    }
}

Scopes

paymentservices Grant read-write access to payment services

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPayments

Retrieves payments for invoices and credit notes


/Payments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPaymentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"AUTHORISED\"";
            var order = "Amount ASC";
            var page = 1;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetPaymentsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPayments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

Up to 100 payments will be returned in a single API call
pageSize
Integer

Number of records to retrieve per page

getPrepayment

Allows you to retrieve a specified prepayments


/Prepayments/{PrepaymentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPrepaymentExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var prepaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPrepaymentAsync(accessToken, xeroTenantId, prepaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPrepayment: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PrepaymentID*
UUID (uuid)

Unique identifier for a PrePayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPrepaymentHistory

Retrieves history record for a specific prepayment


/Prepayments/{PrepaymentID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPrepaymentHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var prepaymentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPrepaymentHistoryAsync(accessToken, xeroTenantId, prepaymentID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPrepaymentHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PrepaymentID*
UUID (uuid)

Unique identifier for a PrePayment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPrepayments

Retrieves prepayments


/Prepayments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPrepaymentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"AUTHORISED\"";
            var order = "Reference ASC";
            var page = 1;
            var unitdp = 4;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetPrepaymentsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPrepayments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
page
Integer

e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
pageSize
Integer

Number of records to retrieve per page

getPurchaseOrder

Retrieves a specific purchase order using a unique purchase order Id


/PurchaseOrders/{PurchaseOrderID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPurchaseOrderAsync(accessToken, xeroTenantId, purchaseOrderID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrder: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPurchaseOrderAsPdf

Retrieves specific purchase order as PDF files using a unique purchase order Id


/PurchaseOrders/{PurchaseOrderID}/pdf

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderAsPdfExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPurchaseOrderAsPdfAsync(accessToken, xeroTenantId, purchaseOrderID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderAsPdf: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPurchaseOrderAttachmentByFileName

Retrieves a specific attachment for a specific purchase order by filename


/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetPurchaseOrderAttachmentByFileNameAsync(accessToken, xeroTenantId, purchaseOrderID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getPurchaseOrderAttachmentById

Retrieves specific attachment for a specific purchase order using a unique attachment Id


/PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetPurchaseOrderAttachmentByIdAsync(accessToken, xeroTenantId, purchaseOrderID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getPurchaseOrderAttachments

Retrieves attachments for a specific purchase order


/PurchaseOrders/{PurchaseOrderID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPurchaseOrderAttachmentsAsync(accessToken, xeroTenantId, purchaseOrderID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPurchaseOrderByNumber

Retrieves a specific purchase order using purchase order number


/PurchaseOrders/{PurchaseOrderNumber}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderByNumberExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderNumber = "PO1234";
            
            try {
                var result = await apiInstance.GetPurchaseOrderByNumberAsync(accessToken, xeroTenantId, purchaseOrderNumber);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderByNumber: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PurchaseOrderNumber*
String

Unique identifier for a PurchaseOrder

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPurchaseOrderHistory

Retrieves history for a specific purchase order


/PurchaseOrders/{PurchaseOrderID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrderHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetPurchaseOrderHistoryAsync(accessToken, xeroTenantId, purchaseOrderID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrderHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getPurchaseOrders

Retrieves purchase orders


/PurchaseOrders

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetPurchaseOrdersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var status = "SUBMITTED";
            var dateFrom = "2019-12-01";
            var dateTo = "2019-12-31";
            var order = "PurchaseOrderNumber ASC";
            var page = 1;
            var pageSize = 100;
            
            try {
                var result = await apiInstance.GetPurchaseOrdersAsync(accessToken, xeroTenantId, ifModifiedSince, status, dateFrom, dateTo, order, page, pageSize);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetPurchaseOrders: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
Status
String

Filter by purchase order status
DateFrom
String

Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
DateTo
String

Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
order
String

Order by an any element
page
Integer

To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
pageSize
Integer

Number of records to retrieve per page

getQuote

Retrieves a specific quote using a unique quote Id


/Quotes/{QuoteID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetQuoteAsync(accessToken, xeroTenantId, quoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuote: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getQuoteAsPdf

Retrieves a specific quote as a PDF file using a unique quote Id


/Quotes/{QuoteID}/pdf

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteAsPdfExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetQuoteAsPdfAsync(accessToken, xeroTenantId, quoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuoteAsPdf: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getQuoteAttachmentByFileName

Retrieves a specific attachment from a specific quote by filename


/Quotes/{QuoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetQuoteAttachmentByFileNameAsync(accessToken, xeroTenantId, quoteID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getQuoteAttachmentById

Retrieves a specific attachment from a specific quote using a unique attachment Id


/Quotes/{QuoteID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetQuoteAttachmentByIdAsync(accessToken, xeroTenantId, quoteID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuoteAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getQuoteAttachments

Retrieves attachments for a specific quote


/Quotes/{QuoteID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetQuoteAttachmentsAsync(accessToken, xeroTenantId, quoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuoteAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getQuoteHistory

Retrieves history records of a specific quote


/Quotes/{QuoteID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuoteHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetQuoteHistoryAsync(accessToken, xeroTenantId, quoteID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuoteHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getQuotes

Retrieves sales quotes


/Quotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetQuotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var dateFrom = DateTime.Parse("2019-10-31");
            var dateTo = DateTime.Parse("2019-10-31");
            var expiryDateFrom = DateTime.Parse("2019-10-31");
            var expiryDateTo = DateTime.Parse("2019-10-31");
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var status = "DRAFT";
            var page = 1;
            var order = "Status ASC";
            var quoteNumber = "QU-0001";
            
            try {
                var result = await apiInstance.GetQuotesAsync(accessToken, xeroTenantId, ifModifiedSince, dateFrom, dateTo, expiryDateFrom, expiryDateTo, contactID, status, page, order, quoteNumber);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetQuotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
DateFrom
date (date)

Filter for quotes after a particular date
DateTo
date (date)

Filter for quotes before a particular date
ExpiryDateFrom
date (date)

Filter for quotes expiring after a particular date
ExpiryDateTo
date (date)

Filter for quotes before a particular date
ContactID
UUID (uuid)

Filter for quotes belonging to a particular contact
Status
String

Filter for quotes of a particular Status
page
Integer

e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote
order
String

Order by an any element
QuoteNumber
String

Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)

getReceipt

Retrieves a specific draft expense claim receipt by using a unique receipt Id


/Receipts/{ReceiptID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetReceiptAsync(accessToken, xeroTenantId, receiptID, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceipt: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getReceiptAttachmentByFileName

Retrieves a specific attachment from a specific expense claim receipts by file name


/Receipts/{ReceiptID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetReceiptAttachmentByFileNameAsync(accessToken, xeroTenantId, receiptID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceiptAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getReceiptAttachmentById

Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id


/Receipts/{ReceiptID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetReceiptAttachmentByIdAsync(accessToken, xeroTenantId, receiptID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceiptAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getReceiptAttachments

Retrieves attachments for a specific expense claim receipt


/Receipts/{ReceiptID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetReceiptAttachmentsAsync(accessToken, xeroTenantId, receiptID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceiptAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getReceiptHistory

Retrieves a history record for a specific receipt


/Receipts/{ReceiptID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetReceiptHistoryAsync(accessToken, xeroTenantId, receiptID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceiptHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getReceipts

Retrieves draft expense claim receipts for any user


/Receipts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReceiptsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "Status==\"DRAFT\"";
            var order = "ReceiptNumber ASC";
            var unitdp = 4;
            
            try {
                var result = await apiInstance.GetReceiptsAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, unitdp);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReceipts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

getRepeatingInvoice

Retrieves a specific repeating invoice by using a unique repeating invoice Id


/RepeatingInvoices/{RepeatingInvoiceID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetRepeatingInvoiceAsync(accessToken, xeroTenantId, repeatingInvoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getRepeatingInvoiceAttachmentByFileName

Retrieves a specific attachment from a specific repeating invoices by file name


/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetRepeatingInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, repeatingInvoiceID, fileName, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getRepeatingInvoiceAttachmentById

Retrieves a specific attachment from a specific repeating invoice


/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoiceAttachmentByIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var attachmentID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var contentType = "image/jpg";
            
            try {
                var result = await apiInstance.GetRepeatingInvoiceAttachmentByIdAsync(accessToken, xeroTenantId, repeatingInvoiceID, attachmentID, contentType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoiceAttachmentById: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
AttachmentID*
UUID (uuid)

Unique identifier for Attachment object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
contentType*
String

The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

Required

getRepeatingInvoiceAttachments

Retrieves attachments from a specific repeating invoice


/RepeatingInvoices/{RepeatingInvoiceID}/Attachments

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoiceAttachmentsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetRepeatingInvoiceAttachmentsAsync(accessToken, xeroTenantId, repeatingInvoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoiceAttachments: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments
accounting.attachments.read Grant read-only access to attachments

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getRepeatingInvoiceHistory

Retrieves history record for a specific repeating invoice


/RepeatingInvoices/{RepeatingInvoiceID}/History

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoiceHistoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetRepeatingInvoiceHistoryAsync(accessToken, xeroTenantId, repeatingInvoiceID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoiceHistory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getRepeatingInvoices

Retrieves repeating invoices


/RepeatingInvoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetRepeatingInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var where = "Status==\"DRAFT\"";
            var order = "Total ASC";
            
            try {
                var result = await apiInstance.GetRepeatingInvoicesAsync(accessToken, xeroTenantId, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetRepeatingInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read Grant read-only access to invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getReportAgedPayablesByContact

Retrieves report for aged payables by contact


/Reports/AgedPayablesByContact

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportAgedPayablesByContactExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactId = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var date = DateTime.Parse("2019-10-31");
            var fromDate = DateTime.Parse("2019-10-31");
            var toDate = DateTime.Parse("2019-10-31");
            
            try {
                var result = await apiInstance.GetReportAgedPayablesByContactAsync(accessToken, xeroTenantId, contactId, date, fromDate, toDate);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportAgedPayablesByContact: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
contactId*
UUID (uuid)

Unique identifier for a Contact

Required
date
date (date)

The date of the Aged Payables By Contact report
fromDate
date (date)

filter by the from date of the report e.g. 2021-02-01
toDate
date (date)

filter by the to date of the report e.g. 2021-02-28

getReportAgedReceivablesByContact

Retrieves report for aged receivables by contact


/Reports/AgedReceivablesByContact

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportAgedReceivablesByContactExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactId = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var date = DateTime.Parse("2019-10-31");
            var fromDate = DateTime.Parse("2019-10-31");
            var toDate = DateTime.Parse("2019-10-31");
            
            try {
                var result = await apiInstance.GetReportAgedReceivablesByContactAsync(accessToken, xeroTenantId, contactId, date, fromDate, toDate);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportAgedReceivablesByContact: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
contactId*
UUID (uuid)

Unique identifier for a Contact

Required
date
date (date)

The date of the Aged Receivables By Contact report
fromDate
date (date)

filter by the from date of the report e.g. 2021-02-01
toDate
date (date)

filter by the to date of the report e.g. 2021-02-28

getReportBalanceSheet

Retrieves report for balancesheet


/Reports/BalanceSheet

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportBalanceSheetExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var date = DateTime.Parse("2019-11-01");
            var periods = 3;
            var timeframe = "MONTH";
            var trackingOptionID1 = "00000000-0000-0000-0000-000000000000";
            var trackingOptionID2 = "00000000-0000-0000-0000-000000000000";
            var standardLayout = true;
            var paymentsOnly = false;
            
            try {
                var result = await apiInstance.GetReportBalanceSheetAsync(accessToken, xeroTenantId, date, periods, timeframe, trackingOptionID1, trackingOptionID2, standardLayout, paymentsOnly);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportBalanceSheet: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
date
date (date)

The date of the Balance Sheet report
periods
Integer

The number of periods for the Balance Sheet report
timeframe
String

The period size to compare to (MONTH, QUARTER, YEAR)
trackingOptionID1
String

The tracking option 1 for the Balance Sheet report
trackingOptionID2
String

The tracking option 2 for the Balance Sheet report
standardLayout
Boolean

The standard layout boolean for the Balance Sheet report
paymentsOnly
Boolean

return a cash basis for the Balance Sheet report

getReportBankSummary

Retrieves report for bank summary


/Reports/BankSummary

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportBankSummaryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var fromDate = DateTime.Parse("2019-10-31");
            var toDate = DateTime.Parse("2019-10-31");
            
            try {
                var result = await apiInstance.GetReportBankSummaryAsync(accessToken, xeroTenantId, fromDate, toDate);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportBankSummary: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
fromDate
date (date)

filter by the from date of the report e.g. 2021-02-01
toDate
date (date)

filter by the to date of the report e.g. 2021-02-28

getReportBudgetSummary

Retrieves report for budget summary


/Reports/BudgetSummary

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportBudgetSummaryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var date = DateTime.Parse("2019-03-31");
            var periods = 2;
            var timeframe = 3;
            
            try {
                var result = await apiInstance.GetReportBudgetSummaryAsync(accessToken, xeroTenantId, date, periods, timeframe);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportBudgetSummary: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
date
date (date)

The date for the Bank Summary report e.g. 2018-03-31
periods
Integer

The number of periods to compare (integer between 1 and 12)
timeframe
Integer

The period size to compare to (1=month, 3=quarter, 12=year)

getReportExecutiveSummary

Retrieves report for executive summary


/Reports/ExecutiveSummary

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportExecutiveSummaryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var date = DateTime.Parse("2019-03-31");
            
            try {
                var result = await apiInstance.GetReportExecutiveSummaryAsync(accessToken, xeroTenantId, date);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportExecutiveSummary: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
date
date (date)

The date for the Bank Summary report e.g. 2018-03-31

getReportFromId

Retrieves a specific report using a unique ReportID


/Reports/{ReportID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportFromIdExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var reportID = "00000000-0000-0000-0000-000000000000";
            
            try {
                var result = await apiInstance.GetReportFromIdAsync(accessToken, xeroTenantId, reportID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportFromId: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Path parameters
Name Description
ReportID*
String

Unique identifier for a Report

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getReportProfitAndLoss

Retrieves report for profit and loss


/Reports/ProfitAndLoss

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportProfitAndLossExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var fromDate = DateTime.Parse("2019-10-31");
            var toDate = DateTime.Parse("2019-10-31");
            var periods = 3;
            var timeframe = "MONTH";
            var trackingCategoryID = "00000000-0000-0000-0000-000000000000";
            var trackingCategoryID2 = "00000000-0000-0000-0000-000000000000";
            var trackingOptionID = "00000000-0000-0000-0000-000000000000";
            var trackingOptionID2 = "00000000-0000-0000-0000-000000000000";
            var standardLayout = true;
            var paymentsOnly = false;
            
            try {
                var result = await apiInstance.GetReportProfitAndLossAsync(accessToken, xeroTenantId, fromDate, toDate, periods, timeframe, trackingCategoryID, trackingCategoryID2, trackingOptionID, trackingOptionID2, standardLayout, paymentsOnly);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportProfitAndLoss: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
fromDate
date (date)

filter by the from date of the report e.g. 2021-02-01
toDate
date (date)

filter by the to date of the report e.g. 2021-02-28
periods
Integer

The number of periods to compare (integer between 1 and 12)
timeframe
String

The period size to compare to (MONTH, QUARTER, YEAR)
trackingCategoryID
String

The trackingCategory 1 for the ProfitAndLoss report
trackingCategoryID2
String

The trackingCategory 2 for the ProfitAndLoss report
trackingOptionID
String

The tracking option 1 for the ProfitAndLoss report
trackingOptionID2
String

The tracking option 2 for the ProfitAndLoss report
standardLayout
Boolean

Return the standard layout for the ProfitAndLoss report
paymentsOnly
Boolean

Return cash only basis for the ProfitAndLoss report

getReportTenNinetyNine

Retrieve reports for 1099


/Reports/TenNinetyNine

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportTenNinetyNineExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var reportYear = "2019";
            
            try {
                var result = await apiInstance.GetReportTenNinetyNineAsync(accessToken, xeroTenantId, reportYear);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportTenNinetyNine: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports
accounting.reports.tenninetynine.read Grant read-only access to 1099 reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
reportYear
String

The year of the 1099 report

getReportTrialBalance

Retrieves report for trial balance


/Reports/TrialBalance

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportTrialBalanceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var date = DateTime.Parse("2019-10-31");
            var paymentsOnly = true;
            
            try {
                var result = await apiInstance.GetReportTrialBalanceAsync(accessToken, xeroTenantId, date, paymentsOnly);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportTrialBalance: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
date
date (date)

The date for the Trial Balance report e.g. 2018-03-31
paymentsOnly
Boolean

Return cash only basis for the Trial Balance report

getReportsList

Retrieves a list of the organistaions unique reports that require a uuid to fetch


/Reports

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetReportsListExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            
            try {
                var result = await apiInstance.GetReportsListAsync(accessToken, xeroTenantId);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetReportsList: " + e.Message );
            }
        }
    }
}

Scopes

accounting.reports.read Grant read-only access to accounting reports

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getTaxRateByTaxType

Retrieves a specific tax rate according to given TaxType code


/TaxRates/{TaxType}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetTaxRateByTaxTypeExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var taxType = "INPUT2";
            
            try {
                var result = await apiInstance.GetTaxRateByTaxTypeAsync(accessToken, xeroTenantId, taxType);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetTaxRateByTaxType: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
TaxType*
String

A valid TaxType code

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getTaxRates

Retrieves tax rates


/TaxRates

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetTaxRatesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var where = "Status==\"ACTIVE\"";
            var order = "Name ASC";
            
            try {
                var result = await apiInstance.GetTaxRatesAsync(accessToken, xeroTenantId, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetTaxRates: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

getTrackingCategories

Retrieves tracking categories and options


/TrackingCategories

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetTrackingCategoriesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var where = "Status==\"ACTIVE\"";
            var order = "Name ASC";
            var includeArchived = true;
            
            try {
                var result = await apiInstance.GetTrackingCategoriesAsync(accessToken, xeroTenantId, where, order, includeArchived);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetTrackingCategories: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element
includeArchived
Boolean

e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

getTrackingCategory

Retrieves specific tracking categories and options using a unique tracking category Id


/TrackingCategories/{TrackingCategoryID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetTrackingCategoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetTrackingCategoryAsync(accessToken, xeroTenantId, trackingCategoryID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetTrackingCategory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getUser

Retrieves a specific user


/Users/{UserID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetUserExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var userID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            
            try {
                var result = await apiInstance.GetUserAsync(accessToken, xeroTenantId, userID);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetUser: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Path parameters
Name Description
UserID*
UUID (uuid)

Unique identifier for a User

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required

getUsers

Retrieves users


/Users

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class GetUsersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var ifModifiedSince = DateTime.Parse("2020-02-06T12:17:43.202-08:00");
            var where = "IsSubscriber==true";
            var order = "LastName ASC";
            
            try {
                var result = await apiInstance.GetUsersAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.GetUsers: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings
accounting.settings.read Grant read-only access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
If-Modified-Since
Date (date-time)

Only records created or modified since this timestamp will be returned
Query parameters
Name Description
where
String

Filter by an any element
order
String

Order by an any element

postSetup

Sets the chart of accounts, the conversion date and conversion balances


/Setup

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class PostSetupExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var account = new Account();
            account.Code = "123";
            account.Name = "Business supplies";
            account.Type = AccountType.EXPENSE;
            var accounts = new List<Account>();
            accounts.Add(account);

            var conversionDate = new ConversionDate();
            conversionDate.Month = 10;
            conversionDate.Year = 2020;
            var conversionBalances = new List<ConversionBalances>();

            var setup = new Setup();
            setup.Accounts = accounts;
            setup.ConversionDate = conversionDate;
            setup.ConversionBalances = conversionBalances;
            
            try {
                var result = await apiInstance.PostSetupAsync(accessToken, xeroTenantId, setup, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.PostSetup: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
setup *
Setup 
      Object including an accounts array, a conversion balances array and a conversion date object in body of request
Required

updateAccount

Updates a chart of accounts


/Accounts/{AccountID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateAccountExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var account = new Account();
            account.Code = "123456";
            account.Name = "BarFoo";
            account.Type = AccountType.EXPENSE;
            account.Description = "Hello World";
            account.TaxType = "NONE";

            var accounts = new Accounts();
            var accountsList = new List<Account>();
            accountsList.Add(account); 
            accounts._Accounts = accountsList;
            
            try {
                var result = await apiInstance.UpdateAccountAsync(accessToken, xeroTenantId, accountID, accounts, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateAccount: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
accounts *
Accounts 
      Request of type Accounts array with one Account
Required

updateAccountAttachmentByFileName

Updates attachment on a specific account by filename


/Accounts/{AccountID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateAccountAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var accountID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateAccountAttachmentByFileNameAsync(accessToken, xeroTenantId, accountID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateAccountAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
AccountID*
UUID (uuid)

Unique identifier for Account object

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateBankTransaction

Updates a single spent or received money transaction


/BankTransactions/{BankTransactionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateBankTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var bankAccount = new Account();
            bankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var bankTransaction = new BankTransaction();
            bankTransaction.Reference = "You just updated";
            bankTransaction.Type = BankTransaction.TypeEnum.RECEIVE;
            bankTransaction.Contact = contact;
            bankTransaction.LineItems = lineItems;
            bankTransaction.BankAccount = bankAccount;

            var bankTransactions = new BankTransactions();
            var bankTransactionsList = new List<BankTransaction>();
            bankTransactionsList.Add(bankTransaction); 
            bankTransactions._BankTransactions = bankTransactionsList;
            
            try {
                var result = await apiInstance.UpdateBankTransactionAsync(accessToken, xeroTenantId, bankTransactionID, bankTransactions, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateBankTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
bankTransactions *
BankTransactions
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateBankTransactionAttachmentByFileName

Updates a specific attachment from a specific bank transaction by filename


/BankTransactions/{BankTransactionID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateBankTransactionAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateBankTransactionAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransactionID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateBankTransactionAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
BankTransactionID*
UUID (uuid)

Xero generated unique identifier for a bank transaction

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateBankTransferAttachmentByFileName


/BankTransfers/{BankTransferID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateBankTransferAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var bankTransferID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateBankTransferAttachmentByFileNameAsync(accessToken, xeroTenantId, bankTransferID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateBankTransferAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
BankTransferID*
UUID (uuid)

Xero generated unique identifier for a bank transfer

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateContact

Updates a specific contact in a Xero organisation


/Contacts/{ContactID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateContactExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.Name = "Thanos";
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var contacts = new Contacts();
            var contactsList = new List<Contact>();
            contactsList.Add(contact); 
            contacts._Contacts = contactsList;
            
            try {
                var result = await apiInstance.UpdateContactAsync(accessToken, xeroTenantId, contactID, contacts, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateContact: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contacts *
Contacts 
      an array of Contacts containing single Contact object with properties to update
Required

updateContactAttachmentByFileName


/Contacts/{ContactID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateContactAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateContactAttachmentByFileNameAsync(accessToken, xeroTenantId, contactID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateContactAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ContactID*
UUID (uuid)

Unique identifier for a Contact

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateContactGroup

Updates a specific contact group


/ContactGroups/{ContactGroupID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateContactGroupExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var contactGroupID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var contactGroup = new ContactGroup();
            contactGroup.Name = "Vendor";

            var contactGroups = new ContactGroups();
            var contactGroupsList = new List<ContactGroup>();
            contactGroupsList.Add(contactGroup); 
            contactGroups._ContactGroups = contactGroupsList;
            
            try {
                var result = await apiInstance.UpdateContactGroupAsync(accessToken, xeroTenantId, contactGroupID, contactGroups, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateContactGroup: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Path parameters
Name Description
ContactGroupID*
UUID (uuid)

Unique identifier for a Contact Group

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contactGroups *
ContactGroups 
      an array of Contact groups with Name of specific group to update
Required

updateCreditNote

Updates a specific credit note


/CreditNotes/{CreditNoteID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateCreditNoteExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var creditNote = new CreditNote();
            creditNote.Type = CreditNote.TypeEnum.ACCPAYCREDIT;
            creditNote.Status = CreditNote.StatusEnum.AUTHORISED;
            creditNote.Reference = "My ref.";
            creditNote.Contact = contact;
            creditNote.Date = currDate;
            creditNote.LineItems = lineItems;

            var creditNotes = new CreditNotes();
            var creditNotesList = new List<CreditNote>();
            creditNotesList.Add(creditNote); 
            creditNotes._CreditNotes = creditNotesList;
            
            try {
                var result = await apiInstance.UpdateCreditNoteAsync(accessToken, xeroTenantId, creditNoteID, creditNotes, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateCreditNote: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
creditNotes *
CreditNotes 
      an array of Credit Notes containing credit note details to update
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateCreditNoteAttachmentByFileName

Updates attachments on a specific credit note by file name


/CreditNotes/{CreditNoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateCreditNoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateCreditNoteAttachmentByFileNameAsync(accessToken, xeroTenantId, creditNoteID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateCreditNoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
CreditNoteID*
UUID (uuid)

Unique identifier for a Credit Note

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateExpenseClaim

Updates a specific expense claims


/ExpenseClaims/{ExpenseClaimID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateExpenseClaimExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var expenseClaimID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var user = new User();
            user.UserID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var receipt = new Receipt();
            receipt.ReceiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            receipt.Date = currDate;
            var receipts = new List<Receipt>();
            receipts.Add(receipt);

            var expenseClaim = new ExpenseClaim();
            expenseClaim.Status = ExpenseClaim.StatusEnum.SUBMITTED;
            expenseClaim.User = user;
            expenseClaim.Receipts = receipts;

            var expenseClaims = new ExpenseClaims();
            var expenseClaimsList = new List<ExpenseClaim>();
            expenseClaimsList.Add(expenseClaim); 
            expenseClaims._ExpenseClaims = expenseClaimsList;
            
            try {
                var result = await apiInstance.UpdateExpenseClaimAsync(accessToken, xeroTenantId, expenseClaimID, expenseClaims, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateExpenseClaim: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ExpenseClaimID*
UUID (uuid)

Unique identifier for a ExpenseClaim

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
expenseClaims *
ExpenseClaims
Required

updateInvoice

Updates a specific sales invoices or purchase bills


/Invoices/{InvoiceID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var invoice = new Invoice();
            invoice.Reference = "I am Iron man";

            var invoices = new Invoices();
            var invoicesList = new List<Invoice>();
            invoicesList.Add(invoice); 
            invoices._Invoices = invoicesList;
            
            try {
                var result = await apiInstance.UpdateInvoiceAsync(accessToken, xeroTenantId, invoiceID, invoices, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
invoices *
Invoices
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateInvoiceAttachmentByFileName

Updates an attachment from a specific invoices or purchase bill by filename


/Invoices/{InvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, invoiceID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
InvoiceID*
UUID (uuid)

Unique identifier for an Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateItem

Updates a specific item


/Items/{ItemID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateItemExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var itemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var item = new Item();
            item.Code = "ItemCode123";
            item.Description = "Goodbye";

            var items = new Items();
            var itemsList = new List<Item>();
            itemsList.Add(item); 
            items._Items = itemsList;
            
            try {
                var result = await apiInstance.UpdateItemAsync(accessToken, xeroTenantId, itemID, items, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateItem: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
ItemID*
UUID (uuid)

Unique identifier for an Item

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
items *
Items
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateLinkedTransaction

Updates a specific linked transactions (billable expenses)


/LinkedTransactions/{LinkedTransactionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateLinkedTransactionExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var linkedTransactionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var linkedTransaction = new LinkedTransaction();
            linkedTransaction.SourceLineItemID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            linkedTransaction.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var linkedTransactions = new LinkedTransactions();
            var linkedTransactionsList = new List<LinkedTransaction>();
            linkedTransactionsList.Add(linkedTransaction); 
            linkedTransactions._LinkedTransactions = linkedTransactionsList;
            
            try {
                var result = await apiInstance.UpdateLinkedTransactionAsync(accessToken, xeroTenantId, linkedTransactionID, linkedTransactions, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateLinkedTransaction: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
LinkedTransactionID*
UUID (uuid)

Unique identifier for a LinkedTransaction

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
linkedTransactions *
LinkedTransactions
Required

updateManualJournal

Updates a specific manual journal


/ManualJournals/{ManualJournalID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateManualJournalExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";
            var dateValue = new DateTime(2020, 10, 10);
            var manualJournalLines = new List<ManualJournalLine>();

            var credit = new ManualJournalLine();
            credit.LineAmount = new decimal(-100.0);
            credit.AccountCode = "400";
            credit.Description = "Hello there";
            manualJournalLines.Add(credit);

            var debit = new ManualJournalLine();
            debit.LineAmount = new decimal(100.0);
            debit.AccountCode = "120";
            debit.Description = "Hello there";
            manualJournalLines.Add(debit);

            var manualJournal = new ManualJournal();
            manualJournal.Narration = "Foobar";
            manualJournal.Date = dateValue;
            manualJournal.JournalLines = manualJournalLines;

            var manualJournals = new ManualJournals();
            var manualJournalsList = new List<ManualJournal>();
            manualJournalsList.Add(manualJournal); 
            manualJournals._ManualJournals = manualJournalsList;
            
            try {
                var result = await apiInstance.UpdateManualJournalAsync(accessToken, xeroTenantId, manualJournalID, manualJournals, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateManualJournal: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
manualJournals *
ManualJournals
Required

updateManualJournalAttachmentByFileName

Updates a specific attachment from a specific manual journal by file name


/ManualJournals/{ManualJournalID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateManualJournalAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var manualJournalID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateManualJournalAttachmentByFileNameAsync(accessToken, xeroTenantId, manualJournalID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateManualJournalAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ManualJournalID*
UUID (uuid)

Unique identifier for a ManualJournal

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateOrCreateBankTransactions

Updates or creates one or more spent or received money transaction


/BankTransactions

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateBankTransactionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var bankAccount = new Account();
            bankAccount.AccountID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var bankTransaction = new BankTransaction();
            bankTransaction.Type = BankTransaction.TypeEnum.RECEIVE;
            bankTransaction.Contact = contact;
            bankTransaction.LineItems = lineItems;
            bankTransaction.BankAccount = bankAccount;

            var bankTransactions = new BankTransactions();
            var bankTransactionsList = new List<BankTransaction>();
            bankTransactionsList.Add(bankTransaction); 
            bankTransactions._BankTransactions = bankTransactionsList;
            
            try {
                var result = await apiInstance.UpdateOrCreateBankTransactionsAsync(accessToken, xeroTenantId, bankTransactions, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateBankTransactions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
bankTransactions *
BankTransactions
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateOrCreateContacts

Updates or creates one or more contacts in a Xero organisation


/Contacts

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateContactsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";

            var phone = new Phone();
            phone.PhoneNumber = "555-1212";
            phone.PhoneType = Phone.PhoneTypeEnum.MOBILE;
            var phones = new List<Phone>();
            phones.Add(phone);

            var contact = new Contact();
            contact.Name = "Bruce Banner";
            contact.EmailAddress = "hulk@avengers.com";
            contact.Phones = phones;

            var contacts = new Contacts();
            var contactsList = new List<Contact>();
            contactsList.Add(contact); 
            contacts._Contacts = contactsList;
            
            try {
                var result = await apiInstance.UpdateOrCreateContactsAsync(accessToken, xeroTenantId, contacts, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateContacts: " + e.Message );
            }
        }
    }
}

Scopes

accounting.contacts Grant read-write access to contacts and contact groups

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
contacts *
Contacts
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updateOrCreateCreditNotes

Updates or creates one or more credit notes


/CreditNotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateCreditNotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var currDate = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var creditNote = new CreditNote();
            creditNote.Type = CreditNote.TypeEnum.ACCPAYCREDIT;
            creditNote.Contact = contact;
            creditNote.Date = currDate;
            creditNote.LineItems = lineItems;

            var creditNotes = new CreditNotes();
            var creditNotesList = new List<CreditNote>();
            creditNotesList.Add(creditNote); 
            creditNotes._CreditNotes = creditNotesList;
            
            try {
                var result = await apiInstance.UpdateOrCreateCreditNotesAsync(accessToken, xeroTenantId, creditNotes, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateCreditNotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
creditNotes *
CreditNotes 
      an array of Credit Notes with a single CreditNote object.
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateOrCreateEmployees

Creates a single new employees used in Xero payrun


/Employees

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateEmployeesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";

            var employee = new Employee();
            employee.FirstName = "Nick";
            employee.LastName = "Fury";

            var employees = new Employees();
            var employeesList = new List<Employee>();
            employeesList.Add(employee); 
            employees._Employees = employeesList;
            
            try {
                var result = await apiInstance.UpdateOrCreateEmployeesAsync(accessToken, xeroTenantId, employees, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateEmployees: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
employees *
Employees 
      Employees with array of Employee object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updateOrCreateInvoices

Updates or creates one or more sales invoices or purchase bills


/Invoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = new DateTime(2020, 10, 10);
            var dueDateValue = new DateTime(2020, 10, 10);

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var invoice = new Invoice();
            invoice.Type = Invoice.TypeEnum.ACCREC;
            invoice.Contact = contact;
            invoice.Date = dateValue;
            invoice.Date = dueDateValue;
            invoice.LineItems = lineItems;
            invoice.Reference = "Website Design";
            invoice.Status = Invoice.StatusEnum.DRAFT;

            var invoices = new Invoices();
            var invoicesList = new List<Invoice>();
            invoicesList.Add(invoice); 
            invoices._Invoices = invoicesList;
            
            try {
                var result = await apiInstance.UpdateOrCreateInvoicesAsync(accessToken, xeroTenantId, invoices, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
invoices *
Invoices
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateOrCreateItems

Updates or creates one or more items


/Items

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateItemsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";

            var item = new Item();
            item.Code = "abcXYZ123";
            item.Name = "HelloWorld";
            item.Description = "Foobar";

            var items = new Items();
            var itemsList = new List<Item>();
            itemsList.Add(item); 
            items._Items = itemsList;
            
            try {
                var result = await apiInstance.UpdateOrCreateItemsAsync(accessToken, xeroTenantId, items, summarizeErrors, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateItems: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
items *
Items
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateOrCreateManualJournals

Updates or creates a single manual journal


/ManualJournals

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateManualJournalsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = new DateTime(2020, 10, 10);
            var manualJournalLines = new List<ManualJournalLine>();

            var credit = new ManualJournalLine();
            credit.LineAmount = new decimal(-100.0);
            credit.AccountCode = "400";
            credit.Description = "Hello there";
            manualJournalLines.Add(credit);

            var debit = new ManualJournalLine();
            debit.LineAmount = new decimal(100.0);
            debit.AccountCode = "120";
            debit.Description = "Hello there";
            manualJournalLines.Add(debit);

            var manualJournal = new ManualJournal();
            manualJournal.Narration = "Foobar";
            manualJournal.Date = dateValue;
            manualJournal.JournalLines = manualJournalLines;

            var manualJournals = new ManualJournals();
            var manualJournalsList = new List<ManualJournal>();
            manualJournalsList.Add(manualJournal); 
            manualJournals._ManualJournals = manualJournalsList;
            
            try {
                var result = await apiInstance.UpdateOrCreateManualJournalsAsync(accessToken, xeroTenantId, manualJournals, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateManualJournals: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
manualJournals *
ManualJournals 
      ManualJournals array with ManualJournal object in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updateOrCreatePurchaseOrders

Updates or creates one or more purchase orders


/PurchaseOrders

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreatePurchaseOrdersExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var purchaseOrder = new PurchaseOrder();
            purchaseOrder.Contact = contact;
            purchaseOrder.LineItems = lineItems;
            purchaseOrder.Date = dateValue;

            var purchaseOrders = new PurchaseOrders();
            var purchaseOrdersList = new List<PurchaseOrder>();
            purchaseOrdersList.Add(purchaseOrder); 
            purchaseOrders._PurchaseOrders = purchaseOrdersList;
            
            try {
                var result = await apiInstance.UpdateOrCreatePurchaseOrdersAsync(accessToken, xeroTenantId, purchaseOrders, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreatePurchaseOrders: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
purchaseOrders *
PurchaseOrders
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updateOrCreateQuotes

Updates or creates one or more quotes


/Quotes

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateQuotesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var lineItem = new LineItem();
            lineItem.Description = "Foobar";
            lineItem.Quantity = new decimal(1.0);
            lineItem.UnitAmount = new decimal(20.0);
            lineItem.AccountCode = "000";
            var lineItems = new List<LineItem>();
            lineItems.Add(lineItem);

            var quote = new Quote();
            quote.Contact = contact;
            quote.LineItems = lineItems;
            quote.Date = dateValue;

            var quotes = new Quotes();
            var quotesList = new List<Quote>();
            quotesList.Add(quote); 
            quotes._Quotes = quotesList;
            
            try {
                var result = await apiInstance.UpdateOrCreateQuotesAsync(accessToken, xeroTenantId, quotes, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateQuotes: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
quotes *
Quotes
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updateOrCreateRepeatingInvoices

Creates or deletes one or more repeating invoice templates


/RepeatingInvoices

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateOrCreateRepeatingInvoicesExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var summarizeErrors = true;
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateOrCreateRepeatingInvoicesAsync(accessToken, xeroTenantId, repeatingInvoices, summarizeErrors, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateOrCreateRepeatingInvoices: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
repeatingInvoices *
RepeatingInvoices 
      RepeatingInvoices with an array of repeating invoice objects in body of request
Required
Query parameters
Name Description
summarizeErrors
Boolean

If false return 200 OK and mix of successfully created objects and any with validation errors

updatePurchaseOrder

Updates a specific purchase order


/PurchaseOrders/{PurchaseOrderID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdatePurchaseOrderExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var purchaseOrder = new PurchaseOrder();
            purchaseOrder.AttentionTo = "Peter Parker";

            var purchaseOrders = new PurchaseOrders();
            var purchaseOrdersList = new List<PurchaseOrder>();
            purchaseOrdersList.Add(purchaseOrder); 
            purchaseOrders._PurchaseOrders = purchaseOrdersList;
            
            try {
                var result = await apiInstance.UpdatePurchaseOrderAsync(accessToken, xeroTenantId, purchaseOrderID, purchaseOrders, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdatePurchaseOrder: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
purchaseOrders *
PurchaseOrders
Required

updatePurchaseOrderAttachmentByFileName

Updates a specific attachment for a specific purchase order by filename


/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdatePurchaseOrderAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var purchaseOrderID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdatePurchaseOrderAttachmentByFileNameAsync(accessToken, xeroTenantId, purchaseOrderID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdatePurchaseOrderAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
PurchaseOrderID*
UUID (uuid)

Unique identifier for an Purchase Order

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateQuote

Updates a specific quote


/Quotes/{QuoteID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateQuoteExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var contact = new Contact();
            contact.ContactID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var quote = new Quote();
            quote.Reference = "I am an update";
            quote.Contact = contact;
            quote.Date = dateValue;

            var quotes = new Quotes();
            var quotesList = new List<Quote>();
            quotesList.Add(quote); 
            quotes._Quotes = quotesList;
            
            try {
                var result = await apiInstance.UpdateQuoteAsync(accessToken, xeroTenantId, quoteID, quotes, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateQuote: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
quotes *
Quotes
Required

updateQuoteAttachmentByFileName

Updates a specific attachment from a specific quote by filename


/Quotes/{QuoteID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateQuoteAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var quoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateQuoteAttachmentByFileNameAsync(accessToken, xeroTenantId, quoteID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateQuoteAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
QuoteID*
UUID (uuid)

Unique identifier for an Quote

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateReceipt

Updates a specific draft expense claim receipts


/Receipts/{ReceiptID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateReceiptExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var unitdp = 4;
            var idempotencyKey = "KEY_VALUE";
            var dateValue = DateTime.Now;

            var user = new User();
            user.UserID = Guid.Parse("00000000-0000-0000-0000-000000000000");

            var receipt = new Receipt();
            receipt.User = user;
            receipt.Reference = "Foobar";
            receipt.Date = dateValue;

            var receipts = new Receipts();
            var receiptsList = new List<Receipt>();
            receiptsList.Add(receipt); 
            receipts._Receipts = receiptsList;
            
            try {
                var result = await apiInstance.UpdateReceiptAsync(accessToken, xeroTenantId, receiptID, receipts, unitdp, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateReceipt: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
receipts *
Receipts
Required
Query parameters
Name Description
unitdp
Integer

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

updateReceiptAttachmentByFileName

Updates a specific attachment on a specific expense claim receipts by file name


/Receipts/{ReceiptID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateReceiptAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var receiptID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateReceiptAttachmentByFileNameAsync(accessToken, xeroTenantId, receiptID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateReceiptAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
ReceiptID*
UUID (uuid)

Unique identifier for a Receipt

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateRepeatingInvoice

Deletes a specific repeating invoice template


/RepeatingInvoices/{RepeatingInvoiceID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateRepeatingInvoiceExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateRepeatingInvoiceAsync(accessToken, xeroTenantId, repeatingInvoiceID, repeatingInvoices, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateRepeatingInvoice: " + e.Message );
            }
        }
    }
}

Scopes

accounting.transactions Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
repeatingInvoices *
RepeatingInvoices
Required

updateRepeatingInvoiceAttachmentByFileName

Updates a specific attachment from a specific repeating invoices by file name


/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateRepeatingInvoiceAttachmentByFileNameExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var repeatingInvoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var fileName = "xero-dev.jpg";
            var idempotencyKey = "KEY_VALUE";
            
            try {
                var result = await apiInstance.UpdateRepeatingInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, repeatingInvoiceID, fileName, body, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateRepeatingInvoiceAttachmentByFileName: " + e.Message );
            }
        }
    }
}

Scopes

accounting.attachments Grant read-write access to attachments

Parameters

Path parameters
Name Description
RepeatingInvoiceID*
UUID (uuid)

Unique identifier for a Repeating Invoice

Required
FileName*
String

Name of the attachment

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
body *
File 
      Byte array of file in body of request
Required

updateTaxRate

Updates tax rates


/TaxRates

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateTaxRateExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var idempotencyKey = "KEY_VALUE";

            var taxComponent = new TaxComponent();
            taxComponent.Name = "State Tax";
            taxComponent.Rate = new decimal(2.25);
            var taxComponents = new List<TaxComponent>();
            taxComponents.Add(taxComponent);

            var taxRate = new TaxRate();
            taxRate.Name = "CA State Tax";
            taxRate.TaxComponents = taxComponents;

            var taxRates = new TaxRates();
            var taxRatesList = new List<TaxRate>();
            taxRatesList.Add(taxRate); 
            taxRates._TaxRates = taxRatesList;
            
            try {
                var result = await apiInstance.UpdateTaxRateAsync(accessToken, xeroTenantId, taxRates, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateTaxRate: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
taxRates *
TaxRates
Required

updateTrackingCategory

Updates a specific tracking category


/TrackingCategories/{TrackingCategoryID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateTrackingCategoryExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var trackingCategory = new TrackingCategory();
            trackingCategory.Name = "Foobar";
            
            try {
                var result = await apiInstance.UpdateTrackingCategoryAsync(accessToken, xeroTenantId, trackingCategoryID, trackingCategory, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateTrackingCategory: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
trackingCategory *
TrackingCategory
Required

updateTrackingOptions

Updates a specific option for a specific tracking category


/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

Usage and SDK Samples

using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
using Xero.NetStandard.OAuth2.Client;
using Xero.NetStandard.OAuth2.Model;

namespace Example
{
    public class UpdateTrackingOptionsExample
    {
        public async Task Main()
        {            
            var accessToken = "YOUR_ACCESS_TOKEN";          
            var apiInstance = new AccountingApi();
            var xeroTenantId = "YOUR_XERO_TENANT_ID";
            var trackingCategoryID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var trackingOptionID = Guid.Parse("00000000-0000-0000-0000-000000000000");
            var idempotencyKey = "KEY_VALUE";

            var trackingOption = new TrackingOption();
            trackingOption.Name = "Foobar";
            
            try {
                var result = await apiInstance.UpdateTrackingOptionsAsync(accessToken, xeroTenantId, trackingCategoryID, trackingOptionID, trackingOption, idempotencyKey);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling apiInstance.UpdateTrackingOptions: " + e.Message );
            }
        }
    }
}

Scopes

accounting.settings Grant read-write access to organisation and account settings

Parameters

Path parameters
Name Description
TrackingCategoryID*
UUID (uuid)

Unique identifier for a TrackingCategory

Required
TrackingOptionID*
UUID (uuid)

Unique identifier for a Tracking Option

Required
Header parameters
Name Description
xero-tenant-id*
String

Xero identifier for Tenant

Required
Idempotency-Key
String

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Body parameters
Name Description
trackingOption *
TrackingOption
Required