AccountingApi (Xero-Java SDK 2.3.6 API)

java.lang.Object
- com.xero.api.client.AccountingApi

public class AccountingApi
extends Object

Field Summary

Fields
Modifier and Type Field and Description

protected static Pattern MESSAGE_PATTERN

protected com.xero.model.ObjectFactory objFactory

protected static DateFormat utcFormatter

Fields
Modifier and Type	Field and Description
`protected static Pattern`	`MESSAGE_PATTERN`
`protected com.xero.model.ObjectFactory`	`objFactory`
`protected static DateFormat`	`utcFormatter`

Constructor Summary

Constructors
Constructor and Description

AccountingApi(ApiClient apiClient)

AccountingApi(Config config)

AccountingApi(Config config, SignerFactory signerFactory)

Constructors
Constructor and Description
`AccountingApi(ApiClient apiClient)`
`AccountingApi(Config config)`
`AccountingApi(Config config, SignerFactory signerFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToMapIfNotNull(Map<String,String> map, String key, Object value)`
`Accounts`	`createAccount(Account account)` Allows you to create a new chart of accounts
`Attachments`	`createAccountAttachmentByFileName(UUID accountID, String fileName, byte[] body)` Allows you to create Attachment on Account
`BankTransactions`	`createBankTransaction(BankTransactions bankTransactions, Boolean summarizeErrors)` Allows you to create a spend or receive money transaction
`Attachments`	`createBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, byte[] body)` Allows you to createa an Attachment on BankTransaction by Filename
`HistoryRecords`	`createBankTransactionHistoryRecord(UUID bankTransactionID, HistoryRecords historyRecords)` Allows you to create history record for a bank transactions
`BankTransfers`	`createBankTransfer(BankTransfers bankTransfers)` Allows you to create a bank transfers
`Attachments`	`createBankTransferAttachmentByFileName(UUID bankTransferID, String fileName, byte[] body)` 200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
`HistoryRecords`	`createBankTransferHistoryRecord(UUID bankTransferID, HistoryRecords historyRecords)` 200 - Success - return response HistoryRecords array with the newly created HistoryRecord for a Bank Transfer
`BatchPayments`	`createBatchPayment(BatchPayments batchPayments)` Create one or many BatchPayments for invoices
`HistoryRecords`	`createBatchPaymentHistoryRecord(UUID batchPaymentID, HistoryRecords historyRecords)` Allows you to create a history record for a Batch Payment
`PaymentServices`	`createBrandingThemePaymentServices(UUID brandingThemeID, PaymentService paymentService)` Allow for the creation of new custom payment service for specified Branding Theme
`Contacts`	`createContact(Contact contact)` 200 - Success - return response of type Contacts array with newly created Contact
`Attachments`	`createContactAttachmentByFileName(UUID contactID, String fileName, byte[] body)` 200 - Success - return response of type Attachments array with an newly created Attachment
`ContactGroups`	`createContactGroup(ContactGroups contactGroups)` Allows you to create a contact group
`Contacts`	`createContactGroupContacts(UUID contactGroupID, Contacts contacts)` Allows you to add Contacts to a Contract Group
`HistoryRecords`	`createContactHistory(UUID contactID, HistoryRecords historyRecords)` Allows you to retrieve a history records of an Contact
`CreditNotes`	`createCreditNote(Boolean summarizeErrors, CreditNotes creditNotes)` Allows you to create a credit note
`Allocations`	`createCreditNoteAllocation(UUID creditNoteID, Allocations allocations)` Allows you to create Allocation on CreditNote
`Attachments`	`createCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, byte[] body)` Allows you to create Attachments on CreditNote by file name
`HistoryRecords`	`createCreditNoteHistory(UUID creditNoteID, HistoryRecords historyRecords)` Allows you to retrieve a history records of an CreditNote
`Currencies`	`createCurrency(Currencies currencies)` 200 - Unsupported - return response incorrect exception, API is not able to create new Currency
`Employees`	`createEmployee(Employees employees)` Allows you to create new employees used in Xero payrun
`ExpenseClaims`	`createExpenseClaim(ExpenseClaims expenseClaims, Boolean summarizeErrors)` Allows you to retrieve expense claims
`HistoryRecords`	`createExpenseClaimHistory(UUID expenseClaimID, HistoryRecords historyRecords)` Allows you to create a history records of an ExpenseClaim
`Invoices`	`createInvoice(Invoices invoices, Boolean summarizeErrors)` Allows you to create any sales invoices or purchase bills
`Attachments`	`createInvoiceAttachmentByFileName(UUID invoiceID, String fileName, byte[] body)` Allows you to create an Attachment on invoices or purchase bills by it's filename
`HistoryRecords`	`createInvoiceHistory(UUID invoiceID, HistoryRecords historyRecords)` Allows you to retrieve a history records of an invoice
`Items`	`createItem(Items items)` Allows you to create an item
`HistoryRecords`	`createItemHistory(UUID itemID, HistoryRecords historyRecords)` Allows you to create a history record for items
`LinkedTransactions`	`createLinkedTransaction(LinkedTransactions linkedTransactions)` Allows you to create linked transactions (billable expenses)
`ManualJournals`	`createManualJournal(ManualJournals manualJournals)` Allows you to create a manual journal
`Attachments`	`createManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, byte[] body)` Allows you to create a specified Attachment on ManualJournal by file name
`Allocations`	`createOverpaymentAllocation(UUID overpaymentID, Allocations allocations)` Allows you to retrieve Allocations for overpayments
`HistoryRecords`	`createOverpaymentHistory(UUID overpaymentID, HistoryRecords historyRecords)` Allows you to create history records of an Overpayment
`Payments`	`createPayment(Payments payments)` Allows you to create payments for invoices and credit notes
`HistoryRecords`	`createPaymentHistory(UUID paymentID, HistoryRecords historyRecords)` Allows you to create a history record for a payment
`PaymentServices`	`createPaymentService(PaymentServices paymentServices)` Allows you to create payment services
`Allocations`	`createPrepaymentAllocation(UUID prepaymentID, Allocations allocations)` Allows you to create an Allocation for prepayments
`HistoryRecords`	`createPrepaymentHistory(UUID prepaymentID, HistoryRecords historyRecords)` Allows you to create a history record for an Prepayment
`PurchaseOrders`	`createPurchaseOrder(PurchaseOrders purchaseOrders, Boolean summarizeErrors)` Allows you to create purchase orders
`HistoryRecords`	`createPurchaseOrderHistory(UUID purchaseOrderID, HistoryRecords historyRecords)` Allows you to create HistoryRecord for purchase orders
`Receipts`	`createReceipt(Receipts receipts)` Allows you to create draft expense claim receipts for any user
`Attachments`	`createReceiptAttachmentByFileName(UUID receiptID, String fileName, byte[] body)` Allows you to create Attachment on expense claim receipts by file name
`HistoryRecords`	`createReceiptHistory(UUID receiptID, HistoryRecords historyRecords)` Allows you to retrieve a history records of an Receipt
`Attachments`	`createRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, byte[] body)` Allows you to create attachment on repeating invoices by file name
`HistoryRecords`	`createRepeatingInvoiceHistory(UUID repeatingInvoiceID, HistoryRecords historyRecords)` Allows you to create history for a repeating invoice
`TaxRates`	`createTaxRate(TaxRates taxRates)` Allows you to create Tax Rates
`TrackingCategories`	`createTrackingCategory(TrackingCategory trackingCategory)` Allows you to create tracking categories
`TrackingOptions`	`createTrackingOptions(UUID trackingCategoryID, TrackingOption trackingOption)` Allows you to create options for a specified tracking category
`protected String`	`DATA(String url, String body, Map<String,String> params, String method)`
`protected String`	`DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince)`
`protected String`	`DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince, String contentType)`
`protected String`	`DATA(String url, String body, Map<String,String> params, String method, String contentType)`
`protected String`	`DATA(String url, String body, Map<String,String> params, String method, String xeroApplicationId, String xeroTenantId, String xeroUserId)`
`Accounts`	`deleteAccount(UUID accountID)` Allows you to delete a chart of accounts
`void`	`deleteContactGroupContact(UUID contactGroupID, UUID contactID)` Allows you to delete a specific Contact from a Contract Group
`void`	`deleteContactGroupContacts(UUID contactGroupID)` Allows you to delete all Contacts from a Contract Group
`void`	`deleteItem(UUID itemID)` Allows you to delete a specified item
`void`	`deleteLinkedTransaction(UUID linkedTransactionID)` Allows you to delete a specified linked transactions (billable expenses)
`Payments`	`deletePayment(UUID paymentID, Payments payments)` Allows you to update a specified payment for invoices and credit notes
`TrackingCategories`	`deleteTrackingCategory(UUID trackingCategoryID)` Allows you to delete tracking categories
`TrackingOptions`	`deleteTrackingOptions(UUID trackingCategoryID, UUID trackingOptionID)` Allows you to delete a specified option for a specified tracking category
`void`	`emailInvoice(UUID invoiceID, RequestEmpty requestEmpty)` Allows you to email a copy of invoice to related Contact
`protected ByteArrayInputStream`	`FILE(String url, String body, Map<String,String> params, String method)`
`protected String`	`FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody)`
`protected String`	`FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody, String contentType)`
`protected ByteArrayInputStream`	`FILE(String url, String body, Map<String,String> params, String method, String accept)`
`Accounts`	`getAccount(UUID accountID)` Allows you to retrieve a single chart of accounts
`ByteArrayInputStream`	`getAccountAttachmentByFileName(UUID accountID, String fileName, String contentType)` Allows you to retrieve Attachment on Account by Filename
`ByteArrayInputStream`	`getAccountAttachmentById(UUID accountID, UUID attachmentID, String contentType)` Allows you to retrieve specific Attachment on Account
`Attachments`	`getAccountAttachments(UUID accountID)` Allows you to retrieve Attachments for accounts
`Accounts`	`getAccounts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve the full chart of accounts
`ApiClient`	`getApiClient()`
`BankTransactions`	`getBankTransaction(UUID bankTransactionID)` Allows you to retrieve a single spend or receive money transaction
`ByteArrayInputStream`	`getBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, String contentType)` Allows you to retrieve Attachments on BankTransaction by Filename
`ByteArrayInputStream`	`getBankTransactionAttachmentById(UUID bankTransactionID, UUID attachmentID, String contentType)` Allows you to retrieve Attachments on a specific BankTransaction
`Attachments`	`getBankTransactionAttachments(UUID bankTransactionID)` Allows you to retrieve any attachments to bank transactions
`BankTransactions`	`getBankTransactions(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)` Allows you to retrieve any spend or receive money transactions
`HistoryRecords`	`getBankTransactionsHistory(UUID bankTransactionID)` Allows you to retrieve history from a bank transactions
`BankTransfers`	`getBankTransfer(UUID bankTransferID)` Allows you to retrieve any bank transfers
`ByteArrayInputStream`	`getBankTransferAttachmentByFileName(UUID bankTransferID, String fileName, String contentType)` Allows you to retrieve Attachments on BankTransfer by file name
`ByteArrayInputStream`	`getBankTransferAttachmentById(UUID bankTransferID, UUID attachmentID, String contentType)` Allows you to retrieve Attachments on BankTransfer
`Attachments`	`getBankTransferAttachments(UUID bankTransferID)` Allows you to retrieve Attachments from bank transfers
`HistoryRecords`	`getBankTransferHistory(UUID bankTransferID)` Allows you to retrieve history from a bank transfers
`BankTransfers`	`getBankTransfers(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve all bank transfers
`HistoryRecords`	`getBatchPaymentHistory(UUID batchPaymentID)` Allows you to retrieve history from a Batch Payment
`BatchPayments`	`getBatchPayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Retrieve either one or many BatchPayments for invoices
`BrandingThemes`	`getBrandingTheme(UUID brandingThemeID)` Allows you to retrieve a specific BrandingThemes
`PaymentServices`	`getBrandingThemePaymentServices(UUID brandingThemeID)` Allows you to retrieve the Payment services for a Branding Theme
`BrandingThemes`	`getBrandingThemes()` Allows you to retrieve all the BrandingThemes
`Contacts`	`getContact(UUID contactID)` Allows you to retrieve, add and update contacts in a Xero organisation
`ByteArrayInputStream`	`getContactAttachmentByFileName(UUID contactID, String fileName, String contentType)` Allows you to retrieve Attachments on Contacts by file name
`ByteArrayInputStream`	`getContactAttachmentById(UUID contactID, UUID attachmentID, String contentType)` Allows you to retrieve Attachments on Contacts
`Attachments`	`getContactAttachments(UUID contactID)` Allows you to retrieve, add and update contacts in a Xero organisation
`CISSettings`	`getContactCISSettings(UUID contactID)` Allows you to retrieve CISSettings for a contact in a Xero organisation
`ContactGroups`	`getContactGroup(UUID contactGroupID)` Allows you to retrieve a unique Contract Group by ID
`ContactGroups`	`getContactGroups(String where, String order)` Allows you to retrieve the ContactID and Name of all the contacts in a contact group
`HistoryRecords`	`getContactHistory(UUID contactID)` Allows you to retrieve a history records of an Contact
`Contacts`	`getContacts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, String ids, Integer page, Boolean includeArchived)` Allows you to retrieve, add and update contacts in a Xero organisation
`CreditNotes`	`getCreditNote(UUID creditNoteID)` Allows you to retrieve a specific credit note
`ByteArrayInputStream`	`getCreditNoteAsPdf(UUID creditNoteID, String contentType)` Allows you to retrieve Credit Note as PDF files
`ByteArrayInputStream`	`getCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, String contentType)` Allows you to retrieve Attachments on CreditNote by file name
`ByteArrayInputStream`	`getCreditNoteAttachmentById(UUID creditNoteID, UUID attachmentID, String contentType)` Allows you to retrieve Attachments on CreditNote
`Attachments`	`getCreditNoteAttachments(UUID creditNoteID)` Allows you to retrieve Attachments for credit notes
`HistoryRecords`	`getCreditNoteHistory(UUID creditNoteID)` Allows you to retrieve a history records of an CreditNote
`CreditNotes`	`getCreditNotes(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)` Allows you to retrieve any credit notes
`Currencies`	`getCurrencies(String where, String order)` Allows you to retrieve currencies for your organisation
`Employees`	`getEmployee(UUID employeeID)` Allows you to retrieve a specific employee used in Xero payrun
`Employees`	`getEmployees(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve employees used in Xero payrun
`ExpenseClaims`	`getExpenseClaim(UUID expenseClaimID)` Allows you to retrieve a specified expense claim
`HistoryRecords`	`getExpenseClaimHistory(UUID expenseClaimID)` Allows you to retrieve a history records of an ExpenseClaim
`ExpenseClaims`	`getExpenseClaims(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve expense claims
`Invoices`	`getInvoice(UUID invoiceID)` Allows you to retrieve a specified sales invoice or purchase bill
`ByteArrayInputStream`	`getInvoiceAsPdf(UUID invoiceID, String contentType)` Allows you to retrieve invoices or purchase bills as PDF files
`ByteArrayInputStream`	`getInvoiceAttachmentByFileName(UUID invoiceID, String fileName, String contentType)` Allows you to retrieve Attachment on invoices or purchase bills by it's filename
`ByteArrayInputStream`	`getInvoiceAttachmentById(UUID invoiceID, UUID attachmentID, String contentType)` Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID
`Attachments`	`getInvoiceAttachments(UUID invoiceID)` Allows you to retrieve Attachments on invoices or purchase bills
`HistoryRecords`	`getInvoiceHistory(UUID invoiceID)` Allows you to retrieve a history records of an invoice
`InvoiceReminders`	`getInvoiceReminders()` Allows you to retrieve invoice reminder settings
`Invoices`	`getInvoices(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, String ids, String invoiceNumbers, String contactIDs, String statuses, Integer page, Boolean includeArchived, Boolean createdByMyApp, Integer unitdp)` Allows you to retrieve any sales invoices or purchase bills
`Items`	`getItem(UUID itemID)` Allows you to retrieve a specified item
`HistoryRecords`	`getItemHistory(UUID itemID)` Allows you to retrieve history for items
`Items`	`getItems(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)` Allows you to retrieve any items
`Journals`	`getJournal(UUID journalID)` Allows you to retrieve a specified journals.
`Journals`	`getJournals(org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly)` Allows you to retrieve any journals.
`LinkedTransactions`	`getLinkedTransaction(UUID linkedTransactionID)` Allows you to retrieve a specified linked transactions (billable expenses)
`LinkedTransactions`	`getLinkedTransactions(Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID)` Retrieve linked transactions (billable expenses)
`ManualJournals`	`getManualJournal(UUID manualJournalID)` Allows you to retrieve a specified manual journals
`ByteArrayInputStream`	`getManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, String contentType)` Allows you to retrieve specified Attachment on ManualJournal by file name
`ByteArrayInputStream`	`getManualJournalAttachmentById(UUID manualJournalID, UUID attachmentID, String contentType)` Allows you to retrieve specified Attachment on ManualJournals
`Attachments`	`getManualJournalAttachments(UUID manualJournalID)` Allows you to retrieve Attachment for manual journals
`ManualJournals`	`getManualJournals(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page)` Allows you to retrieve any manual journals
`OnlineInvoices`	`getOnlineInvoice(UUID invoiceID)` Allows you to retrieve a URL to an online invoice
`CISOrgSetting`	`getOrganisationCISSettings(UUID organisationID)` Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.
`Organisations`	`getOrganisations()` Allows you to retrieve Organisation details
`Overpayments`	`getOverpayment(UUID overpaymentID)` Allows you to retrieve a specified overpayments
`HistoryRecords`	`getOverpaymentHistory(UUID overpaymentID)` Allows you to retrieve a history records of an Overpayment
`Overpayments`	`getOverpayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)` Allows you to retrieve overpayments
`Payments`	`getPayment(UUID paymentID)` Allows you to retrieve a specified payment for invoices and credit notes
`HistoryRecords`	`getPaymentHistory(UUID paymentID)` Allows you to retrieve history records of a payment
`Payments`	`getPayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve payments for invoices and credit notes
`PaymentServices`	`getPaymentServices()` Allows you to retrieve payment services
`Prepayments`	`getPrepayment(UUID prepaymentID)` Allows you to retrieve a specified prepayments
`HistoryRecords`	`getPrepaymentHistory(UUID prepaymentID)` Allows you to retrieve a history records of an Prepayment
`Prepayments`	`getPrepayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp)` Allows you to retrieve prepayments
`PurchaseOrders`	`getPurchaseOrder(UUID purchaseOrderID)` Allows you to retrieve a specified purchase orders
`HistoryRecords`	`getPurchaseOrderHistory(UUID purchaseOrderID)` Allows you to retrieve history for PurchaseOrder
`PurchaseOrders`	`getPurchaseOrders(org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page)` Allows you to retrieve purchase orders
`Receipts`	`getReceipt(UUID receiptID)` Allows you to retrieve a specified draft expense claim receipts
`ByteArrayInputStream`	`getReceiptAttachmentByFileName(UUID receiptID, String fileName, String contentType)` Allows you to retrieve Attachments on expense claim receipts by file name
`ByteArrayInputStream`	`getReceiptAttachmentById(UUID receiptID, UUID attachmentID, String contentType)` Allows you to retrieve Attachments on expense claim receipts by ID
`Attachments`	`getReceiptAttachments(UUID receiptID)` Allows you to retrieve Attachments for expense claim receipts
`HistoryRecords`	`getReceiptHistory(UUID receiptID)` Allows you to retrieve a history records of an Receipt
`Receipts`	`getReceipts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp)` Allows you to retrieve draft expense claim receipts for any user
`RepeatingInvoices`	`getRepeatingInvoice(UUID repeatingInvoiceID)` Allows you to retrieve a specified repeating invoice
`ByteArrayInputStream`	`getRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, String contentType)` Allows you to retrieve specified attachment on repeating invoices by file name
`ByteArrayInputStream`	`getRepeatingInvoiceAttachmentById(UUID repeatingInvoiceID, UUID attachmentID, String contentType)` Allows you to retrieve a specified Attachments on repeating invoices
`Attachments`	`getRepeatingInvoiceAttachments(UUID repeatingInvoiceID)` Allows you to retrieve Attachments on repeating invoice
`HistoryRecords`	`getRepeatingInvoiceHistory(UUID repeatingInvoiceID)` Allows you to retrieve history for a repeating invoice
`RepeatingInvoices`	`getRepeatingInvoices(String where, String order)` Allows you to retrieve any repeating invoices
`ReportWithRows`	`getReportAgedPayablesByContact(UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate)` Allows you to retrieve report for AgedPayablesByContact
`ReportWithRows`	`getReportAgedReceivablesByContact(UUID contactId, String date, String fromDate, String toDate)` Allows you to retrieve report for AgedReceivablesByContact
`ReportWithRows`	`getReportBalanceSheet(String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)` Allows you to retrieve report for BalanceSheet
`ReportWithRows`	`getReportBankSummary(String date, Integer period, Integer timeframe)` Allows you to retrieve report for BankSummary
`ReportWithRows`	`getReportBASorGST(String reportID)` Allows you to retrieve report for BAS only valid for AU orgs
`ReportWithRows`	`getReportBASorGSTList()` Allows you to retrieve report for BAS only valid for AU orgs
`ReportWithRows`	`getReportBudgetSummary(String date, Integer period, Integer timeframe)` Allows you to retrieve report for Budget Summary
`ReportWithRows`	`getReportExecutiveSummary(String date)` Allows you to retrieve report for ExecutiveSummary
`ReportWithRows`	`getReportProfitAndLoss(String fromDate, String toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly)` Allows you to retrieve report for ProfitAndLoss
`Reports`	`getReportTenNinetyNine(String reportYear)` Allows you to retrieve report for TenNinetyNine
`ReportWithRows`	`getReportTrialBalance(String date, Boolean paymentsOnly)` Allows you to retrieve report for TrialBalance
`TaxRates`	`getTaxRates(String where, String order, String taxType)` Allows you to retrieve Tax Rates
`TrackingCategories`	`getTrackingCategories(String where, String order, Boolean includeArchived)` Allows you to retrieve tracking categories and options
`TrackingCategories`	`getTrackingCategory(UUID trackingCategoryID)` Allows you to retrieve tracking categories and options for specified category
`Users`	`getUser(UUID userID)` Allows you to retrieve a specified user
`Users`	`getUsers(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order)` Allows you to retrieve users
`void`	`setApiClient(ApiClient apiClient)`
`void`	`setOAuthToken(String token, String tokenSecret)`
`Accounts`	`updateAccount(UUID accountID, Accounts accounts)` Allows you to update a chart of accounts
`Attachments`	`updateAccountAttachmentByFileName(UUID accountID, String fileName, byte[] body)` Allows you to update Attachment on Account by Filename
`BankTransactions`	`updateBankTransaction(UUID bankTransactionID, BankTransactions bankTransactions)` Allows you to update a single spend or receive money transaction
`Attachments`	`updateBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, byte[] body)` Allows you to update an Attachment on BankTransaction by Filename
`Attachments`	`updateBankTransferAttachmentByFileName(UUID bankTransferID, String fileName, byte[] body)` 200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
`Contacts`	`updateContact(UUID contactID, Contacts contacts)` 200 - Success - return response of type Contacts array with an updated Contact
`Attachments`	`updateContactAttachmentByFileName(UUID contactID, String fileName, byte[] body)` 200 - Success - return response of type Attachments array with an updated Attachment
`ContactGroups`	`updateContactGroup(UUID contactGroupID, ContactGroups contactGroups)` Allows you to update a Contract Group
`CreditNotes`	`updateCreditNote(UUID creditNoteID, CreditNotes creditNotes)` Allows you to update a specific credit note
`Attachments`	`updateCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, byte[] body)` Allows you to update Attachments on CreditNote by file name
`Employees`	`updateEmployee(UUID employeeID, Employees employees)` Allows you to update a specific employee used in Xero payrun
`ExpenseClaims`	`updateExpenseClaim(UUID expenseClaimID, ExpenseClaims expenseClaims)` Allows you to update specified expense claims
`Invoices`	`updateInvoice(UUID invoiceID, Invoices invoices)` Allows you to update a specified sales invoices or purchase bills
`Attachments`	`updateInvoiceAttachmentByFileName(UUID invoiceID, String fileName, byte[] body)` Allows you to update Attachment on invoices or purchase bills by it's filename
`Items`	`updateItem(UUID itemID, Items items)` Allows you to udpate a specified item
`LinkedTransactions`	`updateLinkedTransaction(UUID linkedTransactionID, LinkedTransactions linkedTransactions)` Allows you to update a specified linked transactions (billable expenses)
`ManualJournals`	`updateManualJournal(UUID manualJournalID, ManualJournals manualJournals)` Allows you to update a specified manual journal
`Attachments`	`updateManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, byte[] body)` Allows you to update a specified Attachment on ManualJournal by file name
`PurchaseOrders`	`updatePurchaseOrder(UUID purchaseOrderID, PurchaseOrders purchaseOrders)` Allows you to update a specified purchase order
`Receipts`	`updateReceipt(UUID receiptID, Receipts receipts)` Allows you to retrieve a specified draft expense claim receipts
`Attachments`	`updateReceiptAttachmentByFileName(UUID receiptID, String fileName, byte[] body)` Allows you to update Attachment on expense claim receipts by file name
`Attachments`	`updateRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, byte[] body)` Allows you to update specified attachment on repeating invoices by file name
`TaxRates`	`updateTaxRate(TaxRates taxRates)` Allows you to update Tax Rates
`TrackingCategories`	`updateTrackingCategory(UUID trackingCategoryID, TrackingCategory trackingCategory)` Allows you to update tracking categories

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - utcFormatter
```
protected static final DateFormat utcFormatter
```
  - MESSAGE_PATTERN
