Package com.xero.api.client

Class AccountingApi

java.lang.Object

com.xero.api.client.AccountingApi

public class AccountingApi
extends Object

AccountingApi has methods for interacting with all endpoints in the API set

Constructor Summary

Constructors

Constructor	Description
AccountingApi()	AccountingApi
AccountingApi(ApiClient apiClient)	AccountingApi

Method Summary

Modifier and Type	Method	Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
Accounts	createAccount(String accessToken, String xeroTenantId, Account account, String idempotencyKey)	Creates a new chart of accounts
Attachments	createAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment on a specific account
Attachments	createAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body, String idempotencyKey)	Creates an attachment on a specific account
com.google.api.client.http.HttpResponse	createAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment on a specific account
com.google.api.client.http.HttpResponse	createAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body, String idempotencyKey)	Creates an attachment on a specific account
com.google.api.client.http.HttpResponse	createAccountForHttpResponse(String accessToken, String xeroTenantId, Account account, String idempotencyKey)	Creates a new chart of accounts
Attachments	createBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment for a specific bank transaction by filename
Attachments	createBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body, String idempotencyKey)	Creates an attachment for a specific bank transaction by filename
com.google.api.client.http.HttpResponse	createBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment for a specific bank transaction by filename
com.google.api.client.http.HttpResponse	createBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body, String idempotencyKey)	Creates an attachment for a specific bank transaction by filename
HistoryRecords	createBankTransactionHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific bank transactions
com.google.api.client.http.HttpResponse	createBankTransactionHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific bank transactions
BankTransactions	createBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more spent or received money transaction
com.google.api.client.http.HttpResponse	createBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more spent or received money transaction
BankTransfers	createBankTransfer(String accessToken, String xeroTenantId, BankTransfers bankTransfers, String idempotencyKey)	Creates a bank transfer
Attachments	createBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
Attachments	createBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body, String idempotencyKey)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
com.google.api.client.http.HttpResponse	createBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
com.google.api.client.http.HttpResponse	createBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body, String idempotencyKey)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
com.google.api.client.http.HttpResponse	createBankTransferForHttpResponse(String accessToken, String xeroTenantId, BankTransfers bankTransfers, String idempotencyKey)	Creates a bank transfer
HistoryRecords	createBankTransferHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific bank transfer
com.google.api.client.http.HttpResponse	createBankTransferHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific bank transfer
BatchPayments	createBatchPayment(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors, String idempotencyKey)	Creates one or many batch payments for invoices
com.google.api.client.http.HttpResponse	createBatchPaymentForHttpResponse(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors, String idempotencyKey)	Creates one or many batch payments for invoices
HistoryRecords	createBatchPaymentHistoryRecord(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific batch payment
com.google.api.client.http.HttpResponse	createBatchPaymentHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific batch payment
PaymentServices	createBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentServices paymentServices, String idempotencyKey)	Creates a new custom payment service for a specific branding theme
com.google.api.client.http.HttpResponse	createBrandingThemePaymentServicesForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentServices paymentServices, String idempotencyKey)	Creates a new custom payment service for a specific branding theme
Attachments	createContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of type Attachments array with an newly created Attachment
Attachments	createContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body, String idempotencyKey)	200 - Success - return response of type Attachments array with an newly created Attachment
com.google.api.client.http.HttpResponse	createContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of type Attachments array with an newly created Attachment
com.google.api.client.http.HttpResponse	createContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body, String idempotencyKey)	200 - Success - return response of type Attachments array with an newly created Attachment
ContactGroups	createContactGroup(String accessToken, String xeroTenantId, ContactGroups contactGroups, String idempotencyKey)	Creates a contact group
Contacts	createContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts, String idempotencyKey)	Creates contacts to a specific contact group
com.google.api.client.http.HttpResponse	createContactGroupContactsForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts, String idempotencyKey)	Creates contacts to a specific contact group
com.google.api.client.http.HttpResponse	createContactGroupForHttpResponse(String accessToken, String xeroTenantId, ContactGroups contactGroups, String idempotencyKey)	Creates a contact group
HistoryRecords	createContactHistory(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords, String idempotencyKey)	Creates a new history record for a specific contact
com.google.api.client.http.HttpResponse	createContactHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords, String idempotencyKey)	Creates a new history record for a specific contact
Contacts	createContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors, String idempotencyKey)	Creates multiple contacts (bulk) in a Xero organisation
com.google.api.client.http.HttpResponse	createContactsForHttpResponse(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors, String idempotencyKey)	Creates multiple contacts (bulk) in a Xero organisation
Allocations	createCreditNoteAllocation(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Creates allocation for a specific credit note
com.google.api.client.http.HttpResponse	createCreditNoteAllocationForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Creates allocation for a specific credit note
Attachments	createCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String idempotencyKey, String mimeType)	Creates an attachment for a specific credit note
Attachments	createCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline, String idempotencyKey)	Creates an attachment for a specific credit note
com.google.api.client.http.HttpResponse	createCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String idempotencyKey, String mimeType)	Creates an attachment for a specific credit note
com.google.api.client.http.HttpResponse	createCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline, String idempotencyKey)	Creates an attachment for a specific credit note
HistoryRecords	createCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords, String idempotencyKey)	Retrieves history records of a specific credit note
com.google.api.client.http.HttpResponse	createCreditNoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords, String idempotencyKey)	Retrieves history records of a specific credit note
CreditNotes	createCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates a new credit note
com.google.api.client.http.HttpResponse	createCreditNotesForHttpResponse(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates a new credit note
Currencies	createCurrency(String accessToken, String xeroTenantId, Currency currency, String idempotencyKey)	Create a new currency for a Xero organisation
com.google.api.client.http.HttpResponse	createCurrencyForHttpResponse(String accessToken, String xeroTenantId, Currency currency, String idempotencyKey)	Create a new currency for a Xero organisation
Employees	createEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors, String idempotencyKey)	Creates new employees used in Xero payrun
com.google.api.client.http.HttpResponse	createEmployeesForHttpResponse(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors, String idempotencyKey)	Creates new employees used in Xero payrun
HistoryRecords	createExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific expense claim
com.google.api.client.http.HttpResponse	createExpenseClaimHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific expense claim
ExpenseClaims	createExpenseClaims(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims, String idempotencyKey)	Creates expense claims
com.google.api.client.http.HttpResponse	createExpenseClaimsForHttpResponse(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims, String idempotencyKey)	Creates expense claims
Attachments	createInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String idempotencyKey, String mimeType)	Creates an attachment for a specific invoice or purchase bill by filename
Attachments	createInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline, String idempotencyKey)	Creates an attachment for a specific invoice or purchase bill by filename
com.google.api.client.http.HttpResponse	createInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String idempotencyKey, String mimeType)	Creates an attachment for a specific invoice or purchase bill by filename
com.google.api.client.http.HttpResponse	createInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline, String idempotencyKey)	Creates an attachment for a specific invoice or purchase bill by filename
HistoryRecords	createInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific invoice
com.google.api.client.http.HttpResponse	createInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific invoice
Invoices	createInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more sales invoices or purchase bills
com.google.api.client.http.HttpResponse	createInvoicesForHttpResponse(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more sales invoices or purchase bills
HistoryRecords	createItemHistory(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific item
com.google.api.client.http.HttpResponse	createItemHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific item
Items	createItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more items
com.google.api.client.http.HttpResponse	createItemsForHttpResponse(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Creates one or more items
LinkedTransactions	createLinkedTransaction(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction, String idempotencyKey)	Creates linked transactions (billable expenses)
com.google.api.client.http.HttpResponse	createLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction, String idempotencyKey)	Creates linked transactions (billable expenses)
Attachments	createManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates a specific attachment for a specific manual journal by file name
Attachments	createManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body, String idempotencyKey)	Creates a specific attachment for a specific manual journal by file name
com.google.api.client.http.HttpResponse	createManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates a specific attachment for a specific manual journal by file name
com.google.api.client.http.HttpResponse	createManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body, String idempotencyKey)	Creates a specific attachment for a specific manual journal by file name
HistoryRecords	createManualJournalHistoryRecord(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific manual journal
com.google.api.client.http.HttpResponse	createManualJournalHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific manual journal
ManualJournals	createManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors, String idempotencyKey)	Creates one or more manual journals
com.google.api.client.http.HttpResponse	createManualJournalsForHttpResponse(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors, String idempotencyKey)	Creates one or more manual journals
Allocations	createOverpaymentAllocations(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Creates a single allocation for a specific overpayment
com.google.api.client.http.HttpResponse	createOverpaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Creates a single allocation for a specific overpayment
HistoryRecords	createOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific overpayment
com.google.api.client.http.HttpResponse	createOverpaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific overpayment
Payments	createPayment(String accessToken, String xeroTenantId, Payment payment, String idempotencyKey)	Creates a single payment for invoice or credit notes
com.google.api.client.http.HttpResponse	createPaymentForHttpResponse(String accessToken, String xeroTenantId, Payment payment, String idempotencyKey)	Creates a single payment for invoice or credit notes
HistoryRecords	createPaymentHistory(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific payment
com.google.api.client.http.HttpResponse	createPaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific payment
Payments	createPayments(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors, String idempotencyKey)	Creates multiple payments for invoices or credit notes
PaymentServices	createPaymentService(String accessToken, String xeroTenantId, PaymentServices paymentServices, String idempotencyKey)	Creates a payment service
com.google.api.client.http.HttpResponse	createPaymentServiceForHttpResponse(String accessToken, String xeroTenantId, PaymentServices paymentServices, String idempotencyKey)	Creates a payment service
com.google.api.client.http.HttpResponse	createPaymentsForHttpResponse(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors, String idempotencyKey)	Creates multiple payments for invoices or credit notes
Allocations	createPrepaymentAllocations(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Allows you to create an Allocation for prepayments
com.google.api.client.http.HttpResponse	createPrepaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors, String idempotencyKey)	Allows you to create an Allocation for prepayments
HistoryRecords	createPrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific prepayment
com.google.api.client.http.HttpResponse	createPrepaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific prepayment
Attachments	createPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates attachment for a specific purchase order
Attachments	createPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body, String idempotencyKey)	Creates attachment for a specific purchase order
com.google.api.client.http.HttpResponse	createPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates attachment for a specific purchase order
com.google.api.client.http.HttpResponse	createPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body, String idempotencyKey)	Creates attachment for a specific purchase order
HistoryRecords	createPurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific purchase orders
com.google.api.client.http.HttpResponse	createPurchaseOrderHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific purchase orders
PurchaseOrders	createPurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors, String idempotencyKey)	Creates one or more purchase orders
com.google.api.client.http.HttpResponse	createPurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors, String idempotencyKey)	Creates one or more purchase orders
Attachments	createQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates attachment for a specific quote
Attachments	createQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body, String idempotencyKey)	Creates attachment for a specific quote
com.google.api.client.http.HttpResponse	createQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates attachment for a specific quote
com.google.api.client.http.HttpResponse	createQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body, String idempotencyKey)	Creates attachment for a specific quote
HistoryRecords	createQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific quote
com.google.api.client.http.HttpResponse	createQuoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific quote
Quotes	createQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors, String idempotencyKey)	Create one or more quotes
com.google.api.client.http.HttpResponse	createQuotesForHttpResponse(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors, String idempotencyKey)	Create one or more quotes
Receipts	createReceipt(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp, String idempotencyKey)	Creates draft expense claim receipts for any user
Attachments	createReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment on a specific expense claim receipts by file name
Attachments	createReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body, String idempotencyKey)	Creates an attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	createReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	createReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body, String idempotencyKey)	Creates an attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	createReceiptForHttpResponse(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp, String idempotencyKey)	Creates draft expense claim receipts for any user
HistoryRecords	createReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific receipt
com.google.api.client.http.HttpResponse	createReceiptHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific receipt
Attachments	createRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment from a specific repeating invoices by file name
Attachments	createRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body, String idempotencyKey)	Creates an attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	createRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Creates an attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	createRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body, String idempotencyKey)	Creates an attachment from a specific repeating invoices by file name
HistoryRecords	createRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific repeating invoice
com.google.api.client.http.HttpResponse	createRepeatingInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords, String idempotencyKey)	Creates a history record for a specific repeating invoice
RepeatingInvoices	createRepeatingInvoices(String accessToken, String xeroTenantId, RepeatingInvoices repeatingInvoices, Boolean summarizeErrors, String idempotencyKey)	Creates one or more repeating invoice templates
com.google.api.client.http.HttpResponse	createRepeatingInvoicesForHttpResponse(String accessToken, String xeroTenantId, RepeatingInvoices repeatingInvoices, Boolean summarizeErrors, String idempotencyKey)	Creates one or more repeating invoice templates
TaxRates	createTaxRates(String accessToken, String xeroTenantId, TaxRates taxRates, String idempotencyKey)	Creates one or more tax rates
com.google.api.client.http.HttpResponse	createTaxRatesForHttpResponse(String accessToken, String xeroTenantId, TaxRates taxRates, String idempotencyKey)	Creates one or more tax rates
TrackingCategories	createTrackingCategory(String accessToken, String xeroTenantId, TrackingCategory trackingCategory, String idempotencyKey)	Create tracking categories
com.google.api.client.http.HttpResponse	createTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, TrackingCategory trackingCategory, String idempotencyKey)	Create tracking categories
TrackingOptions	createTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption, String idempotencyKey)	Creates options for a specific tracking category
com.google.api.client.http.HttpResponse	createTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption, String idempotencyKey)	Creates options for a specific tracking category
Accounts	deleteAccount(String accessToken, String xeroTenantId, UUID accountID)	Deletes a chart of accounts
com.google.api.client.http.HttpResponse	deleteAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)	Deletes a chart of accounts
BatchPayments	deleteBatchPayment(String accessToken, String xeroTenantId, BatchPaymentDelete batchPaymentDelete, String idempotencyKey)	Updates a specific batch payment for invoices and credit notes
BatchPayments	deleteBatchPaymentByUrlParam(String accessToken, String xeroTenantId, UUID batchPaymentID, BatchPaymentDeleteByUrlParam batchPaymentDeleteByUrlParam, String idempotencyKey)	Updates a specific batch payment for invoices and credit notes
com.google.api.client.http.HttpResponse	deleteBatchPaymentByUrlParamForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID, BatchPaymentDeleteByUrlParam batchPaymentDeleteByUrlParam, String idempotencyKey)	Updates a specific batch payment for invoices and credit notes
com.google.api.client.http.HttpResponse	deleteBatchPaymentForHttpResponse(String accessToken, String xeroTenantId, BatchPaymentDelete batchPaymentDelete, String idempotencyKey)	Updates a specific batch payment for invoices and credit notes
void	deleteContactGroupContact(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID)	Deletes a specific contact from a contact group using a unique contact Id
com.google.api.client.http.HttpResponse	deleteContactGroupContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID)	Deletes a specific contact from a contact group using a unique contact Id
void	deleteContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID)	Deletes all contacts from a specific contact group
com.google.api.client.http.HttpResponse	deleteContactGroupContactsForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID)	Deletes all contacts from a specific contact group
Allocation	deleteCreditNoteAllocations(String accessToken, String xeroTenantId, UUID creditNoteID, UUID allocationID)	Deletes an Allocation from a Credit Note
com.google.api.client.http.HttpResponse	deleteCreditNoteAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, UUID allocationID)	Deletes an Allocation from a Credit Note
void	deleteItem(String accessToken, String xeroTenantId, UUID itemID)	Deletes a specific item
com.google.api.client.http.HttpResponse	deleteItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID)	Deletes a specific item
void	deleteLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID)	Deletes a specific linked transactions (billable expenses)
com.google.api.client.http.HttpResponse	deleteLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID)	Deletes a specific linked transactions (billable expenses)
Allocation	deleteOverpaymentAllocations(String accessToken, String xeroTenantId, UUID overpaymentID, UUID allocationID)	Deletes an Allocation from an overpayment
com.google.api.client.http.HttpResponse	deleteOverpaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID, UUID allocationID)	Deletes an Allocation from an overpayment
Payments	deletePayment(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete, String idempotencyKey)	Updates a specific payment for invoices and credit notes
com.google.api.client.http.HttpResponse	deletePaymentForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete, String idempotencyKey)	Updates a specific payment for invoices and credit notes
Allocation	deletePrepaymentAllocations(String accessToken, String xeroTenantId, UUID prepaymentID, UUID allocationID)	Deletes an Allocation from a Prepayment
com.google.api.client.http.HttpResponse	deletePrepaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID, UUID allocationID)	Deletes an Allocation from a Prepayment
TrackingCategories	deleteTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID)	Deletes a specific tracking category
com.google.api.client.http.HttpResponse	deleteTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID)	Deletes a specific tracking category
TrackingOptions	deleteTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID)	Deletes a specific option for a specific tracking category
com.google.api.client.http.HttpResponse	deleteTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID)	Deletes a specific option for a specific tracking category
void	emailInvoice(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty, String idempotencyKey)	Sends a copy of a specific invoice to related contact via email
com.google.api.client.http.HttpResponse	emailInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty, String idempotencyKey)	Sends a copy of a specific invoice to related contact via email
Accounts	getAccount(String accessToken, String xeroTenantId, UUID accountID)	Retrieves a single chart of accounts by using a unique account Id
ByteArrayInputStream	getAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType)	Retrieves an attachment for a specific account by filename
com.google.api.client.http.HttpResponse	getAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType)	Retrieves an attachment for a specific account by filename
ByteArrayInputStream	getAccountAttachmentById(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific account using a unique attachment Id
com.google.api.client.http.HttpResponse	getAccountAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific account using a unique attachment Id
Attachments	getAccountAttachments(String accessToken, String xeroTenantId, UUID accountID)	Retrieves attachments for a specific accounts by using a unique account Id
com.google.api.client.http.HttpResponse	getAccountAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)	Retrieves attachments for a specific accounts by using a unique account Id
com.google.api.client.http.HttpResponse	getAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)	Retrieves a single chart of accounts by using a unique account Id
Accounts	getAccounts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves the full chart of accounts
com.google.api.client.http.HttpResponse	getAccountsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves the full chart of accounts
ApiClient	getApiClient()	get ApiClient
BankTransactions	getBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp)	Retrieves a single spent or received money transaction by using a unique bank transaction Id
ByteArrayInputStream	getBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType)	Retrieves a specific attachment from a specific bank transaction by filename
com.google.api.client.http.HttpResponse	getBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType)	Retrieves a specific attachment from a specific bank transaction by filename
ByteArrayInputStream	getBankTransactionAttachmentById(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType)	Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
com.google.api.client.http.HttpResponse	getBankTransactionAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType)	Retrieves specific attachments from a specific BankTransaction using a unique attachment Id
Attachments	getBankTransactionAttachments(String accessToken, String xeroTenantId, UUID bankTransactionID)	Retrieves any attachments from a specific bank transactions
com.google.api.client.http.HttpResponse	getBankTransactionAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID)	Retrieves any attachments from a specific bank transactions
com.google.api.client.http.HttpResponse	getBankTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp)	Retrieves a single spent or received money transaction by using a unique bank transaction Id
BankTransactions	getBankTransactions(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves any spent or received money transactions
com.google.api.client.http.HttpResponse	getBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves any spent or received money transactions
HistoryRecords	getBankTransactionsHistory(String accessToken, String xeroTenantId, UUID bankTransactionID)	Retrieves history from a specific bank transaction using a unique bank transaction Id
com.google.api.client.http.HttpResponse	getBankTransactionsHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID)	Retrieves history from a specific bank transaction using a unique bank transaction Id
BankTransfers	getBankTransfer(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves specific bank transfers by using a unique bank transfer Id
ByteArrayInputStream	getBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType)	Retrieves a specific attachment on a specific bank transfer by file name
com.google.api.client.http.HttpResponse	getBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType)	Retrieves a specific attachment on a specific bank transfer by file name
ByteArrayInputStream	getBankTransferAttachmentById(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
com.google.api.client.http.HttpResponse	getBankTransferAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific bank transfer using a unique attachment ID
Attachments	getBankTransferAttachments(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves attachments from a specific bank transfer
com.google.api.client.http.HttpResponse	getBankTransferAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves attachments from a specific bank transfer
com.google.api.client.http.HttpResponse	getBankTransferForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves specific bank transfers by using a unique bank transfer Id
HistoryRecords	getBankTransferHistory(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves history from a specific bank transfer using a unique bank transfer Id
com.google.api.client.http.HttpResponse	getBankTransferHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)	Retrieves history from a specific bank transfer using a unique bank transfer Id
BankTransfers	getBankTransfers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves all bank transfers
com.google.api.client.http.HttpResponse	getBankTransfersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves all bank transfers
BatchPayments	getBatchPayment(String accessToken, String xeroTenantId, UUID batchPaymentID)	Retrieves a specific batch payment using a unique batch payment Id
com.google.api.client.http.HttpResponse	getBatchPaymentForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID)	Retrieves a specific batch payment using a unique batch payment Id
HistoryRecords	getBatchPaymentHistory(String accessToken, String xeroTenantId, UUID batchPaymentID)	Retrieves history from a specific batch payment
com.google.api.client.http.HttpResponse	getBatchPaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID)	Retrieves history from a specific batch payment
BatchPayments	getBatchPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves either one or many batch payments for invoices
com.google.api.client.http.HttpResponse	getBatchPaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves either one or many batch payments for invoices
BrandingThemes	getBrandingTheme(String accessToken, String xeroTenantId, UUID brandingThemeID)	Retrieves a specific branding theme using a unique branding theme Id
com.google.api.client.http.HttpResponse	getBrandingThemeForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID)	Retrieves a specific branding theme using a unique branding theme Id
PaymentServices	getBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID)	Retrieves the payment services for a specific branding theme
com.google.api.client.http.HttpResponse	getBrandingThemePaymentServicesForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID)	Retrieves the payment services for a specific branding theme
BrandingThemes	getBrandingThemes(String accessToken, String xeroTenantId)	Retrieves all the branding themes
com.google.api.client.http.HttpResponse	getBrandingThemesForHttpResponse(String accessToken, String xeroTenantId)	Retrieves all the branding themes
Budgets	getBudget(String accessToken, String xeroTenantId, UUID budgetID, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate dateFrom)	Retrieves a specific budget, which includes budget lines
com.google.api.client.http.HttpResponse	getBudgetForHttpResponse(String accessToken, String xeroTenantId, UUID budgetID, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate dateFrom)	Retrieves a specific budget, which includes budget lines
Budgets	getBudgets(String accessToken, String xeroTenantId, List<UUID> ids, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate dateFrom)	Retrieve a list of budgets
com.google.api.client.http.HttpResponse	getBudgetsForHttpResponse(String accessToken, String xeroTenantId, List<UUID> ids, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate dateFrom)	Retrieve a list of budgets
Contacts	getContact(String accessToken, String xeroTenantId, UUID contactID)	Retrieves a specific contacts in a Xero organisation using a unique contact Id
ByteArrayInputStream	getContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType)	Retrieves a specific attachment from a specific contact by file name
com.google.api.client.http.HttpResponse	getContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType)	Retrieves a specific attachment from a specific contact by file name
ByteArrayInputStream	getContactAttachmentById(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific contact using a unique attachment Id
com.google.api.client.http.HttpResponse	getContactAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific contact using a unique attachment Id
Attachments	getContactAttachments(String accessToken, String xeroTenantId, UUID contactID)	Retrieves attachments for a specific contact in a Xero organisation
com.google.api.client.http.HttpResponse	getContactAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)	Retrieves attachments for a specific contact in a Xero organisation
Contacts	getContactByContactNumber(String accessToken, String xeroTenantId, String contactNumber)	Retrieves a specific contact by contact number in a Xero organisation
com.google.api.client.http.HttpResponse	getContactByContactNumberForHttpResponse(String accessToken, String xeroTenantId, String contactNumber)	Retrieves a specific contact by contact number in a Xero organisation
CISSettings	getContactCISSettings(String accessToken, String xeroTenantId, UUID contactID)	Retrieves CIS settings for a specific contact in a Xero organisation
com.google.api.client.http.HttpResponse	getContactCISSettingsForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)	Retrieves CIS settings for a specific contact in a Xero organisation
com.google.api.client.http.HttpResponse	getContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)	Retrieves a specific contacts in a Xero organisation using a unique contact Id
ContactGroups	getContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID)	Retrieves a specific contact group by using a unique contact group Id
com.google.api.client.http.HttpResponse	getContactGroupForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID)	Retrieves a specific contact group by using a unique contact group Id
ContactGroups	getContactGroups(String accessToken, String xeroTenantId, String where, String order)	Retrieves the contact Id and name of each contact group
com.google.api.client.http.HttpResponse	getContactGroupsForHttpResponse(String accessToken, String xeroTenantId, String where, String order)	Retrieves the contact Id and name of each contact group
HistoryRecords	getContactHistory(String accessToken, String xeroTenantId, UUID contactID)	Retrieves history records for a specific contact
com.google.api.client.http.HttpResponse	getContactHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)	Retrieves history records for a specific contact
Contacts	getContacts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived, Boolean summaryOnly, String searchTerm, Integer pageSize)	Retrieves all contacts in a Xero organisation
com.google.api.client.http.HttpResponse	getContactsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived, Boolean summaryOnly, String searchTerm, Integer pageSize)	Retrieves all contacts in a Xero organisation
CreditNotes	getCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp)	Retrieves a specific credit note using a unique credit note Id
ByteArrayInputStream	getCreditNoteAsPdf(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves credit notes as PDF files
com.google.api.client.http.HttpResponse	getCreditNoteAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves credit notes as PDF files
ByteArrayInputStream	getCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType)	Retrieves a specific attachment on a specific credit note by file name
com.google.api.client.http.HttpResponse	getCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType)	Retrieves a specific attachment on a specific credit note by file name
ByteArrayInputStream	getCreditNoteAttachmentById(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific credit note using a unique attachment Id
com.google.api.client.http.HttpResponse	getCreditNoteAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific credit note using a unique attachment Id
Attachments	getCreditNoteAttachments(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves attachments for a specific credit notes
com.google.api.client.http.HttpResponse	getCreditNoteAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves attachments for a specific credit notes
com.google.api.client.http.HttpResponse	getCreditNoteForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp)	Retrieves a specific credit note using a unique credit note Id
HistoryRecords	getCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves history records of a specific credit note
com.google.api.client.http.HttpResponse	getCreditNoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)	Retrieves history records of a specific credit note
CreditNotes	getCreditNotes(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves any credit notes
com.google.api.client.http.HttpResponse	getCreditNotesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves any credit notes
Currencies	getCurrencies(String accessToken, String xeroTenantId, String where, String order)	Retrieves currencies for your Xero organisation
com.google.api.client.http.HttpResponse	getCurrenciesForHttpResponse(String accessToken, String xeroTenantId, String where, String order)	Retrieves currencies for your Xero organisation
Employees	getEmployee(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee used in Xero payrun using a unique employee Id
com.google.api.client.http.HttpResponse	getEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)	Retrieves a specific employee used in Xero payrun using a unique employee Id
Employees	getEmployees(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves employees used in Xero payrun
com.google.api.client.http.HttpResponse	getEmployeesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves employees used in Xero payrun
ExpenseClaims	getExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID)	Retrieves a specific expense claim using a unique expense claim Id
com.google.api.client.http.HttpResponse	getExpenseClaimForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID)	Retrieves a specific expense claim using a unique expense claim Id
HistoryRecords	getExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID)	Retrieves history records of a specific expense claim
com.google.api.client.http.HttpResponse	getExpenseClaimHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID)	Retrieves history records of a specific expense claim
ExpenseClaims	getExpenseClaims(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves expense claims
com.google.api.client.http.HttpResponse	getExpenseClaimsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves expense claims
static AccountingApi	getInstance(ApiClient apiClient)	AccountingApi getInstance
Invoices	getInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp)	Retrieves a specific sales invoice or purchase bill using a unique invoice Id
ByteArrayInputStream	getInvoiceAsPdf(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves invoices or purchase bills as PDF files
com.google.api.client.http.HttpResponse	getInvoiceAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves invoices or purchase bills as PDF files
ByteArrayInputStream	getInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType)	Retrieves an attachment from a specific invoice or purchase bill by filename
com.google.api.client.http.HttpResponse	getInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType)	Retrieves an attachment from a specific invoice or purchase bill by filename
ByteArrayInputStream	getInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
com.google.api.client.http.HttpResponse	getInvoiceAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific invoices or purchase bills by using a unique attachment Id
Attachments	getInvoiceAttachments(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves attachments for a specific invoice or purchase bill
com.google.api.client.http.HttpResponse	getInvoiceAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves attachments for a specific invoice or purchase bill
com.google.api.client.http.HttpResponse	getInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp)	Retrieves a specific sales invoice or purchase bill using a unique invoice Id
HistoryRecords	getInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves history records for a specific invoice
com.google.api.client.http.HttpResponse	getInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves history records for a specific invoice
InvoiceReminders	getInvoiceReminders(String accessToken, String xeroTenantId)	Retrieves invoice reminder settings
com.google.api.client.http.HttpResponse	getInvoiceRemindersForHttpResponse(String accessToken, String xeroTenantId)	Retrieves invoice reminder settings
Invoices	getInvoices(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, List<String> invoiceNumbers, List<UUID> contactIDs, List<String> statuses, Integer page, Boolean includeArchived, Boolean createdByMyApp, Integer unitdp, Boolean summaryOnly, Integer pageSize, String searchTerm)	Retrieves sales invoices or purchase bills
com.google.api.client.http.HttpResponse	getInvoicesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, List<String> invoiceNumbers, List<UUID> contactIDs, List<String> statuses, Integer page, Boolean includeArchived, Boolean createdByMyApp, Integer unitdp, Boolean summaryOnly, Integer pageSize, String searchTerm)	Retrieves sales invoices or purchase bills
Items	getItem(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp)	Retrieves a specific item using a unique item Id
com.google.api.client.http.HttpResponse	getItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp)	Retrieves a specific item using a unique item Id
HistoryRecords	getItemHistory(String accessToken, String xeroTenantId, UUID itemID)	Retrieves history for a specific item
com.google.api.client.http.HttpResponse	getItemHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID itemID)	Retrieves history for a specific item
Items	getItems(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)	Retrieves items
com.google.api.client.http.HttpResponse	getItemsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)	Retrieves items
Journals	getJournal(String accessToken, String xeroTenantId, UUID journalID)	Retrieves a specific journal using a unique journal Id.
Journals	getJournalByNumber(String accessToken, String xeroTenantId, Integer journalNumber)	Retrieves a specific journal using a unique journal number.
com.google.api.client.http.HttpResponse	getJournalByNumberForHttpResponse(String accessToken, String xeroTenantId, Integer journalNumber)	Retrieves a specific journal using a unique journal number.
com.google.api.client.http.HttpResponse	getJournalForHttpResponse(String accessToken, String xeroTenantId, UUID journalID)	Retrieves a specific journal using a unique journal Id.
Journals	getJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly)	Retrieves journals
com.google.api.client.http.HttpResponse	getJournalsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly)	Retrieves journals
LinkedTransactions	getLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID)	Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
com.google.api.client.http.HttpResponse	getLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID)	Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
LinkedTransactions	getLinkedTransactions(String accessToken, String xeroTenantId, Integer page, UUID linkedTransactionID, UUID sourceTransactionID, UUID contactID, String status, UUID targetTransactionID)	Retrieves linked transactions (billable expenses)
com.google.api.client.http.HttpResponse	getLinkedTransactionsForHttpResponse(String accessToken, String xeroTenantId, Integer page, UUID linkedTransactionID, UUID sourceTransactionID, UUID contactID, String status, UUID targetTransactionID)	Retrieves linked transactions (billable expenses)
ManualJournals	getManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves a specific manual journal
ByteArrayInputStream	getManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType)	Retrieves a specific attachment from a specific manual journal by file name
com.google.api.client.http.HttpResponse	getManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType)	Retrieves a specific attachment from a specific manual journal by file name
ByteArrayInputStream	getManualJournalAttachmentById(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType)	Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
com.google.api.client.http.HttpResponse	getManualJournalAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType)	Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id
Attachments	getManualJournalAttachments(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves attachment for a specific manual journal
com.google.api.client.http.HttpResponse	getManualJournalAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves attachment for a specific manual journal
com.google.api.client.http.HttpResponse	getManualJournalForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves a specific manual journal
ManualJournals	getManualJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer pageSize)	Retrieves manual journals
com.google.api.client.http.HttpResponse	getManualJournalsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer pageSize)	Retrieves manual journals
HistoryRecords	getManualJournalsHistory(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves history for a specific manual journal
com.google.api.client.http.HttpResponse	getManualJournalsHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)	Retrieves history for a specific manual journal
OnlineInvoices	getOnlineInvoice(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves a URL to an online invoice
com.google.api.client.http.HttpResponse	getOnlineInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)	Retrieves a URL to an online invoice
Actions	getOrganisationActions(String accessToken, String xeroTenantId)	Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
com.google.api.client.http.HttpResponse	getOrganisationActionsForHttpResponse(String accessToken, String xeroTenantId)	Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.
CISOrgSettings	getOrganisationCISSettings(String accessToken, String xeroTenantId, UUID organisationID)	Retrieves the CIS settings for the Xero organistaion.
com.google.api.client.http.HttpResponse	getOrganisationCISSettingsForHttpResponse(String accessToken, String xeroTenantId, UUID organisationID)	Retrieves the CIS settings for the Xero organistaion.
Organisations	getOrganisations(String accessToken, String xeroTenantId)	Retrieves Xero organisation details
com.google.api.client.http.HttpResponse	getOrganisationsForHttpResponse(String accessToken, String xeroTenantId)	Retrieves Xero organisation details
Overpayments	getOverpayment(String accessToken, String xeroTenantId, UUID overpaymentID)	Retrieves a specific overpayment using a unique overpayment Id
com.google.api.client.http.HttpResponse	getOverpaymentForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID)	Retrieves a specific overpayment using a unique overpayment Id
HistoryRecords	getOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID)	Retrieves history records of a specific overpayment
com.google.api.client.http.HttpResponse	getOverpaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID)	Retrieves history records of a specific overpayment
Overpayments	getOverpayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves overpayments
com.google.api.client.http.HttpResponse	getOverpaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves overpayments
Payments	getPayment(String accessToken, String xeroTenantId, UUID paymentID)	Retrieves a specific payment for invoices and credit notes using a unique payment Id
com.google.api.client.http.HttpResponse	getPaymentForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID)	Retrieves a specific payment for invoices and credit notes using a unique payment Id
HistoryRecords	getPaymentHistory(String accessToken, String xeroTenantId, UUID paymentID)	Retrieves history records of a specific payment
com.google.api.client.http.HttpResponse	getPaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID)	Retrieves history records of a specific payment
Payments	getPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer pageSize)	Retrieves payments for invoices and credit notes
PaymentServices	getPaymentServices(String accessToken, String xeroTenantId)	Retrieves payment services
com.google.api.client.http.HttpResponse	getPaymentServicesForHttpResponse(String accessToken, String xeroTenantId)	Retrieves payment services
com.google.api.client.http.HttpResponse	getPaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer pageSize)	Retrieves payments for invoices and credit notes
Prepayments	getPrepayment(String accessToken, String xeroTenantId, UUID prepaymentID)	Allows you to retrieve a specified prepayments
com.google.api.client.http.HttpResponse	getPrepaymentForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID)	Allows you to retrieve a specified prepayments
HistoryRecords	getPrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID)	Retrieves history record for a specific prepayment
com.google.api.client.http.HttpResponse	getPrepaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID)	Retrieves history record for a specific prepayment
Prepayments	getPrepayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves prepayments
com.google.api.client.http.HttpResponse	getPrepaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp, Integer pageSize)	Retrieves prepayments
PurchaseOrders	getPurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves a specific purchase order using a unique purchase order Id
ByteArrayInputStream	getPurchaseOrderAsPdf(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves specific purchase order as PDF files using a unique purchase order Id
com.google.api.client.http.HttpResponse	getPurchaseOrderAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves specific purchase order as PDF files using a unique purchase order Id
ByteArrayInputStream	getPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType)	Retrieves a specific attachment for a specific purchase order by filename
com.google.api.client.http.HttpResponse	getPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType)	Retrieves a specific attachment for a specific purchase order by filename
ByteArrayInputStream	getPurchaseOrderAttachmentById(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType)	Retrieves specific attachment for a specific purchase order using a unique attachment Id
com.google.api.client.http.HttpResponse	getPurchaseOrderAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType)	Retrieves specific attachment for a specific purchase order using a unique attachment Id
Attachments	getPurchaseOrderAttachments(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves attachments for a specific purchase order
com.google.api.client.http.HttpResponse	getPurchaseOrderAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves attachments for a specific purchase order
PurchaseOrders	getPurchaseOrderByNumber(String accessToken, String xeroTenantId, String purchaseOrderNumber)	Retrieves a specific purchase order using purchase order number
com.google.api.client.http.HttpResponse	getPurchaseOrderByNumberForHttpResponse(String accessToken, String xeroTenantId, String purchaseOrderNumber)	Retrieves a specific purchase order using purchase order number
com.google.api.client.http.HttpResponse	getPurchaseOrderForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves a specific purchase order using a unique purchase order Id
HistoryRecords	getPurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves history for a specific purchase order
com.google.api.client.http.HttpResponse	getPurchaseOrderHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)	Retrieves history for a specific purchase order
PurchaseOrders	getPurchaseOrders(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page, Integer pageSize)	Retrieves purchase orders
com.google.api.client.http.HttpResponse	getPurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page, Integer pageSize)	Retrieves purchase orders
Quotes	getQuote(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves a specific quote using a unique quote Id
ByteArrayInputStream	getQuoteAsPdf(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves a specific quote as a PDF file using a unique quote Id
com.google.api.client.http.HttpResponse	getQuoteAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves a specific quote as a PDF file using a unique quote Id
ByteArrayInputStream	getQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType)	Retrieves a specific attachment from a specific quote by filename
com.google.api.client.http.HttpResponse	getQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType)	Retrieves a specific attachment from a specific quote by filename
ByteArrayInputStream	getQuoteAttachmentById(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific quote using a unique attachment Id
com.google.api.client.http.HttpResponse	getQuoteAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific quote using a unique attachment Id
Attachments	getQuoteAttachments(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves attachments for a specific quote
com.google.api.client.http.HttpResponse	getQuoteAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves attachments for a specific quote
com.google.api.client.http.HttpResponse	getQuoteForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves a specific quote using a unique quote Id
HistoryRecords	getQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves history records of a specific quote
com.google.api.client.http.HttpResponse	getQuoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)	Retrieves history records of a specific quote
Quotes	getQuotes(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, org.threeten.bp.LocalDate dateFrom, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate expiryDateFrom, org.threeten.bp.LocalDate expiryDateTo, UUID contactID, String status, Integer page, String order, String quoteNumber)	Retrieves sales quotes
com.google.api.client.http.HttpResponse	getQuotesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, org.threeten.bp.LocalDate dateFrom, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate expiryDateFrom, org.threeten.bp.LocalDate expiryDateTo, UUID contactID, String status, Integer page, String order, String quoteNumber)	Retrieves sales quotes
Receipts	getReceipt(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp)	Retrieves a specific draft expense claim receipt by using a unique receipt Id
ByteArrayInputStream	getReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType)	Retrieves a specific attachment from a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	getReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType)	Retrieves a specific attachment from a specific expense claim receipts by file name
ByteArrayInputStream	getReceiptAttachmentById(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType)	Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
com.google.api.client.http.HttpResponse	getReceiptAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType)	Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id
Attachments	getReceiptAttachments(String accessToken, String xeroTenantId, UUID receiptID)	Retrieves attachments for a specific expense claim receipt
com.google.api.client.http.HttpResponse	getReceiptAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID)	Retrieves attachments for a specific expense claim receipt
com.google.api.client.http.HttpResponse	getReceiptForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp)	Retrieves a specific draft expense claim receipt by using a unique receipt Id
HistoryRecords	getReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID)	Retrieves a history record for a specific receipt
com.google.api.client.http.HttpResponse	getReceiptHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID)	Retrieves a history record for a specific receipt
Receipts	getReceipts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)	Retrieves draft expense claim receipts for any user
com.google.api.client.http.HttpResponse	getReceiptsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)	Retrieves draft expense claim receipts for any user
RepeatingInvoices	getRepeatingInvoice(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves a specific repeating invoice by using a unique repeating invoice Id
ByteArrayInputStream	getRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType)	Retrieves a specific attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	getRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType)	Retrieves a specific attachment from a specific repeating invoices by file name
ByteArrayInputStream	getRepeatingInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific repeating invoice
com.google.api.client.http.HttpResponse	getRepeatingInvoiceAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType)	Retrieves a specific attachment from a specific repeating invoice
Attachments	getRepeatingInvoiceAttachments(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves attachments from a specific repeating invoice
com.google.api.client.http.HttpResponse	getRepeatingInvoiceAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves attachments from a specific repeating invoice
com.google.api.client.http.HttpResponse	getRepeatingInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves a specific repeating invoice by using a unique repeating invoice Id
HistoryRecords	getRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves history record for a specific repeating invoice
com.google.api.client.http.HttpResponse	getRepeatingInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)	Retrieves history record for a specific repeating invoice
RepeatingInvoices	getRepeatingInvoices(String accessToken, String xeroTenantId, String where, String order)	Retrieves repeating invoices
com.google.api.client.http.HttpResponse	getRepeatingInvoicesForHttpResponse(String accessToken, String xeroTenantId, String where, String order)	Retrieves repeating invoices
ReportWithRows	getReportAgedPayablesByContact(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for aged payables by contact
com.google.api.client.http.HttpResponse	getReportAgedPayablesByContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for aged payables by contact
ReportWithRows	getReportAgedReceivablesByContact(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for aged receivables by contact
com.google.api.client.http.HttpResponse	getReportAgedReceivablesByContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for aged receivables by contact
ReportWithRows	getReportBalanceSheet(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)	Retrieves report for balancesheet
com.google.api.client.http.HttpResponse	getReportBalanceSheetForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)	Retrieves report for balancesheet
ReportWithRows	getReportBankSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for bank summary
com.google.api.client.http.HttpResponse	getReportBankSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)	Retrieves report for bank summary
ReportWithRows	getReportBudgetSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer periods, Integer timeframe)	Retrieves report for budget summary
com.google.api.client.http.HttpResponse	getReportBudgetSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer periods, Integer timeframe)	Retrieves report for budget summary
ReportWithRows	getReportExecutiveSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date)	Retrieves report for executive summary
com.google.api.client.http.HttpResponse	getReportExecutiveSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date)	Retrieves report for executive summary
ReportWithRows	getReportFromId(String accessToken, String xeroTenantId, String reportID)	Retrieves a specific report using a unique ReportID
com.google.api.client.http.HttpResponse	getReportFromIdForHttpResponse(String accessToken, String xeroTenantId, String reportID)	Retrieves a specific report using a unique ReportID
ReportWithRows	getReportProfitAndLoss(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)	Retrieves report for profit and loss
com.google.api.client.http.HttpResponse	getReportProfitAndLossForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)	Retrieves report for profit and loss
ReportWithRows	getReportsList(String accessToken, String xeroTenantId)	Retrieves a list of the organistaions unique reports that require a uuid to fetch
com.google.api.client.http.HttpResponse	getReportsListForHttpResponse(String accessToken, String xeroTenantId)	Retrieves a list of the organistaions unique reports that require a uuid to fetch
Reports	getReportTenNinetyNine(String accessToken, String xeroTenantId, String reportYear)	Retrieve reports for 1099
com.google.api.client.http.HttpResponse	getReportTenNinetyNineForHttpResponse(String accessToken, String xeroTenantId, String reportYear)	Retrieve reports for 1099
ReportWithRows	getReportTrialBalance(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly)	Retrieves report for trial balance
com.google.api.client.http.HttpResponse	getReportTrialBalanceForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly)	Retrieves report for trial balance
TaxRates	getTaxRateByTaxType(String accessToken, String xeroTenantId, String taxType)	Retrieves a specific tax rate according to given TaxType code
com.google.api.client.http.HttpResponse	getTaxRateByTaxTypeForHttpResponse(String accessToken, String xeroTenantId, String taxType)	Retrieves a specific tax rate according to given TaxType code
TaxRates	getTaxRates(String accessToken, String xeroTenantId, String where, String order)	Retrieves tax rates
com.google.api.client.http.HttpResponse	getTaxRatesForHttpResponse(String accessToken, String xeroTenantId, String where, String order)	Retrieves tax rates
TrackingCategories	getTrackingCategories(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived)	Retrieves tracking categories and options
com.google.api.client.http.HttpResponse	getTrackingCategoriesForHttpResponse(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived)	Retrieves tracking categories and options
TrackingCategories	getTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID)	Retrieves specific tracking categories and options using a unique tracking category Id
com.google.api.client.http.HttpResponse	getTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID)	Retrieves specific tracking categories and options using a unique tracking category Id
Users	getUser(String accessToken, String xeroTenantId, UUID userID)	Retrieves a specific user
String	getUserAgent()	get user agent
com.google.api.client.http.HttpResponse	getUserForHttpResponse(String accessToken, String xeroTenantId, UUID userID)	Retrieves a specific user
Users	getUsers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves users
com.google.api.client.http.HttpResponse	getUsersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)	Retrieves users
ImportSummaryObject	postSetup(String accessToken, String xeroTenantId, Setup setup, String idempotencyKey)	Sets the chart of accounts, the conversion date and conversion balances
com.google.api.client.http.HttpResponse	postSetupForHttpResponse(String accessToken, String xeroTenantId, Setup setup, String idempotencyKey)	Sets the chart of accounts, the conversion date and conversion balances
void	setApiClient(ApiClient apiClient)	set ApiClient
void	setUserAgent(String userAgent)	set user agent
Accounts	updateAccount(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts, String idempotencyKey)	Updates a chart of accounts
Attachments	updateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates attachment on a specific account by filename
Attachments	updateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body, String idempotencyKey)	Updates attachment on a specific account by filename
com.google.api.client.http.HttpResponse	updateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates attachment on a specific account by filename
com.google.api.client.http.HttpResponse	updateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body, String idempotencyKey)	Updates attachment on a specific account by filename
com.google.api.client.http.HttpResponse	updateAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts, String idempotencyKey)	Updates a chart of accounts
BankTransactions	updateBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp, String idempotencyKey)	Updates a single spent or received money transaction
Attachments	updateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific bank transaction by filename
Attachments	updateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific bank transaction by filename
com.google.api.client.http.HttpResponse	updateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific bank transaction by filename
com.google.api.client.http.HttpResponse	updateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific bank transaction by filename
com.google.api.client.http.HttpResponse	updateBankTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp, String idempotencyKey)	Updates a single spent or received money transaction
Attachments	updateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
Attachments	updateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body, String idempotencyKey)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
com.google.api.client.http.HttpResponse	updateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
com.google.api.client.http.HttpResponse	updateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body, String idempotencyKey)	200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
Contacts	updateContact(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts, String idempotencyKey)	Updates a specific contact in a Xero organisation
Attachments	updateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of type Attachments array with an updated Attachment
Attachments	updateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body, String idempotencyKey)	200 - Success - return response of type Attachments array with an updated Attachment
com.google.api.client.http.HttpResponse	updateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String idempotencyKey, String mimeType)	200 - Success - return response of type Attachments array with an updated Attachment
com.google.api.client.http.HttpResponse	updateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body, String idempotencyKey)	200 - Success - return response of type Attachments array with an updated Attachment
com.google.api.client.http.HttpResponse	updateContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts, String idempotencyKey)	Updates a specific contact in a Xero organisation
ContactGroups	updateContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups, String idempotencyKey)	Updates a specific contact group
com.google.api.client.http.HttpResponse	updateContactGroupForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups, String idempotencyKey)	Updates a specific contact group
CreditNotes	updateCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp, String idempotencyKey)	Updates a specific credit note
Attachments	updateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates attachments on a specific credit note by file name
Attachments	updateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, String idempotencyKey)	Updates attachments on a specific credit note by file name
com.google.api.client.http.HttpResponse	updateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates attachments on a specific credit note by file name
com.google.api.client.http.HttpResponse	updateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, String idempotencyKey)	Updates attachments on a specific credit note by file name
com.google.api.client.http.HttpResponse	updateCreditNoteForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp, String idempotencyKey)	Updates a specific credit note
ExpenseClaims	updateExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims, String idempotencyKey)	Updates a specific expense claims
com.google.api.client.http.HttpResponse	updateExpenseClaimForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims, String idempotencyKey)	Updates a specific expense claims
Invoices	updateInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp, String idempotencyKey)	Updates a specific sales invoices or purchase bills
Attachments	updateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates an attachment from a specific invoices or purchase bill by filename
Attachments	updateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, String idempotencyKey)	Updates an attachment from a specific invoices or purchase bill by filename
com.google.api.client.http.HttpResponse	updateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates an attachment from a specific invoices or purchase bill by filename
com.google.api.client.http.HttpResponse	updateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, String idempotencyKey)	Updates an attachment from a specific invoices or purchase bill by filename
com.google.api.client.http.HttpResponse	updateInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp, String idempotencyKey)	Updates a specific sales invoices or purchase bills
Items	updateItem(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp, String idempotencyKey)	Updates a specific item
com.google.api.client.http.HttpResponse	updateItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp, String idempotencyKey)	Updates a specific item
LinkedTransactions	updateLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions, String idempotencyKey)	Updates a specific linked transactions (billable expenses)
com.google.api.client.http.HttpResponse	updateLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions, String idempotencyKey)	Updates a specific linked transactions (billable expenses)
ManualJournals	updateManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals, String idempotencyKey)	Updates a specific manual journal
Attachments	updateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific manual journal by file name
Attachments	updateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific manual journal by file name
com.google.api.client.http.HttpResponse	updateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific manual journal by file name
com.google.api.client.http.HttpResponse	updateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific manual journal by file name
com.google.api.client.http.HttpResponse	updateManualJournalForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals, String idempotencyKey)	Updates a specific manual journal
BankTransactions	updateOrCreateBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more spent or received money transaction
com.google.api.client.http.HttpResponse	updateOrCreateBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more spent or received money transaction
Contacts	updateOrCreateContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more contacts in a Xero organisation
com.google.api.client.http.HttpResponse	updateOrCreateContactsForHttpResponse(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more contacts in a Xero organisation
CreditNotes	updateOrCreateCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more credit notes
com.google.api.client.http.HttpResponse	updateOrCreateCreditNotesForHttpResponse(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more credit notes
Employees	updateOrCreateEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors, String idempotencyKey)	Creates a single new employees used in Xero payrun
com.google.api.client.http.HttpResponse	updateOrCreateEmployeesForHttpResponse(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors, String idempotencyKey)	Creates a single new employees used in Xero payrun
Invoices	updateOrCreateInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more sales invoices or purchase bills
com.google.api.client.http.HttpResponse	updateOrCreateInvoicesForHttpResponse(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more sales invoices or purchase bills
Items	updateOrCreateItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more items
com.google.api.client.http.HttpResponse	updateOrCreateItemsForHttpResponse(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp, String idempotencyKey)	Updates or creates one or more items
ManualJournals	updateOrCreateManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors, String idempotencyKey)	Updates or creates a single manual journal
com.google.api.client.http.HttpResponse	updateOrCreateManualJournalsForHttpResponse(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors, String idempotencyKey)	Updates or creates a single manual journal
PurchaseOrders	updateOrCreatePurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more purchase orders
com.google.api.client.http.HttpResponse	updateOrCreatePurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more purchase orders
Quotes	updateOrCreateQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more quotes
com.google.api.client.http.HttpResponse	updateOrCreateQuotesForHttpResponse(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors, String idempotencyKey)	Updates or creates one or more quotes
RepeatingInvoices	updateOrCreateRepeatingInvoices(String accessToken, String xeroTenantId, RepeatingInvoices repeatingInvoices, Boolean summarizeErrors, String idempotencyKey)	Creates or deletes one or more repeating invoice templates
com.google.api.client.http.HttpResponse	updateOrCreateRepeatingInvoicesForHttpResponse(String accessToken, String xeroTenantId, RepeatingInvoices repeatingInvoices, Boolean summarizeErrors, String idempotencyKey)	Creates or deletes one or more repeating invoice templates
PurchaseOrders	updatePurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders, String idempotencyKey)	Updates a specific purchase order
Attachments	updatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment for a specific purchase order by filename
Attachments	updatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body, String idempotencyKey)	Updates a specific attachment for a specific purchase order by filename
com.google.api.client.http.HttpResponse	updatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment for a specific purchase order by filename
com.google.api.client.http.HttpResponse	updatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body, String idempotencyKey)	Updates a specific attachment for a specific purchase order by filename
com.google.api.client.http.HttpResponse	updatePurchaseOrderForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders, String idempotencyKey)	Updates a specific purchase order
Quotes	updateQuote(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes, String idempotencyKey)	Updates a specific quote
Attachments	updateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific quote by filename
Attachments	updateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific quote by filename
com.google.api.client.http.HttpResponse	updateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific quote by filename
com.google.api.client.http.HttpResponse	updateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific quote by filename
com.google.api.client.http.HttpResponse	updateQuoteForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes, String idempotencyKey)	Updates a specific quote
Receipts	updateReceipt(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp, String idempotencyKey)	Updates a specific draft expense claim receipts
Attachments	updateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment on a specific expense claim receipts by file name
Attachments	updateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body, String idempotencyKey)	Updates a specific attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	updateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	updateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body, String idempotencyKey)	Updates a specific attachment on a specific expense claim receipts by file name
com.google.api.client.http.HttpResponse	updateReceiptForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp, String idempotencyKey)	Updates a specific draft expense claim receipts
RepeatingInvoices	updateRepeatingInvoice(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, RepeatingInvoices repeatingInvoices, String idempotencyKey)	Deletes a specific repeating invoice template
Attachments	updateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific repeating invoices by file name
Attachments	updateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	updateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String idempotencyKey, String mimeType)	Updates a specific attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	updateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body, String idempotencyKey)	Updates a specific attachment from a specific repeating invoices by file name
com.google.api.client.http.HttpResponse	updateRepeatingInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, RepeatingInvoices repeatingInvoices, String idempotencyKey)	Deletes a specific repeating invoice template
TaxRates	updateTaxRate(String accessToken, String xeroTenantId, TaxRates taxRates, String idempotencyKey)	Updates tax rates
com.google.api.client.http.HttpResponse	updateTaxRateForHttpResponse(String accessToken, String xeroTenantId, TaxRates taxRates, String idempotencyKey)	Updates tax rates
TrackingCategories	updateTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory, String idempotencyKey)	Updates a specific tracking category
com.google.api.client.http.HttpResponse	updateTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory, String idempotencyKey)	Updates a specific tracking category
TrackingOptions	updateTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption, String idempotencyKey)	Updates a specific option for a specific tracking category
com.google.api.client.http.HttpResponse	updateTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption, String idempotencyKey)	Updates a specific option for a specific tracking category

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AccountingApi

