+
-
-
- createEmployees
-Creates new employees used in Xero payrun
+createExpenseClaimHistory
+Creates a history record for a specific expense claim
This endpoint is deprecated and will be removed April 28, 2026
+-
/Employees/ExpenseClaims/{ExpenseClaimID}/History
Usage and SDK Samples
-
+
+
+
-
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -11516,32 +11510,31 @@ Usage and SDK Samples
namespace Example
{
- public class CreateEmployeesExample
+ public class CreateExpenseClaimHistoryExample
{
public async Task Main()
{
var accessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccountingApi();
var xeroTenantId = "YOUR_XERO_TENANT_ID";
- var summarizeErrors = true;
+ var expenseClaimID = Guid.Parse("00000000-0000-0000-0000-000000000000");
var idempotencyKey = "KEY_VALUE";
- var employee = new Employee();
- employee.FirstName = "Nick";
- employee.LastName = "Fury";
+ var historyRecord = new HistoryRecord();
+ historyRecord.Details = "Hello World";
- var employees = new Employees();
- var employeesList = new List<Employee>();
- employeesList.Add(employee);
- employees._Employees = employeesList;
+ var historyRecords = new HistoryRecords();
+ var historyRecordsList = new List<HistoryRecord>();
+ historyRecordsList.Add(historyRecord);
+ historyRecords._HistoryRecords = historyRecordsList;
try {
- var result = await apiInstance.CreateEmployeesAsync(accessToken, xeroTenantId, employees, summarizeErrors, idempotencyKey);
+ var result = await apiInstance.CreateExpenseClaimHistoryAsync(accessToken, xeroTenantId, expenseClaimID, historyRecords, idempotencyKey);
Console.WriteLine(result);
}
catch (Exception e)
{
- Console.WriteLine("Exception when calling apiInstance.CreateEmployees: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.CreateExpenseClaimHistory: " + e.Message );
}
}
}
@@ -11552,12 +11545,45 @@ Scopes
- accounting.settings
- Grant read-write access to organisation and account settings
+ 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
@@ -11568,7 +11594,7 @@ Parameters
-
+
@@ -11591,7 +11617,7 @@ Parameters
-
+
@@ -11615,15 +11641,15 @@ Parameters
Description
- employees *
+ historyRecords *
- Employees
+ HistoryRecords
- Employees with array of Employee object in body of request
+ HistoryRecords containing an array of HistoryRecord objects in body of request
@@ -11632,19 +11658,15 @@ Parameters
- Query parameters
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 |
|---|---|
| summarizeErrors | +|
| xero-tenant-id* |
-
+
- Boolean
+ String
+
-If false return 200 OK and mix of successfully created objects and any with validation errors
+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
+
+ |
-
-
+
+
-
-
@@ -11695,17 +11874,17 @@ createExpenseClaimHistory
-Creates a history record for a specific expense claim
+createInvoiceAttachmentByFileName
+Creates an attachment for a specific invoice or purchase bill by filename
createExpenseClaimHistory
-
/ExpenseClaims/{ExpenseClaimID}/History/Invoices/{InvoiceID}/Attachments/{FileName}
Usage and SDK Samples
-
+
-
-
-
-
-
-
-
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -11714,31 +11893,26 @@ Usage and SDK Samples
namespace Example
{
- public class CreateExpenseClaimHistoryExample
+ public class CreateInvoiceAttachmentByFileNameExample
{
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 invoiceID = Guid.Parse("00000000-0000-0000-0000-000000000000");
+ var fileName = "xero-dev.jpg";
+ var includeOnline = true;
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;
+ byte[] body = System.IO.File.ReadAllBytes(fileName);
try {
- var result = await apiInstance.CreateExpenseClaimHistoryAsync(accessToken, xeroTenantId, expenseClaimID, historyRecords, idempotencyKey);
+ var result = await apiInstance.CreateInvoiceAttachmentByFileNameAsync(accessToken, xeroTenantId, invoiceID, fileName, body, includeOnline, idempotencyKey);
Console.WriteLine(result);
}
catch (Exception e)
{
- Console.WriteLine("Exception when calling apiInstance.CreateExpenseClaimHistory: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.CreateInvoiceAttachmentByFileName: " + e.Message );
}
}
}
@@ -11749,8 +11923,8 @@ Scopes
- accounting.transactions
- Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
+ accounting.attachments
+ Grant read-write access to attachments
@@ -11761,11 +11935,11 @@ Parameters
Name
Description
- ExpenseClaimID*
+ InvoiceID*
-
+
@@ -11776,7 +11950,30 @@ Parameters
-Unique identifier for a ExpenseClaim
+Unique identifier for an Invoice
+
+
+
+ Required
+
+
+
+
+FileName*
+
+
+
+
+
+
+
+ String
+
+
+
+Name of the attachment
@@ -11798,408 +11995,7 @@ Parameters
-
-
-
-
- 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.
-
-
-
-
-
-
-
- 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";
- byte[] body = System.IO.File.ReadAllBytes(fileName);
-
- 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* | -
-
-
-
+
@@ -26808,483 +26604,7 @@ Parameters
- |
-
-
-
-
-
-
- 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* | -
-
-
-
+
@@ -27301,17 +26621,40 @@
Parameters |
+
| contentType* | +
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
+
+
+ Required
+
+ |
-
-
+
+
-
-
@@ -27319,17 +26662,17 @@ getCreditNotes
-Retrieves any credit notes
+getCreditNoteAttachmentById
+Retrieves a specific attachment from a specific credit note using a unique attachment Id
getCreditNotes
-
/CreditNotes/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}
Usage and SDK Samples
-
+
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -27338,27 +26681,24 @@ Usage and SDK Samples
namespace Example
{
- public class GetCreditNotesExample
+ public class GetCreditNoteAttachmentByIdExample
{
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;
+ 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.GetCreditNotesAsync(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
+ var result = await apiInstance.GetCreditNoteAttachmentByIdAsync(accessToken, xeroTenantId, creditNoteID, attachmentID, contentType);
Console.WriteLine(result);
}
catch (Exception e)
{
- Console.WriteLine("Exception when calling apiInstance.GetCreditNotes: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAttachmentById: " + e.Message );
}
}
}
@@ -27369,36 +26709,39 @@ Scopes
- accounting.transactions
- Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
+ accounting.attachments
+ Grant read-write access to attachments
- accounting.transactions.read
- Grant read-only access to invoices
+ accounting.attachments.read
+ Grant read-only access to attachments
Parameters
- Header parameters
+ Path parameters
Name
Description
- xero-tenant-id*
+ CreditNoteID*
-
+
- String
+ UUID
+
+ (uuid)
+
-Xero identifier for Tenant
+Unique identifier for a Credit Note
@@ -27409,41 +26752,44 @@ Parameters
If-Modified-Since
+ AttachmentID*
-
+
- Date
+ UUID
- (date-time)
+ (uuid)
-Only records created or modified since this timestamp will be returned
+Unique identifier for Attachment object
+
+ Required
+
- Query parameters
+ Header parameters
Name
Description
- where
+ xero-tenant-id*
-
+
@@ -27451,19 +26797,22 @@ Parameters
-Filter by an any element
+Xero identifier for Tenant
+
+ Required
+
order
+ contentType*
-
+
@@ -27471,69 +26820,12 @@ Parameters
-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
+The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
+
+ Required
+
@@ -27543,11 +26835,11 @@ Parameters
-
-
+
+
- getCurrencies
- Retrieves currencies for your Xero organisation
+ getCreditNoteAttachments
+ Retrieves attachments for a specific credit notes
@@ -27555,17 +26847,17 @@ getCurrencies
- /Currencies
+ /CreditNotes/{CreditNoteID}/Attachments
Usage and SDK Samples
-
+
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -27574,23 +26866,22 @@ Usage and SDK Samples
namespace Example
{
- public class GetCurrenciesExample
+ public class GetCreditNoteAttachmentsExample
{
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";
+ var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
try {
- var result = await apiInstance.GetCurrenciesAsync(accessToken, xeroTenantId, where, order);
+ var result = await apiInstance.GetCreditNoteAttachmentsAsync(accessToken, xeroTenantId, creditNoteID);
Console.WriteLine(result);
}
catch (Exception e)
{
- Console.WriteLine("Exception when calling apiInstance.GetCurrencies: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.GetCreditNoteAttachments: " + e.Message );
}
}
}
@@ -27601,36 +26892,39 @@ Scopes
- accounting.settings
- Grant read-write access to organisation and account settings
+ accounting.attachments
+ Grant read-write access to attachments
- accounting.settings.read
- Grant read-only access to organisation and account settings
+ accounting.attachments.read
+ Grant read-only access to attachments
Parameters
- Header parameters
+ Path parameters
Name
Description
- xero-tenant-id*
+ CreditNoteID*
-
+
- String
+ UUID
+
+ (uuid)
+
-Xero identifier for Tenant
+Unique identifier for a Credit Note
@@ -27642,37 +26936,17 @@ Parameters
- Query parameters
+ Header parameters
Name
Description
- where
-
-
-
-
-
-
-
- String
-
-
-
-Filter by an any element
-
-
-
-
-
-order
+ xero-tenant-id*
-
+
@@ -27680,9 +26954,12 @@ Parameters
-Order by an any element
+Xero identifier for Tenant
+
+ Required
+
@@ -27692,29 +26969,29 @@ Parameters
-
-
+
+
- getEmployee
- Retrieves a specific employee used in Xero payrun using a unique employee Id
+ getCreditNoteHistory
+ Retrieves history records of a specific credit note
- This endpoint is deprecated and will be removed April 28, 2026
+
- /Employees/{EmployeeID}
+ /CreditNotes/{CreditNoteID}/History
Usage and SDK Samples
-
+
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -27723,22 +27000,22 @@ Usage and SDK Samples
namespace Example
{
- public class GetEmployeeExample
+ public class GetCreditNoteHistoryExample
{
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");
+ var creditNoteID = Guid.Parse("00000000-0000-0000-0000-000000000000");
try {
- var result = await apiInstance.GetEmployeeAsync(accessToken, xeroTenantId, employeeID);
+ var result = await apiInstance.GetCreditNoteHistoryAsync(accessToken, xeroTenantId, creditNoteID);
Console.WriteLine(result);
}
catch (Exception e)
{
- Console.WriteLine("Exception when calling apiInstance.GetEmployee: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.GetCreditNoteHistory: " + e.Message );
}
}
}
@@ -27749,13 +27026,13 @@ Scopes
- accounting.settings
- Grant read-write access to organisation and account settings
+ accounting.transactions
+ Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
- accounting.settings.read
- Grant read-only access to organisation and account settings
+ accounting.transactions.read
+ Grant read-only access to invoices
@@ -27766,11 +27043,11 @@ Parameters
Name
Description
EmployeeID*
+ CreditNoteID*
-
+
@@ -27781,7 +27058,7 @@ Parameters
-Unique identifier for a Employee
+Unique identifier for a Credit Note
@@ -27803,7 +27080,7 @@ Parameters
-
+
@@ -27826,29 +27103,29 @@ Parameters
-
-
+
+
- getEmployees
- Retrieves employees used in Xero payrun
+ getCreditNotes
+ Retrieves any credit notes
- This endpoint is deprecated and will be removed April 28, 2026
+
- /Employees
+ /CreditNotes
Usage and SDK Samples
-
+
using System;
using System.Diagnostics;
using Xero.NetStandard.OAuth2.Api;
@@ -27857,7 +27134,7 @@ Usage and SDK Samples
namespace Example
{
- public class GetEmployeesExample
+ public class GetCreditNotesExample
{
public async Task Main()
{
@@ -27865,16 +27142,19 @@ Usage and SDK Samples
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";
+ var where = "Status==\"DRAFT\"";
+ var order = "CreditNoteNumber ASC";
+ var page = 1;
+ var unitdp = 4;
+ var pageSize = 100;
try {
- var result = await apiInstance.GetEmployeesAsync(accessToken, xeroTenantId, ifModifiedSince, where, order);
+ 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.GetEmployees: " + e.Message );
+ Console.WriteLine("Exception when calling apiInstance.GetCreditNotes: " + e.Message );
}
}
}
@@ -27885,13 +27165,13 @@ Scopes
- accounting.settings
- Grant read-write access to organisation and account settings
+ accounting.transactions
+ Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
- accounting.settings.read
- Grant read-only access to organisation and account settings
+ accounting.transactions.read
+ Grant read-only access to invoices
@@ -27906,7 +27186,7 @@ Parameters
-
+
@@ -27929,7 +27209,7 @@ Parameters
-
+
@@ -27959,7 +27239,7 @@ Parameters
-
+
@@ -27979,7 +27259,216 @@ Parameters
-
+
+
+
+
+ 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
+
+
+
+
@@ -46139,204 +45628,6 @@ Parameters
-
-
-
-
-
-
-
- updateOrCreateEmployees
- Creates a single new employees used in Xero payrun
-
-
-
-
- This endpoint is deprecated and will be removed April 28, 2026
-
-
- /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
-
-
-
-
-
diff --git a/docs/files/index.html b/docs/files/index.html
index 4fbd8c50..73bfaa8d 100644
--- a/docs/files/index.html
+++ b/docs/files/index.html
@@ -881,6 +881,16 @@
"description" : "The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.",
"example" : 12357
},
+ "CreatedDateUtc" : {
+ "type" : "string",
+ "description" : "The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint.",
+ "format" : "date-time"
+ },
+ "AssociationDateUtc" : {
+ "type" : "string",
+ "description" : "The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint.",
+ "format" : "date-time"
+ },
"FileId" : {
"type" : "string",
"description" : "The unique identifier of the file",