```
protected static final Pattern MESSAGE_PATTERN
```
  - objFactory
```
protected final com.xero.model.ObjectFactory objFactory
```
- Constructor Detail
  - AccountingApi
```
public AccountingApi(Config config)
```
  - AccountingApi
```
public AccountingApi(Config config,
                     SignerFactory signerFactory)
```
  - AccountingApi
```
public AccountingApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - setOAuthToken
```
public void setOAuthToken(String token,
                          String tokenSecret)
```
  - DATA
```
protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method)
               throws IOException
```
    Throws:
    
    IOException
  - DATA
```
protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      org.threeten.bp.OffsetDateTime ifModifiedSince)
               throws IOException
```
    Throws:
    
    IOException
  - DATA
```
protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      String contentType)
               throws IOException
```
    Throws:
    
    IOException
  - DATA
```
protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      org.threeten.bp.OffsetDateTime ifModifiedSince,
                      String contentType)
               throws IOException
```
    Throws:
    
    IOException
  - DATA
```
protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      String xeroApplicationId,
                      String xeroTenantId,
                      String xeroUserId)
               throws IOException
```
    Throws:
    
    IOException
  - FILE
```
protected ByteArrayInputStream FILE(String url,
                                    String body,
                                    Map<String,String> params,
                                    String method)
                             throws IOException