public AccountingApi()

AccountingApi

AccountingApi

public AccountingApi(ApiClient apiClient)

AccountingApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Details

getInstance

public static AccountingApi getInstance(ApiClient apiClient)

AccountingApi getInstance

Parameters:

apiClient - ApiClient pass into the new instance of this class

Returns:

instance of this class

getApiClient

public ApiClient getApiClient()

get ApiClient

Returns:

apiClient the current ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

set ApiClient

Parameters:

apiClient - ApiClient pass into the new instance of this class

setUserAgent

public void setUserAgent(String userAgent)

set user agent

Parameters:

userAgent - string to override the user agent

getUserAgent

public String getUserAgent()

get user agent

Returns:

String of user agent

createAccount

public Accounts createAccount(String accessToken,
 String xeroTenantId,
 Account account,
 String idempotencyKey)
                       throws IOException

Creates a new chart of accounts

200 - Success - created new Account and return response of type Accounts array with new Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

account - Account object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Accounts

Throws:

IOException - if an error occurs while attempting to invoke the API *

createAccountForHttpResponse

public com.google.api.client.http.HttpResponse createAccountForHttpResponse(String accessToken,
 String xeroTenantId,
 Account account,
 String idempotencyKey)
                                                                     throws IOException

Creates a new chart of accounts

