Class AccountingApi
public class AccountingApi extends Object
-
Constructor Summary
Constructors Constructor Description AccountingApi()AccountingApi(ApiClient apiClient) -
Method Summary
Modifier and Type Method Description ByteArrayInputStreamconvertInputToByteArray(InputStream is)AccountscreateAccount(String accessToken, String xeroTenantId, Account account)Allows you to create a new chart of accountsAttachmentscreateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType)Allows you to create Attachment on AccountAttachmentscreateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body)Allows you to create Attachment on Accountcom.google.api.client.http.HttpResponsecreateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body)com.google.api.client.http.HttpResponsecreateAccountForHttpResponse(String accessToken, String xeroTenantId, Account account)AttachmentscreateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType)Allows you to create an Attachment on BankTransaction by FilenameAttachmentscreateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body)Allows you to create an Attachment on BankTransaction by Filenamecom.google.api.client.http.HttpResponsecreateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body)HistoryRecordscreateBankTransactionHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords)Allows you to create history record for a bank transactionscom.google.api.client.http.HttpResponsecreateBankTransactionHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords)BankTransactionscreateBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp)Allows you to create one or more spend or receive money transactioncom.google.api.client.http.HttpResponsecreateBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp)BankTransferscreateBankTransfer(String accessToken, String xeroTenantId, BankTransfers bankTransfers)Allows you to create a bank transfersAttachmentscreateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType)200 - Success - return response of Attachments array of 0 to N Attachment for a Bank TransferAttachmentscreateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body)200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfercom.google.api.client.http.HttpResponsecreateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body)com.google.api.client.http.HttpResponsecreateBankTransferForHttpResponse(String accessToken, String xeroTenantId, BankTransfers bankTransfers)HistoryRecordscreateBankTransferHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords)200 - Success - return response of type HistoryRecords array of HistoryRecord objectscom.google.api.client.http.HttpResponsecreateBankTransferHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords)BatchPaymentscreateBatchPayment(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors)Create one or many BatchPayments for invoicescom.google.api.client.http.HttpResponsecreateBatchPaymentForHttpResponse(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors)HistoryRecordscreateBatchPaymentHistoryRecord(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords)Allows you to create a history record for a Batch Paymentcom.google.api.client.http.HttpResponsecreateBatchPaymentHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords)PaymentServicescreateBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentService paymentService)Allow for the creation of new custom payment service for specified Branding Themecom.google.api.client.http.HttpResponsecreateBrandingThemePaymentServicesForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentService paymentService)AttachmentscreateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType)200 - Success - return response of type Attachments array with an newly created AttachmentAttachmentscreateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body)200 - Success - return response of type Attachments array with an newly created Attachmentcom.google.api.client.http.HttpResponsecreateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body)ContactGroupscreateContactGroup(String accessToken, String xeroTenantId, ContactGroups contactGroups)Allows you to create a contact groupContactscreateContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts)Allows you to add Contacts to a Contact Groupcom.google.api.client.http.HttpResponsecreateContactGroupContactsForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts)com.google.api.client.http.HttpResponsecreateContactGroupForHttpResponse(String accessToken, String xeroTenantId, ContactGroups contactGroups)HistoryRecordscreateContactHistory(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords)Allows you to retrieve a history records of an Contactcom.google.api.client.http.HttpResponsecreateContactHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords)ContactscreateContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors)Allows you to create a multiple contacts (bulk) in a Xero organisationcom.google.api.client.http.HttpResponsecreateContactsForHttpResponse(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors)AllocationscreateCreditNoteAllocation(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors)Allows you to create Allocation on CreditNotecom.google.api.client.http.HttpResponsecreateCreditNoteAllocationForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors)AttachmentscreateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String mimeType)Allows you to create Attachments on CreditNote by file nameAttachmentscreateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline)Allows you to create Attachments on CreditNote by file namecom.google.api.client.http.HttpResponsecreateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String mimeType)com.google.api.client.http.HttpResponsecreateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline)HistoryRecordscreateCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords)Allows you to retrieve a history records of an CreditNotecom.google.api.client.http.HttpResponsecreateCreditNoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords)CreditNotescreateCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp)Allows you to create a credit notecom.google.api.client.http.HttpResponsecreateCreditNotesForHttpResponse(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp)CurrenciescreateCurrency(String accessToken, String xeroTenantId, Currency currency)200 - Unsupported - return response incorrect exception, API is not able to create new Currencycom.google.api.client.http.HttpResponsecreateCurrencyForHttpResponse(String accessToken, String xeroTenantId, Currency currency)EmployeescreateEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors)Allows you to create new employees used in Xero payruncom.google.api.client.http.HttpResponsecreateEmployeesForHttpResponse(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors)HistoryRecordscreateExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords)Allows you to create a history records of an ExpenseClaimcom.google.api.client.http.HttpResponsecreateExpenseClaimHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords)ExpenseClaimscreateExpenseClaims(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims)Allows you to retrieve expense claimscom.google.api.client.http.HttpResponsecreateExpenseClaimsForHttpResponse(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims)AttachmentscreateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String mimeType)Allows you to create an Attachment on invoices or purchase bills by it's filenameAttachmentscreateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline)Allows you to create an Attachment on invoices or purchase bills by it's filenamecom.google.api.client.http.HttpResponsecreateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String mimeType)com.google.api.client.http.HttpResponsecreateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline)HistoryRecordscreateInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords)Allows you to retrieve a history records of an invoicecom.google.api.client.http.HttpResponsecreateInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords)InvoicescreateInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp)Allows you to create one or more sales invoices or purchase billscom.google.api.client.http.HttpResponsecreateInvoicesForHttpResponse(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp)HistoryRecordscreateItemHistory(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords)Allows you to create a history record for itemscom.google.api.client.http.HttpResponsecreateItemHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords)ItemscreateItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp)Allows you to create one or more itemscom.google.api.client.http.HttpResponsecreateItemsForHttpResponse(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp)LinkedTransactionscreateLinkedTransaction(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction)Allows you to create linked transactions (billable expenses)com.google.api.client.http.HttpResponsecreateLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction)AttachmentscreateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType)Allows you to create a specified Attachment on ManualJournal by file nameAttachmentscreateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body)Allows you to create a specified Attachment on ManualJournal by file namecom.google.api.client.http.HttpResponsecreateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body)HistoryRecordscreateManualJournalHistoryRecord(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords)Allows you to create history record for a manual journalcom.google.api.client.http.HttpResponsecreateManualJournalHistoryRecordForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords)ManualJournalscreateManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors)Allows you to create one or more manual journalscom.google.api.client.http.HttpResponsecreateManualJournalsForHttpResponse(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors)AllocationscreateOverpaymentAllocations(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors)Allows you to create a single allocation for an overpaymentcom.google.api.client.http.HttpResponsecreateOverpaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors)HistoryRecordscreateOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords)Allows you to create history records of an Overpaymentcom.google.api.client.http.HttpResponsecreateOverpaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords)PaymentscreatePayment(String accessToken, String xeroTenantId, Payment payment)Allows you to create a single payment for invoices or credit notescom.google.api.client.http.HttpResponsecreatePaymentForHttpResponse(String accessToken, String xeroTenantId, Payment payment)HistoryRecordscreatePaymentHistory(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords)Allows you to create a history record for a paymentcom.google.api.client.http.HttpResponsecreatePaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords)PaymentscreatePayments(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors)Allows you to create multiple payments for invoices or credit notesPaymentServicescreatePaymentService(String accessToken, String xeroTenantId, PaymentServices paymentServices)Allows you to create payment servicescom.google.api.client.http.HttpResponsecreatePaymentServiceForHttpResponse(String accessToken, String xeroTenantId, PaymentServices paymentServices)com.google.api.client.http.HttpResponsecreatePaymentsForHttpResponse(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors)AllocationscreatePrepaymentAllocations(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors)Allows you to create an Allocation for prepaymentscom.google.api.client.http.HttpResponsecreatePrepaymentAllocationsForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors)HistoryRecordscreatePrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords)Allows you to create a history record for an Prepaymentcom.google.api.client.http.HttpResponsecreatePrepaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords)AttachmentscreatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType)Allows you to create Attachment on Purchase OrderAttachmentscreatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body)Allows you to create Attachment on Purchase Ordercom.google.api.client.http.HttpResponsecreatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body)HistoryRecordscreatePurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords)Allows you to create HistoryRecord for purchase orderscom.google.api.client.http.HttpResponsecreatePurchaseOrderHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords)PurchaseOrderscreatePurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors)Allows you to create one or more purchase orderscom.google.api.client.http.HttpResponsecreatePurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors)AttachmentscreateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType)Allows you to create Attachment on QuoteAttachmentscreateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body)Allows you to create Attachment on Quotecom.google.api.client.http.HttpResponsecreateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body)HistoryRecordscreateQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords)Allows you to retrieve a history records of an quotecom.google.api.client.http.HttpResponsecreateQuoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords)QuotescreateQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors)Allows you to create one or more quotescom.google.api.client.http.HttpResponsecreateQuotesForHttpResponse(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors)ReceiptscreateReceipt(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp)Allows you to create draft expense claim receipts for any userAttachmentscreateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType)Allows you to create Attachment on expense claim receipts by file nameAttachmentscreateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body)Allows you to create Attachment on expense claim receipts by file namecom.google.api.client.http.HttpResponsecreateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body)com.google.api.client.http.HttpResponsecreateReceiptForHttpResponse(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp)HistoryRecordscreateReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords)Allows you to retrieve a history records of an Receiptcom.google.api.client.http.HttpResponsecreateReceiptHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords)AttachmentscreateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType)Allows you to create attachment on repeating invoices by file nameAttachmentscreateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body)Allows you to create attachment on repeating invoices by file namecom.google.api.client.http.HttpResponsecreateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponsecreateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body)HistoryRecordscreateRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords)Allows you to create history for a repeating invoicecom.google.api.client.http.HttpResponsecreateRepeatingInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords)TaxRatescreateTaxRates(String accessToken, String xeroTenantId, TaxRates taxRates)Allows you to create one or more Tax Ratescom.google.api.client.http.HttpResponsecreateTaxRatesForHttpResponse(String accessToken, String xeroTenantId, TaxRates taxRates)TrackingCategoriescreateTrackingCategory(String accessToken, String xeroTenantId, TrackingCategory trackingCategory)Allows you to create tracking categoriescom.google.api.client.http.HttpResponsecreateTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, TrackingCategory trackingCategory)TrackingOptionscreateTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption)Allows you to create options for a specified tracking categorycom.google.api.client.http.HttpResponsecreateTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption)AccountsdeleteAccount(String accessToken, String xeroTenantId, UUID accountID)Allows you to delete a chart of accountscom.google.api.client.http.HttpResponsedeleteAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)voiddeleteContactGroupContact(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID)Allows you to delete a specific Contact from a Contact Groupcom.google.api.client.http.HttpResponsedeleteContactGroupContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID)voiddeleteContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID)Allows you to delete all Contacts from a Contact Groupcom.google.api.client.http.HttpResponsedeleteContactGroupContactsForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID)voiddeleteItem(String accessToken, String xeroTenantId, UUID itemID)Allows you to delete a specified itemcom.google.api.client.http.HttpResponsedeleteItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID)voiddeleteLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID)Allows you to delete a specified linked transactions (billable expenses)com.google.api.client.http.HttpResponsedeleteLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID)PaymentsdeletePayment(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete)Allows you to update a specified payment for invoices and credit notescom.google.api.client.http.HttpResponsedeletePaymentForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete)TrackingCategoriesdeleteTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID)Allows you to delete tracking categoriescom.google.api.client.http.HttpResponsedeleteTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID)TrackingOptionsdeleteTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID)Allows you to delete a specified option for a specified tracking categorycom.google.api.client.http.HttpResponsedeleteTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID)voidemailInvoice(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty)Allows you to email a copy of invoice to related Contactcom.google.api.client.http.HttpResponseemailInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty)AccountsgetAccount(String accessToken, String xeroTenantId, UUID accountID)Allows you to retrieve a single chart of accountsByteArrayInputStreamgetAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType)Allows you to retrieve Attachment on Account by Filenamecom.google.api.client.http.HttpResponsegetAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType)ByteArrayInputStreamgetAccountAttachmentById(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType)Allows you to retrieve specific Attachment on Accountcom.google.api.client.http.HttpResponsegetAccountAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType)AttachmentsgetAccountAttachments(String accessToken, String xeroTenantId, UUID accountID)Allows you to retrieve Attachments for accountscom.google.api.client.http.HttpResponsegetAccountAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)com.google.api.client.http.HttpResponsegetAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID)AccountsgetAccounts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Allows you to retrieve the full chart of accountscom.google.api.client.http.HttpResponsegetAccountsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)ApiClientgetApiClient()BankTransactionsgetBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp)Allows you to retrieve a single spend or receive money transactionByteArrayInputStreamgetBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType)Allows you to retrieve Attachments on BankTransaction by Filenamecom.google.api.client.http.HttpResponsegetBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType)ByteArrayInputStreamgetBankTransactionAttachmentById(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType)Allows you to retrieve Attachments on a specific BankTransactioncom.google.api.client.http.HttpResponsegetBankTransactionAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType)AttachmentsgetBankTransactionAttachments(String accessToken, String xeroTenantId, UUID bankTransactionID)Allows you to retrieve any attachments to bank transactionscom.google.api.client.http.HttpResponsegetBankTransactionAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID)com.google.api.client.http.HttpResponsegetBankTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp)BankTransactionsgetBankTransactions(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)Allows you to retrieve any spend or receive money transactionscom.google.api.client.http.HttpResponsegetBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)HistoryRecordsgetBankTransactionsHistory(String accessToken, String xeroTenantId, UUID bankTransactionID)Allows you to retrieve history from a bank transactionscom.google.api.client.http.HttpResponsegetBankTransactionsHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID)BankTransfersgetBankTransfer(String accessToken, String xeroTenantId, UUID bankTransferID)Allows you to retrieve any bank transfersByteArrayInputStreamgetBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType)Allows you to retrieve Attachments on BankTransfer by file namecom.google.api.client.http.HttpResponsegetBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType)ByteArrayInputStreamgetBankTransferAttachmentById(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType)Allows you to retrieve Attachments on BankTransfercom.google.api.client.http.HttpResponsegetBankTransferAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType)AttachmentsgetBankTransferAttachments(String accessToken, String xeroTenantId, UUID bankTransferID)Allows you to retrieve Attachments from bank transferscom.google.api.client.http.HttpResponsegetBankTransferAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)com.google.api.client.http.HttpResponsegetBankTransferForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)HistoryRecordsgetBankTransferHistory(String accessToken, String xeroTenantId, UUID bankTransferID)Allows you to retrieve history from a bank transferscom.google.api.client.http.HttpResponsegetBankTransferHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID)BankTransfersgetBankTransfers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Allows you to retrieve all bank transferscom.google.api.client.http.HttpResponsegetBankTransfersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)HistoryRecordsgetBatchPaymentHistory(String accessToken, String xeroTenantId, UUID batchPaymentID)Allows you to retrieve history from a Batch Paymentcom.google.api.client.http.HttpResponsegetBatchPaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID batchPaymentID)BatchPaymentsgetBatchPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Retrieve either one or many BatchPayments for invoicescom.google.api.client.http.HttpResponsegetBatchPaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)BrandingThemesgetBrandingTheme(String accessToken, String xeroTenantId, UUID brandingThemeID)Allows you to retrieve a specific BrandingThemescom.google.api.client.http.HttpResponsegetBrandingThemeForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID)PaymentServicesgetBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID)Allows you to retrieve the Payment services for a Branding Themecom.google.api.client.http.HttpResponsegetBrandingThemePaymentServicesForHttpResponse(String accessToken, String xeroTenantId, UUID brandingThemeID)BrandingThemesgetBrandingThemes(String accessToken, String xeroTenantId)Allows you to retrieve all the BrandingThemescom.google.api.client.http.HttpResponsegetBrandingThemesForHttpResponse(String accessToken, String xeroTenantId)ContactsgetContact(String accessToken, String xeroTenantId, UUID contactID)Allows you to retrieve a single contacts in a Xero organisationByteArrayInputStreamgetContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType)Allows you to retrieve Attachments on Contacts by file namecom.google.api.client.http.HttpResponsegetContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType)ByteArrayInputStreamgetContactAttachmentById(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType)Allows you to retrieve Attachments on Contactscom.google.api.client.http.HttpResponsegetContactAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType)AttachmentsgetContactAttachments(String accessToken, String xeroTenantId, UUID contactID)Allows you to retrieve, add and update contacts in a Xero organisationcom.google.api.client.http.HttpResponsegetContactAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)ContactsgetContactByContactNumber(String accessToken, String xeroTenantId, String contactNumber)Allows you to retrieve a single contact by Contact Number in a Xero organisationcom.google.api.client.http.HttpResponsegetContactByContactNumberForHttpResponse(String accessToken, String xeroTenantId, String contactNumber)CISSettingsgetContactCISSettings(String accessToken, String xeroTenantId, UUID contactID)Allows you to retrieve CISSettings for a contact in a Xero organisationcom.google.api.client.http.HttpResponsegetContactCISSettingsForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)com.google.api.client.http.HttpResponsegetContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)ContactGroupsgetContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID)Allows you to retrieve a unique Contact Group by IDcom.google.api.client.http.HttpResponsegetContactGroupForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID)ContactGroupsgetContactGroups(String accessToken, String xeroTenantId, String where, String order)Allows you to retrieve the ContactID and Name of all the contacts in a contact groupcom.google.api.client.http.HttpResponsegetContactGroupsForHttpResponse(String accessToken, String xeroTenantId, String where, String order)HistoryRecordsgetContactHistory(String accessToken, String xeroTenantId, UUID contactID)Allows you to retrieve a history records of an Contactcom.google.api.client.http.HttpResponsegetContactHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID contactID)ContactsgetContacts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived)Allows you to retrieve all contacts in a Xero organisationcom.google.api.client.http.HttpResponsegetContactsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived)CreditNotesgetCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp)Allows you to retrieve a specific credit noteByteArrayInputStreamgetCreditNoteAsPdf(String accessToken, String xeroTenantId, UUID creditNoteID)Allows you to retrieve Credit Note as PDF filescom.google.api.client.http.HttpResponsegetCreditNoteAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)ByteArrayInputStreamgetCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType)Allows you to retrieve Attachments on CreditNote by file namecom.google.api.client.http.HttpResponsegetCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType)ByteArrayInputStreamgetCreditNoteAttachmentById(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType)Allows you to retrieve Attachments on CreditNotecom.google.api.client.http.HttpResponsegetCreditNoteAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType)AttachmentsgetCreditNoteAttachments(String accessToken, String xeroTenantId, UUID creditNoteID)Allows you to retrieve Attachments for credit notescom.google.api.client.http.HttpResponsegetCreditNoteAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)com.google.api.client.http.HttpResponsegetCreditNoteForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp)HistoryRecordsgetCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID)Allows you to retrieve a history records of an CreditNotecom.google.api.client.http.HttpResponsegetCreditNoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID)CreditNotesgetCreditNotes(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)Allows you to retrieve any credit notescom.google.api.client.http.HttpResponsegetCreditNotesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)CurrenciesgetCurrencies(String accessToken, String xeroTenantId, String where, String order)Allows you to retrieve currencies for your organisationcom.google.api.client.http.HttpResponsegetCurrenciesForHttpResponse(String accessToken, String xeroTenantId, String where, String order)EmployeesgetEmployee(String accessToken, String xeroTenantId, UUID employeeID)Allows you to retrieve a specific employee used in Xero payruncom.google.api.client.http.HttpResponsegetEmployeeForHttpResponse(String accessToken, String xeroTenantId, UUID employeeID)EmployeesgetEmployees(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Allows you to retrieve employees used in Xero payruncom.google.api.client.http.HttpResponsegetEmployeesForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)ExpenseClaimsgetExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID)Allows you to retrieve a specified expense claimcom.google.api.client.http.HttpResponsegetExpenseClaimForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID)HistoryRecordsgetExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID)Allows you to retrieve a history records of an ExpenseClaimcom.google.api.client.http.HttpResponsegetExpenseClaimHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID)ExpenseClaimsgetExpenseClaims(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Allows you to retrieve expense claimscom.google.api.client.http.HttpResponsegetExpenseClaimsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)static AccountingApigetInstance(ApiClient apiClient)InvoicesgetInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp)Allows you to retrieve a specified sales invoice or purchase billByteArrayInputStreamgetInvoiceAsPdf(String accessToken, String xeroTenantId, UUID invoiceID)Allows you to retrieve invoices or purchase bills as PDF filescom.google.api.client.http.HttpResponsegetInvoiceAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)ByteArrayInputStreamgetInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType)Allows you to retrieve Attachment on invoices or purchase bills by it's filenamecom.google.api.client.http.HttpResponsegetInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType)ByteArrayInputStreamgetInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType)Allows you to retrieve a specified Attachment on invoices or purchase bills by it's IDcom.google.api.client.http.HttpResponsegetInvoiceAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType)AttachmentsgetInvoiceAttachments(String accessToken, String xeroTenantId, UUID invoiceID)Allows you to retrieve Attachments on invoices or purchase billscom.google.api.client.http.HttpResponsegetInvoiceAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)com.google.api.client.http.HttpResponsegetInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp)HistoryRecordsgetInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID)Allows you to retrieve a history records of an invoicecom.google.api.client.http.HttpResponsegetInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)InvoiceRemindersgetInvoiceReminders(String accessToken, String xeroTenantId)Allows you to retrieve invoice reminder settingscom.google.api.client.http.HttpResponsegetInvoiceRemindersForHttpResponse(String accessToken, String xeroTenantId)InvoicesgetInvoices(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)Allows you to retrieve any sales invoices or purchase billscom.google.api.client.http.HttpResponsegetInvoicesForHttpResponse(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)ItemsgetItem(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp)Allows you to retrieve a specified itemcom.google.api.client.http.HttpResponsegetItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp)HistoryRecordsgetItemHistory(String accessToken, String xeroTenantId, UUID itemID)Allows you to retrieve history for itemscom.google.api.client.http.HttpResponsegetItemHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID itemID)ItemsgetItems(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)Allows you to retrieve any itemscom.google.api.client.http.HttpResponsegetItemsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)JournalsgetJournal(String accessToken, String xeroTenantId, UUID journalID)Allows you to retrieve a specified journals.com.google.api.client.http.HttpResponsegetJournalForHttpResponse(String accessToken, String xeroTenantId, UUID journalID)JournalsgetJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly)Allows you to retrieve any journals.com.google.api.client.http.HttpResponsegetJournalsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly)LinkedTransactionsgetLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID)Allows you to retrieve a specified linked transactions (billable expenses)com.google.api.client.http.HttpResponsegetLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID)LinkedTransactionsgetLinkedTransactions(String accessToken, String xeroTenantId, Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID)Retrieve linked transactions (billable expenses)com.google.api.client.http.HttpResponsegetLinkedTransactionsForHttpResponse(String accessToken, String xeroTenantId, Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID)ManualJournalsgetManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID)Allows you to retrieve a specified manual journalsByteArrayInputStreamgetManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType)Allows you to retrieve specified Attachment on ManualJournal by file namecom.google.api.client.http.HttpResponsegetManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType)ByteArrayInputStreamgetManualJournalAttachmentById(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType)Allows you to retrieve specified Attachment on ManualJournalscom.google.api.client.http.HttpResponsegetManualJournalAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType)AttachmentsgetManualJournalAttachments(String accessToken, String xeroTenantId, UUID manualJournalID)Allows you to retrieve Attachment for manual journalscom.google.api.client.http.HttpResponsegetManualJournalAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)com.google.api.client.http.HttpResponsegetManualJournalForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)ManualJournalsgetManualJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)Allows you to retrieve any manual journalscom.google.api.client.http.HttpResponsegetManualJournalsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)HistoryRecordsgetManualJournalsHistory(String accessToken, String xeroTenantId, UUID manualJournalID)Allows you to retrieve history from a manual journalcom.google.api.client.http.HttpResponsegetManualJournalsHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID)OnlineInvoicesgetOnlineInvoice(String accessToken, String xeroTenantId, UUID invoiceID)Allows you to retrieve a URL to an online invoicecom.google.api.client.http.HttpResponsegetOnlineInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID)ActionsgetOrganisationActions(String accessToken, String xeroTenantId)Retrieve a list of the key actions your app has permission to perform in the connected organisation.com.google.api.client.http.HttpResponsegetOrganisationActionsForHttpResponse(String accessToken, String xeroTenantId)CISOrgSettinggetOrganisationCISSettings(String accessToken, String xeroTenantId, UUID organisationID)Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.com.google.api.client.http.HttpResponsegetOrganisationCISSettingsForHttpResponse(String accessToken, String xeroTenantId, UUID organisationID)OrganisationsgetOrganisations(String accessToken, String xeroTenantId)Allows you to retrieve Organisation detailscom.google.api.client.http.HttpResponsegetOrganisationsForHttpResponse(String accessToken, String xeroTenantId)OverpaymentsgetOverpayment(String accessToken, String xeroTenantId, UUID overpaymentID)Allows you to retrieve a specified overpaymentscom.google.api.client.http.HttpResponsegetOverpaymentForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID)HistoryRecordsgetOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID)Allows you to retrieve a history records of an Overpaymentcom.google.api.client.http.HttpResponsegetOverpaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID overpaymentID)OverpaymentsgetOverpayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)Allows you to retrieve overpaymentscom.google.api.client.http.HttpResponsegetOverpaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)PaymentsgetPayment(String accessToken, String xeroTenantId, UUID paymentID)Allows you to retrieve a specified payment for invoices and credit notescom.google.api.client.http.HttpResponsegetPaymentForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID)HistoryRecordsgetPaymentHistory(String accessToken, String xeroTenantId, UUID paymentID)Allows you to retrieve history records of a paymentcom.google.api.client.http.HttpResponsegetPaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID paymentID)PaymentsgetPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)Allows you to retrieve payments for invoices and credit notesPaymentServicesgetPaymentServices(String accessToken, String xeroTenantId)Allows you to retrieve payment servicescom.google.api.client.http.HttpResponsegetPaymentServicesForHttpResponse(String accessToken, String xeroTenantId)com.google.api.client.http.HttpResponsegetPaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)PrepaymentsgetPrepayment(String accessToken, String xeroTenantId, UUID prepaymentID)Allows you to retrieve a specified prepaymentscom.google.api.client.http.HttpResponsegetPrepaymentForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID)HistoryRecordsgetPrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID)Allows you to retrieve a history records of an Prepaymentcom.google.api.client.http.HttpResponsegetPrepaymentHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID prepaymentID)PrepaymentsgetPrepayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)Allows you to retrieve prepaymentscom.google.api.client.http.HttpResponsegetPrepaymentsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)PurchaseOrdersgetPurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID)Allows you to retrieve a specified purchase ordersByteArrayInputStreamgetPurchaseOrderAsPdf(String accessToken, String xeroTenantId, UUID purchaseOrderID)Allows you to retrieve purchase orders as PDF filescom.google.api.client.http.HttpResponsegetPurchaseOrderAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)ByteArrayInputStreamgetPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType)Allows you to retrieve Attachment on a Purchase Order by Filenamecom.google.api.client.http.HttpResponsegetPurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType)ByteArrayInputStreamgetPurchaseOrderAttachmentById(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType)Allows you to retrieve specific Attachment on purchase ordercom.google.api.client.http.HttpResponsegetPurchaseOrderAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType)AttachmentsgetPurchaseOrderAttachments(String accessToken, String xeroTenantId, UUID purchaseOrderID)Allows you to retrieve attachments for purchase orderscom.google.api.client.http.HttpResponsegetPurchaseOrderAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)PurchaseOrdersgetPurchaseOrderByNumber(String accessToken, String xeroTenantId, String purchaseOrderNumber)Allows you to retrieve a specified purchase orderscom.google.api.client.http.HttpResponsegetPurchaseOrderByNumberForHttpResponse(String accessToken, String xeroTenantId, String purchaseOrderNumber)com.google.api.client.http.HttpResponsegetPurchaseOrderForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)HistoryRecordsgetPurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID)Allows you to retrieve history for PurchaseOrdercom.google.api.client.http.HttpResponsegetPurchaseOrderHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID)PurchaseOrdersgetPurchaseOrders(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page)Allows you to retrieve purchase orderscom.google.api.client.http.HttpResponsegetPurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page)QuotesgetQuote(String accessToken, String xeroTenantId, UUID quoteID)Allows you to retrieve a specified quoteByteArrayInputStreamgetQuoteAsPdf(String accessToken, String xeroTenantId, UUID quoteID)Allows you to retrieve quotes as PDF filescom.google.api.client.http.HttpResponsegetQuoteAsPdfForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)ByteArrayInputStreamgetQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType)Allows you to retrieve Attachment on Quote by Filenamecom.google.api.client.http.HttpResponsegetQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType)ByteArrayInputStreamgetQuoteAttachmentById(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType)Allows you to retrieve specific Attachment on Quotecom.google.api.client.http.HttpResponsegetQuoteAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType)AttachmentsgetQuoteAttachments(String accessToken, String xeroTenantId, UUID quoteID)Allows you to retrieve Attachments for Quotescom.google.api.client.http.HttpResponsegetQuoteAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)com.google.api.client.http.HttpResponsegetQuoteForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)HistoryRecordsgetQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID)Allows you to retrieve a history records of an quotecom.google.api.client.http.HttpResponsegetQuoteHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID)QuotesgetQuotes(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)Allows you to retrieve any sales quotescom.google.api.client.http.HttpResponsegetQuotesForHttpResponse(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)ReceiptsgetReceipt(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp)Allows you to retrieve a specified draft expense claim receiptsByteArrayInputStreamgetReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType)Allows you to retrieve Attachments on expense claim receipts by file namecom.google.api.client.http.HttpResponsegetReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType)ByteArrayInputStreamgetReceiptAttachmentById(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType)Allows you to retrieve Attachments on expense claim receipts by IDcom.google.api.client.http.HttpResponsegetReceiptAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType)AttachmentsgetReceiptAttachments(String accessToken, String xeroTenantId, UUID receiptID)Allows you to retrieve Attachments for expense claim receiptscom.google.api.client.http.HttpResponsegetReceiptAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID)com.google.api.client.http.HttpResponsegetReceiptForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp)HistoryRecordsgetReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID)Allows you to retrieve a history records of an Receiptcom.google.api.client.http.HttpResponsegetReceiptHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID)ReceiptsgetReceipts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)Allows you to retrieve draft expense claim receipts for any usercom.google.api.client.http.HttpResponsegetReceiptsForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)RepeatingInvoicesgetRepeatingInvoice(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)Allows you to retrieve a specified repeating invoiceByteArrayInputStreamgetRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType)Allows you to retrieve specified attachment on repeating invoices by file namecom.google.api.client.http.HttpResponsegetRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType)ByteArrayInputStreamgetRepeatingInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType)Allows you to retrieve a specified Attachments on repeating invoicescom.google.api.client.http.HttpResponsegetRepeatingInvoiceAttachmentByIdForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType)AttachmentsgetRepeatingInvoiceAttachments(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)Allows you to retrieve Attachments on repeating invoicecom.google.api.client.http.HttpResponsegetRepeatingInvoiceAttachmentsForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)com.google.api.client.http.HttpResponsegetRepeatingInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)HistoryRecordsgetRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)Allows you to retrieve history for a repeating invoicecom.google.api.client.http.HttpResponsegetRepeatingInvoiceHistoryForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID)RepeatingInvoicesgetRepeatingInvoices(String accessToken, String xeroTenantId, String where, String order)Allows you to retrieve any repeating invoicescom.google.api.client.http.HttpResponsegetRepeatingInvoicesForHttpResponse(String accessToken, String xeroTenantId, String where, String order)ReportWithRowsgetReportAgedPayablesByContact(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)Allows you to retrieve report for AgedPayablesByContactcom.google.api.client.http.HttpResponsegetReportAgedPayablesByContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)ReportWithRowsgetReportAgedReceivablesByContact(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)Allows you to retrieve report for AgedReceivablesByContactcom.google.api.client.http.HttpResponsegetReportAgedReceivablesByContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)ReportWithRowsgetReportBalanceSheet(String accessToken, String xeroTenantId, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)Allows you to retrieve report for BalanceSheetcom.google.api.client.http.HttpResponsegetReportBalanceSheetForHttpResponse(String accessToken, String xeroTenantId, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)ReportWithRowsgetReportBankSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)Allows you to retrieve report for BankSummarycom.google.api.client.http.HttpResponsegetReportBankSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)ReportWithRowsgetReportBASorGST(String accessToken, String xeroTenantId, String reportID)Allows you to retrieve report for BAS only valid for AU orgscom.google.api.client.http.HttpResponsegetReportBASorGSTForHttpResponse(String accessToken, String xeroTenantId, String reportID)ReportWithRowsgetReportBASorGSTList(String accessToken, String xeroTenantId)Allows you to retrieve report for BAS only valid for AU orgscom.google.api.client.http.HttpResponsegetReportBASorGSTListForHttpResponse(String accessToken, String xeroTenantId)ReportWithRowsgetReportBudgetSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer period, Integer timeframe)Allows you to retrieve report for Budget Summarycom.google.api.client.http.HttpResponsegetReportBudgetSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer period, Integer timeframe)ReportWithRowsgetReportExecutiveSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date)Allows you to retrieve report for ExecutiveSummarycom.google.api.client.http.HttpResponsegetReportExecutiveSummaryForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date)ReportWithRowsgetReportProfitAndLoss(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)Allows you to retrieve report for ProfitAndLosscom.google.api.client.http.HttpResponsegetReportProfitAndLossForHttpResponse(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)ReportsgetReportTenNinetyNine(String accessToken, String xeroTenantId, String reportYear)Allows you to retrieve report for TenNinetyNinecom.google.api.client.http.HttpResponsegetReportTenNinetyNineForHttpResponse(String accessToken, String xeroTenantId, String reportYear)ReportWithRowsgetReportTrialBalance(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly)Allows you to retrieve report for TrialBalancecom.google.api.client.http.HttpResponsegetReportTrialBalanceForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly)TaxRatesgetTaxRates(String accessToken, String xeroTenantId, String where, String order, String taxType)Allows you to retrieve Tax Ratescom.google.api.client.http.HttpResponsegetTaxRatesForHttpResponse(String accessToken, String xeroTenantId, String where, String order, String taxType)TrackingCategoriesgetTrackingCategories(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived)Allows you to retrieve tracking categories and optionscom.google.api.client.http.HttpResponsegetTrackingCategoriesForHttpResponse(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived)TrackingCategoriesgetTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID)Allows you to retrieve tracking categories and options for specified categorycom.google.api.client.http.HttpResponsegetTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID)UsersgetUser(String accessToken, String xeroTenantId, UUID userID)Allows you to retrieve a specified userStringgetUserAgent()com.google.api.client.http.HttpResponsegetUserForHttpResponse(String accessToken, String xeroTenantId, UUID userID)UsersgetUsers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)Allows you to retrieve userscom.google.api.client.http.HttpResponsegetUsersForHttpResponse(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)ImportSummarypostSetup(String accessToken, String xeroTenantId, Setup setup)Allows you to set the chart of accounts, the conversion date and conversion balancescom.google.api.client.http.HttpResponsepostSetupForHttpResponse(String accessToken, String xeroTenantId, Setup setup)voidsetApiClient(ApiClient apiClient)voidsetUserAgent(String userAgent)AccountsupdateAccount(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts)Allows you to update a chart of accountsAttachmentsupdateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType)Allows you to update Attachment on Account by FilenameAttachmentsupdateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body)Allows you to update Attachment on Account by Filenamecom.google.api.client.http.HttpResponseupdateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateAccountAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body)com.google.api.client.http.HttpResponseupdateAccountForHttpResponse(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts)BankTransactionsupdateBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp)Allows you to update a single spend or receive money transactionAttachmentsupdateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType)Allows you to update an Attachment on BankTransaction by FilenameAttachmentsupdateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body)Allows you to update an Attachment on BankTransaction by Filenamecom.google.api.client.http.HttpResponseupdateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateBankTransactionAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body)com.google.api.client.http.HttpResponseupdateBankTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp)AttachmentsupdateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType)200 - Success - return response of Attachments array of 0 to N Attachment for a Bank TransferAttachmentsupdateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body)200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfercom.google.api.client.http.HttpResponseupdateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateBankTransferAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body)ContactsupdateContact(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts)200 - Success - return response of type Contacts array with an updated ContactAttachmentsupdateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType)200 - Success - return response of type Attachments array with an updated AttachmentAttachmentsupdateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body)200 - Success - return response of type Attachments array with an updated Attachmentcom.google.api.client.http.HttpResponseupdateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateContactAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body)com.google.api.client.http.HttpResponseupdateContactForHttpResponse(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts)ContactGroupsupdateContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups)Allows you to update a Contact Groupcom.google.api.client.http.HttpResponseupdateContactGroupForHttpResponse(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups)CreditNotesupdateCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp)Allows you to update a specific credit noteAttachmentsupdateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String mimeType)Allows you to update Attachments on CreditNote by file nameAttachmentsupdateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body)Allows you to update Attachments on CreditNote by file namecom.google.api.client.http.HttpResponseupdateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateCreditNoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body)com.google.api.client.http.HttpResponseupdateCreditNoteForHttpResponse(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp)ExpenseClaimsupdateExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims)Allows you to update specified expense claimscom.google.api.client.http.HttpResponseupdateExpenseClaimForHttpResponse(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims)InvoicesupdateInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp)Allows you to update a specified sales invoices or purchase billsAttachmentsupdateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String mimeType)Allows you to update Attachment on invoices or purchase bills by it's filenameAttachmentsupdateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body)Allows you to update Attachment on invoices or purchase bills by it's filenamecom.google.api.client.http.HttpResponseupdateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body)com.google.api.client.http.HttpResponseupdateInvoiceForHttpResponse(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp)ItemsupdateItem(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp)Allows you to update a specified itemcom.google.api.client.http.HttpResponseupdateItemForHttpResponse(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp)LinkedTransactionsupdateLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions)Allows you to update a specified linked transactions (billable expenses)com.google.api.client.http.HttpResponseupdateLinkedTransactionForHttpResponse(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions)ManualJournalsupdateManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals)Allows you to update a specified manual journalAttachmentsupdateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType)Allows you to update a specified Attachment on ManualJournal by file nameAttachmentsupdateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body)Allows you to update a specified Attachment on ManualJournal by file namecom.google.api.client.http.HttpResponseupdateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateManualJournalAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body)com.google.api.client.http.HttpResponseupdateManualJournalForHttpResponse(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals)BankTransactionsupdateOrCreateBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp)Allows you to update or create one or more spend or receive money transactioncom.google.api.client.http.HttpResponseupdateOrCreateBankTransactionsForHttpResponse(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp)ContactsupdateOrCreateContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors)Allows you to update OR create one or more contacts in a Xero organisationcom.google.api.client.http.HttpResponseupdateOrCreateContactsForHttpResponse(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors)CreditNotesupdateOrCreateCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp)Allows you to update OR create one or more credit notescom.google.api.client.http.HttpResponseupdateOrCreateCreditNotesForHttpResponse(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp)EmployeesupdateOrCreateEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors)Allows you to create a single new employees used in Xero payruncom.google.api.client.http.HttpResponseupdateOrCreateEmployeesForHttpResponse(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors)InvoicesupdateOrCreateInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp)Allows you to update OR create one or more sales invoices or purchase billscom.google.api.client.http.HttpResponseupdateOrCreateInvoicesForHttpResponse(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp)ItemsupdateOrCreateItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp)Allows you to update or create one or more itemscom.google.api.client.http.HttpResponseupdateOrCreateItemsForHttpResponse(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp)ManualJournalsupdateOrCreateManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors)Allows you to create a single manual journalcom.google.api.client.http.HttpResponseupdateOrCreateManualJournalsForHttpResponse(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors)PurchaseOrdersupdateOrCreatePurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors)Allows you to update or create one or more purchase orderscom.google.api.client.http.HttpResponseupdateOrCreatePurchaseOrdersForHttpResponse(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors)QuotesupdateOrCreateQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors)Allows you to update OR create one or more quotescom.google.api.client.http.HttpResponseupdateOrCreateQuotesForHttpResponse(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors)PurchaseOrdersupdatePurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders)Allows you to update a specified purchase orderAttachmentsupdatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType)Allows you to update Attachment on Purchase Order by FilenameAttachmentsupdatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body)Allows you to update Attachment on Purchase Order by Filenamecom.google.api.client.http.HttpResponseupdatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdatePurchaseOrderAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body)com.google.api.client.http.HttpResponseupdatePurchaseOrderForHttpResponse(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders)QuotesupdateQuote(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes)Allows you to update a specified quoteAttachmentsupdateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType)Allows you to update Attachment on Quote by FilenameAttachmentsupdateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body)Allows you to update Attachment on Quote by Filenamecom.google.api.client.http.HttpResponseupdateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateQuoteAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body)com.google.api.client.http.HttpResponseupdateQuoteForHttpResponse(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes)ReceiptsupdateReceipt(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp)Allows you to retrieve a specified draft expense claim receiptsAttachmentsupdateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType)Allows you to update Attachment on expense claim receipts by file nameAttachmentsupdateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body)Allows you to update Attachment on expense claim receipts by file namecom.google.api.client.http.HttpResponseupdateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateReceiptAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body)com.google.api.client.http.HttpResponseupdateReceiptForHttpResponse(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp)AttachmentsupdateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType)Allows you to update specified attachment on repeating invoices by file nameAttachmentsupdateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body)Allows you to update specified attachment on repeating invoices by file namecom.google.api.client.http.HttpResponseupdateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType)com.google.api.client.http.HttpResponseupdateRepeatingInvoiceAttachmentByFileNameForHttpResponse(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body)TaxRatesupdateTaxRate(String accessToken, String xeroTenantId, TaxRates taxRates)Allows you to update Tax Ratescom.google.api.client.http.HttpResponseupdateTaxRateForHttpResponse(String accessToken, String xeroTenantId, TaxRates taxRates)TrackingCategoriesupdateTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory)Allows you to update tracking categoriescom.google.api.client.http.HttpResponseupdateTrackingCategoryForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory)TrackingOptionsupdateTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption)Allows you to update options for a specified tracking categorycom.google.api.client.http.HttpResponseupdateTrackingOptionsForHttpResponse(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption)
-
Constructor Details
-
AccountingApi
public AccountingApi() -
AccountingApi
-
-
Method Details
-
getInstance
-
getApiClient
-
setApiClient
-
setUserAgent
-
getUserAgent
-
createAccount
public Accounts createAccount(String accessToken, String xeroTenantId, Account account) throws IOExceptionAllows you to create a new chart of accounts200 - 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:
xeroTenantId- Xero identifier for Tenantaccount- Account object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createAccountAttachmentByFileName
public Attachments createAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create Attachment on Account200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createAccountAttachmentByFileName
public Attachments createAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOExceptionAllows you to create Attachment on Account200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransactionAttachmentByFileName
public Attachments createBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create an Attachment on BankTransaction by Filename200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionfileName- The name of the file being attachedbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createBankTransactionAttachmentByFileName
public Attachments createBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOExceptionAllows you to create an Attachment on BankTransaction by Filename200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionfileName- The name of the file being attachedbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransactionHistoryRecord
public HistoryRecords createBankTransactionHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords) throws IOExceptionAllows you to create history record for a bank transactions200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransactions
public BankTransactions createBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to create one or more spend or receive money transaction200 - Success - return response of type BankTransactions array with new BankTransaction
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactions- BankTransactions with an array of BankTransaction objects in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransfer
public BankTransfers createBankTransfer(String accessToken, String xeroTenantId, BankTransfers bankTransfers) throws IOExceptionAllows you to create a bank transfers200 - Success - return response of BankTransfers array of one BankTransfer
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransfers- BankTransfers with array of BankTransfer objects in request bodyaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransferAttachmentByFileName
public Attachments createBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType) throws IOException200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferfileName- The name of the file being attached to a Bank Transferbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createBankTransferAttachmentByFileName
public Attachments createBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferfileName- The name of the file being attached to a Bank Transferbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBankTransferHistoryRecord
public HistoryRecords createBankTransferHistoryRecord(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords) throws IOException200 - Success - return response of type HistoryRecords array of HistoryRecord objects400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBatchPayment
public BatchPayments createBatchPayment(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors) throws IOExceptionCreate one or many BatchPayments for invoices200 - Success - return response of type BatchPayments array of BatchPayment objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbatchPayments- BatchPayments with an array of Payments in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBatchPaymentHistoryRecord
public HistoryRecords createBatchPaymentHistoryRecord(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords) throws IOExceptionAllows you to create a history record for a Batch Payment200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbatchPaymentID- Unique identifier for BatchPaymenthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createBrandingThemePaymentServices
public PaymentServices createBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentService paymentService) throws IOExceptionAllow for the creation of new custom payment service for specified Branding Theme200 - Success - return response of type PaymentServices array with newly created PaymentService
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbrandingThemeID- Unique identifier for a Branding ThemepaymentService- PaymentService object in body of requestaccessToken- Authorization token for user set in header of each request- 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, PaymentService paymentService) throws IOException- Throws:
IOException
-
createContactAttachmentByFileName
public Attachments createContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType) throws IOException200 - Success - return response of type Attachments array with an newly created Attachment400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactfileName- Name for the file you are attachingbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createContactAttachmentByFileName
public Attachments createContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException200 - Success - return response of type Attachments array with an newly created Attachment400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactfileName- Name for the file you are attachingbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createContactGroup
public ContactGroups createContactGroup(String accessToken, String xeroTenantId, ContactGroups contactGroups) throws IOExceptionAllows you to create a contact group200 - 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:
xeroTenantId- Xero identifier for TenantcontactGroups- ContactGroups with an array of names in request bodyaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createContactGroupContacts
public Contacts createContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts) throws IOExceptionAllows you to add Contacts to a Contact Group200 - Success - return response of type Contacts array of added Contacts
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactGroupID- Unique identifier for a Contact Groupcontacts- Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createContactHistory
public HistoryRecords createContactHistory(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords) throws IOExceptionAllows you to retrieve a history records of an Contact200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContacthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createContacts
public Contacts createContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOExceptionAllows you to create a multiple contacts (bulk) in a Xero organisation200 - Success - return response of type Contacts array with newly created Contact
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for Tenantcontacts- Contacts with an array of Contact objects to create in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createCreditNoteAllocation
public Allocations createCreditNoteAllocation(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors) throws IOExceptionAllows you to create Allocation on CreditNote200 - Success - return response of type Allocations array with newly created Allocation for specific Credit Note
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit Noteallocations- 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 errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createCreditNoteAttachmentByFileName
public Attachments createCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String mimeType) throws IOExceptionAllows you to create Attachments on CreditNote by file name200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotefileName- Name of the file you are attaching to Credit Notebody- Byte array of file in body of requestincludeOnline- Allows an attachment to be seen by the end customer within their online invoicemimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createCreditNoteAttachmentByFileName
public Attachments createCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline) throws IOExceptionAllows you to create Attachments on CreditNote by file name200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotefileName- Name of the file you are attaching to Credit Notebody- Byte array of file in body of requestincludeOnline- Allows an attachment to be seen by the end customer within their online invoiceaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createCreditNoteHistory
public HistoryRecords createCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords) throws IOExceptionAllows you to retrieve a history records of an CreditNote200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotehistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createCreditNotes
public CreditNotes createCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to create a credit note200 - Success - return response of type Credit Notes array of newly created CreditNote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNotes- Credit Notes with array of CreditNote object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createCurrency
public Currencies createCurrency(String accessToken, String xeroTenantId, Currency currency) throws IOException200 - Unsupported - return response incorrect exception, API is not able to create new Currency- Parameters:
xeroTenantId- Xero identifier for Tenantcurrency- Currency obejct in the body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createEmployees
public Employees createEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOExceptionAllows you to create new employees used in Xero payrun200 - Success - return response of type Employees array with new Employee
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantemployees- Employees with array of Employee object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createExpenseClaimHistory
public HistoryRecords createExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords) throws IOExceptionAllows you to create a history records of an ExpenseClaim200 - Success - return response of type HistoryRecords array of HistoryRecord objects
- Parameters:
xeroTenantId- Xero identifier for TenantexpenseClaimID- Unique identifier for a ExpenseClaimhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createExpenseClaims
public ExpenseClaims createExpenseClaims(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims) throws IOExceptionAllows you to retrieve expense claims200 - Success - return response of type ExpenseClaims array with newly created ExpenseClaim
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantexpenseClaims- ExpenseClaims with array of ExpenseClaim object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createInvoiceAttachmentByFileName
public Attachments createInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String mimeType) throws IOExceptionAllows you to create an Attachment on invoices or purchase bills by it's filename200 - Success - return response of type Attachments array with newly created Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicefileName- Name of the file you are attachingbody- Byte array of file in body of requestincludeOnline- Allows an attachment to be seen by the end customer within their online invoicemimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createInvoiceAttachmentByFileName
public Attachments createInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline) throws IOExceptionAllows you to create an Attachment on invoices or purchase bills by it's filename200 - Success - return response of type Attachments array with newly created Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicefileName- Name of the file you are attachingbody- Byte array of file in body of requestincludeOnline- Allows an attachment to be seen by the end customer within their online invoiceaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createInvoiceHistory
public HistoryRecords createInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords) throws IOExceptionAllows you to retrieve a history records of an invoice200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicehistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createInvoices
public Invoices createInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to create one or more sales invoices or purchase bills200 - Success - return response of type Invoices array with newly created Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantinvoices- Invoices with an array of invoice objects in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createItemHistory
public HistoryRecords createItemHistory(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords) throws IOExceptionAllows you to create a history record for items200 - Success - return response of type HistoryRecords array of HistoryRecord objects
- Parameters:
xeroTenantId- Xero identifier for TenantitemID- Unique identifier for an ItemhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createItems
public Items createItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to create one or more items200 - Success - return response of type Items array with newly created Item
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantitems- Items with an array of Item objects in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createLinkedTransaction
public LinkedTransactions createLinkedTransaction(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction) throws IOExceptionAllows you to create 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:
xeroTenantId- Xero identifier for TenantlinkedTransaction- LinkedTransaction object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createManualJournalAttachmentByFileName
public Attachments createManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create a specified Attachment on ManualJournal by file name200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalfileName- The name of the file being attached to a ManualJournalbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createManualJournalAttachmentByFileName
public Attachments createManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOExceptionAllows you to create a specified Attachment on ManualJournal by file name200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalfileName- The name of the file being attached to a ManualJournalbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createManualJournalHistoryRecord
public HistoryRecords createManualJournalHistoryRecord(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords) throws IOExceptionAllows you to create history record for a manual journal200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Xero generated unique identifier for a manual journalhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createManualJournals
public ManualJournals createManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOExceptionAllows you to create one or more manual journals200 - Success - return response of type ManualJournals array with newly created ManualJournal
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournals- ManualJournals array with ManualJournal object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createOverpaymentAllocations
public Allocations createOverpaymentAllocations(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors) throws IOExceptionAllows you to create a single allocation for an overpayment200 - Success - return response of type Allocations array with all Allocation for Overpayments
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantoverpaymentID- Unique identifier for a Overpaymentallocations- Allocations array with Allocation object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createOverpaymentHistory
public HistoryRecords createOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords) throws IOExceptionAllows you to create history records of an Overpayment200 - 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:
xeroTenantId- Xero identifier for TenantoverpaymentID- Unique identifier for a OverpaymenthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPayment
public Payments createPayment(String accessToken, String xeroTenantId, Payment payment) throws IOExceptionAllows you to create a single payment for invoices or credit notes200 - Success - return response of type Payments array for newly created Payment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantpayment- Request body with a single Payment objectaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPaymentHistory
public HistoryRecords createPaymentHistory(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords) throws IOExceptionAllows you to create a history record for a payment200 - 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:
xeroTenantId- Xero identifier for TenantpaymentID- Unique identifier for a PaymenthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPaymentService
public PaymentServices createPaymentService(String accessToken, String xeroTenantId, PaymentServices paymentServices) throws IOExceptionAllows you to create payment services200 - Success - return response of type PaymentServices array for newly created PaymentService
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpaymentServices- PaymentServices array with PaymentService object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPayments
public Payments createPayments(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors) throws IOExceptionAllows you to create multiple payments for invoices or credit notes200 - Success - return response of type Payments array for newly created Payment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantpayments- Payments array with Payment object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPrepaymentAllocations
public Allocations createPrepaymentAllocations(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors) throws IOExceptionAllows you to create an Allocation for prepayments200 - Success - return response of type Allocations array of Allocation for all Prepayment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantprepaymentID- Unique identifier for Prepaymentallocations- Allocations with an array of Allocation object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPrepaymentHistory
public HistoryRecords createPrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords) throws IOExceptionAllows you to create a history record for an Prepayment200 - 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:
xeroTenantId- Xero identifier for TenantprepaymentID- Unique identifier for a PrePaymenthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPurchaseOrderAttachmentByFileName
public Attachments createPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create Attachment on Purchase Order200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createPurchaseOrderAttachmentByFileName
public Attachments createPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOExceptionAllows you to create Attachment on Purchase Order200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPurchaseOrderHistory
public HistoryRecords createPurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords) throws IOExceptionAllows you to create HistoryRecord for purchase orders200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for a PurchaseOrderhistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createPurchaseOrders
public PurchaseOrders createPurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOExceptionAllows you to create one or more purchase orders200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrders- PurchaseOrders with an array of PurchaseOrder object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createQuoteAttachmentByFileName
public Attachments createQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create Attachment on Quote200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createQuoteAttachmentByFileName
public Attachments createQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOExceptionAllows you to create Attachment on Quote200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createQuoteHistory
public HistoryRecords createQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords) throws IOExceptionAllows you to retrieve a history records of an quote200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for an QuotehistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createQuotes
public Quotes createQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOExceptionAllows you to create one or more quotes200 - Success - return response of type Quotes with array with newly created Quote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantquotes- Quotes with an array of Quote object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createReceipt
public Receipts createReceipt(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp) throws IOExceptionAllows you to create draft expense claim receipts for any user200 - Success - return response of type Receipts array for newly created Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantreceipts- Receipts with an array of Receipt object in body of requestunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createReceiptAttachmentByFileName
public Attachments createReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create Attachment on expense claim receipts by file name200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptfileName- The name of the file being attached to the Receiptbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createReceiptAttachmentByFileName
public Attachments createReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOExceptionAllows you to create Attachment on expense claim receipts by file name200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptfileName- The name of the file being attached to the Receiptbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createReceiptHistory
public HistoryRecords createReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords) throws IOExceptionAllows you to retrieve a history records of an Receipt200 - 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:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceipthistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createRepeatingInvoiceAttachmentByFileName
public Attachments createRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to create attachment on repeating invoices by file name200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicefileName- The name of the file being attached to a Repeating Invoicebody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
createRepeatingInvoiceAttachmentByFileName
public Attachments createRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOExceptionAllows you to create attachment on repeating invoices by file name200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicefileName- The name of the file being attached to a Repeating Invoicebody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createRepeatingInvoiceHistory
public HistoryRecords createRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords) throws IOExceptionAllows you to create history for a repeating invoice200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicehistoryRecords- HistoryRecords containing an array of HistoryRecord objects in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createTaxRates
public TaxRates createTaxRates(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOExceptionAllows you to create one or more Tax Rates200 - Success - return response of type TaxRates array newly created TaxRate
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttaxRates- TaxRates array with TaxRate object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createTrackingCategory
public TrackingCategories createTrackingCategory(String accessToken, String xeroTenantId, TrackingCategory trackingCategory) throws IOExceptionAllows you to create tracking categories200 - Success - return response of type TrackingCategories array of newly created TrackingCategory
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategory- TrackingCategory object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
createTrackingOptions
public TrackingOptions createTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption) throws IOExceptionAllows you to create options for a specified tracking category200 - Success - return response of type TrackingOptions array of options for a specified category
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategorytrackingOption- TrackingOption object in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
deleteAccount
public Accounts deleteAccount(String accessToken, String xeroTenantId, UUID accountID) throws IOExceptionAllows you to delete a chart of accounts200 - 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:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for retrieving single objectaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deleteContactGroupContact
public void deleteContactGroupContact(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID) throws IOExceptionAllows you to delete a specific Contact from a Contact Group204 - Success - return response 204 no content
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactGroupID- Unique identifier for a Contact GroupcontactID- Unique identifier for a ContactaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deleteContactGroupContacts
public void deleteContactGroupContacts(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOExceptionAllows you to delete all Contacts from a Contact Group204 - Success - return response 204 no content
- Parameters:
xeroTenantId- Xero identifier for TenantcontactGroupID- Unique identifier for a Contact GroupaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deleteItem
Allows you to delete a specified item204 - Success - return response 204 no content
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantitemID- Unique identifier for an ItemaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deleteLinkedTransaction
public void deleteLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOExceptionAllows you to delete a specified linked transactions (billable expenses)204 - Success - return response 204 no content
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantlinkedTransactionID- Unique identifier for a LinkedTransactionaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deletePayment
public Payments deletePayment(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete) throws IOExceptionAllows you to update a specified payment for invoices and credit notes200 - Success - return response of type Payments array for updated Payment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpaymentID- Unique identifier for a PaymentpaymentDelete- The paymentDelete parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
deleteTrackingCategory
public TrackingCategories deleteTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOExceptionAllows you to delete tracking categories200 - Success - return response of type TrackingCategories array of deleted TrackingCategory
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategoryaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
deleteTrackingOptions
public TrackingOptions deleteTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID) throws IOExceptionAllows you to delete a specified option for a specified tracking category200 - Success - return response of type TrackingOptions array of remaining options for a specified category
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategorytrackingOptionID- Unique identifier for a Tracking OptionaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
emailInvoice
public void emailInvoice(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty) throws IOExceptionAllows you to email a copy of invoice to related Contact204 - Success - return response 204 no content
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicerequestEmpty- The requestEmpty parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getAccount
public Accounts getAccount(String accessToken, String xeroTenantId, UUID accountID) throws IOExceptionAllows you to retrieve a single chart of accounts200 - Success - return response of type Accounts array with one Account
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for retrieving single objectaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getAccountAttachmentByFileName
public ByteArrayInputStream getAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachment on Account by Filename200 - Success - return response of attachment for Account as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectfileName- Name of the attachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getAccountAttachmentById
public ByteArrayInputStream getAccountAttachmentById(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve specific Attachment on Account200 - Success - return response of attachment for Account as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectattachmentID- Unique identifier for Attachment objectcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getAccountAttachments
public Attachments getAccountAttachments(String accessToken, String xeroTenantId, UUID accountID) throws IOExceptionAllows you to retrieve Attachments for accounts200 - Success - return response of type Attachments array of Attachment
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getAccounts
public Accounts getAccounts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionAllows you to retrieve the full chart of accounts200 - Success - return response of type Accounts array with 0 to n Account
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransaction
public BankTransactions getBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp) throws IOExceptionAllows you to retrieve a single spend or receive money transaction200 - Success - return response of type BankTransactions array with a specific BankTransaction
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransactionAttachmentByFileName
public ByteArrayInputStream getBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachments on BankTransaction by Filename200 - Success - return response of attachment for BankTransaction as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionfileName- The name of the file being attachedcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getBankTransactionAttachmentById
public ByteArrayInputStream getBankTransactionAttachmentById(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve Attachments on a specific BankTransaction200 - Success - return response of attachment for BankTransaction as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionattachmentID- Xero generated unique identifier for an attachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getBankTransactionAttachments
public Attachments getBankTransactionAttachments(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOExceptionAllows you to retrieve any attachments to bank transactions200 - Success - return response of type Attachments array with 0 to n Attachment
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransactions
public BankTransactions getBankTransactions(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOExceptionAllows you to retrieve any spend or receive money transactions200 - Success - return response of type BankTransactions array with 0 to n BankTransaction
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- Up to 100 bank transactions will be returned in a single API call with line items detailsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getBankTransactionsHistory
public HistoryRecords getBankTransactionsHistory(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOExceptionAllows you to retrieve history from a bank transactions200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransfer
public BankTransfers getBankTransfer(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOExceptionAllows you to retrieve any bank transfers200 - Success - return response of BankTransfers array with one BankTransfer
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransferAttachmentByFileName
public ByteArrayInputStream getBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachments on BankTransfer by file name200 - Success - return response of binary data from the Attachment to a Bank Transfer
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferfileName- The name of the file being attached to a Bank TransfercontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getBankTransferAttachmentById
public ByteArrayInputStream getBankTransferAttachmentById(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve Attachments on BankTransfer200 - Success - return response of binary data from the Attachment to a Bank Transfer
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferattachmentID- Xero generated unique identifier for an Attachment to a bank transfercontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getBankTransferAttachments
public Attachments getBankTransferAttachments(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOExceptionAllows you to retrieve Attachments from bank transfers200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransferHistory
public HistoryRecords getBankTransferHistory(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOExceptionAllows you to retrieve history from a bank transfers200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBankTransfers
public BankTransfers getBankTransfers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionAllows you to retrieve all bank transfers200 - Success - return response of BankTransfers array of 0 to N BankTransfer
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBatchPaymentHistory
public HistoryRecords getBatchPaymentHistory(String accessToken, String xeroTenantId, UUID batchPaymentID) throws IOExceptionAllows you to retrieve history from a Batch Payment200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantbatchPaymentID- Unique identifier for BatchPaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBatchPayments
public BatchPayments getBatchPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionRetrieve either one or many BatchPayments for invoices200 - Success - return response of type BatchPayments array of BatchPayment objects
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBrandingTheme
public BrandingThemes getBrandingTheme(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOExceptionAllows you to retrieve a specific BrandingThemes200 - Success - return response of type BrandingThemes with one BrandingTheme
- Parameters:
xeroTenantId- Xero identifier for TenantbrandingThemeID- Unique identifier for a Branding ThemeaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBrandingThemePaymentServices
public PaymentServices getBrandingThemePaymentServices(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOExceptionAllows you to retrieve the Payment services for a Branding Theme200 - Success - return response of type PaymentServices array with 0 to N PaymentService
- Parameters:
xeroTenantId- Xero identifier for TenantbrandingThemeID- Unique identifier for a Branding ThemeaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getBrandingThemes
public BrandingThemes getBrandingThemes(String accessToken, String xeroTenantId) throws IOExceptionAllows you to retrieve all the BrandingThemes200 - Success - return response of type BrandingThemes
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContact
public Contacts getContact(String accessToken, String xeroTenantId, UUID contactID) throws IOExceptionAllows you to retrieve a single contacts in a Xero organisation200 - Success - return response of type Contacts array with a unique Contact
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactAttachmentByFileName
public ByteArrayInputStream getContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachments on Contacts by file name200 - Success - return response of attachment for Contact as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactfileName- Name for the file you are attachingcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getContactAttachmentById
public ByteArrayInputStream getContactAttachmentById(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve Attachments on Contacts200 - Success - return response of attachment for Contact as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactattachmentID- Unique identifier for a AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getContactAttachments
public Attachments getContactAttachments(String accessToken, String xeroTenantId, UUID contactID) throws IOExceptionAllows you to retrieve, add and update contacts in a Xero organisation200 - Success - return response of type Attachments array with 0 to N Attachment
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactByContactNumber
public Contacts getContactByContactNumber(String accessToken, String xeroTenantId, String contactNumber) throws IOExceptionAllows you to retrieve a single contact by Contact Number in a Xero organisation200 - Success - return response of type Contacts array with a unique Contact
- Parameters:
xeroTenantId- Xero identifier for TenantcontactNumber- This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).accessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactCISSettings
public CISSettings getContactCISSettings(String accessToken, String xeroTenantId, UUID contactID) throws IOExceptionAllows you to retrieve CISSettings for a contact in a Xero organisation200 - Success - return response of type CISSettings for a specific Contact
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactGroup
public ContactGroups getContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOExceptionAllows you to retrieve a unique Contact Group by ID200 - Success - return response of type Contact Groups array with a specific Contact Group
- Parameters:
xeroTenantId- Xero identifier for TenantcontactGroupID- Unique identifier for a Contact GroupaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactGroups
public ContactGroups getContactGroups(String accessToken, String xeroTenantId, String where, String order) throws IOExceptionAllows you to retrieve the ContactID and Name of all the contacts in a contact group200 - Success - return response of type Contact Groups array of Contact Group
- Parameters:
xeroTenantId- Xero identifier for Tenantwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContactHistory
public HistoryRecords getContactHistory(String accessToken, String xeroTenantId, UUID contactID) throws IOExceptionAllows you to retrieve a history records of an Contact200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getContacts
public Contacts getContacts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived) throws IOExceptionAllows you to retrieve all contacts in a Xero organisation200 - Success - return response of type Contacts array with 0 to N Contact
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementids- 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 responseaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getCreditNote
public CreditNotes getCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp) throws IOExceptionAllows you to retrieve a specific credit note200 - Success - return response of type Credit Notes array with a unique CreditNote
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit Noteunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getCreditNoteAsPdf
public ByteArrayInputStream getCreditNoteAsPdf(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOExceptionAllows you to retrieve Credit Note as PDF files200 - Success - return response of binary data from the Attachment to a Credit Note
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NoteaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getCreditNoteAttachmentByFileName
public ByteArrayInputStream getCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachments on CreditNote by file name200 - Success - return response of attachment for Credit Note as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotefileName- Name of the file you are attaching to Credit NotecontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getCreditNoteAttachmentById
public ByteArrayInputStream getCreditNoteAttachmentById(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve Attachments on CreditNote200 - Success - return response of attachment for Credit Note as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NoteattachmentID- Unique identifier for a AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getCreditNoteAttachments
public Attachments getCreditNoteAttachments(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOExceptionAllows you to retrieve Attachments for credit notes200 - Success - return response of type Attachments array with all Attachment for specific Credit Note
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NoteaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getCreditNoteHistory
public HistoryRecords getCreditNoteHistory(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOExceptionAllows you to retrieve a history records of an CreditNote200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NoteaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getCreditNotes
public CreditNotes getCreditNotes(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOExceptionAllows you to retrieve any credit notes200 - Success - return response of type Credit Notes array of CreditNote
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit noteunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getCurrencies
public Currencies getCurrencies(String accessToken, String xeroTenantId, String where, String order) throws IOExceptionAllows you to retrieve currencies for your organisation200 - Success - return response of type Currencies array with all Currencies
- Parameters:
xeroTenantId- Xero identifier for Tenantwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getEmployee
public Employees getEmployee(String accessToken, String xeroTenantId, UUID employeeID) throws IOExceptionAllows you to retrieve a specific employee used in Xero payrun200 - Success - return response of type Employees array with specified Employee
- Parameters:
xeroTenantId- Xero identifier for TenantemployeeID- Unique identifier for a EmployeeaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getEmployees
public Employees getEmployees(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionAllows you to retrieve employees used in Xero payrun200 - Success - return response of type Employees array with all Employee
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getExpenseClaim
public ExpenseClaims getExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOExceptionAllows you to retrieve a specified expense claim200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim
- Parameters:
xeroTenantId- Xero identifier for TenantexpenseClaimID- Unique identifier for a ExpenseClaimaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getExpenseClaimHistory
public HistoryRecords getExpenseClaimHistory(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOExceptionAllows you to retrieve a history records of an ExpenseClaim200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantexpenseClaimID- Unique identifier for a ExpenseClaimaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getExpenseClaims
public ExpenseClaims getExpenseClaims(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionAllows you to retrieve expense claims200 - Success - return response of type ExpenseClaims array with all ExpenseClaims
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getInvoice
public Invoices getInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp) throws IOExceptionAllows you to retrieve a specified sales invoice or purchase bill200 - Success - return response of type Invoices array with specified Invoices
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an Invoiceunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getInvoiceAsPdf
public ByteArrayInputStream getInvoiceAsPdf(String accessToken, String xeroTenantId, UUID invoiceID) throws IOExceptionAllows you to retrieve invoices or purchase bills as PDF files200 - Success - return response of byte array pdf version of specified Invoices
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoiceaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getInvoiceAttachmentByFileName
public ByteArrayInputStream getInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachment on invoices or purchase bills by it's filename200 - Success - return response of attachment for Invoice as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicefileName- Name of the file you are attachingcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getInvoiceAttachmentById
public ByteArrayInputStream getInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve a specified Attachment on invoices or purchase bills by it's ID200 - Success - return response of attachment for Invoice as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoiceattachmentID- Unique identifier for an AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getInvoiceAttachments
public Attachments getInvoiceAttachments(String accessToken, String xeroTenantId, UUID invoiceID) throws IOExceptionAllows you to retrieve Attachments on invoices or purchase bills200 - Success - return response of type Attachments array of Attachments for specified Invoices
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getInvoiceHistory
public HistoryRecords getInvoiceHistory(String accessToken, String xeroTenantId, UUID invoiceID) throws IOExceptionAllows you to retrieve a history records of an invoice200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getInvoiceReminders
public InvoiceReminders getInvoiceReminders(String accessToken, String xeroTenantId) throws IOExceptionAllows you to retrieve invoice reminder settings200 - Success - return response of Invoice Reminders
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
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) throws IOExceptionAllows you to retrieve any sales invoices or purchase bills200 - Success - return response of type Invoices array with all Invoices
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementids- 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 invoiceincludeArchived- e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the responsecreatedByMyApp- When set to true you'll only retrieve Invoices created by your appunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getItem
public Items getItem(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp) throws IOExceptionAllows you to retrieve a specified item200 - Success - return response of type Items array with specified Item
- Parameters:
xeroTenantId- Xero identifier for TenantitemID- Unique identifier for an Itemunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getItemHistory
public HistoryRecords getItemHistory(String accessToken, String xeroTenantId, UUID itemID) throws IOExceptionAllows you to retrieve history for items200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantitemID- Unique identifier for an ItemaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getItems
public Items getItems(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOExceptionAllows you to retrieve any items200 - Success - return response of type Items array with all Item
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getJournal
public Journals getJournal(String accessToken, String xeroTenantId, UUID journalID) throws IOExceptionAllows you to retrieve a specified journals.200 - Success - return response of type Journals array with specified Journal
- Parameters:
xeroTenantId- Xero identifier for TenantjournalID- Unique identifier for a JournalaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getJournals
public Journals getJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly) throws IOExceptionAllows you to retrieve any journals.200 - Success - return response of type Journals array with all Journals
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedoffset- Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returnedpaymentsOnly- Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.accessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getLinkedTransaction
public LinkedTransactions getLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOExceptionAllows you to retrieve a specified linked transactions (billable expenses)200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction
- Parameters:
xeroTenantId- Xero identifier for TenantlinkedTransactionID- Unique identifier for a LinkedTransactionaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getLinkedTransactions
public LinkedTransactions getLinkedTransactions(String accessToken, String xeroTenantId, Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID) throws IOExceptionRetrieve linked transactions (billable expenses)200 - Success - return response of type LinkedTransactions array with all LinkedTransaction
- Parameters:
xeroTenantId- Xero identifier for Tenantpage- 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 TransactionsourceTransactionID- Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoicecontactID- 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 associaed to a customer and with a statustargetTransactionID- Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoiceaccessToken- Authorization token for user set in header of each request- 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, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID) throws IOException- Throws:
IOException
-
getManualJournal
public ManualJournals getManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOExceptionAllows you to retrieve a specified manual journals200 - Success - return response of type ManualJournals array with a specified ManualJournals
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getManualJournalAttachmentByFileName
public ByteArrayInputStream getManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType) throws IOExceptionAllows you to retrieve specified Attachment on ManualJournal by file name200 - Success - return response of attachment for Manual Journal as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalfileName- The name of the file being attached to a ManualJournalcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getManualJournalAttachmentById
public ByteArrayInputStream getManualJournalAttachmentById(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve specified Attachment on ManualJournals200 - Success - return response of attachment for Manual Journal as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalattachmentID- Unique identifier for a AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getManualJournalAttachments
public Attachments getManualJournalAttachments(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOExceptionAllows you to retrieve Attachment for manual journals200 - Success - return response of type Attachments array with all Attachments for a ManualJournals
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getManualJournals
public ManualJournals getManualJournals(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOExceptionAllows you to retrieve any manual journals200 - Success - return response of type ManualJournals array with a all ManualJournals
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpaymentaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getManualJournalsHistory
public HistoryRecords getManualJournalsHistory(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOExceptionAllows you to retrieve history from a manual journal200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Xero generated unique identifier for a manual journalaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOnlineInvoice
public OnlineInvoices getOnlineInvoice(String accessToken, String xeroTenantId, UUID invoiceID) throws IOExceptionAllows you to retrieve a URL to an online invoice200 - Success - return response of type OnlineInvoice array with one OnlineInvoice
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOrganisationActions
Retrieve a list of the key actions your app has permission to perform in the connected organisation.200 - Success - return response of type Actions array with all key actions
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOrganisationCISSettings
public CISOrgSetting getOrganisationCISSettings(String accessToken, String xeroTenantId, UUID organisationID) throws IOExceptionAllows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.200 - Success - return response of type Organisation array with specified Organisation
- Parameters:
xeroTenantId- Xero identifier for TenantorganisationID- The unique Xero identifier for an organisationaccessToken- Authorization token for user set in header of each request- Returns:
- CISOrgSetting
- 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- Throws:
IOException
-
getOrganisations
Allows you to retrieve Organisation details200 - Success - return response of type Organisation array with all Organisation
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOverpayment
public Overpayments getOverpayment(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOExceptionAllows you to retrieve a specified overpayments200 - Success - return response of type Overpayments array with specified Overpayments
- Parameters:
xeroTenantId- Xero identifier for TenantoverpaymentID- Unique identifier for a OverpaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOverpaymentHistory
public HistoryRecords getOverpaymentHistory(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOExceptionAllows you to retrieve a history records of an Overpayment200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantoverpaymentID- Unique identifier for a OverpaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getOverpayments
public Overpayments getOverpayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOExceptionAllows you to retrieve overpayments200 - Success - return response of type Overpayments array with all Overpayments
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpaymentunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getPayment
public Payments getPayment(String accessToken, String xeroTenantId, UUID paymentID) throws IOExceptionAllows you to retrieve a specified payment for invoices and credit notes200 - Success - return response of type Payments array for specified Payment
- Parameters:
xeroTenantId- Xero identifier for TenantpaymentID- Unique identifier for a PaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPaymentHistory
public HistoryRecords getPaymentHistory(String accessToken, String xeroTenantId, UUID paymentID) throws IOExceptionAllows you to retrieve history records of a payment200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantpaymentID- Unique identifier for a PaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPaymentServices
public PaymentServices getPaymentServices(String accessToken, String xeroTenantId) throws IOExceptionAllows you to retrieve payment services200 - Success - return response of type PaymentServices array for all PaymentService
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPayments
public Payments getPayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOExceptionAllows you to retrieve payments for invoices and credit notes200 - Success - return response of type Payments array for all Payments
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- Up to 100 payments will be returned in a single API callaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getPrepayment
public Prepayments getPrepayment(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOExceptionAllows you to retrieve a specified prepayments200 - Success - return response of type Prepayments array for a specified Prepayment
- Parameters:
xeroTenantId- Xero identifier for TenantprepaymentID- Unique identifier for a PrePaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPrepaymentHistory
public HistoryRecords getPrepaymentHistory(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOExceptionAllows you to retrieve a history records of an Prepayment200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantprepaymentID- Unique identifier for a PrePaymentaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPrepayments
public Prepayments getPrepayments(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOExceptionAllows you to retrieve prepayments200 - Success - return response of type Prepayments array for all Prepayment
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementpage- e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpaymentunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getPurchaseOrder
public PurchaseOrders getPurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOExceptionAllows you to retrieve a specified purchase orders200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for a PurchaseOrderaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPurchaseOrderAsPdf
public ByteArrayInputStream getPurchaseOrderAsPdf(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOExceptionAllows you to retrieve purchase orders as PDF files200 - Success - return response of byte array pdf version of specified Purchase Orders
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for an Purchase OrderaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getPurchaseOrderAttachmentByFileName
public ByteArrayInputStream getPurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachment on a Purchase Order by Filename200 - Success - return response of attachment for Purchase Order as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectfileName- Name of the attachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getPurchaseOrderAttachmentById
public ByteArrayInputStream getPurchaseOrderAttachmentById(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve specific Attachment on purchase order200 - Success - return response of attachment for Account as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectattachmentID- Unique identifier for Attachment objectcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getPurchaseOrderAttachments
public Attachments getPurchaseOrderAttachments(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOExceptionAllows you to retrieve attachments for purchase orders200 - Success - return response of type Attachments array of Purchase Orders
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Orders objectaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPurchaseOrderByNumber
public PurchaseOrders getPurchaseOrderByNumber(String accessToken, String xeroTenantId, String purchaseOrderNumber) throws IOExceptionAllows you to retrieve a specified purchase orders200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderNumber- Unique identifier for a PurchaseOrderaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPurchaseOrderHistory
public HistoryRecords getPurchaseOrderHistory(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOExceptionAllows you to retrieve history for PurchaseOrder200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for a PurchaseOrderaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getPurchaseOrders
public PurchaseOrders getPurchaseOrders(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page) throws IOExceptionAllows you to retrieve purchase orders200 - Success - return response of type PurchaseOrder array of all PurchaseOrder
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedstatus- Filter by purchase order statusdateFrom- Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31dateTo- Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31order- Order by an any elementpage- 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.accessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
getQuote
Allows you to retrieve a specified quote200 - Success - return response of type Quotes array with specified Quote
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for an QuoteaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getQuoteAsPdf
public ByteArrayInputStream getQuoteAsPdf(String accessToken, String xeroTenantId, UUID quoteID) throws IOExceptionAllows you to retrieve quotes as PDF files200 - Success - return response of byte array pdf version of specified Quotes
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for an QuoteaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getQuoteAttachmentByFileName
public ByteArrayInputStream getQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachment on Quote by Filename200 - Success - return response of attachment for Quote as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectfileName- Name of the attachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getQuoteAttachmentById
public ByteArrayInputStream getQuoteAttachmentById(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve specific Attachment on Quote200 - Success - return response of attachment for Quote as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectattachmentID- Unique identifier for Attachment objectcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getQuoteAttachments
public Attachments getQuoteAttachments(String accessToken, String xeroTenantId, UUID quoteID) throws IOExceptionAllows you to retrieve Attachments for Quotes200 - Success - return response of type Attachments array of Attachment
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getQuoteHistory
public HistoryRecords getQuoteHistory(String accessToken, String xeroTenantId, UUID quoteID) throws IOExceptionAllows you to retrieve a history records of an quote200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for an QuoteaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
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 IOExceptionAllows you to retrieve any sales quotes200 - Success - return response of type quotes array with all quotes
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returneddateFrom- Filter for quotes after a particular datedateTo- Filter for quotes before a particular dateexpiryDateFrom- Filter for quotes expiring after a particular dateexpiryDateTo- Filter for quotes before a particular datecontactID- Filter for quotes belonging to a particular contactstatus- Filter for quotes of a particular Statuspage- e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quoteorder- Order by an any elementquoteNumber- Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)accessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReceipt
public Receipts getReceipt(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp) throws IOExceptionAllows you to retrieve a specified draft expense claim receipts200 - Success - return response of type Receipts array for a specified Receipt
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a Receiptunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReceiptAttachmentByFileName
public ByteArrayInputStream getReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType) throws IOExceptionAllows you to retrieve Attachments on expense claim receipts by file name200 - Success - return response of attachment for Receipt as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptfileName- The name of the file being attached to the ReceiptcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getReceiptAttachmentById
public ByteArrayInputStream getReceiptAttachmentById(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve Attachments on expense claim receipts by ID200 - Success - return response of attachment for Receipt as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptattachmentID- Unique identifier for a AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getReceiptAttachments
public Attachments getReceiptAttachments(String accessToken, String xeroTenantId, UUID receiptID) throws IOExceptionAllows you to retrieve Attachments for expense claim receipts200 - Success - return response of type Attachments array of Attachments for a specified Receipt
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReceiptHistory
public HistoryRecords getReceiptHistory(String accessToken, String xeroTenantId, UUID receiptID) throws IOExceptionAllows you to retrieve a history records of an Receipt200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReceipts
public Receipts getReceipts(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOExceptionAllows you to retrieve draft expense claim receipts for any user200 - Success - return response of type Receipts array for all Receipt
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getRepeatingInvoice
public RepeatingInvoices getRepeatingInvoice(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOExceptionAllows you to retrieve a specified repeating invoice200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getRepeatingInvoiceAttachmentByFileName
public ByteArrayInputStream getRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType) throws IOExceptionAllows you to retrieve specified attachment on repeating invoices by file name200 - Success - return response of attachment for Repeating Invoice as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicefileName- The name of the file being attached to a Repeating InvoicecontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getRepeatingInvoiceAttachmentById
public ByteArrayInputStream getRepeatingInvoiceAttachmentById(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType) throws IOExceptionAllows you to retrieve a specified Attachments on repeating invoices200 - Success - return response of attachment for Repeating Invoice as binary data
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoiceattachmentID- Unique identifier for a AttachmentcontentType- The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfaccessToken- Authorization token for user set in header of each request- Returns:
- File
- 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- Throws:
IOException
-
getRepeatingInvoiceAttachments
public Attachments getRepeatingInvoiceAttachments(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOExceptionAllows you to retrieve Attachments on repeating invoice200 - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getRepeatingInvoiceHistory
public HistoryRecords getRepeatingInvoiceHistory(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOExceptionAllows you to retrieve history for a repeating invoice200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoiceaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getRepeatingInvoices
public RepeatingInvoices getRepeatingInvoices(String accessToken, String xeroTenantId, String where, String order) throws IOExceptionAllows you to retrieve any repeating invoices200 - Success - return response of type Repeating Invoices array for all Repeating Invoice
- Parameters:
xeroTenantId- Xero identifier for Tenantwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
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 IOExceptionAllows you to retrieve report for AgedPayablesByContact200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantcontactId- Unique identifier for a Contactdate- The date of the Aged Payables By Contact reportfromDate- The from date of the Aged Payables By Contact reporttoDate- The to date of the Aged Payables By Contact reportaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
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 IOExceptionAllows you to retrieve report for AgedReceivablesByContact200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantcontactId- Unique identifier for a Contactdate- The date of the Aged Receivables By Contact reportfromDate- The from date of the Aged Receivables By Contact reporttoDate- The to date of the Aged Receivables By Contact reportaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReportBASorGST
public ReportWithRows getReportBASorGST(String accessToken, String xeroTenantId, String reportID) throws IOExceptionAllows you to retrieve report for BAS only valid for AU orgs200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantreportID- Unique identifier for a ReportaccessToken- Authorization token for user set in header of each request- Returns:
- ReportWithRows
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getReportBASorGSTForHttpResponse
public com.google.api.client.http.HttpResponse getReportBASorGSTForHttpResponse(String accessToken, String xeroTenantId, String reportID) throws IOException- Throws:
IOException
-
getReportBASorGSTList
public ReportWithRows getReportBASorGSTList(String accessToken, String xeroTenantId) throws IOExceptionAllows you to retrieve report for BAS only valid for AU orgs200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantaccessToken- Authorization token for user set in header of each request- Returns:
- ReportWithRows
- Throws:
IOException- if an error occurs while attempting to invoke the API
-
getReportBASorGSTListForHttpResponse
public com.google.api.client.http.HttpResponse getReportBASorGSTListForHttpResponse(String accessToken, String xeroTenantId) throws IOException- Throws:
IOException
-
getReportBalanceSheet
public ReportWithRows getReportBalanceSheet(String accessToken, String xeroTenantId, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOExceptionAllows you to retrieve report for BalanceSheet200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for Tenantdate- The date of the Balance Sheet reportperiods- The number of periods for the Balance Sheet reporttimeframe- The period size to compare to (MONTH, QUARTER, YEAR)trackingOptionID1- The tracking option 1 for the Balance Sheet reporttrackingOptionID2- The tracking option 2 for the Balance Sheet reportstandardLayout- The standard layout boolean for the Balance Sheet reportpaymentsOnly- return a cash basis for the Balance Sheet reportaccessToken- Authorization token for user set in header of each request- 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, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException- Throws:
IOException
-
getReportBankSummary
public ReportWithRows getReportBankSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOExceptionAllows you to retrieve report for BankSummary200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantfromDate- The from date for the Bank Summary report e.g. 2018-03-31toDate- The to date for the Bank Summary report e.g. 2018-03-31accessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReportBudgetSummary
public ReportWithRows getReportBudgetSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer period, Integer timeframe) throws IOExceptionAllows you to retrieve report for Budget Summary200 - success- return a Report with Rows object
- Parameters:
xeroTenantId- Xero identifier for Tenantdate- The date for the Bank Summary report e.g. 2018-03-31period- The number of periods to compare (integer between 1 and 12)timeframe- The period size to compare to (1=month, 3=quarter, 12=year)accessToken- Authorization token for user set in header of each request- 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 period, Integer timeframe) throws IOException- Throws:
IOException
-
getReportExecutiveSummary
public ReportWithRows getReportExecutiveSummary(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date) throws IOExceptionAllows you to retrieve report for ExecutiveSummary200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for Tenantdate- The date for the Bank Summary report e.g. 2018-03-31accessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
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 IOExceptionAllows you to retrieve report for ProfitAndLoss200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for TenantfromDate- The from date for the ProfitAndLoss report e.g. 2018-03-31toDate- The to date for the ProfitAndLoss report e.g. 2018-03-31periods- 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 reporttrackingCategoryID2- The trackingCategory 2 for the ProfitAndLoss reporttrackingOptionID- The tracking option 1 for the ProfitAndLoss reporttrackingOptionID2- The tracking option 2 for the ProfitAndLoss reportstandardLayout- Return the standard layout for the ProfitAndLoss reportpaymentsOnly- Return cash only basis for the ProfitAndLoss reportaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReportTenNinetyNine
public Reports getReportTenNinetyNine(String accessToken, String xeroTenantId, String reportYear) throws IOExceptionAllows you to retrieve report for TenNinetyNine200 - Success - return response of type Reports
- Parameters:
xeroTenantId- Xero identifier for TenantreportYear- The year of the 1099 reportaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getReportTrialBalance
public ReportWithRows getReportTrialBalance(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly) throws IOExceptionAllows you to retrieve report for TrialBalance200 - Success - return response of type ReportWithRows
- Parameters:
xeroTenantId- Xero identifier for Tenantdate- The date for the Trial Balance report e.g. 2018-03-31paymentsOnly- Return cash only basis for the Trial Balance reportaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getTaxRates
public TaxRates getTaxRates(String accessToken, String xeroTenantId, String where, String order, String taxType) throws IOExceptionAllows you to retrieve Tax Rates200 - Success - return response of type TaxRates array with TaxRates
- Parameters:
xeroTenantId- Xero identifier for Tenantwhere- Filter by an any elementorder- Order by an any elementtaxType- Filter by tax typeaccessToken- Authorization token for user set in header of each request- 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, String taxType) throws IOException- Throws:
IOException
-
getTrackingCategories
public TrackingCategories getTrackingCategories(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived) throws IOExceptionAllows you to retrieve tracking categories and options200 - Success - return response of type TrackingCategories array of TrackingCategory
- Parameters:
xeroTenantId- Xero identifier for Tenantwhere- Filter by an any elementorder- Order by an any elementincludeArchived- e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the responseaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getTrackingCategory
public TrackingCategories getTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOExceptionAllows you to retrieve tracking categories and options for specified category200 - Success - return response of type TrackingCategories array of specified TrackingCategory
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategoryaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getUser
Allows you to retrieve a specified user200 - Success - return response of type Users array of specified User
- Parameters:
xeroTenantId- Xero identifier for TenantuserID- Unique identifier for a UseraccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
getUsers
public Users getUsers(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOExceptionAllows you to retrieve users200 - Success - return response of type Users array of all User
- Parameters:
xeroTenantId- Xero identifier for TenantifModifiedSince- Only records created or modified since this timestamp will be returnedwhere- Filter by an any elementorder- Order by an any elementaccessToken- Authorization token for user set in header of each request- 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- Throws:
IOException
-
postSetup
public ImportSummary postSetup(String accessToken, String xeroTenantId, Setup setup) throws IOExceptionAllows you to set the chart of accounts, the conversion date and conversion balances200 - Success - returns a summary of the chart of accounts updates
- Parameters:
xeroTenantId- Xero identifier for Tenantsetup- Object including an accounts array, a conversion balances array and a conversion date object in body of requestaccessToken- Authorization token for user set in header of each request- Returns:
- ImportSummary
- 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) throws IOException- Throws:
IOException
-
updateAccount
public Accounts updateAccount(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts) throws IOExceptionAllows you to update a chart of accounts200 - 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:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for retrieving single objectaccounts- Request of type Accounts array with one AccountaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateAccountAttachmentByFileName
public Attachments updateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachment on Account by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateAccountAttachmentByFileName
public Attachments updateAccountAttachmentByFileName(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOExceptionAllows you to update Attachment on Account by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantaccountID- Unique identifier for Account objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateBankTransaction
public BankTransactions updateBankTransaction(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp) throws IOExceptionAllows you to update a single spend or receive money transaction200 - Success - return response of type BankTransactions array with updated BankTransaction
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionbankTransactions- The bankTransactions parameterunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateBankTransactionAttachmentByFileName
public Attachments updateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update an Attachment on BankTransaction by Filename200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionfileName- The name of the file being attachedbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateBankTransactionAttachmentByFileName
public Attachments updateBankTransactionAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOExceptionAllows you to update an Attachment on BankTransaction by Filename200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactionID- Xero generated unique identifier for a bank transactionfileName- The name of the file being attachedbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateBankTransferAttachmentByFileName
public Attachments updateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType) throws IOException200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferfileName- The name of the file being attached to a Bank Transferbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateBankTransferAttachmentByFileName
public Attachments updateBankTransferAttachmentByFileName(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransferID- Xero generated unique identifier for a bank transferfileName- The name of the file being attached to a Bank Transferbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateContact
public Contacts updateContact(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts) throws IOException200 - Success - return response of type Contacts array with an updated Contact400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a Contactcontacts- an array of Contacts containing single Contact object with properties to updateaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateContactAttachmentByFileName
public Attachments updateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType) throws IOException200 - Success - return response of type Attachments array with an updated Attachment400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactfileName- Name for the file you are attachingbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateContactAttachmentByFileName
public Attachments updateContactAttachmentByFileName(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException200 - Success - return response of type Attachments array with an updated Attachment400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactID- Unique identifier for a ContactfileName- Name for the file you are attachingbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateContactGroup
public ContactGroups updateContactGroup(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups) throws IOExceptionAllows you to update a Contact Group200 - Success - return response of type Contact Groups array of updated Contact Group
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcontactGroupID- Unique identifier for a Contact GroupcontactGroups- an array of Contact groups with Name of specific group to updateaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateCreditNote
public CreditNotes updateCreditNote(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp) throws IOExceptionAllows you to update a specific credit note200 - Success - return response of type Credit Notes array with updated CreditNote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotecreditNotes- an array of Credit Notes containing credit note details to updateunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateCreditNoteAttachmentByFileName
public Attachments updateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachments on CreditNote by file name200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotefileName- Name of the file you are attaching to Credit Notebody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateCreditNoteAttachmentByFileName
public Attachments updateCreditNoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body) throws IOExceptionAllows you to update Attachments on CreditNote by file name200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNoteID- Unique identifier for a Credit NotefileName- Name of the file you are attaching to Credit Notebody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateExpenseClaim
public ExpenseClaims updateExpenseClaim(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims) throws IOExceptionAllows you to update specified expense claims200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantexpenseClaimID- Unique identifier for a ExpenseClaimexpenseClaims- The expenseClaims parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateInvoice
public Invoices updateInvoice(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp) throws IOExceptionAllows you to update a specified sales invoices or purchase bills200 - Success - return response of type Invoices array with updated Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an Invoiceinvoices- The invoices parameterunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateInvoiceAttachmentByFileName
public Attachments updateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachment on invoices or purchase bills by it's filename200 - Success - return response of type Attachments array with updated Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicefileName- Name of the file you are attachingbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateInvoiceAttachmentByFileName
public Attachments updateInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body) throws IOExceptionAllows you to update Attachment on invoices or purchase bills by it's filename200 - Success - return response of type Attachments array with updated Attachment
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantinvoiceID- Unique identifier for an InvoicefileName- Name of the file you are attachingbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateItem
public Items updateItem(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp) throws IOExceptionAllows you to update a specified item200 - Success - return response of type Items array with updated Item
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantitemID- Unique identifier for an Itemitems- The items parameterunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateLinkedTransaction
public LinkedTransactions updateLinkedTransaction(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions) throws IOExceptionAllows you to update a specified 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:
xeroTenantId- Xero identifier for TenantlinkedTransactionID- Unique identifier for a LinkedTransactionlinkedTransactions- The linkedTransactions parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateManualJournal
public ManualJournals updateManualJournal(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals) throws IOExceptionAllows you to update a specified manual journal200 - Success - return response of type ManualJournals array with an updated ManualJournal
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalmanualJournals- The manualJournals parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateManualJournalAttachmentByFileName
public Attachments updateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update a specified Attachment on ManualJournal by file name200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalfileName- The name of the file being attached to a ManualJournalbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateManualJournalAttachmentByFileName
public Attachments updateManualJournalAttachmentByFileName(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOExceptionAllows you to update a specified Attachment on ManualJournal by file name200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournalID- Unique identifier for a ManualJournalfileName- The name of the file being attached to a ManualJournalbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateBankTransactions
public BankTransactions updateOrCreateBankTransactions(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to update or create one or more spend or receive money transaction200 - Success - return response of type BankTransactions array with new BankTransaction
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantbankTransactions- The bankTransactions parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateContacts
public Contacts updateOrCreateContacts(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOExceptionAllows you to update OR create one or more contacts in a Xero organisation200 - Success - return response of type Contacts array with newly created Contact
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for Tenantcontacts- The contacts parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateCreditNotes
public CreditNotes updateOrCreateCreditNotes(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to update OR create one or more credit notes200 - Success - return response of type Credit Notes array of newly created CreditNote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantcreditNotes- 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 errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateEmployees
public Employees updateOrCreateEmployees(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOExceptionAllows you to create a single new employees used in Xero payrun200 - Success - return response of type Employees array with new Employee
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantemployees- Employees with array of Employee object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateInvoices
public Invoices updateOrCreateInvoices(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to update OR create one or more sales invoices or purchase bills200 - Success - return response of type Invoices array with newly created Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantinvoices- The invoices parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateItems
public Items updateOrCreateItems(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOExceptionAllows you to update or create one or more items200 - Success - return response of type Items array with newly created Item
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantitems- The items parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateManualJournals
public ManualJournals updateOrCreateManualJournals(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOExceptionAllows you to create a single manual journal200 - Success - return response of type ManualJournals array with newly created ManualJournal
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantmanualJournals- ManualJournals array with ManualJournal object in body of requestsummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreatePurchaseOrders
public PurchaseOrders updateOrCreatePurchaseOrders(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOExceptionAllows you to update or create one or more purchase orders200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrders- The purchaseOrders parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateOrCreateQuotes
public Quotes updateOrCreateQuotes(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOExceptionAllows you to update OR create one or more quotes200 - Success - return response of type Quotes array with updated or created Quote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for Tenantquotes- The quotes parametersummarizeErrors- If false return 200 OK and mix of successfully created objects and any with validation errorsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updatePurchaseOrder
public PurchaseOrders updatePurchaseOrder(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders) throws IOExceptionAllows you to update a specified purchase order200 - Success - return response of type PurchaseOrder array for updated PurchaseOrder
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for a PurchaseOrderpurchaseOrders- The purchaseOrders parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updatePurchaseOrderAttachmentByFileName
public Attachments updatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachment on Purchase Order by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updatePurchaseOrderAttachmentByFileName
public Attachments updatePurchaseOrderAttachmentByFileName(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOExceptionAllows you to update Attachment on Purchase Order by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantpurchaseOrderID- Unique identifier for Purchase Order objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateQuote
public Quotes updateQuote(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes) throws IOExceptionAllows you to update a specified quote200 - Success - return response of type Quotes array with updated Quote
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for an Quotequotes- The quotes parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateQuoteAttachmentByFileName
public Attachments updateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachment on Quote by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectfileName- Name of the attachmentbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateQuoteAttachmentByFileName
public Attachments updateQuoteAttachmentByFileName(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOExceptionAllows you to update Attachment on Quote by Filename200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
- Parameters:
xeroTenantId- Xero identifier for TenantquoteID- Unique identifier for Quote objectfileName- Name of the attachmentbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateReceipt
public Receipts updateReceipt(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp) throws IOExceptionAllows you to retrieve a specified draft expense claim receipts200 - Success - return response of type Receipts array for updated Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a Receiptreceipts- The receipts parameterunitdp- e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amountsaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateReceiptAttachmentByFileName
public Attachments updateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update Attachment on expense claim receipts by file name200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptfileName- The name of the file being attached to the Receiptbody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateReceiptAttachmentByFileName
public Attachments updateReceiptAttachmentByFileName(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOExceptionAllows you to update Attachment on expense claim receipts by file name200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantreceiptID- Unique identifier for a ReceiptfileName- The name of the file being attached to the Receiptbody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateRepeatingInvoiceAttachmentByFileName
public Attachments updateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType) throws IOExceptionAllows you to update specified attachment on repeating invoices by file name200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicefileName- The name of the file being attached to a Repeating Invoicebody- Byte array of file in body of requestmimeType- The type of file being attachedaccessToken- Authorization token for user set in header of each request- 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 mimeType) throws IOException- Throws:
IOException
-
updateRepeatingInvoiceAttachmentByFileName
public Attachments updateRepeatingInvoiceAttachmentByFileName(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOExceptionAllows you to update specified attachment on repeating invoices by file name200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenantrepeatingInvoiceID- Unique identifier for a Repeating InvoicefileName- The name of the file being attached to a Repeating Invoicebody- Byte array of file in body of requestaccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateTaxRate
public TaxRates updateTaxRate(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOExceptionAllows you to update Tax Rates200 - Success - return response of type TaxRates array updated TaxRate
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttaxRates- The taxRates parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateTrackingCategory
public TrackingCategories updateTrackingCategory(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory) throws IOExceptionAllows you to update tracking categories200 - Success - return response of type TrackingCategories array of updated TrackingCategory
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategorytrackingCategory- The trackingCategory parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
updateTrackingOptions
public TrackingOptions updateTrackingOptions(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption) throws IOExceptionAllows you to update options for a specified tracking category200 - Success - return response of type TrackingOptions array of options for a specified category
400 - A failed request due to validation error
- Parameters:
xeroTenantId- Xero identifier for TenanttrackingCategoryID- Unique identifier for a TrackingCategorytrackingOptionID- Unique identifier for a Tracking OptiontrackingOption- The trackingOption parameteraccessToken- Authorization token for user set in header of each request- 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) throws IOException- Throws:
IOException
-
convertInputToByteArray
- Throws:
IOException
-