import org.openapitools.client.api.*;
import org.openapitools.client.api.client.AccountingApi;
import org.openapitools.client.models.accounting.*;
@@ -27077,19 +26430,17 @@ Usage and SDK Samples
apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
-
- OffsetDateTime ifModifiedSince = OffsetDateTime.parse("2020-02-06T12:17:43.202-08:00");
- String where = 'Status=="DRAFT"';
- String order = 'CreditNoteNumber ASC';
- Integer page = 1;
- Integer unitdp = 4;
- Integer pageSize = 100;
+ UUID creditNoteID = UUID.fromString("00000000-0000-0000-0000-000000000000");
+ UUID creditNoteID = '00000000-0000-0000-0000-000000000000';
+ UUID attachmentID = UUID.fromString("00000000-0000-0000-0000-000000000000");
+ UUID attachmentID = '00000000-0000-0000-0000-000000000000';
+ String contentType = 'image/jpg';
try {
- CreditNotes result = apiInstance.getCreditNotes(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
+ ByteArrayInputStream result = apiInstance.getCreditNoteAttachmentById(accessToken, xeroTenantId, creditNoteID, attachmentID, contentType);
System.out.println(result);
} catch (XeroException e) {
- System.err.println("Exception when calling AccountingApi#getCreditNotes");
+ System.err.println("Exception when calling AccountingApi#getCreditNoteAttachmentById");
e.printStackTrace();
}
}
@@ -27100,36 +26451,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
@@ -27140,41 +26494,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* |
-
+
@@ -27182,19 +26539,22 @@ Parameters
-Filter by an any element
+Xero identifier for Tenant
+
+ Required
+
|
- | order |
+
| contentType* |
-
+
@@ -27202,69 +26562,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
+
|
@@ -27274,11 +26577,11 @@ Parameters
-
-
+
+
-
getCurrencies
-
Retrieves currencies for your Xero organisation
+
getCreditNoteAttachments
+
Retrieves attachments for a specific credit notes
getCurrencies
- /Currencies
+ /CreditNotes/{CreditNoteID}/Attachments
Usage and SDK Samples
-
+
import org.openapitools.client.api.*;
import org.openapitools.client.api.client.AccountingApi;
import org.openapitools.client.models.accounting.*;
@@ -27311,14 +26614,14 @@ Usage and SDK Samples
apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
- String where = 'Code=="USD"';
- String order = 'Code ASC';
+ UUID creditNoteID = UUID.fromString("00000000-0000-0000-0000-000000000000");
+ UUID creditNoteID = '00000000-0000-0000-0000-000000000000';
try {
- Currencies result = apiInstance.getCurrencies(accessToken, xeroTenantId, where, order);
+ Attachments result = apiInstance.getCreditNoteAttachments(accessToken, xeroTenantId, creditNoteID);
System.out.println(result);
} catch (XeroException e) {
- System.err.println("Exception when calling AccountingApi#getCurrencies");
+ System.err.println("Exception when calling AccountingApi#getCreditNoteAttachments");
e.printStackTrace();
}
}
@@ -27329,36 +26632,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
@@ -27370,37 +26676,17 @@ Parameters
|
- Query parameters
+ Header parameters
| Name |
Description |
- | where |
-
-
-
-
-
-
-
- String
-
-
-
-Filter by an any element
-
-
-
- |
-
-
- | order |
+
| xero-tenant-id* |
-
+
@@ -27408,9 +26694,12 @@ Parameters
-Order by an any element
+Xero identifier for Tenant
+
+ Required
+
|
@@ -27420,27 +26709,27 @@ 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
-
+
import org.openapitools.client.api.*;
import org.openapitools.client.api.client.AccountingApi;
import org.openapitools.client.models.accounting.*;
@@ -27457,14 +26746,14 @@ Usage and SDK Samples
apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
- UUID employeeID = UUID.fromString("00000000-0000-0000-0000-000000000000");
- UUID employeeID = '00000000-0000-0000-0000-000000000000';
+ UUID creditNoteID = UUID.fromString("00000000-0000-0000-0000-000000000000");
+ UUID creditNoteID = '00000000-0000-0000-0000-000000000000';
try {
- Employees result = apiInstance.getEmployee(accessToken, xeroTenantId, employeeID);
+ HistoryRecords result = apiInstance.getCreditNoteHistory(accessToken, xeroTenantId, creditNoteID);
System.out.println(result);
} catch (XeroException e) {
- System.err.println("Exception when calling AccountingApi#getEmployee");
+ System.err.println("Exception when calling AccountingApi#getCreditNoteHistory");
e.printStackTrace();
}
}
@@ -27475,13 +26764,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 |
@@ -27492,11 +26781,11 @@ Parameters
Name |
Description |
- | EmployeeID* |
+
| CreditNoteID* |
-
+
@@ -27507,7 +26796,7 @@ Parameters
-Unique identifier for a Employee
+Unique identifier for a Credit Note
@@ -27529,7 +26818,7 @@ Parameters
-
+
@@ -27552,27 +26841,27 @@ 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
-
+
import org.openapitools.client.api.*;
import org.openapitools.client.api.client.AccountingApi;
import org.openapitools.client.models.accounting.*;
@@ -27591,14 +26880,17 @@ Usage and SDK Samples
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
OffsetDateTime ifModifiedSince = OffsetDateTime.parse("2020-02-06T12:17:43.202-08:00");
- String where = 'Status=="ACTIVE"';
- String order = 'LastName ASC';
+ String where = 'Status=="DRAFT"';
+ String order = 'CreditNoteNumber ASC';
+ Integer page = 1;
+ Integer unitdp = 4;
+ Integer pageSize = 100;
try {
- Employees result = apiInstance.getEmployees(accessToken, xeroTenantId, ifModifiedSince, where, order);
+ CreditNotes result = apiInstance.getCreditNotes(accessToken, xeroTenantId, ifModifiedSince, where, order, page, unitdp, pageSize);
System.out.println(result);
} catch (XeroException e) {
- System.err.println("Exception when calling AccountingApi#getEmployees");
+ System.err.println("Exception when calling AccountingApi#getCreditNotes");
e.printStackTrace();
}
}
@@ -27609,13 +26901,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 |
@@ -27630,7 +26922,7 @@ Parameters
-
+
@@ -27653,7 +26945,7 @@ Parameters
-
+
@@ -27683,7 +26975,213 @@ Parameters
-
+
+
+
+
+ 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
+
+
+
+
+
import org.openapitools.client.api.*;
+import org.openapitools.client.api.client.AccountingApi;
+import org.openapitools.client.models.accounting.*;
+
+import java.io.File;
+import java.util.*;
+
+public class AccountingApiExample {
+ private AccountingApi apiInstance;
+
+ public static void main(String[] args) {
+ String accessToken = "YOUR_ACCESS_TOKEN";
+ ApiClient defaultClient = new ApiClient();
+
+ apiInstance = AccountingApi.getInstance(defaultClient);
+ String xeroTenantId = 'YOUR_XERO_TENANT_ID';
+ String where = 'Code=="USD"';
+ String order = 'Code ASC';
+
+ try {
+ Currencies result = apiInstance.getCurrencies(accessToken, xeroTenantId, where, order);
+ System.out.println(result);
+ } catch (XeroException e) {
+ System.err.println("Exception when calling AccountingApi#getCurrencies");
+ e.printStackTrace();
+ }
+ }
+}
+
+
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 |
+
+
+
+
@@ -27703,7 +27201,7 @@ Parameters
-
+
@@ -45653,199 +45151,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
-
-
-
-
-
import org.openapitools.client.api.*;
-import org.openapitools.client.api.client.AccountingApi;
-import org.openapitools.client.models.accounting.*;
-
-import java.io.File;
-import java.util.*;
-
-public class AccountingApiExample {
- private AccountingApi apiInstance;
-
- public static void main(String[] args) {
- String accessToken = "YOUR_ACCESS_TOKEN";
- ApiClient defaultClient = new ApiClient();
-
- apiInstance = AccountingApi.getInstance(defaultClient);
- String xeroTenantId = 'YOUR_XERO_TENANT_ID';
- Boolean summarizeErrors = true;
- String idempotencyKey = 'KEY_VALUE';
-
- Employee employee = new Employee();
- employee.setFirstName("Nick");
- employee.setLastName("Fury");
-
- Employees employees = new Employees();
- employees.addEmployeesItem(employee);
-
- try {
- Employees result = apiInstance.updateOrCreateEmployees(accessToken, xeroTenantId, employees, summarizeErrors, idempotencyKey);
- System.out.println(result);
- } catch (XeroException e) {
- System.err.println("Exception when calling AccountingApi#updateOrCreateEmployees");
- e.printStackTrace();
- }
- }
-}
-
-
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/v4/appstore/index.html b/docs/v4/appstore/index.html
index 723cb989..f6e40479 100644
--- a/docs/v4/appstore/index.html
+++ b/docs/v4/appstore/index.html
@@ -1238,7 +1238,7 @@