200 - Success - created new Account and return response of type Accounts array with new Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

account - Account object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createAccountAttachmentByFileName

public Attachments createAccountAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

Creates an attachment on a specific account

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createAccountAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createAccountAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

Creates an attachment on a specific account

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createAccountAttachmentByFileName

public Attachments createAccountAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

Creates an attachment on a specific account

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createAccountAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createAccountAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

Creates an attachment on a specific account

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransactionAttachmentByFileName

public Attachments createBankTransactionAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                      throws IOException

Creates an attachment for a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransactionAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransactionAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                                 throws IOException

Creates an attachment for a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransactionAttachmentByFileName

public Attachments createBankTransactionAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 File body,
 String idempotencyKey)
                                                      throws IOException

Creates an attachment for a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransactionAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransactionAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                                 throws IOException

Creates an attachment for a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransactionHistoryRecord

public HistoryRecords createBankTransactionHistoryRecord(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                  throws IOException

Creates a history record for a specific bank transactions

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransactionHistoryRecordForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransactionHistoryRecordForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                          throws IOException

Creates a history record for a specific bank transactions

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransactions

public BankTransactions createBankTransactions(String accessToken,
 String xeroTenantId,
 BankTransactions bankTransactions,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                        throws IOException

Creates one or more spent or received money transaction

200 - Success - return response of type BankTransactions array with new BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactions - BankTransactions with an array of BankTransaction objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BankTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransactionsForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransactionsForHttpResponse(String accessToken,
 String xeroTenantId,
 BankTransactions bankTransactions,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                              throws IOException

Creates one or more spent or received money transaction

200 - Success - return response of type BankTransactions array with new BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactions - BankTransactions with an array of BankTransaction objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransfer

public BankTransfers createBankTransfer(String accessToken,
 String xeroTenantId,
 BankTransfers bankTransfers,
 String idempotencyKey)
                                 throws IOException

Creates a bank transfer

200 - Success - return response of BankTransfers array of one BankTransfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransfers - BankTransfers with array of BankTransfer objects in request body

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BankTransfers

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransferForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransferForHttpResponse(String accessToken,
 String xeroTenantId,
 BankTransfers bankTransfers,
 String idempotencyKey)
                                                                          throws IOException

Creates a bank transfer

200 - Success - return response of BankTransfers array of one BankTransfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransfers - BankTransfers with array of BankTransfer objects in request body

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransferAttachmentByFileName

public Attachments createBankTransferAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                   throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransferAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransferAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                              throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransferAttachmentByFileName

public Attachments createBankTransferAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 File body,
 String idempotencyKey)
                                                   throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransferAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransferAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                              throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBankTransferHistoryRecord

public HistoryRecords createBankTransferHistoryRecord(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                               throws IOException

Creates a history record for a specific bank transfer

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBankTransferHistoryRecordForHttpResponse

public com.google.api.client.http.HttpResponse createBankTransferHistoryRecordForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                       throws IOException

Creates a history record for a specific bank transfer

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBatchPayment

public BatchPayments createBatchPayment(String accessToken,
 String xeroTenantId,
 BatchPayments batchPayments,
 Boolean summarizeErrors,
 String idempotencyKey)
                                 throws IOException

Creates one or many batch payments for invoices

200 - Success - return response of type BatchPayments array of BatchPayment objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPayments - BatchPayments with an array of Payments in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BatchPayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBatchPaymentForHttpResponse

public com.google.api.client.http.HttpResponse createBatchPaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 BatchPayments batchPayments,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                          throws IOException

Creates one or many batch payments for invoices

200 - Success - return response of type BatchPayments array of BatchPayment objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPayments - BatchPayments with an array of Payments in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBatchPaymentHistoryRecord

public HistoryRecords createBatchPaymentHistoryRecord(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                               throws IOException

Creates a history record for a specific batch payment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBatchPaymentHistoryRecordForHttpResponse

public com.google.api.client.http.HttpResponse createBatchPaymentHistoryRecordForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                       throws IOException

Creates a history record for a specific batch payment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createBrandingThemePaymentServices

public PaymentServices createBrandingThemePaymentServices(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID,
 PaymentServices paymentServices,
 String idempotencyKey)
                                                   throws IOException

Creates a new custom payment service for a specific branding theme

200 - Success - return response of type PaymentServices array with newly created PaymentService

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

paymentServices - PaymentServices array with PaymentService object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

PaymentServices

Throws:

IOException - if an error occurs while attempting to invoke the API *

createBrandingThemePaymentServicesForHttpResponse

public com.google.api.client.http.HttpResponse createBrandingThemePaymentServicesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID,
 PaymentServices paymentServices,
 String idempotencyKey)
                                                                                          throws IOException

Creates a new custom payment service for a specific branding theme

200 - Success - return response of type PaymentServices array with newly created PaymentService

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

paymentServices - PaymentServices array with PaymentService object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createContactAttachmentByFileName

public Attachments createContactAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

200 - Success - return response of type Attachments array with an newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createContactAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createContactAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

200 - Success - return response of type Attachments array with an newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactAttachmentByFileName

public Attachments createContactAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

200 - Success - return response of type Attachments array with an newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createContactAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

200 - Success - return response of type Attachments array with an newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createContactGroup

public ContactGroups createContactGroup(String accessToken,
 String xeroTenantId,
 ContactGroups contactGroups,
 String idempotencyKey)
                                 throws IOException

Creates a contact group

200 - Success - return response of type Contact Groups array of newly created Contact Group

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroups - ContactGroups with an array of names in request body

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ContactGroups

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactGroupForHttpResponse

public com.google.api.client.http.HttpResponse createContactGroupForHttpResponse(String accessToken,
 String xeroTenantId,
 ContactGroups contactGroups,
 String idempotencyKey)
                                                                          throws IOException

Creates a contact group

200 - Success - return response of type Contact Groups array of newly created Contact Group

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroups - ContactGroups with an array of names in request body

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createContactGroupContacts

public Contacts createContactGroupContacts(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 Contacts contacts,
 String idempotencyKey)
                                    throws IOException

Creates contacts to a specific contact group

200 - Success - return response of type Contacts array of added Contacts

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contacts - Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactGroupContactsForHttpResponse

public com.google.api.client.http.HttpResponse createContactGroupContactsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 Contacts contacts,
 String idempotencyKey)
                                                                                  throws IOException

Creates contacts to a specific contact group

200 - Success - return response of type Contacts array of added Contacts

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contacts - Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createContactHistory

public HistoryRecords createContactHistory(String accessToken,
 String xeroTenantId,
 UUID contactID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                    throws IOException

Creates a new history record for a specific contact

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createContactHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                            throws IOException

Creates a new history record for a specific contact

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createContacts

public Contacts createContacts(String accessToken,
 String xeroTenantId,
 Contacts contacts,
 Boolean summarizeErrors,
 String idempotencyKey)
                        throws IOException

Creates multiple contacts (bulk) in a Xero organisation

200 - Success - return response of type Contacts array with newly created Contact

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contacts - Contacts with an array of Contact objects to create in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

createContactsForHttpResponse

public com.google.api.client.http.HttpResponse createContactsForHttpResponse(String accessToken,
 String xeroTenantId,
 Contacts contacts,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                      throws IOException

Creates multiple contacts (bulk) in a Xero organisation

200 - Success - return response of type Contacts array with newly created Contact

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contacts - Contacts with an array of Contact objects to create in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createCreditNoteAllocation

public Allocations createCreditNoteAllocation(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                       throws IOException

Creates allocation for a specific credit note

200 - Success - return response of type Allocations array with newly created Allocation for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

allocations - Allocations with array of Allocation object in body of request.

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Allocations

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCreditNoteAllocationForHttpResponse

public com.google.api.client.http.HttpResponse createCreditNoteAllocationForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                  throws IOException

Creates allocation for a specific credit note

200 - Success - return response of type Allocations array with newly created Allocation for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

allocations - Allocations with array of Allocation object in body of request.

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createCreditNoteAttachmentByFileName

public Attachments createCreditNoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 byte[] body,
 Boolean includeOnline,
 String idempotencyKey,
 String mimeType)
                                                 throws IOException

Creates an attachment for a specific credit note

200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createCreditNoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createCreditNoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 byte[] body,
 Boolean includeOnline,
 String idempotencyKey,
 String mimeType)
                                                                                            throws IOException

Creates an attachment for a specific credit note

200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCreditNoteAttachmentByFileName

public Attachments createCreditNoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 File body,
 Boolean includeOnline,
 String idempotencyKey)
                                                 throws IOException

Creates an attachment for a specific credit note

200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCreditNoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createCreditNoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 File body,
 Boolean includeOnline,
 String idempotencyKey)
                                                                                            throws IOException

Creates an attachment for a specific credit note

200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createCreditNoteHistory

public HistoryRecords createCreditNoteHistory(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                       throws IOException

Retrieves history records of a specific credit note

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCreditNoteHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createCreditNoteHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                               throws IOException

Retrieves history records of a specific credit note

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createCreditNotes

public CreditNotes createCreditNotes(String accessToken,
 String xeroTenantId,
 CreditNotes creditNotes,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                              throws IOException

Creates a new credit note

200 - Success - return response of type Credit Notes array of newly created CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNotes - Credit Notes with array of CreditNote object in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

CreditNotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCreditNotesForHttpResponse

public com.google.api.client.http.HttpResponse createCreditNotesForHttpResponse(String accessToken,
 String xeroTenantId,
 CreditNotes creditNotes,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                         throws IOException

Creates a new credit note

200 - Success - return response of type Credit Notes array of newly created CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNotes - Credit Notes with array of CreditNote object in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createCurrency

public Currencies createCurrency(String accessToken,
 String xeroTenantId,
 Currency currency,
 String idempotencyKey)
                          throws IOException

Create a new currency for a Xero organisation

200 - Unsupported - return response incorrect exception, API is not able to create new Currency

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

currency - Currency object in the body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Currencies

Throws:

IOException - if an error occurs while attempting to invoke the API *

createCurrencyForHttpResponse

public com.google.api.client.http.HttpResponse createCurrencyForHttpResponse(String accessToken,
 String xeroTenantId,
 Currency currency,
 String idempotencyKey)
                                                                      throws IOException

Create a new currency for a Xero organisation

200 - Unsupported - return response incorrect exception, API is not able to create new Currency

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

currency - Currency object in the body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createEmployees

public Employees createEmployees(String accessToken,
 String xeroTenantId,
 Employees employees,
 Boolean summarizeErrors,
 String idempotencyKey)
                          throws IOException

Creates new employees used in Xero payrun

200 - Success - return response of type Employees array with new Employee

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employees - Employees with array of Employee object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Employees

Throws:

IOException - if an error occurs while attempting to invoke the API *

createEmployeesForHttpResponse

public com.google.api.client.http.HttpResponse createEmployeesForHttpResponse(String accessToken,
 String xeroTenantId,
 Employees employees,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                       throws IOException

Creates new employees used in Xero payrun

200 - Success - return response of type Employees array with new Employee

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employees - Employees with array of Employee object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createExpenseClaimHistory

public HistoryRecords createExpenseClaimHistory(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                         throws IOException

Creates a history record for a specific expense claim

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createExpenseClaimHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createExpenseClaimHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                 throws IOException

Creates a history record for a specific expense claim

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createExpenseClaims

public ExpenseClaims createExpenseClaims(String accessToken,
 String xeroTenantId,
 ExpenseClaims expenseClaims,
 String idempotencyKey)
                                  throws IOException

Creates expense claims

200 - Success - return response of type ExpenseClaims array with newly created ExpenseClaim

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaims - ExpenseClaims with array of ExpenseClaim object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ExpenseClaims

Throws:

IOException - if an error occurs while attempting to invoke the API *

createExpenseClaimsForHttpResponse

public com.google.api.client.http.HttpResponse createExpenseClaimsForHttpResponse(String accessToken,
 String xeroTenantId,
 ExpenseClaims expenseClaims,
 String idempotencyKey)
                                                                           throws IOException

Creates expense claims

200 - Success - return response of type ExpenseClaims array with newly created ExpenseClaim

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaims - ExpenseClaims with array of ExpenseClaim object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createInvoiceAttachmentByFileName

public Attachments createInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 byte[] body,
 Boolean includeOnline,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 byte[] body,
 Boolean includeOnline,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createInvoiceAttachmentByFileName

public Attachments createInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 File body,
 Boolean includeOnline,
 String idempotencyKey)
                                              throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 File body,
 Boolean includeOnline,
 String idempotencyKey)
                                                                                         throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createInvoiceHistory

public HistoryRecords createInvoiceHistory(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                    throws IOException

Creates a history record for a specific invoice

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createInvoiceHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createInvoiceHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                            throws IOException

Creates a history record for a specific invoice

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createInvoices

public Invoices createInvoices(String accessToken,
 String xeroTenantId,
 Invoices invoices,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                        throws IOException

Creates one or more sales invoices or purchase bills

200 - Success - return response of type Invoices array with newly created Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoices - Invoices with an array of invoice objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Invoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

createInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse createInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 Invoices invoices,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                      throws IOException

Creates one or more sales invoices or purchase bills

200 - Success - return response of type Invoices array with newly created Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoices - Invoices with an array of invoice objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createItemHistory

public HistoryRecords createItemHistory(String accessToken,
 String xeroTenantId,
 UUID itemID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                 throws IOException

Creates a history record for a specific item

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createItemHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createItemHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID itemID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                         throws IOException

Creates a history record for a specific item

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createItems

public Items createItems(String accessToken,
 String xeroTenantId,
 Items items,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                  throws IOException

Creates one or more items

200 - Success - return response of type Items array with newly created Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

items - Items with an array of Item objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Items

Throws:

IOException - if an error occurs while attempting to invoke the API *

createItemsForHttpResponse

public com.google.api.client.http.HttpResponse createItemsForHttpResponse(String accessToken,
 String xeroTenantId,
 Items items,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                   throws IOException

Creates one or more items

200 - Success - return response of type Items array with newly created Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

items - Items with an array of Item objects in body of request

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createLinkedTransaction

public LinkedTransactions createLinkedTransaction(String accessToken,
 String xeroTenantId,
 LinkedTransaction linkedTransaction,
 String idempotencyKey)
                                           throws IOException

Creates linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with newly created LinkedTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransaction - LinkedTransaction object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

LinkedTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

createLinkedTransactionForHttpResponse

public com.google.api.client.http.HttpResponse createLinkedTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 LinkedTransaction linkedTransaction,
 String idempotencyKey)
                                                                               throws IOException

Creates linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with newly created LinkedTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransaction - LinkedTransaction object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createManualJournalAttachmentByFileName

public Attachments createManualJournalAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                    throws IOException

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

200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createManualJournalAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createManualJournalAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                               throws IOException

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

200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createManualJournalAttachmentByFileName

public Attachments createManualJournalAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 File body,
 String idempotencyKey)
                                                    throws IOException

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

200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createManualJournalAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createManualJournalAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                               throws IOException

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

200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createManualJournalHistoryRecord

public HistoryRecords createManualJournalHistoryRecord(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                throws IOException

Creates a history record for a specific manual journal

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createManualJournalHistoryRecordForHttpResponse

public com.google.api.client.http.HttpResponse createManualJournalHistoryRecordForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                        throws IOException

Creates a history record for a specific manual journal

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createManualJournals

public ManualJournals createManualJournals(String accessToken,
 String xeroTenantId,
 ManualJournals manualJournals,
 Boolean summarizeErrors,
 String idempotencyKey)
                                    throws IOException

Creates one or more manual journals

200 - Success - return response of type ManualJournals array with newly created ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournals - ManualJournals array with ManualJournal object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ManualJournals

Throws:

IOException - if an error occurs while attempting to invoke the API *

createManualJournalsForHttpResponse

public com.google.api.client.http.HttpResponse createManualJournalsForHttpResponse(String accessToken,
 String xeroTenantId,
 ManualJournals manualJournals,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                            throws IOException

Creates one or more manual journals

200 - Success - return response of type ManualJournals array with newly created ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournals - ManualJournals array with ManualJournal object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createOverpaymentAllocations

public Allocations createOverpaymentAllocations(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                         throws IOException

Creates a single allocation for a specific overpayment

200 - Success - return response of type Allocations array with all Allocation for Overpayments

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

allocations - Allocations array with Allocation object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Allocations

Throws:

IOException - if an error occurs while attempting to invoke the API *

createOverpaymentAllocationsForHttpResponse

public com.google.api.client.http.HttpResponse createOverpaymentAllocationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                    throws IOException

Creates a single allocation for a specific overpayment

200 - Success - return response of type Allocations array with all Allocation for Overpayments

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

allocations - Allocations array with Allocation object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createOverpaymentHistory

public HistoryRecords createOverpaymentHistory(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                        throws IOException

Creates a history record for a specific overpayment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error - API is not able to create HistoryRecord for Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createOverpaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createOverpaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                throws IOException

Creates a history record for a specific overpayment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error - API is not able to create HistoryRecord for Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPayment

public Payments createPayment(String accessToken,
 String xeroTenantId,
 Payment payment,
 String idempotencyKey)
                       throws IOException

Creates a single payment for invoice or credit notes

200 - Success - return response of type Payments array for newly created Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payment - Request body with a single Payment object

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Payments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPaymentForHttpResponse

public com.google.api.client.http.HttpResponse createPaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 Payment payment,
 String idempotencyKey)
                                                                     throws IOException

Creates a single payment for invoice or credit notes

200 - Success - return response of type Payments array for newly created Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payment - Request body with a single Payment object

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPaymentHistory

public HistoryRecords createPaymentHistory(String accessToken,
 String xeroTenantId,
 UUID paymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                    throws IOException

Creates a history record for a specific payment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error - API is not able to create HistoryRecord for Payments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createPaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID paymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                            throws IOException

Creates a history record for a specific payment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error - API is not able to create HistoryRecord for Payments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPaymentService

public PaymentServices createPaymentService(String accessToken,
 String xeroTenantId,
 PaymentServices paymentServices,
 String idempotencyKey)
                                     throws IOException

Creates a payment service

200 - Success - return response of type PaymentServices array for newly created PaymentService

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentServices - PaymentServices array with PaymentService object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

PaymentServices

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPaymentServiceForHttpResponse

public com.google.api.client.http.HttpResponse createPaymentServiceForHttpResponse(String accessToken,
 String xeroTenantId,
 PaymentServices paymentServices,
 String idempotencyKey)
                                                                            throws IOException

Creates a payment service

200 - Success - return response of type PaymentServices array for newly created PaymentService

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentServices - PaymentServices array with PaymentService object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPayments

public Payments createPayments(String accessToken,
 String xeroTenantId,
 Payments payments,
 Boolean summarizeErrors,
 String idempotencyKey)
                        throws IOException

Creates multiple payments for invoices or credit notes

200 - Success - return response of type Payments array for newly created Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payments - Payments array with Payment object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Payments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPaymentsForHttpResponse

public com.google.api.client.http.HttpResponse createPaymentsForHttpResponse(String accessToken,
 String xeroTenantId,
 Payments payments,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                      throws IOException

Creates multiple payments for invoices or credit notes

200 - Success - return response of type Payments array for newly created Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

payments - Payments array with Payment object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPrepaymentAllocations

public Allocations createPrepaymentAllocations(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                        throws IOException

Allows you to create an Allocation for prepayments

200 - Success - return response of type Allocations array of Allocation for all Prepayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

allocations - Allocations with an array of Allocation object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Allocations

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPrepaymentAllocationsForHttpResponse

public com.google.api.client.http.HttpResponse createPrepaymentAllocationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 Allocations allocations,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                   throws IOException

Allows you to create an Allocation for prepayments

200 - Success - return response of type Allocations array of Allocation for all Prepayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

allocations - Allocations with an array of Allocation object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPrepaymentHistory

public HistoryRecords createPrepaymentHistory(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                       throws IOException

Creates a history record for a specific prepayment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPrepaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createPrepaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                               throws IOException

Creates a history record for a specific prepayment

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPurchaseOrderAttachmentByFileName

public Attachments createPurchaseOrderAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                    throws IOException

Creates attachment for a specific purchase order

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createPurchaseOrderAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                               throws IOException

Creates attachment for a specific purchase order

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPurchaseOrderAttachmentByFileName

public Attachments createPurchaseOrderAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 File body,
 String idempotencyKey)
                                                    throws IOException

Creates attachment for a specific purchase order

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPurchaseOrderAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                               throws IOException

Creates attachment for a specific purchase order

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPurchaseOrderHistory

public HistoryRecords createPurchaseOrderHistory(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                          throws IOException

Creates a history record for a specific purchase orders

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPurchaseOrderHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createPurchaseOrderHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                  throws IOException

Creates a history record for a specific purchase orders

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createPurchaseOrders

public PurchaseOrders createPurchaseOrders(String accessToken,
 String xeroTenantId,
 PurchaseOrders purchaseOrders,
 Boolean summarizeErrors,
 String idempotencyKey)
                                    throws IOException

Creates one or more purchase orders

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrders - PurchaseOrders with an array of PurchaseOrder object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

createPurchaseOrdersForHttpResponse

public com.google.api.client.http.HttpResponse createPurchaseOrdersForHttpResponse(String accessToken,
 String xeroTenantId,
 PurchaseOrders purchaseOrders,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                            throws IOException

Creates one or more purchase orders

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrders - PurchaseOrders with an array of PurchaseOrder object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createQuoteAttachmentByFileName

public Attachments createQuoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                            throws IOException

Creates attachment for a specific quote

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createQuoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createQuoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                       throws IOException

Creates attachment for a specific quote

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createQuoteAttachmentByFileName

public Attachments createQuoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                            throws IOException

Creates attachment for a specific quote

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createQuoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createQuoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                       throws IOException

Creates attachment for a specific quote

200 - Success - return response of type Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createQuoteHistory

public HistoryRecords createQuoteHistory(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                  throws IOException

Creates a history record for a specific quote

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createQuoteHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createQuoteHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                          throws IOException

Creates a history record for a specific quote

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createQuotes

public Quotes createQuotes(String accessToken,
 String xeroTenantId,
 Quotes quotes,
 Boolean summarizeErrors,
 String idempotencyKey)
                    throws IOException

Create one or more quotes

200 - Success - return response of type Quotes with array with newly created Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quotes - Quotes with an array of Quote object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Quotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

createQuotesForHttpResponse

public com.google.api.client.http.HttpResponse createQuotesForHttpResponse(String accessToken,
 String xeroTenantId,
 Quotes quotes,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                    throws IOException

Create one or more quotes

200 - Success - return response of type Quotes with array with newly created Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quotes - Quotes with an array of Quote object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createReceipt

public Receipts createReceipt(String accessToken,
 String xeroTenantId,
 Receipts receipts,
 Integer unitdp,
 String idempotencyKey)
                       throws IOException

Creates draft expense claim receipts for any user

200 - Success - return response of type Receipts array for newly created Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receipts - Receipts with an array of Receipt object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Receipts

Throws:

IOException - if an error occurs while attempting to invoke the API *

createReceiptForHttpResponse

public com.google.api.client.http.HttpResponse createReceiptForHttpResponse(String accessToken,
 String xeroTenantId,
 Receipts receipts,
 Integer unitdp,
 String idempotencyKey)
                                                                     throws IOException

Creates draft expense claim receipts for any user

200 - Success - return response of type Receipts array for newly created Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receipts - Receipts with an array of Receipt object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createReceiptAttachmentByFileName

public Attachments createReceiptAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createReceiptAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createReceiptAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createReceiptAttachmentByFileName

public Attachments createReceiptAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createReceiptAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createReceiptAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

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

200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createReceiptHistory

public HistoryRecords createReceiptHistory(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                    throws IOException

Creates a history record for a specific receipt

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Receipts

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createReceiptHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createReceiptHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                            throws IOException

Creates a history record for a specific receipt

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Receipts

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createRepeatingInvoiceAttachmentByFileName

public Attachments createRepeatingInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                       throws IOException

Creates an attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

createRepeatingInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                                  throws IOException

Creates an attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

createRepeatingInvoiceAttachmentByFileName

public Attachments createRepeatingInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                                       throws IOException

Creates an attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

createRepeatingInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse createRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                                  throws IOException

Creates an attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createRepeatingInvoiceHistory

public HistoryRecords createRepeatingInvoiceHistory(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                             throws IOException

Creates a history record for a specific repeating invoice

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

createRepeatingInvoiceHistoryForHttpResponse

public com.google.api.client.http.HttpResponse createRepeatingInvoiceHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 HistoryRecords historyRecords,
 String idempotencyKey)
                                                                                     throws IOException

Creates a history record for a specific repeating invoice

200 - Success - return response of type HistoryRecords array of HistoryRecord objects

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createRepeatingInvoices

public RepeatingInvoices createRepeatingInvoices(String accessToken,
 String xeroTenantId,
 RepeatingInvoices repeatingInvoices,
 Boolean summarizeErrors,
 String idempotencyKey)
                                          throws IOException

Creates one or more repeating invoice templates

200 - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

RepeatingInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

createRepeatingInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse createRepeatingInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 RepeatingInvoices repeatingInvoices,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                               throws IOException

Creates one or more repeating invoice templates

200 - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createTaxRates

public TaxRates createTaxRates(String accessToken,
 String xeroTenantId,
 TaxRates taxRates,
 String idempotencyKey)
                        throws IOException

Creates one or more tax rates

200 - Success - return response of type TaxRates array newly created TaxRate

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxRates - TaxRates array with TaxRate object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TaxRates

Throws:

IOException - if an error occurs while attempting to invoke the API *

createTaxRatesForHttpResponse

public com.google.api.client.http.HttpResponse createTaxRatesForHttpResponse(String accessToken,
 String xeroTenantId,
 TaxRates taxRates,
 String idempotencyKey)
                                                                      throws IOException

Creates one or more tax rates

200 - Success - return response of type TaxRates array newly created TaxRate

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxRates - TaxRates array with TaxRate object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createTrackingCategory

public TrackingCategories createTrackingCategory(String accessToken,
 String xeroTenantId,
 TrackingCategory trackingCategory,
 String idempotencyKey)
                                          throws IOException

Create tracking categories

200 - Success - return response of type TrackingCategories array of newly created TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategory - TrackingCategory object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

createTrackingCategoryForHttpResponse

public com.google.api.client.http.HttpResponse createTrackingCategoryForHttpResponse(String accessToken,
 String xeroTenantId,
 TrackingCategory trackingCategory,
 String idempotencyKey)
                                                                              throws IOException

Create tracking categories

200 - Success - return response of type TrackingCategories array of newly created TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategory - TrackingCategory object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

createTrackingOptions

public TrackingOptions createTrackingOptions(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 TrackingOption trackingOption,
 String idempotencyKey)
                                      throws IOException

Creates options for a specific tracking category

200 - Success - return response of type TrackingOptions array of options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOption - TrackingOption object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TrackingOptions

Throws:

IOException - if an error occurs while attempting to invoke the API *

createTrackingOptionsForHttpResponse

public com.google.api.client.http.HttpResponse createTrackingOptionsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 TrackingOption trackingOption,
 String idempotencyKey)
                                                                             throws IOException

Creates options for a specific tracking category

200 - Success - return response of type TrackingOptions array of options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOption - TrackingOption object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteAccount

public Accounts deleteAccount(String accessToken,
 String xeroTenantId,
 UUID accountID)
                       throws IOException

Deletes a chart of accounts

200 - Success - delete existing Account and return response of type Accounts array with deleted Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

Accounts

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteAccountForHttpResponse

public com.google.api.client.http.HttpResponse deleteAccountForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID)
                                                                     throws IOException

Deletes a chart of accounts

200 - Success - delete existing Account and return response of type Accounts array with deleted Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteBatchPayment

public BatchPayments deleteBatchPayment(String accessToken,
 String xeroTenantId,
 BatchPaymentDelete batchPaymentDelete,
 String idempotencyKey)
                                 throws IOException

Updates a specific batch payment for invoices and credit notes

200 - Success - return response of type BatchPayments array for updated BatchPayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentDelete - The batchPaymentDelete parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BatchPayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteBatchPaymentForHttpResponse

public com.google.api.client.http.HttpResponse deleteBatchPaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 BatchPaymentDelete batchPaymentDelete,
 String idempotencyKey)
                                                                          throws IOException

Updates a specific batch payment for invoices and credit notes

200 - Success - return response of type BatchPayments array for updated BatchPayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentDelete - The batchPaymentDelete parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteBatchPaymentByUrlParam

public BatchPayments deleteBatchPaymentByUrlParam(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID,
 BatchPaymentDeleteByUrlParam batchPaymentDeleteByUrlParam,
 String idempotencyKey)
                                           throws IOException

Updates a specific batch payment for invoices and credit notes

200 - Success - return response of type BatchPayments array for updated BatchPayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

batchPaymentDeleteByUrlParam - The batchPaymentDeleteByUrlParam parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BatchPayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteBatchPaymentByUrlParamForHttpResponse

public com.google.api.client.http.HttpResponse deleteBatchPaymentByUrlParamForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID,
 BatchPaymentDeleteByUrlParam batchPaymentDeleteByUrlParam,
 String idempotencyKey)
                                                                                    throws IOException

Updates a specific batch payment for invoices and credit notes

200 - Success - return response of type BatchPayments array for updated BatchPayment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

batchPaymentDeleteByUrlParam - The batchPaymentDeleteByUrlParam parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteContactGroupContact

public void deleteContactGroupContact(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 UUID contactID)
                               throws IOException

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

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contactID - Unique identifier for a Contact

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteContactGroupContactForHttpResponse

public com.google.api.client.http.HttpResponse deleteContactGroupContactForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 UUID contactID)
                                                                                 throws IOException

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

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contactID - Unique identifier for a Contact

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteContactGroupContacts

public void deleteContactGroupContacts(String accessToken,
 String xeroTenantId,
 UUID contactGroupID)
                                throws IOException

Deletes all contacts from a specific contact group

204 - Success - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteContactGroupContactsForHttpResponse

public com.google.api.client.http.HttpResponse deleteContactGroupContactsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactGroupID)
                                                                                  throws IOException

Deletes all contacts from a specific contact group

204 - Success - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteCreditNoteAllocations

public Allocation deleteCreditNoteAllocations(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 UUID allocationID)
                                       throws IOException

Deletes an Allocation from a Credit Note

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

allocationID - Unique identifier for Allocation object

Returns:

Allocation

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteCreditNoteAllocationsForHttpResponse

public com.google.api.client.http.HttpResponse deleteCreditNoteAllocationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 UUID allocationID)
                                                                                   throws IOException

Deletes an Allocation from a Credit Note

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

allocationID - Unique identifier for Allocation object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteItem

public void deleteItem(String accessToken,
 String xeroTenantId,
 UUID itemID)
                throws IOException

Deletes a specific item

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteItemForHttpResponse

public com.google.api.client.http.HttpResponse deleteItemForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID itemID)
                                                                  throws IOException

Deletes a specific item

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteLinkedTransaction

public void deleteLinkedTransaction(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID)
                             throws IOException

Deletes a specific linked transactions (billable expenses)

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteLinkedTransactionForHttpResponse

public com.google.api.client.http.HttpResponse deleteLinkedTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID)
                                                                               throws IOException

Deletes a specific linked transactions (billable expenses)

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteOverpaymentAllocations

public Allocation deleteOverpaymentAllocations(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 UUID allocationID)
                                        throws IOException

Deletes an Allocation from an overpayment

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

allocationID - Unique identifier for Allocation object

Returns:

Allocation

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteOverpaymentAllocationsForHttpResponse

public com.google.api.client.http.HttpResponse deleteOverpaymentAllocationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID overpaymentID,
 UUID allocationID)
                                                                                    throws IOException

Deletes an Allocation from an overpayment

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

allocationID - Unique identifier for Allocation object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deletePayment

public Payments deletePayment(String accessToken,
 String xeroTenantId,
 UUID paymentID,
 PaymentDelete paymentDelete,
 String idempotencyKey)
                       throws IOException

Updates a specific payment for invoices and credit notes

200 - Success - return response of type Payments array for updated Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

paymentDelete - The paymentDelete parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Payments

Throws:

IOException - if an error occurs while attempting to invoke the API *

deletePaymentForHttpResponse

public com.google.api.client.http.HttpResponse deletePaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID paymentID,
 PaymentDelete paymentDelete,
 String idempotencyKey)
                                                                     throws IOException

Updates a specific payment for invoices and credit notes

200 - Success - return response of type Payments array for updated Payment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

paymentDelete - The paymentDelete parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deletePrepaymentAllocations

public Allocation deletePrepaymentAllocations(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 UUID allocationID)
                                       throws IOException

Deletes an Allocation from a Prepayment

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

allocationID - Unique identifier for Allocation object

Returns:

Allocation

Throws:

IOException - if an error occurs while attempting to invoke the API *

deletePrepaymentAllocationsForHttpResponse

public com.google.api.client.http.HttpResponse deletePrepaymentAllocationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID prepaymentID,
 UUID allocationID)
                                                                                   throws IOException

Deletes an Allocation from a Prepayment

200 - Success - return response of type Allocation with the isDeleted flag as true

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

allocationID - Unique identifier for Allocation object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteTrackingCategory

public TrackingCategories deleteTrackingCategory(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID)
                                          throws IOException

Deletes a specific tracking category

200 - Success - return response of type TrackingCategories array of deleted TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteTrackingCategoryForHttpResponse

public com.google.api.client.http.HttpResponse deleteTrackingCategoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID)
                                                                              throws IOException

Deletes a specific tracking category

200 - Success - return response of type TrackingCategories array of deleted TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteTrackingOptions

public TrackingOptions deleteTrackingOptions(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 UUID trackingOptionID)
                                      throws IOException

Deletes a specific option for a specific tracking category

200 - Success - return response of type TrackingOptions array of remaining options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOptionID - Unique identifier for a Tracking Option

Returns:

TrackingOptions

Throws:

IOException - if an error occurs while attempting to invoke the API *

deleteTrackingOptionsForHttpResponse

public com.google.api.client.http.HttpResponse deleteTrackingOptionsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 UUID trackingOptionID)
                                                                             throws IOException

Deletes a specific option for a specific tracking category

200 - Success - return response of type TrackingOptions array of remaining options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOptionID - Unique identifier for a Tracking Option

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

emailInvoice

public void emailInvoice(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 RequestEmpty requestEmpty,
 String idempotencyKey)
                  throws IOException

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

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

requestEmpty - The requestEmpty parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Throws:

IOException - if an error occurs while attempting to invoke the API *

emailInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse emailInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 RequestEmpty requestEmpty,
 String idempotencyKey)
                                                                    throws IOException

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

204 - Success - return response 204 no content

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

requestEmpty - The requestEmpty parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getAccount

public Accounts getAccount(String accessToken,
 String xeroTenantId,
 UUID accountID)
                    throws IOException

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

200 - Success - return response of type Accounts array with one Account

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

Accounts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getAccountForHttpResponse

public com.google.api.client.http.HttpResponse getAccountForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID)
                                                                  throws IOException

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

200 - Success - return response of type Accounts array with one Account

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getAccountAttachmentByFileName

public ByteArrayInputStream getAccountAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 String contentType)
                                                    throws IOException

Retrieves an attachment for a specific account by filename

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getAccountAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getAccountAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 String contentType)
                                                                                      throws IOException

