public class AccountingApi extends Object
| Modifier and Type | Field and Description |
|---|---|
protected static Pattern |
MESSAGE_PATTERN |
protected com.xero.model.ObjectFactory |
objFactory |
protected static DateFormat |
utcFormatter |
| Constructor and Description |
|---|
AccountingApi(ApiClient apiClient) |
AccountingApi(Config config) |
AccountingApi(Config config,
SignerFactory signerFactory) |
| 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
|
protected static final DateFormat utcFormatter
protected static final Pattern MESSAGE_PATTERN
protected final com.xero.model.ObjectFactory objFactory
public AccountingApi(Config config)
public AccountingApi(Config config, SignerFactory signerFactory)
public AccountingApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
protected String DATA(String url, String body, Map<String,String> params, String method) throws IOException
IOExceptionprotected String DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince) throws IOException
IOExceptionprotected String DATA(String url, String body, Map<String,String> params, String method, String contentType) throws IOException
IOExceptionprotected String DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince, String contentType) throws IOException
IOExceptionprotected String DATA(String url, String body, Map<String,String> params, String method, String xeroApplicationId, String xeroTenantId, String xeroUserId) throws IOException
IOExceptionprotected ByteArrayInputStream FILE(String url, String body, Map<String,String> params, String method) throws IOException
IOExceptionprotected ByteArrayInputStream FILE(String url, String body, Map<String,String> params, String method, String accept) throws IOException
IOExceptionprotected String FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody) throws IOException
IOExceptionprotected String FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody, String contentType) throws IOException
IOExceptionpublic Accounts createAccount(Account account) throws IOException
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
account - Request of type AccountIOException - if an error occurs while attempting to invoke the APIpublic Attachments createAccountAttachmentByFileName(UUID accountID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array of Attachment
400 - A failed request due to validation error
accountID - Unique identifier for Account objectfileName - Name of the attachmentbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic BankTransactions createBankTransaction(BankTransactions bankTransactions, Boolean summarizeErrors) throws IOException
200 - Success - return response of type BankTransactions array with new BankTransaction
400 - A failed request due to validation error
bankTransactions - The bankTransactions parametersummarizeErrors - response format that shows validation errors for each bank transactionIOException - if an error occurs while attempting to invoke the APIpublic Attachments createBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, byte[] body) throws IOException
200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
bankTransactionID - Xero generated unique identifier for a bank transactionfileName - The name of the file being attachedbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createBankTransactionHistoryRecord(UUID bankTransactionID, HistoryRecords historyRecords) throws IOException
200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
400 - A failed request due to validation error
bankTransactionID - Xero generated unique identifier for a bank transactionhistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic BankTransfers createBankTransfer(BankTransfers bankTransfers) throws IOException
200 - Success - return response of BankTransfers array of one BankTransfer
400 - A failed request due to validation error
bankTransfers - The bankTransfers parameterIOException - if an error occurs while attempting to invoke the APIpublic 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
bankTransferID - Xero generated unique identifier for a bank transferfileName - The name of the file being attached to a Bank Transferbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic 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
bankTransferID - Xero generated unique identifier for a bank transferhistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic BatchPayments createBatchPayment(BatchPayments batchPayments) throws IOException
200 - Success - return response of type BatchPayments array of BatchPayment objects
400 - A failed request due to validation error
batchPayments - Request of type BatchPayments containing a Payments array with one or more Payment objectsIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createBatchPaymentHistoryRecord(UUID batchPaymentID, HistoryRecords historyRecords) throws IOException
200 - Success - return response of type HistoryRecords array of HistoryRecord objects
400 - A failed request due to validation error
batchPaymentID - Unique identifier for BatchPaymenthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic PaymentServices createBrandingThemePaymentServices(UUID brandingThemeID, PaymentService paymentService) throws IOException
200 - Success - return response of type PaymentServices array with newly created PaymentService
400 - A failed request due to validation error
brandingThemeID - Unique identifier for a Branding ThemepaymentService - The paymentService parameterIOException - if an error occurs while attempting to invoke the APIpublic 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
contact - The contact parameterIOException - if an error occurs while attempting to invoke the APIpublic 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
contactID - Unique identifier for a ContactfileName - Name for the file you are attachingbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic ContactGroups createContactGroup(ContactGroups contactGroups) throws IOException
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
contactGroups - The contactGroups parameterIOException - if an error occurs while attempting to invoke the APIpublic Contacts createContactGroupContacts(UUID contactGroupID, Contacts contacts) throws IOException
200 - Success - return response of type Contacts array of added Contacts
400 - A failed request due to validation error
contactGroupID - Unique identifier for a Contact Groupcontacts - The contacts parameterIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createContactHistory(UUID contactID, HistoryRecords historyRecords) throws IOException
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
contactID - Unique identifier for a ContacthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic CreditNotes createCreditNote(Boolean summarizeErrors, CreditNotes creditNotes) throws IOException
200 - Success - return response of type Credit Notes array of newly created CreditNote
400 - A failed request due to validation error
summarizeErrors - shows validation errors for each credit notecreditNotes - The creditNotes parameterIOException - if an error occurs while attempting to invoke the APIpublic Allocations createCreditNoteAllocation(UUID creditNoteID, Allocations allocations) throws IOException
200 - Success - return response of type Allocations array with newly created Allocation for specific Credit Note
400 - A failed request due to validation error
creditNoteID - Unique identifier for a Credit Noteallocations - The allocations parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments createCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with newly created Attachment for specific Credit Note
400 - A failed request due to validation error
creditNoteID - Unique identifier for a Credit NotefileName - Name of the file you are attaching to Credit Notebody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createCreditNoteHistory(UUID creditNoteID, HistoryRecords historyRecords) throws IOException
200 - Success - return response of type HistoryRecords array with newly created HistoryRecord for specific Credit Note
400 - A failed request due to validation error
creditNoteID - Unique identifier for a Credit NotehistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Currencies createCurrency(Currencies currencies) throws IOException
200 - Unsupported - return response incorrect exception, API is not able to create new Currency
currencies - The currencies parameterIOException - if an error occurs while attempting to invoke the APIpublic Employees createEmployee(Employees employees) throws IOException
200 - Success - return response of type Employees array with new Employee
400 - A failed request due to validation error
employees - The employees parameterIOException - if an error occurs while attempting to invoke the APIpublic ExpenseClaims createExpenseClaim(ExpenseClaims expenseClaims, Boolean summarizeErrors) throws IOException
200 - Success - return response of type ExpenseClaims array with newly created ExpenseClaim
400 - A failed request due to validation error
expenseClaims - The expenseClaims parametersummarizeErrors - shows validation errors for each expense claimIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createExpenseClaimHistory(UUID expenseClaimID, HistoryRecords historyRecords) throws IOException
200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Expense Claims
expenseClaimID - Unique identifier for a ExpenseClaimhistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Invoices createInvoice(Invoices invoices, Boolean summarizeErrors) throws IOException
200 - Success - return response of type Invoices array with newly created Invoice
400 - A failed request due to validation error
invoices - The invoices parametersummarizeErrors - shows validation errors for each invoiceIOException - if an error occurs while attempting to invoke the APIpublic Attachments createInvoiceAttachmentByFileName(UUID invoiceID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with newly created Attachment
400 - A failed request due to validation error
invoiceID - Unique identifier for an InvoicefileName - Name of the file you are attachingbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createInvoiceHistory(UUID invoiceID, HistoryRecords historyRecords) throws IOException
200 - Success - return response of type HistoryRecords array with newly created HistoryRecord for specific Invoice
400 - A failed request due to validation error
invoiceID - Unique identifier for an InvoicehistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Items createItem(Items items) throws IOException
200 - Success - return response of type Items array with newly created Item
400 - A failed request due to validation error
items - The items parameterIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createItemHistory(UUID itemID, HistoryRecords historyRecords) throws IOException
200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Items
itemID - Unique identifier for an ItemhistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic LinkedTransactions createLinkedTransaction(LinkedTransactions linkedTransactions) throws IOException
200 - Success - return response of type LinkedTransactions array with newly created LinkedTransaction
400 - A failed request due to validation error
linkedTransactions - The linkedTransactions parameterIOException - if an error occurs while attempting to invoke the APIpublic ManualJournals createManualJournal(ManualJournals manualJournals) throws IOException
200 - Success - return response of type ManualJournals array with newly created ManualJournal
400 - A failed request due to validation error
manualJournals - The manualJournals parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments createManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with a newly created Attachment for a ManualJournals
400 - A failed request due to validation error
manualJournalID - Unique identifier for a ManualJournalfileName - The name of the file being attached to a ManualJournalbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic Allocations createOverpaymentAllocation(UUID overpaymentID, Allocations allocations) throws IOException
200 - Success - return response of type Allocations array with all Allocation for Overpayments
400 - A failed request due to validation error
overpaymentID - Unique identifier for a Overpaymentallocations - The allocations parameterIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createOverpaymentHistory(UUID overpaymentID, HistoryRecords historyRecords) throws IOException
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
overpaymentID - Unique identifier for a OverpaymenthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Payments createPayment(Payments payments) throws IOException
200 - Success - return response of type Payments array for newly created Payment
400 - A failed request due to validation error
payments - The payments parameterIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createPaymentHistory(UUID paymentID, HistoryRecords historyRecords) throws IOException
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
paymentID - Unique identifier for a PaymenthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic PaymentServices createPaymentService(PaymentServices paymentServices) throws IOException
200 - Success - return response of type PaymentServices array for newly created PaymentService
400 - A failed request due to validation error
paymentServices - The paymentServices parameterIOException - if an error occurs while attempting to invoke the APIpublic Allocations createPrepaymentAllocation(UUID prepaymentID, Allocations allocations) throws IOException
200 - Success - return response of type Allocations array of Allocation for all Prepayment
400 - A failed request due to validation error
prepaymentID - The prepaymentID parameterallocations - The allocations parameterIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createPrepaymentHistory(UUID prepaymentID, HistoryRecords historyRecords) throws IOException
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
prepaymentID - Unique identifier for a PrePaymenthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic PurchaseOrders createPurchaseOrder(PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOException
200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
400 - A failed request due to validation error
purchaseOrders - The purchaseOrders parametersummarizeErrors - shows validation errors for each purchase order.IOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createPurchaseOrderHistory(UUID purchaseOrderID, HistoryRecords historyRecords) throws IOException
200 - Success - return response of type HistoryRecords array for newly created HistoryRecord for PurchaseOrder
400 - A failed request due to validation error
purchaseOrderID - Unique identifier for a PurchaseOrderhistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Receipts createReceipt(Receipts receipts) throws IOException
200 - Success - return response of type Receipts array for newly created Receipt
400 - A failed request due to validation error
receipts - The receipts parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments createReceiptAttachmentByFileName(UUID receiptID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with newly created Attachment for a specified Receipt
400 - A failed request due to validation error
receiptID - Unique identifier for a ReceiptfileName - The name of the file being attached to the Receiptbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createReceiptHistory(UUID receiptID, HistoryRecords historyRecords) throws IOException
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
receiptID - Unique identifier for a ReceipthistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments createRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with updated Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
repeatingInvoiceID - Unique identifier for a Repeating InvoicefileName - The name of the file being attached to a Repeating Invoicebody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords createRepeatingInvoiceHistory(UUID repeatingInvoiceID, HistoryRecords historyRecords) throws IOException
200 - Unsupported - return response incorrect exception, API is not able to create HistoryRecord for Repeating Invoice
400 - A failed request due to validation error
repeatingInvoiceID - Unique identifier for a Repeating InvoicehistoryRecords - The historyRecords parameterIOException - if an error occurs while attempting to invoke the APIpublic TaxRates createTaxRate(TaxRates taxRates) throws IOException
200 - Success - return response of type TaxRates array newly created TaxRate
400 - A failed request due to validation error
taxRates - The taxRates parameterIOException - if an error occurs while attempting to invoke the APIpublic TrackingCategories createTrackingCategory(TrackingCategory trackingCategory) throws IOException
200 - Success - return response of type TrackingCategories array of newly created TrackingCategory
400 - A failed request due to validation error
trackingCategory - The trackingCategory parameterIOException - if an error occurs while attempting to invoke the APIpublic TrackingOptions createTrackingOptions(UUID trackingCategoryID, TrackingOption trackingOption) throws IOException
200 - Success - return response of type TrackingOptions array of options for a specified category
400 - A failed request due to validation error
trackingCategoryID - Unique identifier for a TrackingCategorytrackingOption - The trackingOption parameterIOException - if an error occurs while attempting to invoke the APIpublic Accounts deleteAccount(UUID accountID) throws IOException
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
accountID - Unique identifier for retrieving single objectIOException - if an error occurs while attempting to invoke the APIpublic void deleteContactGroupContact(UUID contactGroupID, UUID contactID) throws IOException
204 - Success - return response 204 no content
400 - A failed request due to validation error
contactGroupID - Unique identifier for a Contact GroupcontactID - Unique identifier for a ContactIOException - if an error occurs while attempting to invoke the APIpublic void deleteContactGroupContacts(UUID contactGroupID) throws IOException
200 - Success - return response 204 no content
contactGroupID - Unique identifier for a Contact GroupIOException - if an error occurs while attempting to invoke the APIpublic void deleteItem(UUID itemID) throws IOException
204 - Success - return response 204 no content
400 - A failed request due to validation error
itemID - Unique identifier for an ItemIOException - if an error occurs while attempting to invoke the APIpublic void deleteLinkedTransaction(UUID linkedTransactionID) throws IOException
204 - Success - return response 204 no content
400 - A failed request due to validation error
linkedTransactionID - Unique identifier for a LinkedTransactionIOException - if an error occurs while attempting to invoke the APIpublic Payments deletePayment(UUID paymentID, Payments payments) throws IOException
200 - Success - return response of type Payments array for updated Payment
400 - A failed request due to validation error
paymentID - Unique identifier for a Paymentpayments - The payments parameterIOException - if an error occurs while attempting to invoke the APIpublic TrackingCategories deleteTrackingCategory(UUID trackingCategoryID) throws IOException
200 - Success - return response of type TrackingCategories array of deleted TrackingCategory
400 - A failed request due to validation error
trackingCategoryID - Unique identifier for a TrackingCategoryIOException - if an error occurs while attempting to invoke the APIpublic TrackingOptions deleteTrackingOptions(UUID trackingCategoryID, UUID trackingOptionID) throws IOException
200 - Success - return response of type TrackingOptions array of remaining options for a specified category
400 - A failed request due to validation error
trackingCategoryID - Unique identifier for a TrackingCategorytrackingOptionID - Unique identifier for a Tracking OptionIOException - if an error occurs while attempting to invoke the APIpublic void emailInvoice(UUID invoiceID, RequestEmpty requestEmpty) throws IOException
204 - Success - return response 204 no content
400 - A failed request due to validation error
invoiceID - Unique identifier for an InvoicerequestEmpty - The requestEmpty parameterIOException - if an error occurs while attempting to invoke the APIpublic Accounts getAccount(UUID accountID) throws IOException
200 - Success - return response of type Accounts array with one Account
accountID - Unique identifier for retrieving single objectIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getAccountAttachmentByFileName(UUID accountID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Account as binary data
accountID - Unique identifier for Account objectfileName - Name of the attachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getAccountAttachmentById(UUID accountID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Account as binary data
accountID - Unique identifier for Account objectattachmentID - Unique identifier for Attachment objectcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getAccountAttachments(UUID accountID) throws IOException
200 - Success - return response of type Attachments array of Attachment
accountID - Unique identifier for Account objectIOException - if an error occurs while attempting to invoke the APIpublic Accounts getAccounts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type Accounts array with 0 to n Account
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic BankTransactions getBankTransaction(UUID bankTransactionID) throws IOException
200 - Success - return response of type BankTransactions array with a specific BankTransaction
bankTransactionID - Xero generated unique identifier for a bank transactionIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for BankTransaction as binary data
bankTransactionID - Xero generated unique identifier for a bank transactionfileName - The name of the file being attachedcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getBankTransactionAttachmentById(UUID bankTransactionID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for BankTransaction as binary data
bankTransactionID - Xero generated unique identifier for a bank transactionattachmentID - Xero generated unique identifier for an attachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getBankTransactionAttachments(UUID bankTransactionID) throws IOException
200 - Success - return response of type Attachments array with 0 to n Attachment
bankTransactionID - Xero generated unique identifier for a bank transactionIOException - if an error occurs while attempting to invoke the APIpublic BankTransactions getBankTransactions(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
200 - Success - return response of type BankTransactions array with 0 to n BankTransaction
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementpage - e.g. page=1 – Up to 100 bank transactions will be returned in a single API call with line items shown for each bank transactionunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getBankTransactionsHistory(UUID bankTransactionID) throws IOException
200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord
bankTransactionID - Xero generated unique identifier for a bank transactionIOException - if an error occurs while attempting to invoke the APIpublic BankTransfers getBankTransfer(UUID bankTransferID) throws IOException
200 - Success - return response of BankTransfers array with one BankTransfer
bankTransferID - Xero generated unique identifier for a bank transferIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getBankTransferAttachmentByFileName(UUID bankTransferID, String fileName, String contentType) throws IOException
200 - Success - return response of binary data from the Attachment to a Bank Transfer
bankTransferID - Xero generated unique identifier for a bank transferfileName - The name of the file being attached to a Bank TransfercontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getBankTransferAttachmentById(UUID bankTransferID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of binary data from the Attachment to a Bank Transfer
bankTransferID - Xero generated unique identifier for a bank transferattachmentID - Xero generated unique identifier for an Attachment to a bank transfercontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getBankTransferAttachments(UUID bankTransferID) throws IOException
200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer
bankTransferID - Xero generated unique identifier for a bank transferIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getBankTransferHistory(UUID bankTransferID) throws IOException
200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord for a Bank Transfer
bankTransferID - Xero generated unique identifier for a bank transferIOException - if an error occurs while attempting to invoke the APIpublic BankTransfers getBankTransfers(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of BankTransfers array of 0 to N BankTransfer
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getBatchPaymentHistory(UUID batchPaymentID) throws IOException
200 - Success - return response of type HistoryRecords array of HistoryRecord objects
batchPaymentID - Unique identifier for BatchPaymentIOException - if an error occurs while attempting to invoke the APIpublic BatchPayments getBatchPayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type BatchPayments array of BatchPayment objects
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic BrandingThemes getBrandingTheme(UUID brandingThemeID) throws IOException
200 - Success - return response of type BrandingThemes with one BrandingTheme
brandingThemeID - Unique identifier for a Branding ThemeIOException - if an error occurs while attempting to invoke the APIpublic PaymentServices getBrandingThemePaymentServices(UUID brandingThemeID) throws IOException
200 - Success - return response of type PaymentServices array with 0 to N PaymentService
brandingThemeID - Unique identifier for a Branding ThemeIOException - if an error occurs while attempting to invoke the APIpublic BrandingThemes getBrandingThemes() throws IOException
200 - Success - return response of type BrandingThemes
IOException - if an error occurs while attempting to invoke the APIpublic Contacts getContact(UUID contactID) throws IOException
200 - Success - return response of type Contacts array with a unique Contact
contactID - Unique identifier for a ContactIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getContactAttachmentByFileName(UUID contactID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Contact as binary data
contactID - Unique identifier for a ContactfileName - Name for the file you are attachingcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getContactAttachmentById(UUID contactID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Contact as binary data
contactID - Unique identifier for a ContactattachmentID - Unique identifier for a AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getContactAttachments(UUID contactID) throws IOException
200 - Success - return response of type Attachments array with 0 to N Attachment
contactID - Unique identifier for a ContactIOException - if an error occurs while attempting to invoke the APIpublic CISSettings getContactCISSettings(UUID contactID) throws IOException
200 - Success - return response of type CISSettings for a specific Contact
contactID - Unique identifier for a ContactIOException - if an error occurs while attempting to invoke the APIpublic ContactGroups getContactGroup(UUID contactGroupID) throws IOException
200 - Success - return response of type Contact Groups array with a specific Contact Group
contactGroupID - Unique identifier for a Contact GroupIOException - if an error occurs while attempting to invoke the APIpublic ContactGroups getContactGroups(String where, String order) throws IOException
200 - Success - return response of type Contact Groups array of Contact Group
where - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getContactHistory(UUID contactID) throws IOException
200 - Success - return response of type History Records array of 0 to N History Record for a specific Contact
contactID - Unique identifier for a ContactIOException - if an error occurs while attempting to invoke the APIpublic Contacts getContacts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, String ids, Integer page, Boolean includeArchived) throws IOException
200 - Success - return response of type Contacts array with 0 to N Contact
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementids - Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.page - e.g. page=1 - Up to 100 contacts will be returned in a single API call.includeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the responseIOException - if an error occurs while attempting to invoke the APIpublic CreditNotes getCreditNote(UUID creditNoteID) throws IOException
200 - Success - return response of type Credit Notes array with a unique CreditNote
creditNoteID - Unique identifier for a Credit NoteIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getCreditNoteAsPdf(UUID creditNoteID, String contentType) throws IOException
200 - Success - return response of binary data from the Attachment to a Credit Note
creditNoteID - Unique identifier for a Credit NotecontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Credit Note as binary data
creditNoteID - Unique identifier for a Credit NotefileName - Name of the file you are attaching to Credit NotecontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getCreditNoteAttachmentById(UUID creditNoteID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Credit Note as binary data
creditNoteID - Unique identifier for a Credit NoteattachmentID - Unique identifier for a AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getCreditNoteAttachments(UUID creditNoteID) throws IOException
200 - Success - return response of type Attachments array with all Attachment for specific Credit Note
creditNoteID - Unique identifier for a Credit NoteIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getCreditNoteHistory(UUID creditNoteID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Credit Note
creditNoteID - Unique identifier for a Credit NoteIOException - if an error occurs while attempting to invoke the APIpublic CreditNotes getCreditNotes(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
200 - Success - return response of type Credit Notes array of CreditNote
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementpage - e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit noteIOException - if an error occurs while attempting to invoke the APIpublic Currencies getCurrencies(String where, String order) throws IOException
200 - Success - return response of type Currencies array with all Currencies
where - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic Employees getEmployee(UUID employeeID) throws IOException
200 - Success - return response of type Employees array with specified Employee
employeeID - Unique identifier for a EmployeeIOException - if an error occurs while attempting to invoke the APIpublic Employees getEmployees(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type Employees array with all Employee
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic ExpenseClaims getExpenseClaim(UUID expenseClaimID) throws IOException
200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim
expenseClaimID - Unique identifier for a ExpenseClaimIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getExpenseClaimHistory(UUID expenseClaimID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific ExpenseClaim
expenseClaimID - Unique identifier for a ExpenseClaimIOException - if an error occurs while attempting to invoke the APIpublic ExpenseClaims getExpenseClaims(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type ExpenseClaims array with all ExpenseClaims
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic Invoices getInvoice(UUID invoiceID) throws IOException
200 - Success - return response of type Invoices array with specified Invoices
invoiceID - Unique identifier for an InvoiceIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getInvoiceAsPdf(UUID invoiceID, String contentType) throws IOException
200 - Success - return response of byte array pdf version of specified Invoices
invoiceID - Unique identifier for an InvoicecontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getInvoiceAttachmentByFileName(UUID invoiceID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Invoice as binary data
invoiceID - Unique identifier for an InvoicefileName - Name of the file you are attachingcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getInvoiceAttachmentById(UUID invoiceID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Invoice as binary data
invoiceID - Unique identifier for an InvoiceattachmentID - Unique identifier for an AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getInvoiceAttachments(UUID invoiceID) throws IOException
200 - Success - return response of type Attachments array of Attachments for specified Invoices
invoiceID - Unique identifier for an InvoiceIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getInvoiceHistory(UUID invoiceID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Invoice
invoiceID - Unique identifier for an InvoiceIOException - if an error occurs while attempting to invoke the APIpublic InvoiceReminders getInvoiceReminders() throws IOException
200 - Success - return response of Invoice Reminders
IOException - if an error occurs while attempting to invoke the APIpublic 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
200 - Success - return response of type Invoices array with all Invoices
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementids - Filter by a comma-separated list of InvoicesIDs. 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 invoiceincludeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the responsecreatedByMyApp - When set to true you'll only retrieve Invoices created by your appunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic Items getItem(UUID itemID) throws IOException
200 - Success - return response of type Items array with specified Item
itemID - Unique identifier for an ItemIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getItemHistory(UUID itemID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for specific Item
itemID - Unique identifier for an ItemIOException - if an error occurs while attempting to invoke the APIpublic Items getItems(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
200 - Success - return response of type Items array with all Item
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic Journals getJournal(UUID journalID) throws IOException
200 - Success - return response of type Journals array with specified Journal
journalID - Unique identifier for a JournalIOException - if an error occurs while attempting to invoke the APIpublic Journals getJournals(org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly) throws IOException
200 - Success - return response of type Journals array with all Journals
ifModifiedSince - Only records created or modified since this timestamp will be returnedoffset - Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returnedpaymentsOnly - Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.IOException - if an error occurs while attempting to invoke the APIpublic LinkedTransactions getLinkedTransaction(UUID linkedTransactionID) throws IOException
200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction
linkedTransactionID - Unique identifier for a LinkedTransactionIOException - if an error occurs while attempting to invoke the APIpublic LinkedTransactions getLinkedTransactions(Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID) throws IOException
200 - Success - return response of type LinkedTransactions array with all LinkedTransaction
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 TransactionsourceTransactionID - Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoicecontactID - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.status - Filter by the combination of ContactID and Status. Get 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 invoiceIOException - if an error occurs while attempting to invoke the APIpublic ManualJournals getManualJournal(UUID manualJournalID) throws IOException
200 - Success - return response of type ManualJournals array with a specified ManualJournals
manualJournalID - Unique identifier for a ManualJournalIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Manual Journal as binary data
manualJournalID - Unique identifier for a ManualJournalfileName - The name of the file being attached to a ManualJournalcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getManualJournalAttachmentById(UUID manualJournalID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Manual Journal as binary data
manualJournalID - Unique identifier for a ManualJournalattachmentID - Unique identifier for a AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getManualJournalAttachments(UUID manualJournalID) throws IOException
200 - Success - return response of type Attachments array with all Attachments for a ManualJournals
manualJournalID - Unique identifier for a ManualJournalIOException - if an error occurs while attempting to invoke the APIpublic ManualJournals getManualJournals(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
200 - Success - return response of type ManualJournals array with a all ManualJournals
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementpage - e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpaymentIOException - if an error occurs while attempting to invoke the APIpublic OnlineInvoices getOnlineInvoice(UUID invoiceID) throws IOException
200 - Success - return response of type OnlineInvoice array with one OnlineInvoice
invoiceID - Unique identifier for an InvoiceIOException - if an error occurs while attempting to invoke the APIpublic CISOrgSetting getOrganisationCISSettings(UUID organisationID) throws IOException
200 - Success - return response of type Organisation array with specified Organisation
organisationID - The organisationID parameterIOException - if an error occurs while attempting to invoke the APIpublic Organisations getOrganisations() throws IOException
200 - Success - return response of type Organisation array with all Organisation
IOException - if an error occurs while attempting to invoke the APIpublic Overpayments getOverpayment(UUID overpaymentID) throws IOException
200 - Success - return response of type Overpayments array with specified Overpayments
overpaymentID - Unique identifier for a OverpaymentIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getOverpaymentHistory(UUID overpaymentID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for Overpayments
overpaymentID - Unique identifier for a OverpaymentIOException - if an error occurs while attempting to invoke the APIpublic Overpayments getOverpayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
200 - Success - return response of type Overpayments array with all Overpayments
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementpage - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpaymentunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic Payments getPayment(UUID paymentID) throws IOException
200 - Success - return response of type Payments array for specified Payment
paymentID - Unique identifier for a PaymentIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getPaymentHistory(UUID paymentID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for Payments
paymentID - Unique identifier for a PaymentIOException - if an error occurs while attempting to invoke the APIpublic PaymentServices getPaymentServices() throws IOException
200 - Success - return response of type PaymentServices array for all PaymentService
IOException - if an error occurs while attempting to invoke the APIpublic Payments getPayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type Payments array for all Payments
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic Prepayments getPrepayment(UUID prepaymentID) throws IOException
200 - Success - return response of type Prepayments array for a specified Prepayment
prepaymentID - Unique identifier for a PrePaymentIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getPrepaymentHistory(UUID prepaymentID) throws IOException
200 - Success - return response of type HistoryRecords array with all HistoryRecord for PrePayment
prepaymentID - Unique identifier for a PrePaymentIOException - if an error occurs while attempting to invoke the APIpublic Prepayments getPrepayments(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
200 - Success - return response of type Prepayments array for all Prepayment
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementpage - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpaymentunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic PurchaseOrders getPurchaseOrder(UUID purchaseOrderID) throws IOException
200 - Success - return response of type PurchaseOrder array for specified PurchaseOrder
purchaseOrderID - Unique identifier for a PurchaseOrderIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getPurchaseOrderHistory(UUID purchaseOrderID) throws IOException
200 - Success - return response of type HistoryRecords array for all HistoryRecord for PurchaseOrder
purchaseOrderID - Unique identifier for a PurchaseOrderIOException - if an error occurs while attempting to invoke the APIpublic PurchaseOrders getPurchaseOrders(org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page) throws IOException
200 - Success - return response of type PurchaseOrder array of all PurchaseOrder
ifModifiedSince - Only records created or modified since this timestamp will be returnedstatus - Filter by purchase order statusdateFrom - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31dateTo - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31order - Order by an any elementpage - To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.IOException - if an error occurs while attempting to invoke the APIpublic Receipts getReceipt(UUID receiptID) throws IOException
200 - Success - return response of type Receipts array for a specified Receipt
receiptID - Unique identifier for a ReceiptIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getReceiptAttachmentByFileName(UUID receiptID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Receipt as binary data
receiptID - Unique identifier for a ReceiptfileName - The name of the file being attached to the ReceiptcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getReceiptAttachmentById(UUID receiptID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Receipt as binary data
receiptID - Unique identifier for a ReceiptattachmentID - Unique identifier for a AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getReceiptAttachments(UUID receiptID) throws IOException
200 - Success - return response of type Attachments array of Attachments for a specified Receipt
receiptID - Unique identifier for a ReceiptIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getReceiptHistory(UUID receiptID) throws IOException
200 - Success - return response of type HistoryRecords array of all HistoryRecord for Receipt
receiptID - Unique identifier for a ReceiptIOException - if an error occurs while attempting to invoke the APIpublic Receipts getReceipts(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
200 - Success - return response of type Receipts array for all Receipt
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementunitdp - e.g. unitdp=4 – You can opt in to use four decimal places for unit amountsIOException - if an error occurs while attempting to invoke the APIpublic RepeatingInvoices getRepeatingInvoice(UUID repeatingInvoiceID) throws IOException
200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice
repeatingInvoiceID - Unique identifier for a Repeating InvoiceIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, String contentType) throws IOException
200 - Success - return response of attachment for Repeating Invoice as binary data
repeatingInvoiceID - Unique identifier for a Repeating InvoicefileName - The name of the file being attached to a Repeating InvoicecontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic ByteArrayInputStream getRepeatingInvoiceAttachmentById(UUID repeatingInvoiceID, UUID attachmentID, String contentType) throws IOException
200 - Success - return response of attachment for Repeating Invoice as binary data
repeatingInvoiceID - Unique identifier for a Repeating InvoiceattachmentID - Unique identifier for a AttachmentcontentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdfIOException - if an error occurs while attempting to invoke the APIpublic Attachments getRepeatingInvoiceAttachments(UUID repeatingInvoiceID) throws IOException
200 - Success - return response of type Attachments array with all Attachments for a specified Repeating Invoice
repeatingInvoiceID - Unique identifier for a Repeating InvoiceIOException - if an error occurs while attempting to invoke the APIpublic HistoryRecords getRepeatingInvoiceHistory(UUID repeatingInvoiceID) throws IOException
200 - Success - return response of type HistoryRecords array of all HistoryRecord for Repeating Invoice
repeatingInvoiceID - Unique identifier for a Repeating InvoiceIOException - if an error occurs while attempting to invoke the APIpublic RepeatingInvoices getRepeatingInvoices(String where, String order) throws IOException
200 - Success - return response of type Repeating Invoices array for all Repeating Invoice
where - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportAgedPayablesByContact(UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
200 - Success - return response of type ReportWithRows
contactId - Unique identifier for a Contactdate - The date of the Aged Payables By Contact reportfromDate - The from date of the Aged Payables By Contact reporttoDate - The to date of the Aged Payables By Contact reportIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportAgedReceivablesByContact(UUID contactId, String date, String fromDate, String toDate) throws IOException
200 - Success - return response of type ReportWithRows
contactId - Unique identifier for a Contactdate - The date of the Aged Receivables By Contact reportfromDate - The from date of the Aged Receivables By Contact reporttoDate - The to date of the Aged Receivables By Contact reportIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportBASorGST(String reportID) throws IOException
200 - Success - return response of type ReportWithRows
reportID - Unique identifier for a ReportIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportBASorGSTList() throws IOException
200 - Success - return response of type ReportWithRows
IOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportBalanceSheet(String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
200 - Success - return response of type ReportWithRows
date - The date of the Balance Sheet reportperiods - The number of periods for the Balance Sheet reporttimeframe - The period size to compare to (MONTH, QUARTER, YEAR)trackingOptionID1 - The tracking option 1 for the Balance Sheet reporttrackingOptionID2 - The tracking option 2 for the Balance Sheet reportstandardLayout - The standard layout boolean for the Balance Sheet reportpaymentsOnly - return a cash basis for the Balance Sheet reportIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportBankSummary(String date, Integer period, Integer timeframe) throws IOException
200 - Success - return response of type ReportWithRows
date - The date for the Bank Summary report e.g. 2018-03-31period - The number of periods to compare (integer between 1 and 12)timeframe - The period size to compare to (1=month, 3=quarter, 12=year)IOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportBudgetSummary(String date, Integer period, Integer timeframe) throws IOException
200 - success- return a Report with Rows object
date - The date for the Bank Summary report e.g. 2018-03-31period - The number of periods to compare (integer between 1 and 12)timeframe - The period size to compare to (1=month, 3=quarter, 12=year)IOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportExecutiveSummary(String date) throws IOException
200 - Success - return response of type ReportWithRows
date - The date for the Bank Summary report e.g. 2018-03-31IOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportProfitAndLoss(String fromDate, String toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
200 - Success - return response of type ReportWithRows
fromDate - The from date for the ProfitAndLoss report e.g. 2018-03-31toDate - The to date for the ProfitAndLoss report e.g. 2018-03-31periods - The number of periods to compare (integer between 1 and 12)timeframe - The period size to compare to (MONTH, QUARTER, YEAR)trackingCategoryID - The trackingCategory 1 for the ProfitAndLoss reporttrackingCategoryID2 - The trackingCategory 2 for the ProfitAndLoss reporttrackingOptionID - The tracking option 1 for the ProfitAndLoss reporttrackingOptionID2 - The tracking option 2 for the ProfitAndLoss reportstandardLayout - Return the standard layout for the ProfitAndLoss reportpaymentsOnly - Return cash only basis for the ProfitAndLoss reportIOException - if an error occurs while attempting to invoke the APIpublic Reports getReportTenNinetyNine(String reportYear) throws IOException
200 - Success - return response of type Reports
reportYear - The year of the 1099 reportIOException - if an error occurs while attempting to invoke the APIpublic ReportWithRows getReportTrialBalance(String date, Boolean paymentsOnly) throws IOException
200 - Success - return response of type ReportWithRows
date - The date for the Trial Balance report e.g. 2018-03-31paymentsOnly - Return cash only basis for the Trial Balance reportIOException - if an error occurs while attempting to invoke the APIpublic TaxRates getTaxRates(String where, String order, String taxType) throws IOException
200 - Success - return response of type TaxRates array with TaxRates
where - Filter by an any elementorder - Order by an any elementtaxType - Filter by tax typeIOException - if an error occurs while attempting to invoke the APIpublic TrackingCategories getTrackingCategories(String where, String order, Boolean includeArchived) throws IOException
200 - Success - return response of type TrackingCategories array of TrackingCategory
where - Filter by an any elementorder - Order by an any elementincludeArchived - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the responseIOException - if an error occurs while attempting to invoke the APIpublic TrackingCategories getTrackingCategory(UUID trackingCategoryID) throws IOException
200 - Success - return response of type TrackingCategories array of specified TrackingCategory
trackingCategoryID - Unique identifier for a TrackingCategoryIOException - if an error occurs while attempting to invoke the APIpublic Users getUser(UUID userID) throws IOException
200 - Success - return response of type Users array of specified User
userID - Unique identifier for a UserIOException - if an error occurs while attempting to invoke the APIpublic Users getUsers(org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
200 - Success - return response of type Users array of all User
ifModifiedSince - Only records created or modified since this timestamp will be returnedwhere - Filter by an any elementorder - Order by an any elementIOException - if an error occurs while attempting to invoke the APIpublic Accounts updateAccount(UUID accountID, Accounts accounts) throws IOException
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
accountID - Unique identifier for retrieving single objectaccounts - Request of type Accounts array with one AccountIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateAccountAttachmentByFileName(UUID accountID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array of Attachment
400 - Validation Error - some data was incorrect returns response of type Error
accountID - Unique identifier for Account objectfileName - Name of the attachmentbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic BankTransactions updateBankTransaction(UUID bankTransactionID, BankTransactions bankTransactions) throws IOException
200 - Success - return response of type BankTransactions array with updated BankTransaction
400 - A failed request due to validation error
bankTransactionID - Xero generated unique identifier for a bank transactionbankTransactions - The bankTransactions parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateBankTransactionAttachmentByFileName(UUID bankTransactionID, String fileName, byte[] body) throws IOException
200 - Success - return response of Attachments array of Attachment
400 - A failed request due to validation error
bankTransactionID - Xero generated unique identifier for a bank transactionfileName - The name of the file being attachedbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic 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
bankTransferID - Xero generated unique identifier for a bank transferfileName - The name of the file being attached to a Bank Transferbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic 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
contactID - Unique identifier for a Contactcontacts - The contacts parameterIOException - if an error occurs while attempting to invoke the APIpublic 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
contactID - Unique identifier for a ContactfileName - Name for the file you are attachingbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic ContactGroups updateContactGroup(UUID contactGroupID, ContactGroups contactGroups) throws IOException
200 - Success - return response of type Contact Groups array of updated Contact Group
400 - A failed request due to validation error
contactGroupID - Unique identifier for a Contact GroupcontactGroups - The contactGroups parameterIOException - if an error occurs while attempting to invoke the APIpublic CreditNotes updateCreditNote(UUID creditNoteID, CreditNotes creditNotes) throws IOException
200 - Success - return response of type Credit Notes array with updated CreditNote
400 - A failed request due to validation error
creditNoteID - Unique identifier for a Credit NotecreditNotes - The creditNotes parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateCreditNoteAttachmentByFileName(UUID creditNoteID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with updated Attachment for specific Credit Note
400 - A failed request due to validation error
creditNoteID - Unique identifier for a Credit NotefileName - Name of the file you are attaching to Credit Notebody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic Employees updateEmployee(UUID employeeID, Employees employees) throws IOException
200 - Success - return response of type Employees array with updated Employee
400 - A failed request due to validation error
employeeID - Unique identifier for a Employeeemployees - The employees parameterIOException - if an error occurs while attempting to invoke the APIpublic ExpenseClaims updateExpenseClaim(UUID expenseClaimID, ExpenseClaims expenseClaims) throws IOException
200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim
400 - A failed request due to validation error
expenseClaimID - Unique identifier for a ExpenseClaimexpenseClaims - The expenseClaims parameterIOException - if an error occurs while attempting to invoke the APIpublic Invoices updateInvoice(UUID invoiceID, Invoices invoices) throws IOException
200 - Success - return response of type Invoices array with updated Invoice
400 - A failed request due to validation error
invoiceID - Unique identifier for an Invoiceinvoices - The invoices parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateInvoiceAttachmentByFileName(UUID invoiceID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with updated Attachment
400 - A failed request due to validation error
invoiceID - Unique identifier for an InvoicefileName - Name of the file you are attachingbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic Items updateItem(UUID itemID, Items items) throws IOException
200 - Success - return response of type Items array with updated Item
400 - A failed request due to validation error
itemID - Unique identifier for an Itemitems - The items parameterIOException - if an error occurs while attempting to invoke the APIpublic LinkedTransactions updateLinkedTransaction(UUID linkedTransactionID, LinkedTransactions linkedTransactions) throws IOException
200 - Success - return response of type LinkedTransactions array with updated LinkedTransaction
400 - Success - return response of type LinkedTransactions array with updated LinkedTransaction
linkedTransactionID - Unique identifier for a LinkedTransactionlinkedTransactions - The linkedTransactions parameterIOException - if an error occurs while attempting to invoke the APIpublic ManualJournals updateManualJournal(UUID manualJournalID, ManualJournals manualJournals) throws IOException
200 - Success - return response of type ManualJournals array with an updated ManualJournal
400 - A failed request due to validation error
manualJournalID - Unique identifier for a ManualJournalmanualJournals - The manualJournals parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateManualJournalAttachmentByFileName(UUID manualJournalID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals
400 - A failed request due to validation error
manualJournalID - Unique identifier for a ManualJournalfileName - The name of the file being attached to a ManualJournalbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic PurchaseOrders updatePurchaseOrder(UUID purchaseOrderID, PurchaseOrders purchaseOrders) throws IOException
200 - Success - return response of type PurchaseOrder array for updated PurchaseOrder
400 - A failed request due to validation error
purchaseOrderID - Unique identifier for a PurchaseOrderpurchaseOrders - The purchaseOrders parameterIOException - if an error occurs while attempting to invoke the APIpublic Receipts updateReceipt(UUID receiptID, Receipts receipts) throws IOException
200 - Success - return response of type Receipts array for updated Receipt
400 - A failed request due to validation error
receiptID - Unique identifier for a Receiptreceipts - The receipts parameterIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateReceiptAttachmentByFileName(UUID receiptID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with updated Attachment for a specified Receipt
400 - A failed request due to validation error
receiptID - Unique identifier for a ReceiptfileName - The name of the file being attached to the Receiptbody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic Attachments updateRepeatingInvoiceAttachmentByFileName(UUID repeatingInvoiceID, String fileName, byte[] body) throws IOException
200 - Success - return response of type Attachments array with specified Attachment for a specified Repeating Invoice
400 - A failed request due to validation error
repeatingInvoiceID - Unique identifier for a Repeating InvoicefileName - The name of the file being attached to a Repeating Invoicebody - Byte array of file in body of requestIOException - if an error occurs while attempting to invoke the APIpublic TaxRates updateTaxRate(TaxRates taxRates) throws IOException
200 - Success - return response of type TaxRates array updated TaxRate
400 - A failed request due to validation error
taxRates - The taxRates parameterIOException - if an error occurs while attempting to invoke the APIpublic TrackingCategories updateTrackingCategory(UUID trackingCategoryID, TrackingCategory trackingCategory) throws IOException
200 - Success - return response of type TrackingCategories array of updated TrackingCategory
400 - A failed request due to validation error
trackingCategoryID - Unique identifier for a TrackingCategorytrackingCategory - The trackingCategory parameterIOException - if an error occurs while attempting to invoke the APICopyright © 2019. All rights reserved.