```
    Throws:
    
    IOException
  - FILE
```
protected ByteArrayInputStream FILE(String url,
                                    String body,
                                    Map<String,String> params,
                                    String method,
                                    String accept)
                             throws IOException
```
    Throws:
    
    IOException
  - FILE
```
protected String FILE(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      byte[] byteBody)
               throws IOException
```
    Throws:
    
    IOException
  - FILE
```
protected String FILE(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      byte[] byteBody,
                      String contentType)
               throws IOException
```
    Throws:
    
    IOException
  - createAccount
```
public Accounts createAccount(Account account)
                       throws IOException
```
    Allows you to create a new chart of accounts
    200 - Success - created new Account and return response of type Accounts array with new Account
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    account - Request of type Account
    
    Returns:
    
    Accounts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createAccountAttachmentByFileName
```
public Attachments createAccountAttachmentByFileName(UUID accountID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to create Attachment on Account
    200 - Success - return response of type Attachments array of Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    accountID - Unique identifier for Account object
    
    fileName - Name of the attachment
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransaction
```
public BankTransactions createBankTransaction(BankTransactions bankTransactions,
                                              Boolean summarizeErrors)
                                       throws IOException
```
    Allows you to create a spend or receive money transaction
    200 - Success - return response of type BankTransactions array with new BankTransaction
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransactions - The bankTransactions parameter
    
    summarizeErrors - response format that shows validation errors for each bank transaction
    
    Returns:
    
    BankTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransactionAttachmentByFileName
```
public Attachments createBankTransactionAttachmentByFileName(UUID bankTransactionID,
                                                             String fileName,
                                                             byte[] body)
                                                      throws IOException
```
    Allows you to createa an Attachment on BankTransaction by Filename
    200 - Success - return response of Attachments array of Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    fileName - The name of the file being attached
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransactionHistoryRecord
```
public HistoryRecords createBankTransactionHistoryRecord(UUID bankTransactionID,
                                                         HistoryRecords historyRecords)
                                                  throws IOException
```
    Allows you to create history record for a bank transactions
    200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransfer
```
public BankTransfers createBankTransfer(BankTransfers bankTransfers)
                                 throws IOException
```
    Allows you to create a bank transfers
    200 - Success - return response of BankTransfers array of one BankTransfer
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransfers - The bankTransfers parameter
    
    Returns:
    
    BankTransfers
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransferAttachmentByFileName
```
public Attachments createBankTransferAttachmentByFileName(UUID bankTransferID,
                                                          String fileName,
                                                          byte[] body)
                                                   throws IOException
```
    200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    fileName - The name of the file being attached to a Bank Transfer
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBankTransferHistoryRecord
```
public HistoryRecords createBankTransferHistoryRecord(UUID bankTransferID,
                                                      HistoryRecords historyRecords)
                                               throws IOException
```
    200 - Success - return response HistoryRecords array with the newly created HistoryRecord for a Bank Transfer
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBatchPayment
```
public BatchPayments createBatchPayment(BatchPayments batchPayments)
                                 throws IOException
```
    Create one or many BatchPayments for invoices
    200 - Success - return response of type BatchPayments array of BatchPayment objects
    400 - A failed request due to validation error
    
    Parameters:
    
    batchPayments - Request of type BatchPayments containing a Payments array with one or more Payment objects
    
    Returns:
    
    BatchPayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBatchPaymentHistoryRecord
```
public HistoryRecords createBatchPaymentHistoryRecord(UUID batchPaymentID,
                                                      HistoryRecords historyRecords)
                                               throws IOException
```
    Allows you to create a history record for a Batch Payment
    200 - Success - return response of type HistoryRecords array of HistoryRecord objects
    400 - A failed request due to validation error
    
    Parameters:
    
    batchPaymentID - Unique identifier for BatchPayment
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createBrandingThemePaymentServices
```
public PaymentServices createBrandingThemePaymentServices(UUID brandingThemeID,
                                                          PaymentService paymentService)
                                                   throws IOException
```
    Allow for the creation of new custom payment service for specified Branding Theme
    200 - Success - return response of type PaymentServices array with newly created PaymentService
    400 - A failed request due to validation error
    
    Parameters:
    
    brandingThemeID - Unique identifier for a Branding Theme
    
    paymentService - The paymentService parameter
    
    Returns:
    
    PaymentServices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createContact
```
public Contacts createContact(Contact contact)
                       throws IOException
```
    200 - Success - return response of type Contacts array with newly created Contact
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    contact - The contact parameter
    
    Returns:
    
    Contacts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createContactAttachmentByFileName
```
public Attachments createContactAttachmentByFileName(UUID contactID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    200 - Success - return response of type Attachments array with an newly created Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    fileName - Name for the file you are attaching
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createContactGroup
```
public ContactGroups createContactGroup(ContactGroups contactGroups)
                                 throws IOException
```
    Allows you to create a contact group
    200 - Success - return response of type Contact Groups array of newly created Contact Group
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    contactGroups - The contactGroups parameter
    
    Returns:
    
    ContactGroups
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createContactGroupContacts
```
public Contacts createContactGroupContacts(UUID contactGroupID,
                                           Contacts contacts)
                                    throws IOException
```
    Allows you to add Contacts to a Contract Group
    200 - Success - return response of type Contacts array of added Contacts
    400 - A failed request due to validation error
    
    Parameters:
    
    contactGroupID - Unique identifier for a Contact Group
    
    contacts - The contacts parameter
    
    Returns:
    
    Contacts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createContactHistory
```
public HistoryRecords createContactHistory(UUID contactID,
                                           HistoryRecords historyRecords)
                                    throws IOException
```
    Allows you to retrieve a history records of an Contact
    200 - Success - return response of type History Records array of newly created History Record for a specific Contact
    400 - A failed request due to validation error
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createCreditNote
```
public CreditNotes createCreditNote(Boolean summarizeErrors,
                                    CreditNotes creditNotes)
                             throws IOException
```
    Allows you to create a credit note
    200 - Success - return response of type Credit Notes array of newly created CreditNote
    400 - A failed request due to validation error
    
    Parameters:
    
    summarizeErrors - shows validation errors for each credit note
    
    creditNotes - The creditNotes parameter
    
    Returns:
    
    CreditNotes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createCreditNoteAllocation
```
public Allocations createCreditNoteAllocation(UUID creditNoteID,
                                              Allocations allocations)
                                       throws IOException
```
    Allows you to create Allocation on CreditNote
    200 - Success - return response of type Allocations array with newly created Allocation for specific Credit Note
    400 - A failed request due to validation error
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    allocations - The allocations parameter
    
    Returns:
    
    Allocations
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createCreditNoteAttachmentByFileName
```
public Attachments createCreditNoteAttachmentByFileName(UUID creditNoteID,
                                                        String fileName,
                                                        byte[] body)
                                                 throws IOException
```
    Allows you to create Attachments on CreditNote by file name
    200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note
    400 - A failed request due to validation error
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    fileName - Name of the file you are attaching to Credit Note
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createCreditNoteHistory
```
public HistoryRecords createCreditNoteHistory(UUID creditNoteID,
                                              HistoryRecords historyRecords)
                                       throws IOException
```
    Allows you to retrieve a history records of an CreditNote
    200 - Success - return response of type HistoryRecords array with newly created HistoryRecord for specific Credit Note
    400 - A failed request due to validation error
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createCurrency
```
public Currencies createCurrency(Currencies currencies)
                          throws IOException
```
    200 - Unsupported - return response incorrect exception, API is not able to create new Currency
    
    Parameters:
    
    currencies - The currencies parameter
    
    Returns:
    
    Currencies
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createEmployee
```
public Employees createEmployee(Employees employees)
                         throws IOException
```
    Allows you to create new employees used in Xero payrun
    200 - Success - return response of type Employees array with new Employee
    400 - A failed request due to validation error
    
    Parameters:
    
    employees - The employees parameter
    
    Returns:
    
    Employees
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createExpenseClaim
```
public ExpenseClaims createExpenseClaim(ExpenseClaims expenseClaims,
                                        Boolean summarizeErrors)
                                 throws IOException
```
    Allows you to retrieve expense claims
    200 - Success - return response of type ExpenseClaims array with newly created ExpenseClaim
    400 - A failed request due to validation error
    
    Parameters:
    
    expenseClaims - The expenseClaims parameter
    
    summarizeErrors - shows validation errors for each expense claim
    
    Returns:
    
    ExpenseClaims
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createExpenseClaimHistory
```
public HistoryRecords createExpenseClaimHistory(UUID expenseClaimID,
                                                HistoryRecords historyRecords)
                                         throws IOException
```
    Allows you to create a history records of an ExpenseClaim
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims
    
    Parameters:
    
    expenseClaimID - Unique identifier for a ExpenseClaim
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createInvoice
```
public Invoices createInvoice(Invoices invoices,
                              Boolean summarizeErrors)
                       throws IOException
```
    Allows you to create any sales invoices or purchase bills
    200 - Success - return response of type Invoices array with newly created Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    invoices - The invoices parameter
    
    summarizeErrors - shows validation errors for each invoice
    
    Returns:
    
    Invoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createInvoiceAttachmentByFileName
```
public Attachments createInvoiceAttachmentByFileName(UUID invoiceID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to create an Attachment on invoices or purchase bills by it's filename
    200 - Success - return response of type Attachments array with newly created Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    fileName - Name of the file you are attaching
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createInvoiceHistory
```
public HistoryRecords createInvoiceHistory(UUID invoiceID,
                                           HistoryRecords historyRecords)
                                    throws IOException
```
    Allows you to retrieve a history records of an invoice
    200 - Success - return response of type HistoryRecords array with newly created HistoryRecord for specific Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createItem
```
public Items createItem(Items items)
                 throws IOException
```
    Allows you to create an item
    200 - Success - return response of type Items array with newly created Item
    400 - A failed request due to validation error
    
    Parameters:
    
    items - The items parameter
    
    Returns:
    
    Items
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createItemHistory
```
public HistoryRecords createItemHistory(UUID itemID,
                                        HistoryRecords historyRecords)
                                 throws IOException
```
    Allows you to create a history record for items
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Items
    
    Parameters:
    
    itemID - Unique identifier for an Item
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createLinkedTransaction
```
public LinkedTransactions createLinkedTransaction(LinkedTransactions linkedTransactions)
                                           throws IOException
```
    Allows 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:
    
    linkedTransactions - The linkedTransactions parameter
    
    Returns:
    
    LinkedTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createManualJournal
```
public ManualJournals createManualJournal(ManualJournals manualJournals)
                                   throws IOException
```
    Allows you to create a manual journal
    200 - Success - return response of type ManualJournals array with newly created ManualJournal
    400 - A failed request due to validation error
    
    Parameters:
    
    manualJournals - The manualJournals parameter
    
    Returns:
    
    ManualJournals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createManualJournalAttachmentByFileName
```
public Attachments createManualJournalAttachmentByFileName(UUID manualJournalID,
                                                           String fileName,
                                                           byte[] body)
                                                    throws IOException
```
    Allows you to create a specified Attachment on ManualJournal by file name
    200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals
    400 - A failed request due to validation error
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    fileName - The name of the file being attached to a ManualJournal
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createOverpaymentAllocation
```
public Allocations createOverpaymentAllocation(UUID overpaymentID,
                                               Allocations allocations)
                                        throws IOException
```
    Allows you to retrieve Allocations for overpayments
    200 - Success - return response of type Allocations array with all Allocation for Overpayments
    400 - A failed request due to validation error
    
    Parameters:
    
    overpaymentID - Unique identifier for a Overpayment
    
    allocations - The allocations parameter
    
    Returns:
    
    Allocations
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createOverpaymentHistory
```
public HistoryRecords createOverpaymentHistory(UUID overpaymentID,
                                               HistoryRecords historyRecords)
                                        throws IOException
```
    Allows you to create history records of an Overpayment
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Overpayments
    400 - A failed request due to validation error - API is not able to create HistoryRecord for Overpayments
    
    Parameters:
    
    overpaymentID - Unique identifier for a Overpayment
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPayment
```
public Payments createPayment(Payments payments)
                       throws IOException
```
    Allows you to create payments for invoices and credit notes
    200 - Success - return response of type Payments array for newly created Payment
    400 - A failed request due to validation error
    
    Parameters:
    
    payments - The payments parameter
    
    Returns:
    
    Payments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPaymentHistory
```
public HistoryRecords createPaymentHistory(UUID paymentID,
                                           HistoryRecords historyRecords)
                                    throws IOException
```
    Allows you to create a history record for a payment
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Payments
    400 - A failed request due to validation error - API is not able to create HistoryRecord for Payments
    
    Parameters:
    
    paymentID - Unique identifier for a Payment
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPaymentService
```
public PaymentServices createPaymentService(PaymentServices paymentServices)
                                     throws IOException
```
    Allows you to create payment services
    200 - Success - return response of type PaymentServices array for newly created PaymentService
    400 - A failed request due to validation error
    
    Parameters:
    
    paymentServices - The paymentServices parameter
    
    Returns:
    
    PaymentServices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPrepaymentAllocation
```
public Allocations createPrepaymentAllocation(UUID prepaymentID,
                                              Allocations allocations)
                                       throws IOException
```
    Allows you to create an Allocation for prepayments
    200 - Success - return response of type Allocations array of Allocation for all Prepayment
    400 - A failed request due to validation error
    
    Parameters:
    
    prepaymentID - The prepaymentID parameter
    
    allocations - The allocations parameter
    
    Returns:
    
    Allocations
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPrepaymentHistory
```
public HistoryRecords createPrepaymentHistory(UUID prepaymentID,
                                              HistoryRecords historyRecords)
                                       throws IOException
```
    Allows you to create a history record for an Prepayment
    200 - Success - return response of type HistoryRecords array for newly created HistoryRecord for PrePayment
    400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims
    
    Parameters:
    
    prepaymentID - Unique identifier for a PrePayment
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPurchaseOrder
```
public PurchaseOrders createPurchaseOrder(PurchaseOrders purchaseOrders,
                                          Boolean summarizeErrors)
                                   throws IOException
```
    Allows you to create purchase orders
    200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
    400 - A failed request due to validation error
    
    Parameters:
    
    purchaseOrders - The purchaseOrders parameter
    
    summarizeErrors - shows validation errors for each purchase order.
    
    Returns:
    
    PurchaseOrders
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createPurchaseOrderHistory
```
public HistoryRecords createPurchaseOrderHistory(UUID purchaseOrderID,
                                                 HistoryRecords historyRecords)
                                          throws IOException
```
    Allows you to create HistoryRecord for purchase orders
    200 - Success - return response of type HistoryRecords array for newly created HistoryRecord for PurchaseOrder
    400 - A failed request due to validation error
    
    Parameters:
    
    purchaseOrderID - Unique identifier for a PurchaseOrder
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createReceipt
```
public Receipts createReceipt(Receipts receipts)
                       throws IOException
```
    Allows you to create draft expense claim receipts for any user
    200 - Success - return response of type Receipts array for newly created Receipt
    400 - A failed request due to validation error
    
    Parameters:
    
    receipts - The receipts parameter
    
    Returns:
    
    Receipts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createReceiptAttachmentByFileName
```
public Attachments createReceiptAttachmentByFileName(UUID receiptID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to create Attachment on expense claim receipts by file name
    200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt
    400 - A failed request due to validation error
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    fileName - The name of the file being attached to the Receipt
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createReceiptHistory
```
public HistoryRecords createReceiptHistory(UUID receiptID,
                                           HistoryRecords historyRecords)
                                    throws IOException
```
    Allows you to retrieve a history records of an Receipt
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Receipts
    400 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Receipts
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createRepeatingInvoiceAttachmentByFileName
```
public Attachments createRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID,
                                                              String fileName,
                                                              byte[] body)
                                                       throws IOException
```
    Allows you to create attachment on repeating invoices by file name
    200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    fileName - The name of the file being attached to a Repeating Invoice
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createRepeatingInvoiceHistory
```
public HistoryRecords createRepeatingInvoiceHistory(UUID repeatingInvoiceID,
                                                    HistoryRecords historyRecords)
                                             throws IOException
```
    Allows you to create history for a repeating invoice
    200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Repeating Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    historyRecords - The historyRecords parameter
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createTaxRate
```
public TaxRates createTaxRate(TaxRates taxRates)
                       throws IOException
```
    Allows you to create Tax Rates
    200 - Success - return response of type TaxRates array newly created TaxRate
    400 - A failed request due to validation error
    
    Parameters:
    
    taxRates - The taxRates parameter
    
    Returns:
    
    TaxRates
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createTrackingCategory
```
public TrackingCategories createTrackingCategory(TrackingCategory trackingCategory)
                                          throws IOException
```
    Allows you to create tracking categories
    200 - Success - return response of type TrackingCategories array of newly created TrackingCategory
    400 - A failed request due to validation error
    
    Parameters:
    
    trackingCategory - The trackingCategory parameter
    
    Returns:
    
    TrackingCategories
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - createTrackingOptions
```
public TrackingOptions createTrackingOptions(UUID trackingCategoryID,
                                             TrackingOption trackingOption)
                                      throws IOException
```
    Allows you to create options for a specified tracking category
    200 - Success - return response of type TrackingOptions array of options for a specified category
    400 - A failed request due to validation error
    
    Parameters:
    
    trackingCategoryID - Unique identifier for a TrackingCategory
    
    trackingOption - The trackingOption parameter
    
    Returns:
    
    TrackingOptions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteAccount
```
public Accounts deleteAccount(UUID accountID)
                       throws IOException
```
    Allows you to delete a chart of accounts
    200 - Success - delete existing Account and return response of type Accounts array with deleted Account
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    accountID - Unique identifier for retrieving single object
    
    Returns:
    
    Accounts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteContactGroupContact
```
public void deleteContactGroupContact(UUID contactGroupID,
                                      UUID contactID)
                               throws IOException
```
    Allows you to delete a specific Contact from a Contract Group
    204 - Success - return response 204 no content
    400 - A failed request due to validation error
    
    Parameters:
    
    contactGroupID - Unique identifier for a Contact Group
    
    contactID - Unique identifier for a Contact
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteContactGroupContacts
```
public void deleteContactGroupContacts(UUID contactGroupID)
                                throws IOException
```
    Allows you to delete all Contacts from a Contract Group
    200 - Success - return response 204 no content
    
    Parameters:
    
    contactGroupID - Unique identifier for a Contact Group
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteItem
```
public void deleteItem(UUID itemID)
                throws IOException
```
    Allows you to delete a specified item
    204 - Success - return response 204 no content
    400 - A failed request due to validation error
    
    Parameters:
    
    itemID - Unique identifier for an Item
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteLinkedTransaction
```
public void deleteLinkedTransaction(UUID linkedTransactionID)
                             throws IOException
```
    Allows 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:
    
    linkedTransactionID - Unique identifier for a LinkedTransaction
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deletePayment
```
public Payments deletePayment(UUID paymentID,
                              Payments payments)
                       throws IOException
```
    Allows you to update a specified payment for invoices and credit notes
    200 - Success - return response of type Payments array for updated Payment
    400 - A failed request due to validation error
    
    Parameters:
    
    paymentID - Unique identifier for a Payment
    
    payments - The payments parameter
    
    Returns:
    
    Payments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteTrackingCategory
```
public TrackingCategories deleteTrackingCategory(UUID trackingCategoryID)
                                          throws IOException
```
    Allows you to delete tracking categories
    200 - Success - return response of type TrackingCategories array of deleted TrackingCategory
    400 - A failed request due to validation error
    
    Parameters:
    
    trackingCategoryID - Unique identifier for a TrackingCategory
    
    Returns:
    
    TrackingCategories
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - deleteTrackingOptions
```
public TrackingOptions deleteTrackingOptions(UUID trackingCategoryID,
                                             UUID trackingOptionID)
                                      throws IOException
```
    Allows you to delete a specified option for a specified tracking category
    200 - Success - return response of type TrackingOptions array of remaining options for a specified category
    400 - A failed request due to validation error
    
    Parameters:
    
    trackingCategoryID - Unique identifier for a TrackingCategory
    
    trackingOptionID - Unique identifier for a Tracking Option
    
    Returns:
    
    TrackingOptions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - emailInvoice
```
public void emailInvoice(UUID invoiceID,
                         RequestEmpty requestEmpty)
                  throws IOException
```
    Allows you to email a copy of invoice to related Contact
    204 - Success - return response 204 no content
    400 - A failed request due to validation error
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    requestEmpty - The requestEmpty parameter
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getAccount
```
public Accounts getAccount(UUID accountID)
                    throws IOException
```
    Allows you to retrieve a single chart of accounts
    200 - Success - return response of type Accounts array with one Account
    
    Parameters:
    
    accountID - Unique identifier for retrieving single object
    
    Returns:
    
    Accounts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getAccountAttachmentByFileName
```
public ByteArrayInputStream getAccountAttachmentByFileName(UUID accountID,
                                                           String fileName,
                                                           String contentType)
                                                    throws IOException
```
    Allows you to retrieve Attachment on Account by Filename
    200 - Success - return response of attachment for Account as binary data
    
    Parameters:
    
    accountID - Unique identifier for Account object
    
    fileName - Name of the attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getAccountAttachmentById
```
public ByteArrayInputStream getAccountAttachmentById(UUID accountID,
                                                     UUID attachmentID,
                                                     String contentType)
                                              throws IOException
```
    Allows you to retrieve specific Attachment on Account
    200 - Success - return response of attachment for Account as binary data
    
    Parameters:
    
    accountID - Unique identifier for Account object
    
    attachmentID - Unique identifier for Attachment object
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getAccountAttachments
```
public Attachments getAccountAttachments(UUID accountID)
                                  throws IOException
```
    Allows you to retrieve Attachments for accounts
    200 - Success - return response of type Attachments array of Attachment
    
    Parameters:
    
    accountID - Unique identifier for Account object
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getAccounts
```
public Accounts getAccounts(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            String where,
                            String order)
                     throws IOException
```
    Allows you to retrieve the full chart of accounts
    200 - Success - return response of type Accounts array with 0 to n Account
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    Accounts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransaction
```
public BankTransactions getBankTransaction(UUID bankTransactionID)
                                    throws IOException
```
    Allows you to retrieve a single spend or receive money transaction
    200 - Success - return response of type BankTransactions array with a specific BankTransaction
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    Returns:
    
    BankTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransactionAttachmentByFileName
```
public ByteArrayInputStream getBankTransactionAttachmentByFileName(UUID bankTransactionID,
                                                                   String fileName,
                                                                   String contentType)
                                                            throws IOException
```
    Allows you to retrieve Attachments on BankTransaction by Filename
    200 - Success - return response of attachment for BankTransaction as binary data
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    fileName - The name of the file being attached
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransactionAttachmentById
```
public ByteArrayInputStream getBankTransactionAttachmentById(UUID bankTransactionID,
                                                             UUID attachmentID,
                                                             String contentType)
                                                      throws IOException
```
    Allows you to retrieve Attachments on a specific BankTransaction
    200 - Success - return response of attachment for BankTransaction as binary data
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    attachmentID - Xero generated unique identifier for an attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransactionAttachments
```
public Attachments getBankTransactionAttachments(UUID bankTransactionID)
                                          throws IOException
```
    Allows you to retrieve any attachments to bank transactions
    200 - Success - return response of type Attachments array with 0 to n Attachment
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransactions
```
public BankTransactions getBankTransactions(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                            String where,
                                            String order,
                                            Integer page,
                                            Integer unitdp)
                                     throws IOException
```
    Allows you to retrieve any spend or receive money transactions
    200 - Success - return response of type BankTransactions array with 0 to n BankTransaction
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    page - e.g. page=1 – Up to 100 bank transactions will be returned in a single API call with line items shown for each bank transaction
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    BankTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransactionsHistory
```
public HistoryRecords getBankTransactionsHistory(UUID bankTransactionID)
                                          throws IOException
```
    Allows you to retrieve history from a bank transactions
    200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransfer
```
public BankTransfers getBankTransfer(UUID bankTransferID)
                              throws IOException
```
    Allows you to retrieve any bank transfers
    200 - Success - return response of BankTransfers array with one BankTransfer
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    Returns:
    
    BankTransfers
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransferAttachmentByFileName
```
public ByteArrayInputStream getBankTransferAttachmentByFileName(UUID bankTransferID,
                                                                String fileName,
                                                                String contentType)
                                                         throws IOException
```
    Allows you to retrieve Attachments on BankTransfer by file name
    200 - Success - return response of binary data from the Attachment to a Bank Transfer
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    fileName - The name of the file being attached to a Bank Transfer
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransferAttachmentById
```
public ByteArrayInputStream getBankTransferAttachmentById(UUID bankTransferID,
                                                          UUID attachmentID,
                                                          String contentType)
                                                   throws IOException
```
    Allows you to retrieve Attachments on BankTransfer
    200 - Success - return response of binary data from the Attachment to a Bank Transfer
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    attachmentID - Xero generated unique identifier for an Attachment to a bank transfer
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransferAttachments
```
public Attachments getBankTransferAttachments(UUID bankTransferID)
                                       throws IOException
```
    Allows you to retrieve Attachments from bank transfers
    200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransferHistory
```
public HistoryRecords getBankTransferHistory(UUID bankTransferID)
                                      throws IOException
```
    Allows you to retrieve history from a bank transfers
    200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord for a Bank Transfer
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBankTransfers
```
public BankTransfers getBankTransfers(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                      String where,
                                      String order)
                               throws IOException
```
    Allows you to retrieve all bank transfers
    200 - Success - return response of BankTransfers array of 0 to N BankTransfer
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    BankTransfers
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBatchPaymentHistory
```
public HistoryRecords getBatchPaymentHistory(UUID batchPaymentID)
                                      throws IOException
```
    Allows you to retrieve history from a Batch Payment
    200 - Success - return response of type HistoryRecords array of HistoryRecord objects
    
    Parameters:
    
    batchPaymentID - Unique identifier for BatchPayment
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBatchPayments
```
public BatchPayments getBatchPayments(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                      String where,
                                      String order)
                               throws IOException
```
    Retrieve either one or many BatchPayments for invoices
    200 - Success - return response of type BatchPayments array of BatchPayment objects
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    BatchPayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBrandingTheme
```
public BrandingThemes getBrandingTheme(UUID brandingThemeID)
                                throws IOException
```
    Allows you to retrieve a specific BrandingThemes
    200 - Success - return response of type BrandingThemes with one BrandingTheme
    
    Parameters:
    
    brandingThemeID - Unique identifier for a Branding Theme
    
    Returns:
    
    BrandingThemes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBrandingThemePaymentServices
```
public PaymentServices getBrandingThemePaymentServices(UUID brandingThemeID)
                                                throws IOException
```
    Allows you to retrieve the Payment services for a Branding Theme
    200 - Success - return response of type PaymentServices array with 0 to N PaymentService
    
    Parameters:
    
    brandingThemeID - Unique identifier for a Branding Theme
    
    Returns:
    
    PaymentServices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getBrandingThemes
```
public BrandingThemes getBrandingThemes()
                                 throws IOException
```
    Allows you to retrieve all the BrandingThemes
    200 - Success - return response of type BrandingThemes
    
    Returns:
    
    BrandingThemes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContact
```
public Contacts getContact(UUID contactID)
                    throws IOException
```
    Allows you to retrieve, add and update contacts in a Xero organisation
    200 - Success - return response of type Contacts array with a unique Contact
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    Returns:
    
    Contacts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactAttachmentByFileName
```
public ByteArrayInputStream getContactAttachmentByFileName(UUID contactID,
                                                           String fileName,
                                                           String contentType)
                                                    throws IOException
```
    Allows you to retrieve Attachments on Contacts by file name
    200 - Success - return response of attachment for Contact as binary data
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    fileName - Name for the file you are attaching
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactAttachmentById
```
public ByteArrayInputStream getContactAttachmentById(UUID contactID,
                                                     UUID attachmentID,
                                                     String contentType)
                                              throws IOException
```
    Allows you to retrieve Attachments on Contacts
    200 - Success - return response of attachment for Contact as binary data
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    attachmentID - Unique identifier for a Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactAttachments
```
public Attachments getContactAttachments(UUID contactID)
                                  throws IOException
```
    Allows you to retrieve, add and update contacts in a Xero organisation
    200 - Success - return response of type Attachments array with 0 to N Attachment
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactCISSettings
```
public CISSettings getContactCISSettings(UUID contactID)
                                  throws IOException
```
    Allows you to retrieve CISSettings for a contact in a Xero organisation
    200 - Success - return response of type CISSettings for a specific Contact
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    Returns:
    
    CISSettings
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactGroup
```
public ContactGroups getContactGroup(UUID contactGroupID)
                              throws IOException
```
    Allows you to retrieve a unique Contract Group by ID
    200 - Success - return response of type Contact Groups array with a specific Contact Group
    
    Parameters:
    
    contactGroupID - Unique identifier for a Contact Group
    
    Returns:
    
    ContactGroups
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactGroups
```
public ContactGroups getContactGroups(String where,
                                      String order)
                               throws IOException
```
    Allows you to retrieve the ContactID and Name of all the contacts in a contact group
    200 - Success - return response of type Contact Groups array of Contact Group
    
    Parameters:
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    ContactGroups
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContactHistory
```
public HistoryRecords getContactHistory(UUID contactID)
                                 throws IOException
```
    Allows you to retrieve a history records of an Contact
    200 - Success - return response of type History Records array of 0 to N History Record for a specific Contact
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getContacts
```
public Contacts getContacts(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            String where,
                            String order,
                            String ids,
                            Integer page,
                            Boolean includeArchived)
                     throws IOException
```
    Allows you to retrieve, add and update contacts in a Xero organisation
    200 - Success - return response of type Contacts array with 0 to N Contact
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    ids - Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
    
    page - e.g. page=1 - Up to 100 contacts will be returned in a single API call.
    
    includeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
    
    Returns:
    
    Contacts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNote
```
public CreditNotes getCreditNote(UUID creditNoteID)
                          throws IOException
```
    Allows you to retrieve a specific credit note
    200 - Success - return response of type Credit Notes array with a unique CreditNote
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    Returns:
    
    CreditNotes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNoteAsPdf
```
public ByteArrayInputStream getCreditNoteAsPdf(UUID creditNoteID,
                                               String contentType)
                                        throws IOException
```
    Allows you to retrieve Credit Note as PDF files
    200 - Success - return response of binary data from the Attachment to a Credit Note
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNoteAttachmentByFileName
```
public ByteArrayInputStream getCreditNoteAttachmentByFileName(UUID creditNoteID,
                                                              String fileName,
                                                              String contentType)
                                                       throws IOException
```
    Allows you to retrieve Attachments on CreditNote by file name
    200 - Success - return response of attachment for Credit Note as binary data
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    fileName - Name of the file you are attaching to Credit Note
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNoteAttachmentById
```
public ByteArrayInputStream getCreditNoteAttachmentById(UUID creditNoteID,
                                                        UUID attachmentID,
                                                        String contentType)
                                                 throws IOException
```
    Allows you to retrieve Attachments on CreditNote
    200 - Success - return response of attachment for Credit Note as binary data
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    attachmentID - Unique identifier for a Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNoteAttachments
```
public Attachments getCreditNoteAttachments(UUID creditNoteID)
                                     throws IOException
```
    Allows you to retrieve Attachments for credit notes
    200 - Success - return response of type Attachments array with all Attachment for specific Credit Note
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNoteHistory
```
public HistoryRecords getCreditNoteHistory(UUID creditNoteID)
                                    throws IOException
```
    Allows you to retrieve a history records of an CreditNote
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Credit Note
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCreditNotes
```
public CreditNotes getCreditNotes(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                  String where,
                                  String order,
                                  Integer page)
                           throws IOException
```
    Allows you to retrieve any credit notes
    200 - Success - return response of type Credit Notes array of CreditNote
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    page - e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
    
    Returns:
    
    CreditNotes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getCurrencies
```
public Currencies getCurrencies(String where,
                                String order)
                         throws IOException
```
    Allows you to retrieve currencies for your organisation
    200 - Success - return response of type Currencies array with all Currencies
    
    Parameters:
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    Currencies
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getEmployee
```
public Employees getEmployee(UUID employeeID)
                      throws IOException
```
    Allows you to retrieve a specific employee used in Xero payrun
    200 - Success - return response of type Employees array with specified Employee
    
    Parameters:
    
    employeeID - Unique identifier for a Employee
    
    Returns:
    
    Employees
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getEmployees
```
public Employees getEmployees(org.threeten.bp.OffsetDateTime ifModifiedSince,
                              String where,
                              String order)
                       throws IOException
```
    Allows you to retrieve employees used in Xero payrun
    200 - Success - return response of type Employees array with all Employee
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    Employees
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getExpenseClaim
```
public ExpenseClaims getExpenseClaim(UUID expenseClaimID)
                              throws IOException
```
    Allows you to retrieve a specified expense claim
    200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim
    
    Parameters:
    
    expenseClaimID - Unique identifier for a ExpenseClaim
    
    Returns:
    
    ExpenseClaims
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getExpenseClaimHistory
```
public HistoryRecords getExpenseClaimHistory(UUID expenseClaimID)
                                      throws IOException
```
    Allows you to retrieve a history records of an ExpenseClaim
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific ExpenseClaim
    
    Parameters:
    
    expenseClaimID - Unique identifier for a ExpenseClaim
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getExpenseClaims
```
public ExpenseClaims getExpenseClaims(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                      String where,
                                      String order)
                               throws IOException
```
    Allows you to retrieve expense claims
    200 - Success - return response of type ExpenseClaims array with all ExpenseClaims
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    ExpenseClaims
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoice
```
public Invoices getInvoice(UUID invoiceID)
                    throws IOException
```
    Allows you to retrieve a specified sales invoice or purchase bill
    200 - Success - return response of type Invoices array with specified Invoices
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    Returns:
    
    Invoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceAsPdf
```
public ByteArrayInputStream getInvoiceAsPdf(UUID invoiceID,
                                            String contentType)
                                     throws IOException
```
    Allows you to retrieve invoices or purchase bills as PDF files
    200 - Success - return response of byte array pdf version of specified Invoices
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceAttachmentByFileName
```
public ByteArrayInputStream getInvoiceAttachmentByFileName(UUID invoiceID,
                                                           String fileName,
                                                           String contentType)
                                                    throws IOException
```
    Allows you to retrieve Attachment on invoices or purchase bills by it's filename
    200 - Success - return response of attachment for Invoice as binary data
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    fileName - Name of the file you are attaching
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceAttachmentById
```
public ByteArrayInputStream getInvoiceAttachmentById(UUID invoiceID,
                                                     UUID attachmentID,
                                                     String contentType)
                                              throws IOException
```
    Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID
    200 - Success - return response of attachment for Invoice as binary data
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    attachmentID - Unique identifier for an Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceAttachments
```
public Attachments getInvoiceAttachments(UUID invoiceID)
                                  throws IOException
```
    Allows you to retrieve Attachments on invoices or purchase bills
    200 - Success - return response of type Attachments array of Attachments for specified Invoices
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceHistory
```
public HistoryRecords getInvoiceHistory(UUID invoiceID)
                                 throws IOException
```
    Allows you to retrieve a history records of an invoice
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Invoice
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoiceReminders
```
public InvoiceReminders getInvoiceReminders()
                                     throws IOException
```
    Allows you to retrieve invoice reminder settings
    200 - Success - return response of Invoice Reminders
    
    Returns:
    
    InvoiceReminders
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getInvoices
```
public Invoices getInvoices(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            String where,
                            String order,
                            String ids,
                            String invoiceNumbers,
                            String contactIDs,
                            String statuses,
                            Integer page,
                            Boolean includeArchived,
                            Boolean createdByMyApp,
                            Integer unitdp)
                     throws IOException
```
    Allows you to retrieve any sales invoices or purchase bills
    200 - Success - return response of type Invoices array with all Invoices
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    ids - Filter by a comma-separated list of InvoicesIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
    
    invoiceNumbers - Filter by a comma-separated list of InvoiceNumbers. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
    
    contactIDs - Filter by a comma-separated list of ContactIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
    
    statuses - Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
    
    page - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
    
    includeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
    
    createdByMyApp - When set to true you'll only retrieve Invoices created by your app
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    Invoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getItem
```
public Items getItem(UUID itemID)
              throws IOException
```
    Allows you to retrieve a specified item
    200 - Success - return response of type Items array with specified Item
    
    Parameters:
    
    itemID - Unique identifier for an Item
    
    Returns:
    
    Items
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getItemHistory
```
public HistoryRecords getItemHistory(UUID itemID)
                              throws IOException
```
    Allows you to retrieve history for items
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Item
    
    Parameters:
    
    itemID - Unique identifier for an Item
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getItems
```
public Items getItems(org.threeten.bp.OffsetDateTime ifModifiedSince,
                      String where,
                      String order,
                      Integer unitdp)
               throws IOException
```
    Allows you to retrieve any items
    200 - Success - return response of type Items array with all Item
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    Items
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getJournal
```
public Journals getJournal(UUID journalID)
                    throws IOException
```
    Allows you to retrieve a specified journals.
    200 - Success - return response of type Journals array with specified Journal
    
    Parameters:
    
    journalID - Unique identifier for a Journal
    
    Returns:
    
    Journals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getJournals
```
public Journals getJournals(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            Integer offset,
                            Boolean paymentsOnly)
                     throws IOException
```
    Allows you to retrieve any journals.
    200 - Success - return response of type Journals array with all Journals
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    offset - Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
    
    paymentsOnly - Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.
    
    Returns:
    
    Journals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getLinkedTransaction
```
public LinkedTransactions getLinkedTransaction(UUID linkedTransactionID)
                                        throws IOException
```
    Allows you to retrieve a specified linked transactions (billable expenses)
    200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction
    
    Parameters:
    
    linkedTransactionID - Unique identifier for a LinkedTransaction
    
    Returns:
    
    LinkedTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getLinkedTransactions
```
public LinkedTransactions getLinkedTransactions(Integer page,
                                                String linkedTransactionID,
                                                String sourceTransactionID,
                                                String contactID,
                                                String status,
                                                String targetTransactionID)
                                         throws IOException
```
    Retrieve linked transactions (billable expenses)
    200 - Success - return response of type LinkedTransactions array with all LinkedTransaction
    
    Parameters:
    
    page - Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
    
    linkedTransactionID - The Xero identifier for an Linked Transaction
    
    sourceTransactionID - Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
    
    contactID - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
    
    status - Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.
    
    targetTransactionID - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
    
    Returns:
    
    LinkedTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getManualJournal
```
public ManualJournals getManualJournal(UUID manualJournalID)
                                throws IOException
```
    Allows you to retrieve a specified manual journals
    200 - Success - return response of type ManualJournals array with a specified ManualJournals
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    Returns:
    
    ManualJournals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getManualJournalAttachmentByFileName
```
public ByteArrayInputStream getManualJournalAttachmentByFileName(UUID manualJournalID,
                                                                 String fileName,
                                                                 String contentType)
                                                          throws IOException
```
    Allows you to retrieve specified Attachment on ManualJournal by file name
    200 - Success - return response of attachment for Manual Journal as binary data
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    fileName - The name of the file being attached to a ManualJournal
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getManualJournalAttachmentById
```
public ByteArrayInputStream getManualJournalAttachmentById(UUID manualJournalID,
                                                           UUID attachmentID,
                                                           String contentType)
                                                    throws IOException
```
    Allows you to retrieve specified Attachment on ManualJournals
    200 - Success - return response of attachment for Manual Journal as binary data
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    attachmentID - Unique identifier for a Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getManualJournalAttachments
```
public Attachments getManualJournalAttachments(UUID manualJournalID)
                                        throws IOException
```
    Allows you to retrieve Attachment for manual journals
    200 - Success - return response of type Attachments array with all Attachments for a ManualJournals
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getManualJournals
```
public ManualJournals getManualJournals(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                        String where,
                                        String order,
                                        Integer page)
                                 throws IOException
```
    Allows you to retrieve any manual journals
    200 - Success - return response of type ManualJournals array with a all ManualJournals
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    page - e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
    
    Returns:
    
    ManualJournals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOnlineInvoice
```
public OnlineInvoices getOnlineInvoice(UUID invoiceID)
                                throws IOException
```
    Allows you to retrieve a URL to an online invoice
    200 - Success - return response of type OnlineInvoice array with one OnlineInvoice
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    Returns:
    
    OnlineInvoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOrganisationCISSettings
```
public CISOrgSetting getOrganisationCISSettings(UUID organisationID)
                                         throws IOException
```
    Allows 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:
    
    organisationID - The organisationID parameter
    
    Returns:
    
    CISOrgSetting
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOrganisations
```
public Organisations getOrganisations()
                               throws IOException
```
    Allows you to retrieve Organisation details
    200 - Success - return response of type Organisation array with all Organisation
    
    Returns:
    
    Organisations
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOverpayment
```
public Overpayments getOverpayment(UUID overpaymentID)
                            throws IOException
```
    Allows you to retrieve a specified overpayments
    200 - Success - return response of type Overpayments array with specified Overpayments
    
    Parameters:
    
    overpaymentID - Unique identifier for a Overpayment
    
    Returns:
    
    Overpayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOverpaymentHistory
```
public HistoryRecords getOverpaymentHistory(UUID overpaymentID)
                                     throws IOException
```
    Allows you to retrieve a history records of an Overpayment
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for Overpayments
    
    Parameters:
    
    overpaymentID - Unique identifier for a Overpayment
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getOverpayments
```
public Overpayments getOverpayments(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                    String where,
                                    String order,
                                    Integer page,
                                    Integer unitdp)
                             throws IOException
```
    Allows you to retrieve overpayments
    200 - Success - return response of type Overpayments array with all Overpayments
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    page - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    Overpayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPayment
```
public Payments getPayment(UUID paymentID)
                    throws IOException
```
    Allows you to retrieve a specified payment for invoices and credit notes
    200 - Success - return response of type Payments array for specified Payment
    
    Parameters:
    
    paymentID - Unique identifier for a Payment
    
    Returns:
    
    Payments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPaymentHistory
```
public HistoryRecords getPaymentHistory(UUID paymentID)
                                 throws IOException
```
    Allows you to retrieve history records of a payment
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for Payments
    
    Parameters:
    
    paymentID - Unique identifier for a Payment
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPaymentServices
```
public PaymentServices getPaymentServices()
                                   throws IOException
```
    Allows you to retrieve payment services
    200 - Success - return response of type PaymentServices array for all PaymentService
    
    Returns:
    
    PaymentServices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPayments
```
public Payments getPayments(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            String where,
                            String order)
                     throws IOException
```
    Allows you to retrieve payments for invoices and credit notes
    200 - Success - return response of type Payments array for all Payments
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    Payments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPrepayment
```
public Prepayments getPrepayment(UUID prepaymentID)
                          throws IOException
```
    Allows you to retrieve a specified prepayments
    200 - Success - return response of type Prepayments array for a specified Prepayment
    
    Parameters:
    
    prepaymentID - Unique identifier for a PrePayment
    
    Returns:
    
    Prepayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPrepaymentHistory
```
public HistoryRecords getPrepaymentHistory(UUID prepaymentID)
                                    throws IOException
```
    Allows you to retrieve a history records of an Prepayment
    200 - Success - return response of type HistoryRecords array with all HistoryRecord for PrePayment
    
    Parameters:
    
    prepaymentID - Unique identifier for a PrePayment
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPrepayments
```
public Prepayments getPrepayments(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                  String where,
                                  String order,
                                  Integer page,
                                  Integer unitdp)
                           throws IOException
```
    Allows you to retrieve prepayments
    200 - Success - return response of type Prepayments array for all Prepayment
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    page - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    Prepayments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPurchaseOrder
```
public PurchaseOrders getPurchaseOrder(UUID purchaseOrderID)
                                throws IOException
```
    Allows you to retrieve a specified purchase orders
    200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
    
    Parameters:
    
    purchaseOrderID - Unique identifier for a PurchaseOrder
    
    Returns:
    
    PurchaseOrders
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPurchaseOrderHistory
```
public HistoryRecords getPurchaseOrderHistory(UUID purchaseOrderID)
                                       throws IOException
```
    Allows you to retrieve history for PurchaseOrder
    200 - Success - return response of type HistoryRecords array for all HistoryRecord for PurchaseOrder
    
    Parameters:
    
    purchaseOrderID - Unique identifier for a PurchaseOrder
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getPurchaseOrders
```
public PurchaseOrders getPurchaseOrders(org.threeten.bp.OffsetDateTime ifModifiedSince,
                                        String status,
                                        String dateFrom,
                                        String dateTo,
                                        String order,
                                        Integer page)
                                 throws IOException
```
    Allows you to retrieve purchase orders
    200 - Success - return response of type PurchaseOrder array of all PurchaseOrder
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    status - Filter by purchase order status
    
    dateFrom - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
    
    dateTo - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
    
    order - Order by an any element
    
    page - To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
    
    Returns:
    
    PurchaseOrders
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceipt
```
public Receipts getReceipt(UUID receiptID)
                    throws IOException
```
    Allows you to retrieve a specified draft expense claim receipts
    200 - Success - return response of type Receipts array for a specified Receipt
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    Returns:
    
    Receipts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceiptAttachmentByFileName
```
public ByteArrayInputStream getReceiptAttachmentByFileName(UUID receiptID,
                                                           String fileName,
                                                           String contentType)
                                                    throws IOException
```
    Allows you to retrieve Attachments on expense claim receipts by file name
    200 - Success - return response of attachment for Receipt as binary data
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    fileName - The name of the file being attached to the Receipt
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceiptAttachmentById
```
public ByteArrayInputStream getReceiptAttachmentById(UUID receiptID,
                                                     UUID attachmentID,
                                                     String contentType)
                                              throws IOException
```
    Allows you to retrieve Attachments on expense claim receipts by ID
    200 - Success - return response of attachment for Receipt as binary data
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    attachmentID - Unique identifier for a Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceiptAttachments
```
public Attachments getReceiptAttachments(UUID receiptID)
                                  throws IOException
```
    Allows you to retrieve Attachments for expense claim receipts
    200 - Success - return response of type Attachments array of Attachments for a specified Receipt
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceiptHistory
```
public HistoryRecords getReceiptHistory(UUID receiptID)
                                 throws IOException
```
    Allows you to retrieve a history records of an Receipt
    200 - Success - return response of type HistoryRecords array of all HistoryRecord for Receipt
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReceipts
```
public Receipts getReceipts(org.threeten.bp.OffsetDateTime ifModifiedSince,
                            String where,
                            String order,
                            Integer unitdp)
                     throws IOException
```
    Allows you to retrieve draft expense claim receipts for any user
    200 - Success - return response of type Receipts array for all Receipt
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    unitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
    
    Returns:
    
    Receipts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoice
```
public RepeatingInvoices getRepeatingInvoice(UUID repeatingInvoiceID)
                                      throws IOException
```
    Allows you to retrieve a specified repeating invoice
    200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    Returns:
    
    RepeatingInvoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoiceAttachmentByFileName
```
public ByteArrayInputStream getRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID,
                                                                    String fileName,
                                                                    String contentType)
                                                             throws IOException