Retrieves an attachment for a specific account by filename

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getAccountAttachmentById

public ByteArrayInputStream getAccountAttachmentById(String accessToken,
 String xeroTenantId,
 UUID accountID,
 UUID attachmentID,
 String contentType)
                                              throws IOException

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

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getAccountAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getAccountAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 UUID attachmentID,
 String contentType)
                                                                                throws IOException

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

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getAccountAttachments

public Attachments getAccountAttachments(String accessToken,
 String xeroTenantId,
 UUID accountID)
                                  throws IOException

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

200 - Success - return response of type Attachments array of Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getAccountAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getAccountAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID)
                                                                             throws IOException

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

200 - Success - return response of type Attachments array of Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getAccounts

public Accounts getAccounts(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                     throws IOException

Retrieves the full chart of accounts

200 - Success - return response of type Accounts array with 0 to n Account

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

Accounts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getAccountsForHttpResponse

public com.google.api.client.http.HttpResponse getAccountsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                   throws IOException

Retrieves the full chart of accounts

200 - Success - return response of type Accounts array with 0 to n Account

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransaction

public BankTransactions getBankTransaction(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 Integer unitdp)
                                    throws IOException

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

200 - Success - return response of type BankTransactions array with a specific BankTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

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

Returns:

BankTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 Integer unitdp)
                                                                          throws IOException

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

200 - Success - return response of type BankTransactions array with a specific BankTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransactionAttachmentByFileName

public ByteArrayInputStream getBankTransactionAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 String contentType)
                                                            throws IOException

Retrieves a specific attachment from a specific bank transaction by filename

200 - Success - return response of attachment for BankTransaction as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 String contentType)
                                                                                              throws IOException

Retrieves a specific attachment from a specific bank transaction by filename

200 - Success - return response of attachment for BankTransaction as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransactionAttachmentById

public ByteArrayInputStream getBankTransactionAttachmentById(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 UUID attachmentID,
 String contentType)
                                                      throws IOException

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

200 - Success - return response of attachment for BankTransaction as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 UUID attachmentID,
 String contentType)
                                                                                        throws IOException

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

200 - Success - return response of attachment for BankTransaction as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransactionAttachments

public Attachments getBankTransactionAttachments(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID)
                                          throws IOException

Retrieves any attachments from a specific bank transactions

200 - Success - return response of type Attachments array with 0 to n Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID)
                                                                                     throws IOException

Retrieves any attachments from a specific bank transactions

200 - Success - return response of type Attachments array with 0 to n Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransactions

public BankTransactions getBankTransactions(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                                     throws IOException

Retrieves any spent or received money transactions

200 - Success - return response of type BankTransactions array with 0 to n BankTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

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

pageSize - Number of records to retrieve per page

Returns:

BankTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionsForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                                                                           throws IOException

Retrieves any spent or received money transactions

200 - Success - return response of type BankTransactions array with 0 to n BankTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

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

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransactionsHistory

public HistoryRecords getBankTransactionsHistory(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID)
                                          throws IOException

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

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransactionsHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransactionsHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID)
                                                                                  throws IOException

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

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransfer

public BankTransfers getBankTransfer(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                              throws IOException

Retrieves specific bank transfers by using a unique bank transfer Id

200 - Success - return response of BankTransfers array with one BankTransfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

BankTransfers

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransferForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransferForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                                                                       throws IOException

Retrieves specific bank transfers by using a unique bank transfer Id

200 - Success - return response of BankTransfers array with one BankTransfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransferAttachmentByFileName

public ByteArrayInputStream getBankTransferAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 String contentType)
                                                         throws IOException

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

200 - Success - return response of binary data from the Attachment to a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransferAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransferAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 String contentType)
                                                                                           throws IOException

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

200 - Success - return response of binary data from the Attachment to a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransferAttachmentById

public ByteArrayInputStream getBankTransferAttachmentById(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 UUID attachmentID,
 String contentType)
                                                   throws IOException

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

200 - Success - return response of binary data from the Attachment to a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransferAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransferAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 UUID attachmentID,
 String contentType)
                                                                                     throws IOException

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

200 - Success - return response of binary data from the Attachment to a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransferAttachments

public Attachments getBankTransferAttachments(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                                       throws IOException

Retrieves attachments from a specific bank transfer

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransferAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransferAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                                                                                  throws IOException

Retrieves attachments from a specific bank transfer

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransferHistory

public HistoryRecords getBankTransferHistory(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                                      throws IOException

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

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransferHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransferHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID)
                                                                              throws IOException

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

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBankTransfers

public BankTransfers getBankTransfers(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                               throws IOException

Retrieves all bank transfers

200 - Success - return response of BankTransfers array of 0 to N BankTransfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

BankTransfers

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBankTransfersForHttpResponse

public com.google.api.client.http.HttpResponse getBankTransfersForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                        throws IOException

Retrieves all bank transfers

200 - Success - return response of BankTransfers array of 0 to N BankTransfer

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBatchPayment

public BatchPayments getBatchPayment(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID)
                              throws IOException

Retrieves a specific batch payment using a unique batch payment Id

200 - Success - return response of type BatchPayments array with matching batch payment Id

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

Returns:

BatchPayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBatchPaymentForHttpResponse

public com.google.api.client.http.HttpResponse getBatchPaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID)
                                                                       throws IOException

Retrieves a specific batch payment using a unique batch payment Id

200 - Success - return response of type BatchPayments array with matching batch payment Id

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBatchPaymentHistory

public HistoryRecords getBatchPaymentHistory(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID)
                                      throws IOException

Retrieves history from a specific batch payment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBatchPaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getBatchPaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID batchPaymentID)
                                                                              throws IOException

Retrieves history from a specific batch payment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

batchPaymentID - Unique identifier for BatchPayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBatchPayments

public BatchPayments getBatchPayments(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                               throws IOException

Retrieves either one or many batch payments for invoices

200 - Success - return response of type BatchPayments array of BatchPayment objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

BatchPayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBatchPaymentsForHttpResponse

public com.google.api.client.http.HttpResponse getBatchPaymentsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                        throws IOException

Retrieves either one or many batch payments for invoices

200 - Success - return response of type BatchPayments array of BatchPayment objects

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBrandingTheme

public BrandingThemes getBrandingTheme(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID)
                                throws IOException

Retrieves a specific branding theme using a unique branding theme Id

200 - Success - return response of type BrandingThemes with one BrandingTheme

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

Returns:

BrandingThemes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBrandingThemeForHttpResponse

public com.google.api.client.http.HttpResponse getBrandingThemeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID)
                                                                        throws IOException

Retrieves a specific branding theme using a unique branding theme Id

200 - Success - return response of type BrandingThemes with one BrandingTheme

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBrandingThemePaymentServices

public PaymentServices getBrandingThemePaymentServices(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID)
                                                throws IOException

Retrieves the payment services for a specific branding theme

200 - Success - return response of type PaymentServices array with 0 to N PaymentService

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

Returns:

PaymentServices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBrandingThemePaymentServicesForHttpResponse

public com.google.api.client.http.HttpResponse getBrandingThemePaymentServicesForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID brandingThemeID)
                                                                                       throws IOException

Retrieves the payment services for a specific branding theme

200 - Success - return response of type PaymentServices array with 0 to N PaymentService

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

brandingThemeID - Unique identifier for a Branding Theme

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBrandingThemes

public BrandingThemes getBrandingThemes(String accessToken,
 String xeroTenantId)
                                 throws IOException

Retrieves all the branding themes

200 - Success - return response of type BrandingThemes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

BrandingThemes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBrandingThemesForHttpResponse

public com.google.api.client.http.HttpResponse getBrandingThemesForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                         throws IOException

Retrieves all the branding themes

200 - Success - return response of type BrandingThemes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBudget

public Budgets getBudget(String accessToken,
 String xeroTenantId,
 UUID budgetID,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate dateFrom)
                  throws IOException

Retrieves a specific budget, which includes budget lines

200 - Success - return response of type Invoices array with specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

budgetID - Unique identifier for Budgets

dateTo - Filter by start date

dateFrom - Filter by end date

Returns:

Budgets

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBudgetForHttpResponse

public com.google.api.client.http.HttpResponse getBudgetForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID budgetID,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate dateFrom)
                                                                 throws IOException

Retrieves a specific budget, which includes budget lines

200 - Success - return response of type Invoices array with specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

budgetID - Unique identifier for Budgets

dateTo - Filter by start date

dateFrom - Filter by end date

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getBudgets

public Budgets getBudgets(String accessToken,
 String xeroTenantId,
 List<UUID> ids,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate dateFrom)
                   throws IOException

Retrieve a list of budgets

200 - Success - return response of type Budgets array with 0 to N Budgets

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ids - Filter by BudgetID. Allows you to retrieve a specific individual budget.

dateTo - Filter by start date

dateFrom - Filter by end date

Returns:

Budgets

Throws:

IOException - if an error occurs while attempting to invoke the API *

getBudgetsForHttpResponse

public com.google.api.client.http.HttpResponse getBudgetsForHttpResponse(String accessToken,
 String xeroTenantId,
 List<UUID> ids,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate dateFrom)
                                                                  throws IOException

Retrieve a list of budgets

200 - Success - return response of type Budgets array with 0 to N Budgets

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ids - Filter by BudgetID. Allows you to retrieve a specific individual budget.

dateTo - Filter by start date

dateFrom - Filter by end date

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContact

public Contacts getContact(String accessToken,
 String xeroTenantId,
 UUID contactID)
                    throws IOException

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

200 - Success - return response of type Contacts array with a unique Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactForHttpResponse

public com.google.api.client.http.HttpResponse getContactForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                                                  throws IOException

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

200 - Success - return response of type Contacts array with a unique Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactAttachmentByFileName

public ByteArrayInputStream getContactAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 String contentType)
                                                    throws IOException

Retrieves a specific attachment from a specific contact by file name

200 - Success - return response of attachment for Contact as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getContactAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 String contentType)
                                                                                      throws IOException

Retrieves a specific attachment from a specific contact by file name

200 - Success - return response of attachment for Contact as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactAttachmentById

public ByteArrayInputStream getContactAttachmentById(String accessToken,
 String xeroTenantId,
 UUID contactID,
 UUID attachmentID,
 String contentType)
                                              throws IOException

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

200 - Success - return response of attachment for Contact as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getContactAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 UUID attachmentID,
 String contentType)
                                                                                throws IOException

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

200 - Success - return response of attachment for Contact as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactAttachments

public Attachments getContactAttachments(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                  throws IOException

Retrieves attachments for a specific contact in a Xero organisation

200 - Success - return response of type Attachments array with 0 to N Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getContactAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                                                             throws IOException

Retrieves attachments for a specific contact in a Xero organisation

200 - Success - return response of type Attachments array with 0 to N Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactByContactNumber

public Contacts getContactByContactNumber(String accessToken,
 String xeroTenantId,
 String contactNumber)
                                   throws IOException

Retrieves a specific contact by contact number in a Xero organisation

200 - Success - return response of type Contacts array with a unique Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

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

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactByContactNumberForHttpResponse

public com.google.api.client.http.HttpResponse getContactByContactNumberForHttpResponse(String accessToken,
 String xeroTenantId,
 String contactNumber)
                                                                                 throws IOException

Retrieves a specific contact by contact number in a Xero organisation

200 - Success - return response of type Contacts array with a unique Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactCISSettings

public CISSettings getContactCISSettings(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                  throws IOException

Retrieves CIS settings for a specific contact in a Xero organisation

200 - Success - return response of type CISSettings for a specific Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

CISSettings

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactCISSettingsForHttpResponse

public com.google.api.client.http.HttpResponse getContactCISSettingsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                                                             throws IOException

Retrieves CIS settings for a specific contact in a Xero organisation

200 - Success - return response of type CISSettings for a specific Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactGroup

public ContactGroups getContactGroup(String accessToken,
 String xeroTenantId,
 UUID contactGroupID)
                              throws IOException

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

200 - Success - return response of type Contact Groups array with a specific Contact Group

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

Returns:

ContactGroups

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactGroupForHttpResponse

public com.google.api.client.http.HttpResponse getContactGroupForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactGroupID)
                                                                       throws IOException

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

200 - Success - return response of type Contact Groups array with a specific Contact Group

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactGroups

public ContactGroups getContactGroups(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                               throws IOException

Retrieves the contact Id and name of each contact group

200 - Success - return response of type Contact Groups array of Contact Group

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

ContactGroups

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactGroupsForHttpResponse

public com.google.api.client.http.HttpResponse getContactGroupsForHttpResponse(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                                                                        throws IOException

Retrieves the contact Id and name of each contact group

200 - Success - return response of type Contact Groups array of Contact Group

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContactHistory

public HistoryRecords getContactHistory(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                 throws IOException

Retrieves history records for a specific contact

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getContactHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID)
                                                                         throws IOException

Retrieves history records for a specific contact

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getContacts

public Contacts getContacts(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 List<UUID> ids,
 Integer page,
 Boolean includeArchived,
 Boolean summaryOnly,
 String searchTerm,
 Integer pageSize)
                     throws IOException

Retrieves all contacts in a Xero organisation

200 - Success - return response of type Contacts array with 0 to N Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

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

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

summaryOnly - 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 - Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.

pageSize - Number of records to retrieve per page

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getContactsForHttpResponse

public com.google.api.client.http.HttpResponse getContactsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 List<UUID> ids,
 Integer page,
 Boolean includeArchived,
 Boolean summaryOnly,
 String searchTerm,
 Integer pageSize)
                                                                   throws IOException

Retrieves all contacts in a Xero organisation

200 - Success - return response of type Contacts array with 0 to N Contact

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

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

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

summaryOnly - 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 - Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNote

public CreditNotes getCreditNote(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 Integer unitdp)
                          throws IOException

Retrieves a specific credit note using a unique credit note Id

200 - Success - return response of type Credit Notes array with a unique CreditNote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

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

Returns:

CreditNotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 Integer unitdp)
                                                                     throws IOException

Retrieves a specific credit note using a unique credit note Id

200 - Success - return response of type Credit Notes array with a unique CreditNote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNoteAsPdf

public ByteArrayInputStream getCreditNoteAsPdf(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                        throws IOException

Retrieves credit notes as PDF files

200 - Success - return response of binary data from the Attachment to a Credit Note

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteAsPdfForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteAsPdfForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                                                          throws IOException

Retrieves credit notes as PDF files

200 - Success - return response of binary data from the Attachment to a Credit Note

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNoteAttachmentByFileName

public ByteArrayInputStream getCreditNoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 String contentType)
                                                       throws IOException

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

200 - Success - return response of attachment for Credit Note as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 String contentType)
                                                                                         throws IOException

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

200 - Success - return response of attachment for Credit Note as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNoteAttachmentById

public ByteArrayInputStream getCreditNoteAttachmentById(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 UUID attachmentID,
 String contentType)
                                                 throws IOException

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

200 - Success - return response of attachment for Credit Note as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 UUID attachmentID,
 String contentType)
                                                                                   throws IOException

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

200 - Success - return response of attachment for Credit Note as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNoteAttachments

public Attachments getCreditNoteAttachments(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                     throws IOException

Retrieves attachments for a specific credit notes

200 - Success - return response of type Attachments array with all Attachment for specific Credit Note

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                                                                throws IOException

Retrieves attachments for a specific credit notes

200 - Success - return response of type Attachments array with all Attachment for specific Credit Note

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNoteHistory

public HistoryRecords getCreditNoteHistory(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                    throws IOException

Retrieves history records of a specific credit note

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNoteHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNoteHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID)
                                                                            throws IOException

Retrieves history records of a specific credit note

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCreditNotes

public CreditNotes getCreditNotes(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                           throws IOException

Retrieves any credit notes

200 - Success - return response of type Credit Notes array of CreditNote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - 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 - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

pageSize - Number of records to retrieve per page

Returns:

CreditNotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCreditNotesForHttpResponse

public com.google.api.client.http.HttpResponse getCreditNotesForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                                                                      throws IOException

Retrieves any credit notes

200 - Success - return response of type Credit Notes array of CreditNote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - 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 - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getCurrencies

public Currencies getCurrencies(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                         throws IOException

Retrieves currencies for your Xero organisation

200 - Success - return response of type Currencies array with all Currencies

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

Currencies

Throws:

IOException - if an error occurs while attempting to invoke the API *

getCurrenciesForHttpResponse

public com.google.api.client.http.HttpResponse getCurrenciesForHttpResponse(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                                                                     throws IOException

Retrieves currencies for your Xero organisation

200 - Success - return response of type Currencies array with all Currencies

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployee

public Employees getEmployee(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                      throws IOException

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

200 - Success - return response of type Employees array with specified Employee

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Unique identifier for a Employee

Returns:

Employees

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeeForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeeForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID employeeID)
                                                                   throws IOException

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

200 - Success - return response of type Employees array with specified Employee

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employeeID - Unique identifier for a Employee

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getEmployees

public Employees getEmployees(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                       throws IOException

Retrieves employees used in Xero payrun

200 - Success - return response of type Employees array with all Employee

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

Employees

Throws:

IOException - if an error occurs while attempting to invoke the API *

getEmployeesForHttpResponse

public com.google.api.client.http.HttpResponse getEmployeesForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                    throws IOException

Retrieves employees used in Xero payrun

200 - Success - return response of type Employees array with all Employee

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getExpenseClaim

public ExpenseClaims getExpenseClaim(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID)
                              throws IOException

Retrieves a specific expense claim using a unique expense claim Id

200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

Returns:

ExpenseClaims

Throws:

IOException - if an error occurs while attempting to invoke the API *

getExpenseClaimForHttpResponse

public com.google.api.client.http.HttpResponse getExpenseClaimForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID)
                                                                       throws IOException

Retrieves a specific expense claim using a unique expense claim Id

200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getExpenseClaimHistory

public HistoryRecords getExpenseClaimHistory(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID)
                                      throws IOException

Retrieves history records of a specific expense claim

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getExpenseClaimHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getExpenseClaimHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID)
                                                                              throws IOException

Retrieves history records of a specific expense claim

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getExpenseClaims

public ExpenseClaims getExpenseClaims(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                               throws IOException

Retrieves expense claims

200 - Success - return response of type ExpenseClaims array with all ExpenseClaims

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

ExpenseClaims

Throws:

IOException - if an error occurs while attempting to invoke the API *

getExpenseClaimsForHttpResponse

public com.google.api.client.http.HttpResponse getExpenseClaimsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                        throws IOException

Retrieves expense claims

200 - Success - return response of type ExpenseClaims array with all ExpenseClaims

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoice

public Invoices getInvoice(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 Integer unitdp)
                    throws IOException

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

200 - Success - return response of type Invoices array with specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

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

Returns:

Invoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 Integer unitdp)
                                                                  throws IOException

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

200 - Success - return response of type Invoices array with specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceAsPdf

public ByteArrayInputStream getInvoiceAsPdf(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                     throws IOException

Retrieves invoices or purchase bills as PDF files

200 - Success - return response of byte array pdf version of specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceAsPdfForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceAsPdfForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                                                       throws IOException

Retrieves invoices or purchase bills as PDF files

200 - Success - return response of byte array pdf version of specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceAttachmentByFileName

public ByteArrayInputStream getInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 String contentType)
                                                    throws IOException

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

200 - Success - return response of attachment for Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 String contentType)
                                                                                      throws IOException

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

200 - Success - return response of attachment for Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceAttachmentById

public ByteArrayInputStream getInvoiceAttachmentById(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 UUID attachmentID,
 String contentType)
                                              throws IOException

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

200 - Success - return response of attachment for Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 UUID attachmentID,
 String contentType)
                                                                                throws IOException

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

200 - Success - return response of attachment for Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceAttachments

public Attachments getInvoiceAttachments(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                  throws IOException

Retrieves attachments for a specific invoice or purchase bill

200 - Success - return response of type Attachments array of Attachments for specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                                                             throws IOException

Retrieves attachments for a specific invoice or purchase bill

200 - Success - return response of type Attachments array of Attachments for specified Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceHistory

public HistoryRecords getInvoiceHistory(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                 throws IOException

Retrieves history records for a specific invoice

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                                                         throws IOException

Retrieves history records for a specific invoice

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoiceReminders

public InvoiceReminders getInvoiceReminders(String accessToken,
 String xeroTenantId)
                                     throws IOException

Retrieves invoice reminder settings

200 - Success - return response of Invoice Reminders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

InvoiceReminders

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoiceRemindersForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceRemindersForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                           throws IOException

Retrieves invoice reminder settings

200 - Success - return response of Invoice Reminders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getInvoices

public Invoices getInvoices(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 List<UUID> ids,
 List<String> invoiceNumbers,
 List<UUID> contactIDs,
 List<String> statuses,
 Integer page,
 Boolean includeArchived,
 Boolean createdByMyApp,
 Integer unitdp,
 Boolean summaryOnly,
 Integer pageSize,
 String searchTerm)
                     throws IOException

Retrieves sales invoices or purchase bills

200 - Success - return response of type Invoices array with all Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

ids - Filter by a comma-separated list of InvoicesIDs.

invoiceNumbers - Filter by a comma-separated list of InvoiceNumbers.

contactIDs - Filter by a comma-separated list of ContactIDs.

statuses - 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 - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice

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

createdByMyApp - When set to true you'll only retrieve Invoices created by your app

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

summaryOnly - 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 - Number of records to retrieve per page

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

Returns:

Invoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse getInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 List<UUID> ids,
 List<String> invoiceNumbers,
 List<UUID> contactIDs,
 List<String> statuses,
 Integer page,
 Boolean includeArchived,
 Boolean createdByMyApp,
 Integer unitdp,
 Boolean summaryOnly,
 Integer pageSize,
 String searchTerm)
                                                                   throws IOException

Retrieves sales invoices or purchase bills

200 - Success - return response of type Invoices array with all Invoices

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

ids - Filter by a comma-separated list of InvoicesIDs.

invoiceNumbers - Filter by a comma-separated list of InvoiceNumbers.

contactIDs - Filter by a comma-separated list of ContactIDs.

statuses - 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 - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice

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

createdByMyApp - When set to true you'll only retrieve Invoices created by your app

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

summaryOnly - 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 - Number of records to retrieve per page

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getItem

public Items getItem(String accessToken,
 String xeroTenantId,
 UUID itemID,
 Integer unitdp)
              throws IOException

Retrieves a specific item using a unique item Id

200 - Success - return response of type Items array with specified Item

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

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

Returns:

Items

Throws:

IOException - if an error occurs while attempting to invoke the API *

getItemForHttpResponse

public com.google.api.client.http.HttpResponse getItemForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID itemID,
 Integer unitdp)
                                                               throws IOException

Retrieves a specific item using a unique item Id

200 - Success - return response of type Items array with specified Item

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getItemHistory

public HistoryRecords getItemHistory(String accessToken,
 String xeroTenantId,
 UUID itemID)
                              throws IOException

Retrieves history for a specific item

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getItemHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getItemHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID itemID)
                                                                      throws IOException

Retrieves history for a specific item

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getItems

public Items getItems(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer unitdp)
               throws IOException

Retrieves items

200 - Success - return response of type Items array with all Item

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

Returns:

Items

Throws:

IOException - if an error occurs while attempting to invoke the API *

getItemsForHttpResponse

public com.google.api.client.http.HttpResponse getItemsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer unitdp)
                                                                throws IOException

Retrieves items

200 - Success - return response of type Items array with all Item

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getJournal

public Journals getJournal(String accessToken,
 String xeroTenantId,
 UUID journalID)
                    throws IOException

Retrieves a specific journal using a unique journal Id.

200 - Success - return response of type Journals array with specified Journal

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

journalID - Unique identifier for a Journal

Returns:

Journals

Throws:

IOException - if an error occurs while attempting to invoke the API *

getJournalForHttpResponse

public com.google.api.client.http.HttpResponse getJournalForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID journalID)
                                                                  throws IOException

Retrieves a specific journal using a unique journal Id.

200 - Success - return response of type Journals array with specified Journal

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

journalID - Unique identifier for a Journal

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getJournalByNumber

public Journals getJournalByNumber(String accessToken,
 String xeroTenantId,
 Integer journalNumber)
                            throws IOException

Retrieves a specific journal using a unique journal number.

200 - Success - return response of type Journals array with specified Journal

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

journalNumber - Number of a Journal

Returns:

Journals

Throws:

IOException - if an error occurs while attempting to invoke the API *

getJournalByNumberForHttpResponse

public com.google.api.client.http.HttpResponse getJournalByNumberForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer journalNumber)
                                                                          throws IOException

Retrieves a specific journal using a unique journal number.

200 - Success - return response of type Journals array with specified Journal

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

journalNumber - Number of a Journal

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getJournals

public Journals getJournals(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 Integer offset,
 Boolean paymentsOnly)
                     throws IOException

Retrieves journals

200 - Success - return response of type Journals array with all Journals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

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

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

Returns:

Journals

Throws:

IOException - if an error occurs while attempting to invoke the API *

getJournalsForHttpResponse

public com.google.api.client.http.HttpResponse getJournalsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 Integer offset,
 Boolean paymentsOnly)
                                                                   throws IOException

Retrieves journals

200 - Success - return response of type Journals array with all Journals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

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

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getLinkedTransaction

public LinkedTransactions getLinkedTransaction(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID)
                                        throws IOException

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

200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

Returns:

LinkedTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getLinkedTransactionForHttpResponse

public com.google.api.client.http.HttpResponse getLinkedTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID)
                                                                            throws IOException

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

200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getLinkedTransactions

public LinkedTransactions getLinkedTransactions(String accessToken,
 String xeroTenantId,
 Integer page,
 UUID linkedTransactionID,
 UUID sourceTransactionID,
 UUID contactID,
 String status,
 UUID targetTransactionID)
                                         throws IOException

Retrieves linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with all LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - 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 - The Xero identifier for an Linked Transaction

sourceTransactionID - Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice

contactID - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.

status - Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status

targetTransactionID - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

Returns:

LinkedTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getLinkedTransactionsForHttpResponse

public com.google.api.client.http.HttpResponse getLinkedTransactionsForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer page,
 UUID linkedTransactionID,
 UUID sourceTransactionID,
 UUID contactID,
 String status,
 UUID targetTransactionID)
                                                                             throws IOException

Retrieves linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with all LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

page - 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 - The Xero identifier for an Linked Transaction

sourceTransactionID - Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice

contactID - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.

status - Filter by the combination of ContactID and Status. Get the linked transactions associated to a customer and with a status

targetTransactionID - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournal

public ManualJournals getManualJournal(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                throws IOException

Retrieves a specific manual journal

200 - Success - return response of type ManualJournals array with a specified ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

ManualJournals

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                                                        throws IOException

Retrieves a specific manual journal

200 - Success - return response of type ManualJournals array with a specified ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournalAttachmentByFileName

public ByteArrayInputStream getManualJournalAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 String contentType)
                                                          throws IOException

Retrieves a specific attachment from a specific manual journal by file name

200 - Success - return response of attachment for Manual Journal as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 String contentType)
                                                                                            throws IOException

Retrieves a specific attachment from a specific manual journal by file name

200 - Success - return response of attachment for Manual Journal as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournalAttachmentById

public ByteArrayInputStream getManualJournalAttachmentById(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 UUID attachmentID,
 String contentType)
                                                    throws IOException

Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id

200 - Success - return response of attachment for Manual Journal as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 UUID attachmentID,
 String contentType)
                                                                                      throws IOException

Allows you to retrieve a specific attachment from a specific manual journal using a unique attachment Id

200 - Success - return response of attachment for Manual Journal as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournalAttachments

public Attachments getManualJournalAttachments(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                        throws IOException

Retrieves attachment for a specific manual journal

200 - Success - return response of type Attachments array with all Attachments for a ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                                                                   throws IOException

Retrieves attachment for a specific manual journal

200 - Success - return response of type Attachments array with all Attachments for a ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournals

public ManualJournals getManualJournals(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer pageSize)
                                 throws IOException

Retrieves manual journals

200 - Success - return response of type ManualJournals array with a all ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - 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 - Number of records to retrieve per page

Returns:

ManualJournals

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalsForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer pageSize)
                                                                         throws IOException

Retrieves manual journals

200 - Success - return response of type ManualJournals array with a all ManualJournals

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - 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 - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getManualJournalsHistory

public HistoryRecords getManualJournalsHistory(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                        throws IOException

Retrieves history for a specific manual journal

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getManualJournalsHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getManualJournalsHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID)
                                                                                throws IOException

Retrieves history for a specific manual journal

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOnlineInvoice

public OnlineInvoices getOnlineInvoice(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                throws IOException

Retrieves a URL to an online invoice

200 - Success - return response of type OnlineInvoice array with one OnlineInvoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

OnlineInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOnlineInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse getOnlineInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID)
                                                                        throws IOException

Retrieves a URL to an online invoice

200 - Success - return response of type OnlineInvoice array with one OnlineInvoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOrganisationActions

public Actions getOrganisationActions(String accessToken,
 String xeroTenantId)
                               throws IOException

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.

200 - Success - return response of type Actions array with all key actions

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

Actions

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOrganisationActionsForHttpResponse

public com.google.api.client.http.HttpResponse getOrganisationActionsForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                              throws IOException

Retrieves a list of the key actions your app has permission to perform in the connected Xero organisation.

200 - Success - return response of type Actions array with all key actions

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOrganisationCISSettings

public CISOrgSettings getOrganisationCISSettings(String accessToken,
 String xeroTenantId,
 UUID organisationID)
                                          throws IOException

Retrieves the CIS settings for the Xero organistaion.

200 - Success - return response of type Organisation array with specified Organisation

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

organisationID - The unique Xero identifier for an organisation

Returns:

CISOrgSettings

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOrganisationCISSettingsForHttpResponse

public com.google.api.client.http.HttpResponse getOrganisationCISSettingsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID organisationID)
                                                                                  throws IOException

Retrieves the CIS settings for the Xero organistaion.

200 - Success - return response of type Organisation array with specified Organisation

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

organisationID - The unique Xero identifier for an organisation

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOrganisations

public Organisations getOrganisations(String accessToken,
 String xeroTenantId)
                               throws IOException

Retrieves Xero organisation details

200 - Success - return response of type Organisation array with all Organisation

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

Organisations

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOrganisationsForHttpResponse

public com.google.api.client.http.HttpResponse getOrganisationsForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                        throws IOException

Retrieves Xero organisation details

200 - Success - return response of type Organisation array with all Organisation

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOverpayment

public Overpayments getOverpayment(String accessToken,
 String xeroTenantId,
 UUID overpaymentID)
                            throws IOException

Retrieves a specific overpayment using a unique overpayment Id

200 - Success - return response of type Overpayments array with specified Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

Returns:

Overpayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOverpaymentForHttpResponse

public com.google.api.client.http.HttpResponse getOverpaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID overpaymentID)
                                                                      throws IOException

Retrieves a specific overpayment using a unique overpayment Id

200 - Success - return response of type Overpayments array with specified Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOverpaymentHistory

public HistoryRecords getOverpaymentHistory(String accessToken,
 String xeroTenantId,
 UUID overpaymentID)
                                     throws IOException

Retrieves history records of a specific overpayment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOverpaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getOverpaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID overpaymentID)
                                                                             throws IOException

Retrieves history records of a specific overpayment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

overpaymentID - Unique identifier for a Overpayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getOverpayments

public Overpayments getOverpayments(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                             throws IOException

Retrieves overpayments

200 - Success - return response of type Overpayments array with all Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment

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

pageSize - Number of records to retrieve per page

Returns:

Overpayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getOverpaymentsForHttpResponse

public com.google.api.client.http.HttpResponse getOverpaymentsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                                                                       throws IOException

Retrieves overpayments

200 - Success - return response of type Overpayments array with all Overpayments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment

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

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayment

public Payments getPayment(String accessToken,
 String xeroTenantId,
 UUID paymentID)
                    throws IOException

Retrieves a specific payment for invoices and credit notes using a unique payment Id

200 - Success - return response of type Payments array for specified Payment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

Returns:

Payments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaymentForHttpResponse

public com.google.api.client.http.HttpResponse getPaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID paymentID)
                                                                  throws IOException

Retrieves a specific payment for invoices and credit notes using a unique payment Id

200 - Success - return response of type Payments array for specified Payment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPaymentHistory

public HistoryRecords getPaymentHistory(String accessToken,
 String xeroTenantId,
 UUID paymentID)
                                 throws IOException

Retrieves history records of a specific payment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getPaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID paymentID)
                                                                         throws IOException

Retrieves history records of a specific payment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

paymentID - Unique identifier for a Payment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPaymentServices

public PaymentServices getPaymentServices(String accessToken,
 String xeroTenantId)
                                   throws IOException

Retrieves payment services

200 - Success - return response of type PaymentServices array for all PaymentService

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

PaymentServices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaymentServicesForHttpResponse

public com.google.api.client.http.HttpResponse getPaymentServicesForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                          throws IOException

Retrieves payment services

200 - Success - return response of type PaymentServices array for all PaymentService

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPayments

public Payments getPayments(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer pageSize)
                     throws IOException

Retrieves payments for invoices and credit notes

200 - Success - return response of type Payments array for all Payments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - Up to 100 payments will be returned in a single API call

pageSize - Number of records to retrieve per page

Returns:

Payments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPaymentsForHttpResponse

public com.google.api.client.http.HttpResponse getPaymentsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer pageSize)
                                                                   throws IOException

Retrieves payments for invoices and credit notes

200 - Success - return response of type Payments array for all Payments

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - Up to 100 payments will be returned in a single API call

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPrepayment

public Prepayments getPrepayment(String accessToken,
 String xeroTenantId,
 UUID prepaymentID)
                          throws IOException

Allows you to retrieve a specified prepayments

200 - Success - return response of type Prepayments array for a specified Prepayment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

Returns:

Prepayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPrepaymentForHttpResponse

public com.google.api.client.http.HttpResponse getPrepaymentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID prepaymentID)
                                                                     throws IOException

Allows you to retrieve a specified prepayments

200 - Success - return response of type Prepayments array for a specified Prepayment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPrepaymentHistory

public HistoryRecords getPrepaymentHistory(String accessToken,
 String xeroTenantId,
 UUID prepaymentID)
                                    throws IOException

Retrieves history record for a specific prepayment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPrepaymentHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getPrepaymentHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID prepaymentID)
                                                                            throws IOException

Retrieves history record for a specific prepayment

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

prepaymentID - Unique identifier for a PrePayment

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPrepayments

public Prepayments getPrepayments(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                           throws IOException

Retrieves prepayments

200 - Success - return response of type Prepayments array for all Prepayment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment

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

pageSize - Number of records to retrieve per page

Returns:

Prepayments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPrepaymentsForHttpResponse

public com.google.api.client.http.HttpResponse getPrepaymentsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer page,
 Integer unitdp,
 Integer pageSize)
                                                                      throws IOException

Retrieves prepayments

200 - Success - return response of type Prepayments array for all Prepayment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

page - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment

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

pageSize - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrder

public PurchaseOrders getPurchaseOrder(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                throws IOException

Retrieves a specific purchase order using a unique purchase order Id

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                                                        throws IOException

Retrieves a specific purchase order using a unique purchase order Id

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderAsPdf

public ByteArrayInputStream getPurchaseOrderAsPdf(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                           throws IOException

Retrieves specific purchase order as PDF files using a unique purchase order Id

200 - Success - return response of byte array pdf version of specified Purchase Orders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderAsPdfForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderAsPdfForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                                                             throws IOException

Retrieves specific purchase order as PDF files using a unique purchase order Id

200 - Success - return response of byte array pdf version of specified Purchase Orders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderAttachmentByFileName

public ByteArrayInputStream getPurchaseOrderAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 String contentType)
                                                          throws IOException

Retrieves a specific attachment for a specific purchase order by filename

200 - Success - return response of attachment for Purchase Order as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 String contentType)
                                                                                            throws IOException

Retrieves a specific attachment for a specific purchase order by filename

200 - Success - return response of attachment for Purchase Order as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderAttachmentById

public ByteArrayInputStream getPurchaseOrderAttachmentById(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 UUID attachmentID,
 String contentType)
                                                    throws IOException

Retrieves specific attachment for a specific purchase order using a unique attachment Id

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 UUID attachmentID,
 String contentType)
                                                                                      throws IOException

Retrieves specific attachment for a specific purchase order using a unique attachment Id

200 - Success - return response of attachment for Account as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderAttachments

public Attachments getPurchaseOrderAttachments(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                        throws IOException

Retrieves attachments for a specific purchase order

200 - Success - return response of type Attachments array of Purchase Orders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                                                                   throws IOException

Retrieves attachments for a specific purchase order

200 - Success - return response of type Attachments array of Purchase Orders

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderByNumber

public PurchaseOrders getPurchaseOrderByNumber(String accessToken,
 String xeroTenantId,
 String purchaseOrderNumber)
                                        throws IOException

Retrieves a specific purchase order using purchase order number

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderNumber - Unique identifier for a PurchaseOrder

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderByNumberForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderByNumberForHttpResponse(String accessToken,
 String xeroTenantId,
 String purchaseOrderNumber)
                                                                                throws IOException

Retrieves a specific purchase order using purchase order number

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderNumber - Unique identifier for a PurchaseOrder

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrderHistory

public HistoryRecords getPurchaseOrderHistory(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                       throws IOException

Retrieves history for a specific purchase order

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrderHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrderHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID)
                                                                               throws IOException

Retrieves history for a specific purchase order

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getPurchaseOrders

public PurchaseOrders getPurchaseOrders(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String status,
 String dateFrom,
 String dateTo,
 String order,
 Integer page,
 Integer pageSize)
                                 throws IOException

Retrieves purchase orders

200 - Success - return response of type PurchaseOrder array of all PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

status - Filter by purchase order status

dateFrom - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

dateTo - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

order - Order by an any element

page - 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 - Number of records to retrieve per page

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

getPurchaseOrdersForHttpResponse

public com.google.api.client.http.HttpResponse getPurchaseOrdersForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String status,
 String dateFrom,
 String dateTo,
 String order,
 Integer page,
 Integer pageSize)
                                                                         throws IOException

Retrieves purchase orders

200 - Success - return response of type PurchaseOrder array of all PurchaseOrder

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

status - Filter by purchase order status

dateFrom - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

dateTo - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

order - Order by an any element

page - 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 - Number of records to retrieve per page

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuote

public Quotes getQuote(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                throws IOException

Retrieves a specific quote using a unique quote Id

200 - Success - return response of type Quotes array with specified Quote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

Quotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                                                throws IOException

Retrieves a specific quote using a unique quote Id

200 - Success - return response of type Quotes array with specified Quote

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuoteAsPdf

public ByteArrayInputStream getQuoteAsPdf(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                   throws IOException

Retrieves a specific quote as a PDF file using a unique quote Id

200 - Success - return response of byte array pdf version of specified Quotes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteAsPdfForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteAsPdfForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                                                     throws IOException

Retrieves a specific quote as a PDF file using a unique quote Id

200 - Success - return response of byte array pdf version of specified Quotes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuoteAttachmentByFileName

public ByteArrayInputStream getQuoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 String contentType)
                                                  throws IOException

Retrieves a specific attachment from a specific quote by filename

200 - Success - return response of attachment for Quote as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 String contentType)
                                                                                    throws IOException