```
    Allows you to retrieve specified attachment on repeating invoices by file name
    200 - Success - return response of attachment for Repeating Invoice as binary data
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    fileName - The name of the file being attached to a Repeating Invoice
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoiceAttachmentById
```
public ByteArrayInputStream getRepeatingInvoiceAttachmentById(UUID repeatingInvoiceID,
                                                              UUID attachmentID,
                                                              String contentType)
                                                       throws IOException
```
    Allows you to retrieve a specified Attachments on repeating invoices
    200 - Success - return response of attachment for Repeating Invoice as binary data
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    attachmentID - Unique identifier for a Attachment
    
    contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
    
    Returns:
    
    File
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoiceAttachments
```
public Attachments getRepeatingInvoiceAttachments(UUID repeatingInvoiceID)
                                           throws IOException
```
    Allows you to retrieve Attachments on repeating invoice
    200 - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoiceHistory
```
public HistoryRecords getRepeatingInvoiceHistory(UUID repeatingInvoiceID)
                                          throws IOException
```
    Allows you to retrieve history for a repeating invoice
    200 - Success - return response of type HistoryRecords array of all HistoryRecord for Repeating Invoice
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    Returns:
    
    HistoryRecords
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getRepeatingInvoices
```
public RepeatingInvoices getRepeatingInvoices(String where,
                                              String order)
                                       throws IOException
```
    Allows you to retrieve any repeating invoices
    200 - Success - return response of type Repeating Invoices array for all Repeating Invoice
    
    Parameters:
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    RepeatingInvoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportAgedPayablesByContact
```
public ReportWithRows getReportAgedPayablesByContact(UUID contactId,
                                                     org.threeten.bp.LocalDate date,
                                                     org.threeten.bp.LocalDate fromDate,
                                                     org.threeten.bp.LocalDate toDate)
                                              throws IOException
```
    Allows you to retrieve report for AgedPayablesByContact
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    contactId - Unique identifier for a Contact
    
    date - The date of the Aged Payables By Contact report
    
    fromDate - The from date of the Aged Payables By Contact report
    
    toDate - The to date of the Aged Payables By Contact report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportAgedReceivablesByContact
```
public ReportWithRows getReportAgedReceivablesByContact(UUID contactId,
                                                        String date,
                                                        String fromDate,
                                                        String toDate)
                                                 throws IOException
```
    Allows you to retrieve report for AgedReceivablesByContact
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    contactId - Unique identifier for a Contact
    
    date - The date of the Aged Receivables By Contact report
    
    fromDate - The from date of the Aged Receivables By Contact report
    
    toDate - The to date of the Aged Receivables By Contact report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportBASorGST
```
public ReportWithRows getReportBASorGST(String reportID)
                                 throws IOException
```
    Allows you to retrieve report for BAS only valid for AU orgs
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    reportID - Unique identifier for a Report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportBASorGSTList
```
public ReportWithRows getReportBASorGSTList()
                                     throws IOException
```
    Allows you to retrieve report for BAS only valid for AU orgs
    200 - Success - return response of type ReportWithRows
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportBalanceSheet
```
public ReportWithRows getReportBalanceSheet(String date,
                                            Integer periods,
                                            String timeframe,
                                            String trackingOptionID1,
                                            String trackingOptionID2,
                                            Boolean standardLayout,
                                            Boolean paymentsOnly)
                                     throws IOException
```
    Allows you to retrieve report for BalanceSheet
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    date - The date of the Balance Sheet report
    
    periods - The number of periods for the Balance Sheet report
    
    timeframe - The period size to compare to (MONTH, QUARTER, YEAR)
    
    trackingOptionID1 - The tracking option 1 for the Balance Sheet report
    
    trackingOptionID2 - The tracking option 2 for the Balance Sheet report
    
    standardLayout - The standard layout boolean for the Balance Sheet report
    
    paymentsOnly - return a cash basis for the Balance Sheet report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportBankSummary
```
public ReportWithRows getReportBankSummary(String date,
                                           Integer period,
                                           Integer timeframe)
                                    throws IOException
```
    Allows you to retrieve report for BankSummary
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    date - The date for the Bank Summary report e.g. 2018-03-31
    
    period - The number of periods to compare (integer between 1 and 12)
    
    timeframe - The period size to compare to (1=month, 3=quarter, 12=year)
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportBudgetSummary
```
public ReportWithRows getReportBudgetSummary(String date,
                                             Integer period,
                                             Integer timeframe)
                                      throws IOException
```
    Allows you to retrieve report for Budget Summary
    200 - success- return a Report with Rows object
    
    Parameters:
    
    date - The date for the Bank Summary report e.g. 2018-03-31
    
    period - The number of periods to compare (integer between 1 and 12)
    
    timeframe - The period size to compare to (1=month, 3=quarter, 12=year)
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportExecutiveSummary
```
public ReportWithRows getReportExecutiveSummary(String date)
                                         throws IOException
```
    Allows you to retrieve report for ExecutiveSummary
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    date - The date for the Bank Summary report e.g. 2018-03-31
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportProfitAndLoss
```
public ReportWithRows getReportProfitAndLoss(String fromDate,
                                             String toDate,
                                             Integer periods,
                                             String timeframe,
                                             String trackingCategoryID,
                                             String trackingCategoryID2,
                                             String trackingOptionID,
                                             String trackingOptionID2,
                                             Boolean standardLayout,
                                             Boolean paymentsOnly)
                                      throws IOException
```
    Allows you to retrieve report for ProfitAndLoss
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    fromDate - The from date for the ProfitAndLoss report e.g. 2018-03-31
    
    toDate - The to date for the ProfitAndLoss report e.g. 2018-03-31
    
    periods - The number of periods to compare (integer between 1 and 12)
    
    timeframe - The period size to compare to (MONTH, QUARTER, YEAR)
    
    trackingCategoryID - The trackingCategory 1 for the ProfitAndLoss report
    
    trackingCategoryID2 - The trackingCategory 2 for the ProfitAndLoss report
    
    trackingOptionID - The tracking option 1 for the ProfitAndLoss report
    
    trackingOptionID2 - The tracking option 2 for the ProfitAndLoss report
    
    standardLayout - Return the standard layout for the ProfitAndLoss report
    
    paymentsOnly - Return cash only basis for the ProfitAndLoss report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportTenNinetyNine
```
public Reports getReportTenNinetyNine(String reportYear)
                               throws IOException
```
    Allows you to retrieve report for TenNinetyNine
    200 - Success - return response of type Reports
    
    Parameters:
    
    reportYear - The year of the 1099 report
    
    Returns:
    
    Reports
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getReportTrialBalance
```
public ReportWithRows getReportTrialBalance(String date,
                                            Boolean paymentsOnly)
                                     throws IOException
```
    Allows you to retrieve report for TrialBalance
    200 - Success - return response of type ReportWithRows
    
    Parameters:
    
    date - The date for the Trial Balance report e.g. 2018-03-31
    
    paymentsOnly - Return cash only basis for the Trial Balance report
    
    Returns:
    
    ReportWithRows
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getTaxRates
```
public TaxRates getTaxRates(String where,
                            String order,
                            String taxType)
                     throws IOException
```
    Allows you to retrieve Tax Rates
    200 - Success - return response of type TaxRates array with TaxRates
    
    Parameters:
    
    where - Filter by an any element
    
    order - Order by an any element
    
    taxType - Filter by tax type
    
    Returns:
    
    TaxRates
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getTrackingCategories
```
public TrackingCategories getTrackingCategories(String where,
                                                String order,
                                                Boolean includeArchived)
                                         throws IOException
```
    Allows you to retrieve tracking categories and options
    200 - Success - return response of type TrackingCategories array of TrackingCategory
    
    Parameters:
    
    where - Filter by an any element
    
    order - Order by an any element
    
    includeArchived - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response
    
    Returns:
    
    TrackingCategories
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getTrackingCategory
```
public TrackingCategories getTrackingCategory(UUID trackingCategoryID)
                                       throws IOException
```
    Allows you to retrieve tracking categories and options for specified category
    200 - Success - return response of type TrackingCategories array of specified TrackingCategory
    
    Parameters:
    
    trackingCategoryID - Unique identifier for a TrackingCategory
    
    Returns:
    
    TrackingCategories
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getUser
```
public Users getUser(UUID userID)
              throws IOException
```
    Allows you to retrieve a specified user
    200 - Success - return response of type Users array of specified User
    
    Parameters:
    
    userID - Unique identifier for a User
    
    Returns:
    
    Users
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - getUsers
```
public Users getUsers(org.threeten.bp.OffsetDateTime ifModifiedSince,
                      String where,
                      String order)
               throws IOException
```
    Allows you to retrieve users
    200 - Success - return response of type Users array of all User
    
    Parameters:
    
    ifModifiedSince - Only records created or modified since this timestamp will be returned
    
    where - Filter by an any element
    
    order - Order by an any element
    
    Returns:
    
    Users
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateAccount
```
public Accounts updateAccount(UUID accountID,
                              Accounts accounts)
                       throws IOException
```
    Allows you to update a chart of accounts
    200 - Success - update existing Account and return response of type Accounts array with updated Account
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    accountID - Unique identifier for retrieving single object
    
    accounts - Request of type Accounts array with one Account
    
    Returns:
    
    Accounts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateAccountAttachmentByFileName
```
public Attachments updateAccountAttachmentByFileName(UUID accountID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to update Attachment on Account by Filename
    200 - Success - return response of type Attachments array of Attachment
    400 - Validation Error - some data was incorrect returns response of type Error
    
    Parameters:
    
    accountID - Unique identifier for Account object
    
    fileName - Name of the attachment
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateBankTransaction
```
public BankTransactions updateBankTransaction(UUID bankTransactionID,
                                              BankTransactions bankTransactions)
                                       throws IOException
```
    Allows you to update a single spend or receive money transaction
    200 - Success - return response of type BankTransactions array with updated BankTransaction
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    bankTransactions - The bankTransactions parameter
    
    Returns:
    
    BankTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateBankTransactionAttachmentByFileName
```
public Attachments updateBankTransactionAttachmentByFileName(UUID bankTransactionID,
                                                             String fileName,
                                                             byte[] body)
                                                      throws IOException
```
    Allows you to update an Attachment on BankTransaction by Filename
    200 - Success - return response of Attachments array of Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransactionID - Xero generated unique identifier for a bank transaction
    
    fileName - The name of the file being attached
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateBankTransferAttachmentByFileName
```
public Attachments updateBankTransferAttachmentByFileName(UUID bankTransferID,
                                                          String fileName,
                                                          byte[] body)
                                                   throws IOException
```
    200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
    400 - A failed request due to validation error
    
    Parameters:
    
    bankTransferID - Xero generated unique identifier for a bank transfer
    
    fileName - The name of the file being attached to a Bank Transfer
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateContact
```
public Contacts updateContact(UUID contactID,
                              Contacts contacts)
                       throws IOException
```
    200 - Success - return response of type Contacts array with an updated Contact
    400 - A failed request due to validation error
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    contacts - The contacts parameter
    
    Returns:
    
    Contacts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateContactAttachmentByFileName
```
public Attachments updateContactAttachmentByFileName(UUID contactID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    200 - Success - return response of type Attachments array with an updated Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    contactID - Unique identifier for a Contact
    
    fileName - Name for the file you are attaching
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateContactGroup
```
public ContactGroups updateContactGroup(UUID contactGroupID,
                                        ContactGroups contactGroups)
                                 throws IOException
```
    Allows you to update a Contract Group
    200 - Success - return response of type Contact Groups array of updated Contact Group
    400 - A failed request due to validation error
    
    Parameters:
    
    contactGroupID - Unique identifier for a Contact Group
    
    contactGroups - The contactGroups parameter
    
    Returns:
    
    ContactGroups
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateCreditNote
```
public CreditNotes updateCreditNote(UUID creditNoteID,
                                    CreditNotes creditNotes)
                             throws IOException
```
    Allows you to update a specific credit note
    200 - Success - return response of type Credit Notes array with updated CreditNote
    400 - A failed request due to validation error
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    creditNotes - The creditNotes parameter
    
    Returns:
    
    CreditNotes
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateCreditNoteAttachmentByFileName
```
public Attachments updateCreditNoteAttachmentByFileName(UUID creditNoteID,
                                                        String fileName,
                                                        byte[] body)
                                                 throws IOException
```
    Allows you to update Attachments on CreditNote by file name
    200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note
    400 - A failed request due to validation error
    
    Parameters:
    
    creditNoteID - Unique identifier for a Credit Note
    
    fileName - Name of the file you are attaching to Credit Note
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateEmployee
```
public Employees updateEmployee(UUID employeeID,
                                Employees employees)
                         throws IOException
```
    Allows you to update a specific employee used in Xero payrun
    200 - Success - return response of type Employees array with updated Employee
    400 - A failed request due to validation error
    
    Parameters:
    
    employeeID - Unique identifier for a Employee
    
    employees - The employees parameter
    
    Returns:
    
    Employees
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateExpenseClaim
```
public ExpenseClaims updateExpenseClaim(UUID expenseClaimID,
                                        ExpenseClaims expenseClaims)
                                 throws IOException
```
    Allows you to update specified expense claims
    200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim
    400 - A failed request due to validation error
    
    Parameters:
    
    expenseClaimID - Unique identifier for a ExpenseClaim
    
    expenseClaims - The expenseClaims parameter
    
    Returns:
    
    ExpenseClaims
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateInvoice
```
public Invoices updateInvoice(UUID invoiceID,
                              Invoices invoices)
                       throws IOException
```
    Allows you to update a specified sales invoices or purchase bills
    200 - Success - return response of type Invoices array with updated Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    invoices - The invoices parameter
    
    Returns:
    
    Invoices
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateInvoiceAttachmentByFileName
```
public Attachments updateInvoiceAttachmentByFileName(UUID invoiceID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to update Attachment on invoices or purchase bills by it's filename
    200 - Success - return response of type Attachments array with updated Attachment
    400 - A failed request due to validation error
    
    Parameters:
    
    invoiceID - Unique identifier for an Invoice
    
    fileName - Name of the file you are attaching
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateItem
```
public Items updateItem(UUID itemID,
                        Items items)
                 throws IOException
```
    Allows you to udpate a specified item
    200 - Success - return response of type Items array with updated Item
    400 - A failed request due to validation error
    
    Parameters:
    
    itemID - Unique identifier for an Item
    
    items - The items parameter
    
    Returns:
    
    Items
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateLinkedTransaction
```
public LinkedTransactions updateLinkedTransaction(UUID linkedTransactionID,
                                                  LinkedTransactions linkedTransactions)
                                           throws IOException
```
    Allows 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:
    
    linkedTransactionID - Unique identifier for a LinkedTransaction
    
    linkedTransactions - The linkedTransactions parameter
    
    Returns:
    
    LinkedTransactions
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateManualJournal
```
public ManualJournals updateManualJournal(UUID manualJournalID,
                                          ManualJournals manualJournals)
                                   throws IOException
```
    Allows you to update a specified manual journal
    200 - Success - return response of type ManualJournals array with an updated ManualJournal
    400 - A failed request due to validation error
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    manualJournals - The manualJournals parameter
    
    Returns:
    
    ManualJournals
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateManualJournalAttachmentByFileName
```
public Attachments updateManualJournalAttachmentByFileName(UUID manualJournalID,
                                                           String fileName,
                                                           byte[] body)
                                                    throws IOException
```
    Allows you to update a specified Attachment on ManualJournal by file name
    200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals
    400 - A failed request due to validation error
    
    Parameters:
    
    manualJournalID - Unique identifier for a ManualJournal
    
    fileName - The name of the file being attached to a ManualJournal
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updatePurchaseOrder
```
public PurchaseOrders updatePurchaseOrder(UUID purchaseOrderID,
                                          PurchaseOrders purchaseOrders)
                                   throws IOException
```
    Allows you to update a specified purchase order
    200 - Success - return response of type PurchaseOrder array for updated PurchaseOrder
    400 - A failed request due to validation error
    
    Parameters:
    
    purchaseOrderID - Unique identifier for a PurchaseOrder
    
    purchaseOrders - The purchaseOrders parameter
    
    Returns:
    
    PurchaseOrders
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateReceipt
```
public Receipts updateReceipt(UUID receiptID,
                              Receipts receipts)
                       throws IOException
```
    Allows you to retrieve a specified draft expense claim receipts
    200 - Success - return response of type Receipts array for updated Receipt
    400 - A failed request due to validation error
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    receipts - The receipts parameter
    
    Returns:
    
    Receipts
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateReceiptAttachmentByFileName
```
public Attachments updateReceiptAttachmentByFileName(UUID receiptID,
                                                     String fileName,
                                                     byte[] body)
                                              throws IOException
```
    Allows you to update Attachment on expense claim receipts by file name
    200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt
    400 - A failed request due to validation error
    
    Parameters:
    
    receiptID - Unique identifier for a Receipt
    
    fileName - The name of the file being attached to the Receipt
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateRepeatingInvoiceAttachmentByFileName
```
public Attachments updateRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID,
                                                              String fileName,
                                                              byte[] body)
                                                       throws IOException
```
    Allows you to update specified attachment on repeating invoices by file name
    200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice
    400 - A failed request due to validation error
    
    Parameters:
    
    repeatingInvoiceID - Unique identifier for a Repeating Invoice
    
    fileName - The name of the file being attached to a Repeating Invoice
    
    body - Byte array of file in body of request
    
    Returns:
    
    Attachments
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateTaxRate
```
public TaxRates updateTaxRate(TaxRates taxRates)
                       throws IOException
```
    Allows you to update Tax Rates
    200 - Success - return response of type TaxRates array updated TaxRate
    400 - A failed request due to validation error
    
    Parameters:
    
    taxRates - The taxRates parameter
    
    Returns:
    
    TaxRates
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - updateTrackingCategory
```
public TrackingCategories updateTrackingCategory(UUID trackingCategoryID,
                                                 TrackingCategory trackingCategory)
                                          throws IOException
```
    Allows you to update tracking categories
    200 - Success - return response of type TrackingCategories array of updated TrackingCategory
    400 - A failed request due to validation error
    
    Parameters:
    
    trackingCategoryID - Unique identifier for a TrackingCategory
    
    trackingCategory - The trackingCategory parameter
    
    Returns:
    
    TrackingCategories
    
    Throws:
    
    IOException - if an error occurs while attempting to invoke the API
  - addToMapIfNotNull
```
protected void addToMapIfNotNull(Map<String,String> map,
                                 String key,
                                 Object value)
```

Class AccountingApi

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

utcFormatter

MESSAGE_PATTERN

objFactory

Constructor Detail

AccountingApi

AccountingApi

AccountingApi

Method Detail

getApiClient

setApiClient

setOAuthToken

DATA

DATA

DATA

DATA

DATA

FILE

FILE

FILE

FILE

createAccount

createAccountAttachmentByFileName

createBankTransaction

createBankTransactionAttachmentByFileName

createBankTransactionHistoryRecord

createBankTransfer

createBankTransferAttachmentByFileName

createBankTransferHistoryRecord

createBatchPayment

createBatchPaymentHistoryRecord

createBrandingThemePaymentServices

createContact

createContactAttachmentByFileName

createContactGroup

createContactGroupContacts

createContactHistory

createCreditNote

createCreditNoteAllocation

createCreditNoteAttachmentByFileName

createCreditNoteHistory

createCurrency

createEmployee

createExpenseClaim

createExpenseClaimHistory

createInvoice

createInvoiceAttachmentByFileName

createInvoiceHistory

createItem

createItemHistory

createLinkedTransaction

createManualJournal

createManualJournalAttachmentByFileName

createOverpaymentAllocation

createOverpaymentHistory

createPayment

createPaymentHistory

createPaymentService

createPrepaymentAllocation

createPrepaymentHistory

createPurchaseOrder

createPurchaseOrderHistory

createReceipt

createReceiptAttachmentByFileName

createReceiptHistory

createRepeatingInvoiceAttachmentByFileName

createRepeatingInvoiceHistory

createTaxRate

createTrackingCategory

createTrackingOptions

deleteAccount

deleteContactGroupContact

deleteContactGroupContacts

deleteItem

deleteLinkedTransaction