Retrieves a specific attachment from a specific quote by filename

200 - Success - return response of attachment for Quote as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuoteAttachmentById

public ByteArrayInputStream getQuoteAttachmentById(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 UUID attachmentID,
 String contentType)
                                            throws IOException

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

200 - Success - return response of attachment for Quote as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 UUID attachmentID,
 String contentType)
                                                                              throws IOException

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

200 - Success - return response of attachment for Quote as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuoteAttachments

public Attachments getQuoteAttachments(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                throws IOException

Retrieves attachments for a specific quote

200 - Success - return response of type Attachments array of Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                                                           throws IOException

Retrieves attachments for a specific quote

200 - Success - return response of type Attachments array of Attachment

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuoteHistory

public HistoryRecords getQuoteHistory(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                               throws IOException

Retrieves history records of a specific quote

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuoteHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getQuoteHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID)
                                                                       throws IOException

Retrieves history records of a specific quote

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getQuotes

public Quotes getQuotes(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 org.threeten.bp.LocalDate dateFrom,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate expiryDateFrom,
 org.threeten.bp.LocalDate expiryDateTo,
 UUID contactID,
 String status,
 Integer page,
 String order,
 String quoteNumber)
                 throws IOException

Retrieves sales quotes

200 - Success - return response of type quotes array with all quotes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

dateFrom - Filter for quotes after a particular date

dateTo - Filter for quotes before a particular date

expiryDateFrom - Filter for quotes expiring after a particular date

expiryDateTo - Filter for quotes before a particular date

contactID - Filter for quotes belonging to a particular contact

status - Filter for quotes of a particular Status

page - e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote

order - Order by an any element

quoteNumber - Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)

Returns:

Quotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

getQuotesForHttpResponse

public com.google.api.client.http.HttpResponse getQuotesForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 org.threeten.bp.LocalDate dateFrom,
 org.threeten.bp.LocalDate dateTo,
 org.threeten.bp.LocalDate expiryDateFrom,
 org.threeten.bp.LocalDate expiryDateTo,
 UUID contactID,
 String status,
 Integer page,
 String order,
 String quoteNumber)
                                                                 throws IOException

Retrieves sales quotes

200 - Success - return response of type quotes array with all quotes

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

dateFrom - Filter for quotes after a particular date

dateTo - Filter for quotes before a particular date

expiryDateFrom - Filter for quotes expiring after a particular date

expiryDateTo - Filter for quotes before a particular date

contactID - Filter for quotes belonging to a particular contact

status - Filter for quotes of a particular Status

page - e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote

order - Order by an any element

quoteNumber - Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceipt

public Receipts getReceipt(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 Integer unitdp)
                    throws IOException

Retrieves a specific draft expense claim receipt by using a unique receipt Id

200 - Success - return response of type Receipts array for a specified Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

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

Returns:

Receipts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 Integer unitdp)
                                                                  throws IOException

Retrieves a specific draft expense claim receipt by using a unique receipt Id

200 - Success - return response of type Receipts array for a specified Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceiptAttachmentByFileName

public ByteArrayInputStream getReceiptAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 String contentType)
                                                    throws IOException

Retrieves a specific attachment from a specific expense claim receipts by file name

200 - Success - return response of attachment for Receipt as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 String contentType)
                                                                                      throws IOException

Retrieves a specific attachment from a specific expense claim receipts by file name

200 - Success - return response of attachment for Receipt as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceiptAttachmentById

public ByteArrayInputStream getReceiptAttachmentById(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 UUID attachmentID,
 String contentType)
                                              throws IOException

Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id

200 - Success - return response of attachment for Receipt as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 UUID attachmentID,
 String contentType)
                                                                                throws IOException

Retrieves a specific attachments from a specific expense claim receipts by using a unique attachment Id

200 - Success - return response of attachment for Receipt as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceiptAttachments

public Attachments getReceiptAttachments(String accessToken,
 String xeroTenantId,
 UUID receiptID)
                                  throws IOException

Retrieves attachments for a specific expense claim receipt

200 - Success - return response of type Attachments array of Attachments for a specified Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID)
                                                                             throws IOException

Retrieves attachments for a specific expense claim receipt

200 - Success - return response of type Attachments array of Attachments for a specified Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceiptHistory

public HistoryRecords getReceiptHistory(String accessToken,
 String xeroTenantId,
 UUID receiptID)
                                 throws IOException

Retrieves a history record for a specific receipt

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID)
                                                                         throws IOException

Retrieves a history record for a specific receipt

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReceipts

public Receipts getReceipts(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer unitdp)
                     throws IOException

Retrieves draft expense claim receipts for any user

200 - Success - return response of type Receipts array for all Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

Returns:

Receipts

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReceiptsForHttpResponse

public com.google.api.client.http.HttpResponse getReceiptsForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order,
 Integer unitdp)
                                                                   throws IOException

Retrieves draft expense claim receipts for any user

200 - Success - return response of type Receipts array for all Receipt

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoice

public RepeatingInvoices getRepeatingInvoice(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                      throws IOException

Retrieves a specific repeating invoice by using a unique repeating invoice Id

200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

RepeatingInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                                                           throws IOException

Retrieves a specific repeating invoice by using a unique repeating invoice Id

200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoiceAttachmentByFileName

public ByteArrayInputStream getRepeatingInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 String contentType)
                                                             throws IOException

Retrieves a specific attachment from a specific repeating invoices by file name

200 - Success - return response of attachment for Repeating Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 String contentType)
                                                                                               throws IOException

Retrieves a specific attachment from a specific repeating invoices by file name

200 - Success - return response of attachment for Repeating Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoiceAttachmentById

public ByteArrayInputStream getRepeatingInvoiceAttachmentById(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 UUID attachmentID,
 String contentType)
                                                       throws IOException

Retrieves a specific attachment from a specific repeating invoice

200 - Success - return response of attachment for Repeating Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

attachmentID - Unique identifier for Attachment object

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

Returns:

ByteArrayInputStream

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoiceAttachmentByIdForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentByIdForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 UUID attachmentID,
 String contentType)
                                                                                         throws IOException

Retrieves a specific attachment from a specific repeating invoice

200 - Success - return response of attachment for Repeating Invoice as binary data

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

attachmentID - Unique identifier for Attachment object

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

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoiceAttachments

public Attachments getRepeatingInvoiceAttachments(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                           throws IOException

Retrieves attachments from a specific repeating invoice

200 - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoiceAttachmentsForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                                                                      throws IOException

Retrieves attachments from a specific repeating invoice

200 - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoiceHistory

public HistoryRecords getRepeatingInvoiceHistory(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                          throws IOException

Retrieves history record for a specific repeating invoice

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

HistoryRecords

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoiceHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoiceHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID)
                                                                                  throws IOException

Retrieves history record for a specific repeating invoice

200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getRepeatingInvoices

public RepeatingInvoices getRepeatingInvoices(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                                       throws IOException

Retrieves repeating invoices

200 - Success - return response of type Repeating Invoices array for all Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

RepeatingInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

getRepeatingInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse getRepeatingInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                                                                            throws IOException

Retrieves repeating invoices

200 - Success - return response of type Repeating Invoices array for all Repeating Invoice

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportAgedPayablesByContact

public ReportWithRows getReportAgedPayablesByContact(String accessToken,
 String xeroTenantId,
 UUID contactId,
 org.threeten.bp.LocalDate date,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                              throws IOException

Retrieves report for aged payables by contact

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactId - Unique identifier for a Contact

date - The date of the Aged Payables By Contact report

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportAgedPayablesByContactForHttpResponse

public com.google.api.client.http.HttpResponse getReportAgedPayablesByContactForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactId,
 org.threeten.bp.LocalDate date,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                                                                      throws IOException

Retrieves report for aged payables by contact

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactId - Unique identifier for a Contact

date - The date of the Aged Payables By Contact report

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportAgedReceivablesByContact

public ReportWithRows getReportAgedReceivablesByContact(String accessToken,
 String xeroTenantId,
 UUID contactId,
 org.threeten.bp.LocalDate date,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                                 throws IOException

Retrieves report for aged receivables by contact

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactId - Unique identifier for a Contact

date - The date of the Aged Receivables By Contact report

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportAgedReceivablesByContactForHttpResponse

public com.google.api.client.http.HttpResponse getReportAgedReceivablesByContactForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactId,
 org.threeten.bp.LocalDate date,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                                                                         throws IOException

Retrieves report for aged receivables by contact

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactId - Unique identifier for a Contact

date - The date of the Aged Receivables By Contact report

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportBalanceSheet

public ReportWithRows getReportBalanceSheet(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Integer periods,
 String timeframe,
 String trackingOptionID1,
 String trackingOptionID2,
 Boolean standardLayout,
 Boolean paymentsOnly)
                                     throws IOException

Retrieves report for balancesheet

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date of the Balance Sheet report

periods - The number of periods for the Balance Sheet report

timeframe - The period size to compare to (MONTH, QUARTER, YEAR)

trackingOptionID1 - The tracking option 1 for the Balance Sheet report

trackingOptionID2 - The tracking option 2 for the Balance Sheet report

standardLayout - The standard layout boolean for the Balance Sheet report

paymentsOnly - return a cash basis for the Balance Sheet report

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportBalanceSheetForHttpResponse

public com.google.api.client.http.HttpResponse getReportBalanceSheetForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Integer periods,
 String timeframe,
 String trackingOptionID1,
 String trackingOptionID2,
 Boolean standardLayout,
 Boolean paymentsOnly)
                                                                             throws IOException

Retrieves report for balancesheet

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date of the Balance Sheet report

periods - The number of periods for the Balance Sheet report

timeframe - The period size to compare to (MONTH, QUARTER, YEAR)

trackingOptionID1 - The tracking option 1 for the Balance Sheet report

trackingOptionID2 - The tracking option 2 for the Balance Sheet report

standardLayout - The standard layout boolean for the Balance Sheet report

paymentsOnly - return a cash basis for the Balance Sheet report

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportBankSummary

public ReportWithRows getReportBankSummary(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                    throws IOException

Retrieves report for bank summary

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportBankSummaryForHttpResponse

public com.google.api.client.http.HttpResponse getReportBankSummaryForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate)
                                                                            throws IOException

Retrieves report for bank summary

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportBudgetSummary

public ReportWithRows getReportBudgetSummary(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Integer periods,
 Integer timeframe)
                                      throws IOException

Retrieves report for budget summary

200 - success- return a Report with Rows object

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Bank Summary report e.g. 2018-03-31

periods - The number of periods to compare (integer between 1 and 12)

timeframe - The period size to compare to (1=month, 3=quarter, 12=year)

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportBudgetSummaryForHttpResponse

public com.google.api.client.http.HttpResponse getReportBudgetSummaryForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Integer periods,
 Integer timeframe)
                                                                              throws IOException

Retrieves report for budget summary

200 - success- return a Report with Rows object

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Bank Summary report e.g. 2018-03-31

periods - The number of periods to compare (integer between 1 and 12)

timeframe - The period size to compare to (1=month, 3=quarter, 12=year)

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportExecutiveSummary

public ReportWithRows getReportExecutiveSummary(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date)
                                         throws IOException

Retrieves report for executive summary

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Bank Summary report e.g. 2018-03-31

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportExecutiveSummaryForHttpResponse

public com.google.api.client.http.HttpResponse getReportExecutiveSummaryForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date)
                                                                                 throws IOException

Retrieves report for executive summary

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Bank Summary report e.g. 2018-03-31

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportFromId

public ReportWithRows getReportFromId(String accessToken,
 String xeroTenantId,
 String reportID)
                               throws IOException

Retrieves a specific report using a unique ReportID

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reportID - Unique identifier for a Report

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportFromIdForHttpResponse

public com.google.api.client.http.HttpResponse getReportFromIdForHttpResponse(String accessToken,
 String xeroTenantId,
 String reportID)
                                                                       throws IOException

Retrieves a specific report using a unique ReportID

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reportID - Unique identifier for a Report

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportProfitAndLoss

public ReportWithRows getReportProfitAndLoss(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate,
 Integer periods,
 String timeframe,
 String trackingCategoryID,
 String trackingCategoryID2,
 String trackingOptionID,
 String trackingOptionID2,
 Boolean standardLayout,
 Boolean paymentsOnly)
                                      throws IOException

Retrieves report for profit and loss

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

periods - The number of periods to compare (integer between 1 and 12)

timeframe - The period size to compare to (MONTH, QUARTER, YEAR)

trackingCategoryID - The trackingCategory 1 for the ProfitAndLoss report

trackingCategoryID2 - The trackingCategory 2 for the ProfitAndLoss report

trackingOptionID - The tracking option 1 for the ProfitAndLoss report

trackingOptionID2 - The tracking option 2 for the ProfitAndLoss report

standardLayout - Return the standard layout for the ProfitAndLoss report

paymentsOnly - Return cash only basis for the ProfitAndLoss report

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportProfitAndLossForHttpResponse

public com.google.api.client.http.HttpResponse getReportProfitAndLossForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate fromDate,
 org.threeten.bp.LocalDate toDate,
 Integer periods,
 String timeframe,
 String trackingCategoryID,
 String trackingCategoryID2,
 String trackingOptionID,
 String trackingOptionID2,
 Boolean standardLayout,
 Boolean paymentsOnly)
                                                                              throws IOException

Retrieves report for profit and loss

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fromDate - filter by the from date of the report e.g. 2021-02-01

toDate - filter by the to date of the report e.g. 2021-02-28

periods - The number of periods to compare (integer between 1 and 12)

timeframe - The period size to compare to (MONTH, QUARTER, YEAR)

trackingCategoryID - The trackingCategory 1 for the ProfitAndLoss report

trackingCategoryID2 - The trackingCategory 2 for the ProfitAndLoss report

trackingOptionID - The tracking option 1 for the ProfitAndLoss report

trackingOptionID2 - The tracking option 2 for the ProfitAndLoss report

standardLayout - Return the standard layout for the ProfitAndLoss report

paymentsOnly - Return cash only basis for the ProfitAndLoss report

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportTenNinetyNine

public Reports getReportTenNinetyNine(String accessToken,
 String xeroTenantId,
 String reportYear)
                               throws IOException

Retrieve reports for 1099

200 - Success - return response of type Reports

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reportYear - The year of the 1099 report

Returns:

Reports

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportTenNinetyNineForHttpResponse

public com.google.api.client.http.HttpResponse getReportTenNinetyNineForHttpResponse(String accessToken,
 String xeroTenantId,
 String reportYear)
                                                                              throws IOException

Retrieve reports for 1099

200 - Success - return response of type Reports

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

reportYear - The year of the 1099 report

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportTrialBalance

public ReportWithRows getReportTrialBalance(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Boolean paymentsOnly)
                                     throws IOException

Retrieves report for trial balance

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Trial Balance report e.g. 2018-03-31

paymentsOnly - Return cash only basis for the Trial Balance report

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportTrialBalanceForHttpResponse

public com.google.api.client.http.HttpResponse getReportTrialBalanceForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.LocalDate date,
 Boolean paymentsOnly)
                                                                             throws IOException

Retrieves report for trial balance

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

date - The date for the Trial Balance report e.g. 2018-03-31

paymentsOnly - Return cash only basis for the Trial Balance report

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getReportsList

public ReportWithRows getReportsList(String accessToken,
 String xeroTenantId)
                              throws IOException

Retrieves a list of the organistaions unique reports that require a uuid to fetch

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

ReportWithRows

Throws:

IOException - if an error occurs while attempting to invoke the API *

getReportsListForHttpResponse

public com.google.api.client.http.HttpResponse getReportsListForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                      throws IOException

Retrieves a list of the organistaions unique reports that require a uuid to fetch

200 - Success - return response of type ReportWithRows

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTaxRateByTaxType

public TaxRates getTaxRateByTaxType(String accessToken,
 String xeroTenantId,
 String taxType)
                             throws IOException

Retrieves a specific tax rate according to given TaxType code

200 - Success - return response of type TaxRates array with one TaxRate

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxType - A valid TaxType code

Returns:

TaxRates

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTaxRateByTaxTypeForHttpResponse

public com.google.api.client.http.HttpResponse getTaxRateByTaxTypeForHttpResponse(String accessToken,
 String xeroTenantId,
 String taxType)
                                                                           throws IOException

Retrieves a specific tax rate according to given TaxType code

200 - Success - return response of type TaxRates array with one TaxRate

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxType - A valid TaxType code

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTaxRates

public TaxRates getTaxRates(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                     throws IOException

Retrieves tax rates

200 - Success - return response of type TaxRates array with TaxRates

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

TaxRates

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTaxRatesForHttpResponse

public com.google.api.client.http.HttpResponse getTaxRatesForHttpResponse(String accessToken,
 String xeroTenantId,
 String where,
 String order)
                                                                   throws IOException

Retrieves tax rates

200 - Success - return response of type TaxRates array with TaxRates

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTrackingCategories

public TrackingCategories getTrackingCategories(String accessToken,
 String xeroTenantId,
 String where,
 String order,
 Boolean includeArchived)
                                         throws IOException

Retrieves tracking categories and options

200 - Success - return response of type TrackingCategories array of TrackingCategory

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

includeArchived - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTrackingCategoriesForHttpResponse

public com.google.api.client.http.HttpResponse getTrackingCategoriesForHttpResponse(String accessToken,
 String xeroTenantId,
 String where,
 String order,
 Boolean includeArchived)
                                                                             throws IOException

Retrieves tracking categories and options

200 - Success - return response of type TrackingCategories array of TrackingCategory

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

where - Filter by an any element

order - Order by an any element

includeArchived - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getTrackingCategory

public TrackingCategories getTrackingCategory(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID)
                                       throws IOException

Retrieves specific tracking categories and options using a unique tracking category Id

200 - Success - return response of type TrackingCategories array of specified TrackingCategory

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

getTrackingCategoryForHttpResponse

public com.google.api.client.http.HttpResponse getTrackingCategoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID)
                                                                           throws IOException

Retrieves specific tracking categories and options using a unique tracking category Id

200 - Success - return response of type TrackingCategories array of specified TrackingCategory

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getUser

public Users getUser(String accessToken,
 String xeroTenantId,
 UUID userID)
              throws IOException

Retrieves a specific user

200 - Success - return response of type Users array of specified User

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

userID - Unique identifier for a User

Returns:

Users

Throws:

IOException - if an error occurs while attempting to invoke the API *

getUserForHttpResponse

public com.google.api.client.http.HttpResponse getUserForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID userID)
                                                               throws IOException

Retrieves a specific user

200 - Success - return response of type Users array of specified User

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

userID - Unique identifier for a User

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

getUsers

public Users getUsers(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
               throws IOException

Retrieves users

200 - Success - return response of type Users array of all User

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

Users

Throws:

IOException - if an error occurs while attempting to invoke the API *

getUsersForHttpResponse

public com.google.api.client.http.HttpResponse getUsersForHttpResponse(String accessToken,
 String xeroTenantId,
 org.threeten.bp.OffsetDateTime ifModifiedSince,
 String where,
 String order)
                                                                throws IOException

Retrieves users

200 - Success - return response of type Users array of all User

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

ifModifiedSince - Only records created or modified since this timestamp will be returned

where - Filter by an any element

order - Order by an any element

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

postSetup

public ImportSummaryObject postSetup(String accessToken,
 String xeroTenantId,
 Setup setup,
 String idempotencyKey)
                              throws IOException

Sets the chart of accounts, the conversion date and conversion balances

200 - Success - returns a summary of the chart of accounts updates

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

setup - Object including an accounts array, a conversion balances array and a conversion date object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ImportSummaryObject

Throws:

IOException - if an error occurs while attempting to invoke the API *

postSetupForHttpResponse

public com.google.api.client.http.HttpResponse postSetupForHttpResponse(String accessToken,
 String xeroTenantId,
 Setup setup,
 String idempotencyKey)
                                                                 throws IOException

Sets the chart of accounts, the conversion date and conversion balances

200 - Success - returns a summary of the chart of accounts updates

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

setup - Object including an accounts array, a conversion balances array and a conversion date object in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateAccount

public Accounts updateAccount(String accessToken,
 String xeroTenantId,
 UUID accountID,
 Accounts accounts,
 String idempotencyKey)
                       throws IOException

Updates a chart of accounts

200 - Success - update existing Account and return response of type Accounts array with updated Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

accounts - Request of type Accounts array with one Account

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Accounts

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateAccountForHttpResponse

public com.google.api.client.http.HttpResponse updateAccountForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 Accounts accounts,
 String idempotencyKey)
                                                                     throws IOException

Updates a chart of accounts

200 - Success - update existing Account and return response of type Accounts array with updated Account

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

accounts - Request of type Accounts array with one Account

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateAccountAttachmentByFileName

public Attachments updateAccountAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

Updates attachment on a specific account by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateAccountAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateAccountAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

Updates attachment on a specific account by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateAccountAttachmentByFileName

public Attachments updateAccountAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

Updates attachment on a specific account by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateAccountAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateAccountAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID accountID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

Updates attachment on a specific account by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

accountID - Unique identifier for Account object

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateBankTransaction

public BankTransactions updateBankTransaction(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 BankTransactions bankTransactions,
 Integer unitdp,
 String idempotencyKey)
                                       throws IOException

Updates a single spent or received money transaction

200 - Success - return response of type BankTransactions array with updated BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

bankTransactions - The bankTransactions parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BankTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateBankTransactionForHttpResponse

public com.google.api.client.http.HttpResponse updateBankTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 BankTransactions bankTransactions,
 Integer unitdp,
 String idempotencyKey)
                                                                             throws IOException

Updates a single spent or received money transaction

200 - Success - return response of type BankTransactions array with updated BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

bankTransactions - The bankTransactions parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateBankTransactionAttachmentByFileName

public Attachments updateBankTransactionAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                      throws IOException

Updates a specific attachment from a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateBankTransactionAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                                 throws IOException

Updates a specific attachment from a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateBankTransactionAttachmentByFileName

public Attachments updateBankTransactionAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 File body,
 String idempotencyKey)
                                                      throws IOException

Updates a specific attachment from a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateBankTransactionAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransactionID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                                 throws IOException

Updates a specific attachment from a specific bank transaction by filename

200 - Success - return response of Attachments array of Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactionID - Xero generated unique identifier for a bank transaction

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateBankTransferAttachmentByFileName

public Attachments updateBankTransferAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                   throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateBankTransferAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateBankTransferAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                              throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateBankTransferAttachmentByFileName

public Attachments updateBankTransferAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 File body,
 String idempotencyKey)
                                                   throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateBankTransferAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateBankTransferAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankTransferID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                              throws IOException

200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransferID - Xero generated unique identifier for a bank transfer

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateContact

public Contacts updateContact(String accessToken,
 String xeroTenantId,
 UUID contactID,
 Contacts contacts,
 String idempotencyKey)
                       throws IOException

Updates a specific contact in a Xero organisation

200 - Success - return response of type Contacts array with an updated Contact

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

contacts - an array of Contacts containing single Contact object with properties to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateContactForHttpResponse

public com.google.api.client.http.HttpResponse updateContactForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 Contacts contacts,
 String idempotencyKey)
                                                                     throws IOException

Updates a specific contact in a Xero organisation

200 - Success - return response of type Contacts array with an updated Contact

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

contacts - an array of Contacts containing single Contact object with properties to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateContactAttachmentByFileName

public Attachments updateContactAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

200 - Success - return response of type Attachments array with an updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateContactAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateContactAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

200 - Success - return response of type Attachments array with an updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateContactAttachmentByFileName

public Attachments updateContactAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

200 - Success - return response of type Attachments array with an updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateContactAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateContactAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

200 - Success - return response of type Attachments array with an updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactID - Unique identifier for a Contact

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateContactGroup

public ContactGroups updateContactGroup(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 ContactGroups contactGroups,
 String idempotencyKey)
                                 throws IOException

Updates a specific contact group

200 - Success - return response of type Contact Groups array of updated Contact Group

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contactGroups - an array of Contact groups with Name of specific group to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ContactGroups

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateContactGroupForHttpResponse

public com.google.api.client.http.HttpResponse updateContactGroupForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID contactGroupID,
 ContactGroups contactGroups,
 String idempotencyKey)
                                                                          throws IOException

Updates a specific contact group

200 - Success - return response of type Contact Groups array of updated Contact Group

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contactGroupID - Unique identifier for a Contact Group

contactGroups - an array of Contact groups with Name of specific group to update

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateCreditNote

public CreditNotes updateCreditNote(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 CreditNotes creditNotes,
 Integer unitdp,
 String idempotencyKey)
                             throws IOException

Updates a specific credit note

200 - Success - return response of type Credit Notes array with updated CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

creditNotes - an array of Credit Notes containing credit note details to update

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

CreditNotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateCreditNoteForHttpResponse

public com.google.api.client.http.HttpResponse updateCreditNoteForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 CreditNotes creditNotes,
 Integer unitdp,
 String idempotencyKey)
                                                                        throws IOException

Updates a specific credit note

200 - Success - return response of type Credit Notes array with updated CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

creditNotes - an array of Credit Notes containing credit note details to update

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateCreditNoteAttachmentByFileName

public Attachments updateCreditNoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                 throws IOException

Updates attachments on a specific credit note by file name

200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateCreditNoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                            throws IOException

Updates attachments on a specific credit note by file name

200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateCreditNoteAttachmentByFileName

public Attachments updateCreditNoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                                 throws IOException

Updates attachments on a specific credit note by file name

200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateCreditNoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID creditNoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                            throws IOException

Updates attachments on a specific credit note by file name

200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNoteID - Unique identifier for a Credit Note

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateExpenseClaim

public ExpenseClaims updateExpenseClaim(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID,
 ExpenseClaims expenseClaims,
 String idempotencyKey)
                                 throws IOException

Updates a specific expense claims

200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

expenseClaims - The expenseClaims parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ExpenseClaims

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateExpenseClaimForHttpResponse

public com.google.api.client.http.HttpResponse updateExpenseClaimForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID expenseClaimID,
 ExpenseClaims expenseClaims,
 String idempotencyKey)
                                                                          throws IOException

Updates a specific expense claims

200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

expenseClaimID - Unique identifier for a ExpenseClaim

expenseClaims - The expenseClaims parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateInvoice

public Invoices updateInvoice(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 Invoices invoices,
 Integer unitdp,
 String idempotencyKey)
                       throws IOException

Updates a specific sales invoices or purchase bills

200 - Success - return response of type Invoices array with updated Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

invoices - The invoices parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Invoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse updateInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 Invoices invoices,
 Integer unitdp,
 String idempotencyKey)
                                                                     throws IOException

Updates a specific sales invoices or purchase bills

200 - Success - return response of type Invoices array with updated Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

invoices - The invoices parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateInvoiceAttachmentByFileName

public Attachments updateInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

Updates an attachment from a specific invoices or purchase bill by filename

200 - Success - return response of type Attachments array with updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

Updates an attachment from a specific invoices or purchase bill by filename

200 - Success - return response of type Attachments array with updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateInvoiceAttachmentByFileName

public Attachments updateInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

Updates an attachment from a specific invoices or purchase bill by filename

200 - Success - return response of type Attachments array with updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID invoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

Updates an attachment from a specific invoices or purchase bill by filename

200 - Success - return response of type Attachments array with updated Attachment

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoiceID - Unique identifier for an Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateItem

public Items updateItem(String accessToken,
 String xeroTenantId,
 UUID itemID,
 Items items,
 Integer unitdp,
 String idempotencyKey)
                 throws IOException

Updates a specific item

200 - Success - return response of type Items array with updated Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

items - The items parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Items

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateItemForHttpResponse

public com.google.api.client.http.HttpResponse updateItemForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID itemID,
 Items items,
 Integer unitdp,
 String idempotencyKey)
                                                                  throws IOException

Updates a specific item

200 - Success - return response of type Items array with updated Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

itemID - Unique identifier for an Item

items - The items parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateLinkedTransaction

public LinkedTransactions updateLinkedTransaction(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID,
 LinkedTransactions linkedTransactions,
 String idempotencyKey)
                                           throws IOException

Updates a specific linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

400 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

linkedTransactions - The linkedTransactions parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

LinkedTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateLinkedTransactionForHttpResponse

public com.google.api.client.http.HttpResponse updateLinkedTransactionForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID linkedTransactionID,
 LinkedTransactions linkedTransactions,
 String idempotencyKey)
                                                                               throws IOException

Updates a specific linked transactions (billable expenses)

200 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

400 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

linkedTransactionID - Unique identifier for a LinkedTransaction

linkedTransactions - The linkedTransactions parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateManualJournal

public ManualJournals updateManualJournal(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 ManualJournals manualJournals,
 String idempotencyKey)
                                   throws IOException

Updates a specific manual journal

200 - Success - return response of type ManualJournals array with an updated ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

manualJournals - The manualJournals parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ManualJournals

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateManualJournalForHttpResponse

public com.google.api.client.http.HttpResponse updateManualJournalForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 ManualJournals manualJournals,
 String idempotencyKey)
                                                                           throws IOException

Updates a specific manual journal

200 - Success - return response of type ManualJournals array with an updated ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

manualJournals - The manualJournals parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateManualJournalAttachmentByFileName

public Attachments updateManualJournalAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                    throws IOException

Updates a specific attachment from a specific manual journal by file name

200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateManualJournalAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateManualJournalAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                               throws IOException

Updates a specific attachment from a specific manual journal by file name

200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateManualJournalAttachmentByFileName

public Attachments updateManualJournalAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 File body,
 String idempotencyKey)
                                                    throws IOException

Updates a specific attachment from a specific manual journal by file name

200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateManualJournalAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateManualJournalAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID manualJournalID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                               throws IOException

Updates a specific attachment from a specific manual journal by file name

200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournalID - Unique identifier for a ManualJournal

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateBankTransactions

public BankTransactions updateOrCreateBankTransactions(String accessToken,
 String xeroTenantId,
 BankTransactions bankTransactions,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                throws IOException

Updates or creates one or more spent or received money transaction

200 - Success - return response of type BankTransactions array with new BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactions - The bankTransactions parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

BankTransactions

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateBankTransactionsForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateBankTransactionsForHttpResponse(String accessToken,
 String xeroTenantId,
 BankTransactions bankTransactions,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                                      throws IOException

Updates or creates one or more spent or received money transaction

200 - Success - return response of type BankTransactions array with new BankTransaction

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

bankTransactions - The bankTransactions parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateContacts

public Contacts updateOrCreateContacts(String accessToken,
 String xeroTenantId,
 Contacts contacts,
 Boolean summarizeErrors,
 String idempotencyKey)
                                throws IOException

Updates or creates one or more contacts in a Xero organisation

200 - Success - return response of type Contacts array with newly created Contact

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contacts - The contacts parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Contacts

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateContactsForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateContactsForHttpResponse(String accessToken,
 String xeroTenantId,
 Contacts contacts,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                              throws IOException

Updates or creates one or more contacts in a Xero organisation

200 - Success - return response of type Contacts array with newly created Contact

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

contacts - The contacts parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateCreditNotes

public CreditNotes updateOrCreateCreditNotes(String accessToken,
 String xeroTenantId,
 CreditNotes creditNotes,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                      throws IOException

Updates or creates one or more credit notes

200 - Success - return response of type Credit Notes array of newly created CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNotes - an array of Credit Notes with a single CreditNote object.

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

CreditNotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateCreditNotesForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateCreditNotesForHttpResponse(String accessToken,
 String xeroTenantId,
 CreditNotes creditNotes,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                                 throws IOException

Updates or creates one or more credit notes

200 - Success - return response of type Credit Notes array of newly created CreditNote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

creditNotes - an array of Credit Notes with a single CreditNote object.

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateEmployees

public Employees updateOrCreateEmployees(String accessToken,
 String xeroTenantId,
 Employees employees,
 Boolean summarizeErrors,
 String idempotencyKey)
                                  throws IOException

Creates a single new employees used in Xero payrun

200 - Success - return response of type Employees array with new Employee

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employees - Employees with array of Employee object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Employees

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateEmployeesForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateEmployeesForHttpResponse(String accessToken,
 String xeroTenantId,
 Employees employees,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                               throws IOException

Creates a single new employees used in Xero payrun

200 - Success - return response of type Employees array with new Employee

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

employees - Employees with array of Employee object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateInvoices

public Invoices updateOrCreateInvoices(String accessToken,
 String xeroTenantId,
 Invoices invoices,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                throws IOException

Updates or creates one or more sales invoices or purchase bills

200 - Success - return response of type Invoices array with newly created Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoices - The invoices parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Invoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 Invoices invoices,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                              throws IOException

Updates or creates one or more sales invoices or purchase bills

200 - Success - return response of type Invoices array with newly created Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

invoices - The invoices parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateItems

public Items updateOrCreateItems(String accessToken,
 String xeroTenantId,
 Items items,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                          throws IOException

Updates or creates one or more items

200 - Success - return response of type Items array with newly created Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

items - The items parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Items

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateItemsForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateItemsForHttpResponse(String accessToken,
 String xeroTenantId,
 Items items,
 Boolean summarizeErrors,
 Integer unitdp,
 String idempotencyKey)
                                                                           throws IOException

Updates or creates one or more items

200 - Success - return response of type Items array with newly created Item

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

items - The items parameter

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

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateManualJournals

public ManualJournals updateOrCreateManualJournals(String accessToken,
 String xeroTenantId,
 ManualJournals manualJournals,
 Boolean summarizeErrors,
 String idempotencyKey)
                                            throws IOException

Updates or creates a single manual journal

200 - Success - return response of type ManualJournals array with newly created ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournals - ManualJournals array with ManualJournal object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

ManualJournals

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateManualJournalsForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateManualJournalsForHttpResponse(String accessToken,
 String xeroTenantId,
 ManualJournals manualJournals,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                    throws IOException

Updates or creates a single manual journal

200 - Success - return response of type ManualJournals array with newly created ManualJournal

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

manualJournals - ManualJournals array with ManualJournal object in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreatePurchaseOrders

public PurchaseOrders updateOrCreatePurchaseOrders(String accessToken,
 String xeroTenantId,
 PurchaseOrders purchaseOrders,
 Boolean summarizeErrors,
 String idempotencyKey)
                                            throws IOException

Updates or creates one or more purchase orders

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrders - The purchaseOrders parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreatePurchaseOrdersForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreatePurchaseOrdersForHttpResponse(String accessToken,
 String xeroTenantId,
 PurchaseOrders purchaseOrders,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                    throws IOException

Updates or creates one or more purchase orders

200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrders - The purchaseOrders parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateQuotes

public Quotes updateOrCreateQuotes(String accessToken,
 String xeroTenantId,
 Quotes quotes,
 Boolean summarizeErrors,
 String idempotencyKey)
                            throws IOException

Updates or creates one or more quotes

200 - Success - return response of type Quotes array with updated or created Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quotes - The quotes parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Quotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateQuotesForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateQuotesForHttpResponse(String accessToken,
 String xeroTenantId,
 Quotes quotes,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                            throws IOException

Updates or creates one or more quotes

200 - Success - return response of type Quotes array with updated or created Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quotes - The quotes parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateOrCreateRepeatingInvoices

public RepeatingInvoices updateOrCreateRepeatingInvoices(String accessToken,
 String xeroTenantId,
 RepeatingInvoices repeatingInvoices,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                  throws IOException

Creates or deletes one or more repeating invoice templates

200 - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

RepeatingInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateOrCreateRepeatingInvoicesForHttpResponse

public com.google.api.client.http.HttpResponse updateOrCreateRepeatingInvoicesForHttpResponse(String accessToken,
 String xeroTenantId,
 RepeatingInvoices repeatingInvoices,
 Boolean summarizeErrors,
 String idempotencyKey)
                                                                                       throws IOException

Creates or deletes one or more repeating invoice templates

200 - Success - return response of type RepeatingInvoices array with newly created RepeatingInvoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoices - RepeatingInvoices with an array of repeating invoice objects in body of request

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updatePurchaseOrder

public PurchaseOrders updatePurchaseOrder(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 PurchaseOrders purchaseOrders,
 String idempotencyKey)
                                   throws IOException

Updates a specific purchase order

200 - Success - return response of type PurchaseOrder array for updated PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

purchaseOrders - The purchaseOrders parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

PurchaseOrders

Throws:

IOException - if an error occurs while attempting to invoke the API *

updatePurchaseOrderForHttpResponse

public com.google.api.client.http.HttpResponse updatePurchaseOrderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 PurchaseOrders purchaseOrders,
 String idempotencyKey)
                                                                           throws IOException

Updates a specific purchase order

200 - Success - return response of type PurchaseOrder array for updated PurchaseOrder

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

purchaseOrders - The purchaseOrders parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updatePurchaseOrderAttachmentByFileName

public Attachments updatePurchaseOrderAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                    throws IOException

Updates a specific attachment for a specific purchase order by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updatePurchaseOrderAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                               throws IOException

Updates a specific attachment for a specific purchase order by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updatePurchaseOrderAttachmentByFileName

public Attachments updatePurchaseOrderAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 File body,
 String idempotencyKey)
                                                    throws IOException

Updates a specific attachment for a specific purchase order by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updatePurchaseOrderAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID purchaseOrderID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                               throws IOException

Updates a specific attachment for a specific purchase order by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

purchaseOrderID - Unique identifier for an Purchase Order

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateQuote

public Quotes updateQuote(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 Quotes quotes,
 String idempotencyKey)
                   throws IOException

Updates a specific quote

200 - Success - return response of type Quotes array with updated Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

quotes - The quotes parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Quotes

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateQuoteForHttpResponse

public com.google.api.client.http.HttpResponse updateQuoteForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 Quotes quotes,
 String idempotencyKey)
                                                                   throws IOException

Updates a specific quote

200 - Success - return response of type Quotes array with updated Quote

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

quotes - The quotes parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateQuoteAttachmentByFileName

public Attachments updateQuoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                            throws IOException

Updates a specific attachment from a specific quote by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateQuoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateQuoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                       throws IOException

Updates a specific attachment from a specific quote by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateQuoteAttachmentByFileName

public Attachments updateQuoteAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                            throws IOException

Updates a specific attachment from a specific quote by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateQuoteAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateQuoteAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID quoteID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                       throws IOException

Updates a specific attachment from a specific quote by filename

200 - Success - return response of type Attachments array of Attachment

400 - Validation Error - some data was incorrect returns response of type Error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

quoteID - Unique identifier for an Quote

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateReceipt

public Receipts updateReceipt(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 Receipts receipts,
 Integer unitdp,
 String idempotencyKey)
                       throws IOException

Updates a specific draft expense claim receipts

200 - Success - return response of type Receipts array for updated Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

receipts - The receipts parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Receipts

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateReceiptForHttpResponse

public com.google.api.client.http.HttpResponse updateReceiptForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 Receipts receipts,
 Integer unitdp,
 String idempotencyKey)
                                                                     throws IOException

Updates a specific draft expense claim receipts

200 - Success - return response of type Receipts array for updated Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

receipts - The receipts parameter

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

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateReceiptAttachmentByFileName

public Attachments updateReceiptAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                              throws IOException

Updates a specific attachment on a specific expense claim receipts by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateReceiptAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateReceiptAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                         throws IOException

Updates a specific attachment on a specific expense claim receipts by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateReceiptAttachmentByFileName

public Attachments updateReceiptAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 File body,
 String idempotencyKey)
                                              throws IOException

Updates a specific attachment on a specific expense claim receipts by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateReceiptAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateReceiptAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID receiptID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                         throws IOException

Updates a specific attachment on a specific expense claim receipts by file name

200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

receiptID - Unique identifier for a Receipt

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateRepeatingInvoice

public RepeatingInvoices updateRepeatingInvoice(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 RepeatingInvoices repeatingInvoices,
 String idempotencyKey)
                                         throws IOException

Deletes a specific repeating invoice template

200 - Success - return response of type RepeatingInvoices array with deleted Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

repeatingInvoices - The repeatingInvoices parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

RepeatingInvoices

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateRepeatingInvoiceForHttpResponse

public com.google.api.client.http.HttpResponse updateRepeatingInvoiceForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 RepeatingInvoices repeatingInvoices,
 String idempotencyKey)
                                                                              throws IOException

Deletes a specific repeating invoice template

200 - Success - return response of type RepeatingInvoices array with deleted Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

repeatingInvoices - The repeatingInvoices parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateRepeatingInvoiceAttachmentByFileName

public Attachments updateRepeatingInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                       throws IOException

Updates a specific attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API

updateRepeatingInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 byte[] body,
 String idempotencyKey,
 String mimeType)
                                                                                                  throws IOException

Updates a specific attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The type of file being attached

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateRepeatingInvoiceAttachmentByFileName

public Attachments updateRepeatingInvoiceAttachmentByFileName(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                                       throws IOException

Updates a specific attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Attachments

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateRepeatingInvoiceAttachmentByFileNameForHttpResponse

public com.google.api.client.http.HttpResponse updateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID repeatingInvoiceID,
 String fileName,
 File body,
 String idempotencyKey)
                                                                                                  throws IOException

Updates a specific attachment from a specific repeating invoices by file name

200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

repeatingInvoiceID - Unique identifier for a Repeating Invoice

fileName - Name of the attachment

body - Byte array of file in body of request

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateTaxRate

public TaxRates updateTaxRate(String accessToken,
 String xeroTenantId,
 TaxRates taxRates,
 String idempotencyKey)
                       throws IOException

Updates tax rates

200 - Success - return response of type TaxRates array updated TaxRate

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxRates - The taxRates parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TaxRates

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateTaxRateForHttpResponse

public com.google.api.client.http.HttpResponse updateTaxRateForHttpResponse(String accessToken,
 String xeroTenantId,
 TaxRates taxRates,
 String idempotencyKey)
                                                                     throws IOException

Updates tax rates

200 - Success - return response of type TaxRates array updated TaxRate

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

taxRates - The taxRates parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateTrackingCategory

public TrackingCategories updateTrackingCategory(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 TrackingCategory trackingCategory,
 String idempotencyKey)
                                          throws IOException

Updates a specific tracking category

200 - Success - return response of type TrackingCategories array of updated TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingCategory - The trackingCategory parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TrackingCategories

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateTrackingCategoryForHttpResponse

public com.google.api.client.http.HttpResponse updateTrackingCategoryForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 TrackingCategory trackingCategory,
 String idempotencyKey)
                                                                              throws IOException

Updates a specific tracking category

200 - Success - return response of type TrackingCategories array of updated TrackingCategory

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingCategory - The trackingCategory parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

updateTrackingOptions

public TrackingOptions updateTrackingOptions(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 UUID trackingOptionID,
 TrackingOption trackingOption,
 String idempotencyKey)
                                      throws IOException

Updates a specific option for a specific tracking category

200 - Success - return response of type TrackingOptions array of options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOptionID - Unique identifier for a Tracking Option

trackingOption - The trackingOption parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

TrackingOptions

Throws:

IOException - if an error occurs while attempting to invoke the API *

updateTrackingOptionsForHttpResponse

public com.google.api.client.http.HttpResponse updateTrackingOptionsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID trackingCategoryID,
 UUID trackingOptionID,
 TrackingOption trackingOption,
 String idempotencyKey)
                                                                             throws IOException

Updates a specific option for a specific tracking category

200 - Success - return response of type TrackingOptions array of options for a specified category

400 - A failed request due to validation error

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

trackingCategoryID - Unique identifier for a TrackingCategory

trackingOptionID - Unique identifier for a Tracking Option

trackingOption - The trackingOption parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

IOException - if an error occurs while attempting to invoke the API

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations