Class AccountingApi

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

public class AccountingApi
extends Object
  • Constructor Details

    • AccountingApi

      public AccountingApi()
    • AccountingApi

      public AccountingApi​(ApiClient apiClient)
  • Method Details

    • getInstance

      public static AccountingApi getInstance​(ApiClient apiClient)
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient​(ApiClient apiClient)
    • setUserAgent

      public void setUserAgent​(String userAgent)
    • getUserAgent

      public String getUserAgent()
    • createAccount

      public Accounts createAccount​(String accessToken, String xeroTenantId, Account account) throws IOException
      Allows you to create a new chart of accounts

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      account - Account object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Accounts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createAccountForHttpResponse

      public com.google.api.client.http.HttpResponse createAccountForHttpResponse​(String accessToken, String xeroTenantId, Account account) throws IOException
      Throws:
      IOException
    • createAccountAttachmentByFileName

      public Attachments createAccountAttachmentByFileName​(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create Attachment on Account

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createAccountAttachmentByFileNameForHttpResponse

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

      public Attachments createAccountAttachmentByFileName​(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOException
      Allows you to create Attachment on Account

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createAccountAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createAccountAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createBankTransactionAttachmentByFileName

      public Attachments createBankTransactionAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create an Attachment on BankTransaction by Filename

      200 - Success - return response of Attachments array of Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      fileName - The name of the file being attached
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransactionAttachmentByFileNameForHttpResponse

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

      public Attachments createBankTransactionAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOException
      Allows you to create an Attachment on BankTransaction by Filename

      200 - Success - return response of Attachments array of Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      fileName - The name of the file being attached
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransactionAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransactionAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createBankTransactionHistoryRecord

      public HistoryRecords createBankTransactionHistoryRecord​(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords) throws IOException
      Allows you to create history record for a bank transactions

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransactionHistoryRecordForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransactionHistoryRecordForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createBankTransactions

      public BankTransactions createBankTransactions​(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to create one or more spend or receive money transaction

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactions - BankTransactions with an array of BankTransaction objects in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransactionsForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransactionsForHttpResponse​(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • createBankTransfer

      public BankTransfers createBankTransfer​(String accessToken, String xeroTenantId, BankTransfers bankTransfers) throws IOException
      Allows you to create a bank transfers

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransfers - BankTransfers with array of BankTransfer objects in request body
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransfers
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransferForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransferForHttpResponse​(String accessToken, String xeroTenantId, BankTransfers bankTransfers) throws IOException
      Throws:
      IOException
    • createBankTransferAttachmentByFileName

      public Attachments createBankTransferAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType) throws IOException
      200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      fileName - The name of the file being attached to a Bank Transfer
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransferAttachmentByFileNameForHttpResponse

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

      public Attachments createBankTransferAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException
      200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      fileName - The name of the file being attached to a Bank Transfer
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransferAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransferAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createBankTransferHistoryRecord

      public HistoryRecords createBankTransferHistoryRecord​(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords) throws IOException
      200 - Success - return response of type HistoryRecords array of HistoryRecord objects

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBankTransferHistoryRecordForHttpResponse

      public com.google.api.client.http.HttpResponse createBankTransferHistoryRecordForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createBatchPayment

      public BatchPayments createBatchPayment​(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors) throws IOException
      Create one or many BatchPayments for invoices

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      batchPayments - BatchPayments with an array of Payments in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      BatchPayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBatchPaymentForHttpResponse

      public com.google.api.client.http.HttpResponse createBatchPaymentForHttpResponse​(String accessToken, String xeroTenantId, BatchPayments batchPayments, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createBatchPaymentHistoryRecord

      public HistoryRecords createBatchPaymentHistoryRecord​(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords) throws IOException
      Allows you to create a history record for a Batch Payment

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      batchPaymentID - Unique identifier for BatchPayment
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBatchPaymentHistoryRecordForHttpResponse

      public com.google.api.client.http.HttpResponse createBatchPaymentHistoryRecordForHttpResponse​(String accessToken, String xeroTenantId, UUID batchPaymentID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createBrandingThemePaymentServices

      public PaymentServices createBrandingThemePaymentServices​(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentService paymentService) throws IOException
      Allow for the creation of new custom payment service for specified Branding Theme

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      brandingThemeID - Unique identifier for a Branding Theme
      paymentService - PaymentService object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      PaymentServices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createBrandingThemePaymentServicesForHttpResponse

      public com.google.api.client.http.HttpResponse createBrandingThemePaymentServicesForHttpResponse​(String accessToken, String xeroTenantId, UUID brandingThemeID, PaymentService paymentService) throws IOException
      Throws:
      IOException
    • createContactAttachmentByFileName

      public Attachments createContactAttachmentByFileName​(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType) throws IOException
      200 - Success - return response of type Attachments array with an newly created Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      fileName - Name for the file you are attaching
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactAttachmentByFileNameForHttpResponse

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

      public Attachments createContactAttachmentByFileName​(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException
      200 - Success - return response of type Attachments array with an newly created Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      fileName - Name for the file you are attaching
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createContactAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createContactGroup

      public ContactGroups createContactGroup​(String accessToken, String xeroTenantId, ContactGroups contactGroups) throws IOException
      Allows you to create a contact group

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroups - ContactGroups with an array of names in request body
      accessToken - Authorization token for user set in header of each request
      Returns:
      ContactGroups
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactGroupForHttpResponse

      public com.google.api.client.http.HttpResponse createContactGroupForHttpResponse​(String accessToken, String xeroTenantId, ContactGroups contactGroups) throws IOException
      Throws:
      IOException
    • createContactGroupContacts

      public Contacts createContactGroupContacts​(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts) throws IOException
      Allows you to add Contacts to a Contact Group

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroupID - Unique identifier for a Contact Group
      contacts - Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactGroupContactsForHttpResponse

      public com.google.api.client.http.HttpResponse createContactGroupContactsForHttpResponse​(String accessToken, String xeroTenantId, UUID contactGroupID, Contacts contacts) throws IOException
      Throws:
      IOException
    • createContactHistory

      public HistoryRecords createContactHistory​(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords) throws IOException
      Allows you to retrieve a history records of an Contact

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createContactHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createContacts

      public Contacts createContacts​(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOException
      Allows you to create a multiple contacts (bulk) in a Xero organisation

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contacts - Contacts with an array of Contact objects to create in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createContactsForHttpResponse

      public com.google.api.client.http.HttpResponse createContactsForHttpResponse​(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createCreditNoteAllocation

      public Allocations createCreditNoteAllocation​(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Allows you to create Allocation on CreditNote

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      allocations - Allocations with array of Allocation object in body of request.
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Allocations
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCreditNoteAllocationForHttpResponse

      public com.google.api.client.http.HttpResponse createCreditNoteAllocationForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createCreditNoteAttachmentByFileName

      public Attachments createCreditNoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, Boolean includeOnline, String mimeType) throws IOException
      Allows you to create Attachments on CreditNote by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      fileName - Name of the file you are attaching to Credit Note
      body - Byte array of file in body of request
      includeOnline - Allows an attachment to be seen by the end customer within their online invoice
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCreditNoteAttachmentByFileNameForHttpResponse

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

      public Attachments createCreditNoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body, Boolean includeOnline) throws IOException
      Allows you to create Attachments on CreditNote by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      fileName - Name of the file you are attaching to Credit Note
      body - Byte array of file in body of request
      includeOnline - Allows an attachment to be seen by the end customer within their online invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCreditNoteAttachmentByFileNameForHttpResponse

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

      public HistoryRecords createCreditNoteHistory​(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords) throws IOException
      Allows you to retrieve a history records of an CreditNote

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCreditNoteHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createCreditNoteHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createCreditNotes

      public CreditNotes createCreditNotes​(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to create a credit note

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNotes - Credit Notes with array of CreditNote object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      CreditNotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCreditNotesForHttpResponse

      public com.google.api.client.http.HttpResponse createCreditNotesForHttpResponse​(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • createCurrency

      public Currencies createCurrency​(String accessToken, String xeroTenantId, Currency currency) throws IOException
      200 - Unsupported - return response incorrect exception, API is not able to create new Currency
      Parameters:
      xeroTenantId - Xero identifier for Tenant
      currency - Currency obejct in the body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Currencies
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createCurrencyForHttpResponse

      public com.google.api.client.http.HttpResponse createCurrencyForHttpResponse​(String accessToken, String xeroTenantId, Currency currency) throws IOException
      Throws:
      IOException
    • createEmployees

      public Employees createEmployees​(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOException
      Allows you to create new employees used in Xero payrun

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      employees - Employees with array of Employee object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Employees
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createEmployeesForHttpResponse

      public com.google.api.client.http.HttpResponse createEmployeesForHttpResponse​(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createExpenseClaimHistory

      public HistoryRecords createExpenseClaimHistory​(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords) throws IOException
      Allows you to create a history records of an ExpenseClaim

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      expenseClaimID - Unique identifier for a ExpenseClaim
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createExpenseClaimHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createExpenseClaimHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID expenseClaimID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createExpenseClaims

      public ExpenseClaims createExpenseClaims​(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims) throws IOException
      Allows you to retrieve expense claims

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      expenseClaims - ExpenseClaims with array of ExpenseClaim object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      ExpenseClaims
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createExpenseClaimsForHttpResponse

      public com.google.api.client.http.HttpResponse createExpenseClaimsForHttpResponse​(String accessToken, String xeroTenantId, ExpenseClaims expenseClaims) throws IOException
      Throws:
      IOException
    • createInvoiceAttachmentByFileName

      public Attachments createInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, Boolean includeOnline, String mimeType) throws IOException
      Allows you to create an Attachment on invoices or purchase bills by it's filename

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      fileName - Name of the file you are attaching
      body - Byte array of file in body of request
      includeOnline - Allows an attachment to be seen by the end customer within their online invoice
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createInvoiceAttachmentByFileNameForHttpResponse

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

      public Attachments createInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body, Boolean includeOnline) throws IOException
      Allows you to create an Attachment on invoices or purchase bills by it's filename

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      fileName - Name of the file you are attaching
      body - Byte array of file in body of request
      includeOnline - Allows an attachment to be seen by the end customer within their online invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createInvoiceAttachmentByFileNameForHttpResponse

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

      public HistoryRecords createInvoiceHistory​(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords) throws IOException
      Allows you to retrieve a history records of an invoice

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createInvoiceHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createInvoiceHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createInvoices

      public Invoices createInvoices​(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to create one or more sales invoices or purchase bills

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoices - Invoices with an array of invoice objects in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Invoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createInvoicesForHttpResponse

      public com.google.api.client.http.HttpResponse createInvoicesForHttpResponse​(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • createItemHistory

      public HistoryRecords createItemHistory​(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords) throws IOException
      Allows you to create a history record for items

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      itemID - Unique identifier for an Item
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createItemHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createItemHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID itemID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createItems

      public Items createItems​(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to create one or more items

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      items - Items with an array of Item objects in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Items
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createItemsForHttpResponse

      public com.google.api.client.http.HttpResponse createItemsForHttpResponse​(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • createLinkedTransaction

      public LinkedTransactions createLinkedTransaction​(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction) throws IOException
      Allows you to create linked transactions (billable expenses)

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      linkedTransaction - LinkedTransaction object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      LinkedTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createLinkedTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse createLinkedTransactionForHttpResponse​(String accessToken, String xeroTenantId, LinkedTransaction linkedTransaction) throws IOException
      Throws:
      IOException
    • createManualJournalAttachmentByFileName

      public Attachments createManualJournalAttachmentByFileName​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create a specified Attachment on ManualJournal by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      fileName - The name of the file being attached to a ManualJournal
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createManualJournalAttachmentByFileNameForHttpResponse

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

      public Attachments createManualJournalAttachmentByFileName​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOException
      Allows you to create a specified Attachment on ManualJournal by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      fileName - The name of the file being attached to a ManualJournal
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createManualJournalAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createManualJournalAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createManualJournalHistoryRecord

      public HistoryRecords createManualJournalHistoryRecord​(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords) throws IOException
      Allows you to create history record for a manual journal

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Xero generated unique identifier for a manual journal
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createManualJournalHistoryRecordForHttpResponse

      public com.google.api.client.http.HttpResponse createManualJournalHistoryRecordForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createManualJournals

      public ManualJournals createManualJournals​(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOException
      Allows you to create one or more manual journals

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournals - ManualJournals array with ManualJournal object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      ManualJournals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createManualJournalsForHttpResponse

      public com.google.api.client.http.HttpResponse createManualJournalsForHttpResponse​(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createOverpaymentAllocations

      public Allocations createOverpaymentAllocations​(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Allows you to create a single allocation for an overpayment

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      overpaymentID - Unique identifier for a Overpayment
      allocations - Allocations array with Allocation object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Allocations
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createOverpaymentAllocationsForHttpResponse

      public com.google.api.client.http.HttpResponse createOverpaymentAllocationsForHttpResponse​(String accessToken, String xeroTenantId, UUID overpaymentID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createOverpaymentHistory

      public HistoryRecords createOverpaymentHistory​(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords) throws IOException
      Allows you to create history records of an Overpayment

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      overpaymentID - Unique identifier for a Overpayment
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createOverpaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createOverpaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID overpaymentID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createPayment

      public Payments createPayment​(String accessToken, String xeroTenantId, Payment payment) throws IOException
      Allows you to create a single payment for invoices or credit notes

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      payment - Request body with a single Payment object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Payments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPaymentForHttpResponse

      public com.google.api.client.http.HttpResponse createPaymentForHttpResponse​(String accessToken, String xeroTenantId, Payment payment) throws IOException
      Throws:
      IOException
    • createPaymentHistory

      public HistoryRecords createPaymentHistory​(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords) throws IOException
      Allows you to create a history record for a payment

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      paymentID - Unique identifier for a Payment
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createPaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID paymentID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createPaymentService

      public PaymentServices createPaymentService​(String accessToken, String xeroTenantId, PaymentServices paymentServices) throws IOException
      Allows you to create payment services

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      paymentServices - PaymentServices array with PaymentService object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      PaymentServices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPaymentServiceForHttpResponse

      public com.google.api.client.http.HttpResponse createPaymentServiceForHttpResponse​(String accessToken, String xeroTenantId, PaymentServices paymentServices) throws IOException
      Throws:
      IOException
    • createPayments

      public Payments createPayments​(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors) throws IOException
      Allows you to create multiple payments for invoices or credit notes

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      payments - Payments array with Payment object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Payments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPaymentsForHttpResponse

      public com.google.api.client.http.HttpResponse createPaymentsForHttpResponse​(String accessToken, String xeroTenantId, Payments payments, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createPrepaymentAllocations

      public Allocations createPrepaymentAllocations​(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Allows you to create an Allocation for prepayments

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      prepaymentID - Unique identifier for Prepayment
      allocations - Allocations with an array of Allocation object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Allocations
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPrepaymentAllocationsForHttpResponse

      public com.google.api.client.http.HttpResponse createPrepaymentAllocationsForHttpResponse​(String accessToken, String xeroTenantId, UUID prepaymentID, Allocations allocations, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createPrepaymentHistory

      public HistoryRecords createPrepaymentHistory​(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords) throws IOException
      Allows you to create a history record for an Prepayment

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      prepaymentID - Unique identifier for a PrePayment
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPrepaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createPrepaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID prepaymentID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createPurchaseOrderAttachmentByFileName

      public Attachments createPurchaseOrderAttachmentByFileName​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create Attachment on Purchase Order

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPurchaseOrderAttachmentByFileNameForHttpResponse

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

      public Attachments createPurchaseOrderAttachmentByFileName​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOException
      Allows you to create Attachment on Purchase Order

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPurchaseOrderAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createPurchaseOrderAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createPurchaseOrderHistory

      public HistoryRecords createPurchaseOrderHistory​(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords) throws IOException
      Allows you to create HistoryRecord for purchase orders

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for a PurchaseOrder
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPurchaseOrderHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createPurchaseOrderHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createPurchaseOrders

      public PurchaseOrders createPurchaseOrders​(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOException
      Allows you to create one or more purchase orders

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrders - PurchaseOrders with an array of PurchaseOrder object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createPurchaseOrdersForHttpResponse

      public com.google.api.client.http.HttpResponse createPurchaseOrdersForHttpResponse​(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createQuoteAttachmentByFileName

      public Attachments createQuoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create Attachment on Quote

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createQuoteAttachmentByFileNameForHttpResponse

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

      public Attachments createQuoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOException
      Allows you to create Attachment on Quote

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createQuoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createQuoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createQuoteHistory

      public HistoryRecords createQuoteHistory​(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords) throws IOException
      Allows you to retrieve a history records of an quote

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for an Quote
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createQuoteHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createQuoteHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createQuotes

      public Quotes createQuotes​(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOException
      Allows you to create one or more quotes

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quotes - Quotes with an array of Quote object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Quotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createQuotesForHttpResponse

      public com.google.api.client.http.HttpResponse createQuotesForHttpResponse​(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • createReceipt

      public Receipts createReceipt​(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp) throws IOException
      Allows you to create draft expense claim receipts for any user

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receipts - Receipts with an array of Receipt object in body of request
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Receipts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createReceiptForHttpResponse

      public com.google.api.client.http.HttpResponse createReceiptForHttpResponse​(String accessToken, String xeroTenantId, Receipts receipts, Integer unitdp) throws IOException
      Throws:
      IOException
    • createReceiptAttachmentByFileName

      public Attachments createReceiptAttachmentByFileName​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create Attachment on expense claim receipts by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      fileName - The name of the file being attached to the Receipt
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createReceiptAttachmentByFileNameForHttpResponse

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

      public Attachments createReceiptAttachmentByFileName​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOException
      Allows you to create Attachment on expense claim receipts by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      fileName - The name of the file being attached to the Receipt
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createReceiptAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createReceiptAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createReceiptHistory

      public HistoryRecords createReceiptHistory​(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords) throws IOException
      Allows you to retrieve a history records of an Receipt

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createReceiptHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createReceiptHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createRepeatingInvoiceAttachmentByFileName

      public Attachments createRepeatingInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to create attachment on repeating invoices by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      fileName - The name of the file being attached to a Repeating Invoice
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createRepeatingInvoiceAttachmentByFileNameForHttpResponse

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

      public Attachments createRepeatingInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOException
      Allows you to create attachment on repeating invoices by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      fileName - The name of the file being attached to a Repeating Invoice
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createRepeatingInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse createRepeatingInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOException
      Throws:
      IOException
    • createRepeatingInvoiceHistory

      public HistoryRecords createRepeatingInvoiceHistory​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords) throws IOException
      Allows you to create history for a repeating invoice

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      historyRecords - HistoryRecords containing an array of HistoryRecord objects in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createRepeatingInvoiceHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse createRepeatingInvoiceHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, HistoryRecords historyRecords) throws IOException
      Throws:
      IOException
    • createTaxRates

      public TaxRates createTaxRates​(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOException
      Allows you to create one or more Tax Rates

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      taxRates - TaxRates array with TaxRate object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      TaxRates
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createTaxRatesForHttpResponse

      public com.google.api.client.http.HttpResponse createTaxRatesForHttpResponse​(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOException
      Throws:
      IOException
    • createTrackingCategory

      public TrackingCategories createTrackingCategory​(String accessToken, String xeroTenantId, TrackingCategory trackingCategory) throws IOException
      Allows you to create tracking categories

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategory - TrackingCategory object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingCategories
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createTrackingCategoryForHttpResponse

      public com.google.api.client.http.HttpResponse createTrackingCategoryForHttpResponse​(String accessToken, String xeroTenantId, TrackingCategory trackingCategory) throws IOException
      Throws:
      IOException
    • createTrackingOptions

      public TrackingOptions createTrackingOptions​(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption) throws IOException
      Allows you to create options for a specified tracking category

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      trackingOption - TrackingOption object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingOptions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • createTrackingOptionsForHttpResponse

      public com.google.api.client.http.HttpResponse createTrackingOptionsForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingOption trackingOption) throws IOException
      Throws:
      IOException
    • deleteAccount

      public Accounts deleteAccount​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Allows you to delete a chart of accounts

      200 - Success - delete existing Account and return response of type Accounts array with deleted Account

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for retrieving single object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Accounts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteAccountForHttpResponse

      public com.google.api.client.http.HttpResponse deleteAccountForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Throws:
      IOException
    • deleteContactGroupContact

      public void deleteContactGroupContact​(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID) throws IOException
      Allows you to delete a specific Contact from a Contact Group

      204 - Success - return response 204 no content

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroupID - Unique identifier for a Contact Group
      contactID - Unique identifier for a Contact
      accessToken - Authorization token for user set in header of each request
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteContactGroupContactForHttpResponse

      public com.google.api.client.http.HttpResponse deleteContactGroupContactForHttpResponse​(String accessToken, String xeroTenantId, UUID contactGroupID, UUID contactID) throws IOException
      Throws:
      IOException
    • deleteContactGroupContacts

      public void deleteContactGroupContacts​(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOException
      Allows you to delete all Contacts from a Contact Group

      204 - Success - return response 204 no content

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroupID - Unique identifier for a Contact Group
      accessToken - Authorization token for user set in header of each request
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteContactGroupContactsForHttpResponse

      public com.google.api.client.http.HttpResponse deleteContactGroupContactsForHttpResponse​(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOException
      Throws:
      IOException
    • deleteItem

      public void deleteItem​(String accessToken, String xeroTenantId, UUID itemID) throws IOException
      Allows you to delete a specified item

      204 - Success - return response 204 no content

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      itemID - Unique identifier for an Item
      accessToken - Authorization token for user set in header of each request
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteItemForHttpResponse

      public com.google.api.client.http.HttpResponse deleteItemForHttpResponse​(String accessToken, String xeroTenantId, UUID itemID) throws IOException
      Throws:
      IOException
    • deleteLinkedTransaction

      public void deleteLinkedTransaction​(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOException
      Allows you to delete a specified linked transactions (billable expenses)

      204 - Success - return response 204 no content

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      linkedTransactionID - Unique identifier for a LinkedTransaction
      accessToken - Authorization token for user set in header of each request
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteLinkedTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse deleteLinkedTransactionForHttpResponse​(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOException
      Throws:
      IOException
    • deletePayment

      public Payments deletePayment​(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete) throws IOException
      Allows you to update a specified payment for invoices and credit notes

      200 - Success - return response of type Payments array for updated Payment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      paymentID - Unique identifier for a Payment
      paymentDelete - The paymentDelete parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      Payments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deletePaymentForHttpResponse

      public com.google.api.client.http.HttpResponse deletePaymentForHttpResponse​(String accessToken, String xeroTenantId, UUID paymentID, PaymentDelete paymentDelete) throws IOException
      Throws:
      IOException
    • deleteTrackingCategory

      public TrackingCategories deleteTrackingCategory​(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOException
      Allows you to delete tracking categories

      200 - Success - return response of type TrackingCategories array of deleted TrackingCategory

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingCategories
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteTrackingCategoryForHttpResponse

      public com.google.api.client.http.HttpResponse deleteTrackingCategoryForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOException
      Throws:
      IOException
    • deleteTrackingOptions

      public TrackingOptions deleteTrackingOptions​(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID) throws IOException
      Allows you to delete a specified option for a specified tracking category

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      trackingOptionID - Unique identifier for a Tracking Option
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingOptions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • deleteTrackingOptionsForHttpResponse

      public com.google.api.client.http.HttpResponse deleteTrackingOptionsForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID) throws IOException
      Throws:
      IOException
    • emailInvoice

      public void emailInvoice​(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty) throws IOException
      Allows you to email a copy of invoice to related Contact

      204 - Success - return response 204 no content

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      requestEmpty - The requestEmpty parameter
      accessToken - Authorization token for user set in header of each request
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • emailInvoiceForHttpResponse

      public com.google.api.client.http.HttpResponse emailInvoiceForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, RequestEmpty requestEmpty) throws IOException
      Throws:
      IOException
    • getAccount

      public Accounts getAccount​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Allows you to retrieve a single chart of accounts

      200 - Success - return response of type Accounts array with one Account

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for retrieving single object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Accounts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getAccountForHttpResponse

      public com.google.api.client.http.HttpResponse getAccountForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Throws:
      IOException
    • getAccountAttachmentByFileName

      public ByteArrayInputStream getAccountAttachmentByFileName​(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachment on Account by Filename

      200 - Success - return response of attachment for Account as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      fileName - Name of the attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getAccountAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getAccountAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getAccountAttachmentById

      public ByteArrayInputStream getAccountAttachmentById​(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve specific Attachment on Account

      200 - Success - return response of attachment for Account as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      attachmentID - Unique identifier for Attachment object
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getAccountAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getAccountAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getAccountAttachments

      public Attachments getAccountAttachments​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Allows you to retrieve Attachments for accounts

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getAccountAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getAccountAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID) throws IOException
      Throws:
      IOException
    • getAccounts

      public Accounts getAccounts​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Allows you to retrieve the full chart of accounts

      200 - Success - return response of type Accounts array with 0 to n Account

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      Accounts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getAccountsForHttpResponse

      public com.google.api.client.http.HttpResponse getAccountsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • getBankTransaction

      public BankTransactions getBankTransaction​(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp) throws IOException
      Allows you to retrieve a single spend or receive money transaction

      200 - Success - return response of type BankTransactions array with a specific BankTransaction

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, Integer unitdp) throws IOException
      Throws:
      IOException
    • getBankTransactionAttachmentByFileName

      public ByteArrayInputStream getBankTransactionAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachments on BankTransaction by Filename

      200 - Success - return response of attachment for BankTransaction as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      fileName - The name of the file being attached
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getBankTransactionAttachmentById

      public ByteArrayInputStream getBankTransactionAttachmentById​(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve Attachments on a specific BankTransaction

      200 - Success - return response of attachment for BankTransaction as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      attachmentID - Xero generated unique identifier for an attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getBankTransactionAttachments

      public Attachments getBankTransactionAttachments​(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOException
      Allows you to retrieve any attachments to bank transactions

      200 - Success - return response of type Attachments array with 0 to n Attachment

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOException
      Throws:
      IOException
    • getBankTransactions

      public BankTransactions getBankTransactions​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Allows you to retrieve any spend or receive money transactions

      200 - Success - return response of type BankTransactions array with 0 to n BankTransaction

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - Up to 100 bank transactions will be returned in a single API call with line items details
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionsForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Throws:
      IOException
    • getBankTransactionsHistory

      public HistoryRecords getBankTransactionsHistory​(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOException
      Allows you to retrieve history from a bank transactions

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransactionsHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransactionsHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID) throws IOException
      Throws:
      IOException
    • getBankTransfer

      public BankTransfers getBankTransfer​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Allows you to retrieve any bank transfers

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransfers
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransferForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransferForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Throws:
      IOException
    • getBankTransferAttachmentByFileName

      public ByteArrayInputStream getBankTransferAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachments on BankTransfer by file name

      200 - Success - return response of binary data from the Attachment to a Bank Transfer

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      fileName - The name of the file being attached to a Bank Transfer
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransferAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransferAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getBankTransferAttachmentById

      public ByteArrayInputStream getBankTransferAttachmentById​(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve Attachments on BankTransfer

      200 - Success - return response of binary data from the Attachment to a Bank Transfer

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      attachmentID - Xero generated unique identifier for an Attachment to a bank transfer
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransferAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransferAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getBankTransferAttachments

      public Attachments getBankTransferAttachments​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Allows you to retrieve Attachments from bank transfers

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransferAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransferAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Throws:
      IOException
    • getBankTransferHistory

      public HistoryRecords getBankTransferHistory​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Allows you to retrieve history from a bank transfers

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransferHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransferHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID) throws IOException
      Throws:
      IOException
    • getBankTransfers

      public BankTransfers getBankTransfers​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Allows you to retrieve all bank transfers

      200 - Success - return response of BankTransfers array of 0 to N BankTransfer

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransfers
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBankTransfersForHttpResponse

      public com.google.api.client.http.HttpResponse getBankTransfersForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • getBatchPaymentHistory

      public HistoryRecords getBatchPaymentHistory​(String accessToken, String xeroTenantId, UUID batchPaymentID) throws IOException
      Allows you to retrieve history from a Batch Payment

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      batchPaymentID - Unique identifier for BatchPayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBatchPaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getBatchPaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID batchPaymentID) throws IOException
      Throws:
      IOException
    • getBatchPayments

      public BatchPayments getBatchPayments​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Retrieve either one or many BatchPayments for invoices

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      BatchPayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBatchPaymentsForHttpResponse

      public com.google.api.client.http.HttpResponse getBatchPaymentsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • getBrandingTheme

      public BrandingThemes getBrandingTheme​(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOException
      Allows you to retrieve a specific BrandingThemes

      200 - Success - return response of type BrandingThemes with one BrandingTheme

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      brandingThemeID - Unique identifier for a Branding Theme
      accessToken - Authorization token for user set in header of each request
      Returns:
      BrandingThemes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBrandingThemeForHttpResponse

      public com.google.api.client.http.HttpResponse getBrandingThemeForHttpResponse​(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOException
      Throws:
      IOException
    • getBrandingThemePaymentServices

      public PaymentServices getBrandingThemePaymentServices​(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOException
      Allows you to retrieve the Payment services for a Branding Theme

      200 - Success - return response of type PaymentServices array with 0 to N PaymentService

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      brandingThemeID - Unique identifier for a Branding Theme
      accessToken - Authorization token for user set in header of each request
      Returns:
      PaymentServices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBrandingThemePaymentServicesForHttpResponse

      public com.google.api.client.http.HttpResponse getBrandingThemePaymentServicesForHttpResponse​(String accessToken, String xeroTenantId, UUID brandingThemeID) throws IOException
      Throws:
      IOException
    • getBrandingThemes

      public BrandingThemes getBrandingThemes​(String accessToken, String xeroTenantId) throws IOException
      Allows you to retrieve all the BrandingThemes

      200 - Success - return response of type BrandingThemes

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      BrandingThemes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getBrandingThemesForHttpResponse

      public com.google.api.client.http.HttpResponse getBrandingThemesForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getContact

      public Contacts getContact​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Allows you to retrieve a single contacts in a Xero organisation

      200 - Success - return response of type Contacts array with a unique Contact

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactForHttpResponse

      public com.google.api.client.http.HttpResponse getContactForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Throws:
      IOException
    • getContactAttachmentByFileName

      public ByteArrayInputStream getContactAttachmentByFileName​(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachments on Contacts by file name

      200 - Success - return response of attachment for Contact as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      fileName - Name for the file you are attaching
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getContactAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getContactAttachmentById

      public ByteArrayInputStream getContactAttachmentById​(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve Attachments on Contacts

      200 - Success - return response of attachment for Contact as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      attachmentID - Unique identifier for a Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getContactAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getContactAttachments

      public Attachments getContactAttachments​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Allows you to retrieve, add and update contacts in a Xero organisation

      200 - Success - return response of type Attachments array with 0 to N Attachment

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getContactAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Throws:
      IOException
    • getContactByContactNumber

      public Contacts getContactByContactNumber​(String accessToken, String xeroTenantId, String contactNumber) throws IOException
      Allows you to retrieve a single contact by Contact Number in a Xero organisation

      200 - Success - return response of type Contacts array with a unique Contact

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactNumber - This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactByContactNumberForHttpResponse

      public com.google.api.client.http.HttpResponse getContactByContactNumberForHttpResponse​(String accessToken, String xeroTenantId, String contactNumber) throws IOException
      Throws:
      IOException
    • getContactCISSettings

      public CISSettings getContactCISSettings​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Allows you to retrieve CISSettings for a contact in a Xero organisation

      200 - Success - return response of type CISSettings for a specific Contact

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      accessToken - Authorization token for user set in header of each request
      Returns:
      CISSettings
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactCISSettingsForHttpResponse

      public com.google.api.client.http.HttpResponse getContactCISSettingsForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Throws:
      IOException
    • getContactGroup

      public ContactGroups getContactGroup​(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOException
      Allows you to retrieve a unique Contact Group by ID

      200 - Success - return response of type Contact Groups array with a specific Contact Group

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroupID - Unique identifier for a Contact Group
      accessToken - Authorization token for user set in header of each request
      Returns:
      ContactGroups
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactGroupForHttpResponse

      public com.google.api.client.http.HttpResponse getContactGroupForHttpResponse​(String accessToken, String xeroTenantId, UUID contactGroupID) throws IOException
      Throws:
      IOException
    • getContactGroups

      public ContactGroups getContactGroups​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Allows you to retrieve the ContactID and Name of all the contacts in a contact group

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      ContactGroups
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactGroupsForHttpResponse

      public com.google.api.client.http.HttpResponse getContactGroupsForHttpResponse​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Throws:
      IOException
    • getContactHistory

      public HistoryRecords getContactHistory​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Allows you to retrieve a history records of an Contact

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getContactHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID) throws IOException
      Throws:
      IOException
    • getContacts

      public Contacts getContacts​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived) throws IOException
      Allows you to retrieve all contacts in a Xero organisation

      200 - Success - return response of type Contacts array with 0 to N Contact

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      ids - Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
      page - e.g. page=1 - Up to 100 contacts will be returned in a single API call.
      includeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getContactsForHttpResponse

      public com.google.api.client.http.HttpResponse getContactsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, Integer page, Boolean includeArchived) throws IOException
      Throws:
      IOException
    • getCreditNote

      public CreditNotes getCreditNote​(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp) throws IOException
      Allows you to retrieve a specific credit note

      200 - Success - return response of type Credit Notes array with a unique CreditNote

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      CreditNotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, Integer unitdp) throws IOException
      Throws:
      IOException
    • getCreditNoteAsPdf

      public ByteArrayInputStream getCreditNoteAsPdf​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Allows you to retrieve Credit Note as PDF files

      200 - Success - return response of binary data from the Attachment to a Credit Note

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteAsPdfForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteAsPdfForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Throws:
      IOException
    • getCreditNoteAttachmentByFileName

      public ByteArrayInputStream getCreditNoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachments on CreditNote by file name

      200 - Success - return response of attachment for Credit Note as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      fileName - Name of the file you are attaching to Credit Note
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getCreditNoteAttachmentById

      public ByteArrayInputStream getCreditNoteAttachmentById​(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve Attachments on CreditNote

      200 - Success - return response of attachment for Credit Note as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      attachmentID - Unique identifier for a Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getCreditNoteAttachments

      public Attachments getCreditNoteAttachments​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Allows you to retrieve Attachments for credit notes

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Throws:
      IOException
    • getCreditNoteHistory

      public HistoryRecords getCreditNoteHistory​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Allows you to retrieve a history records of an CreditNote

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNoteHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNoteHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID) throws IOException
      Throws:
      IOException
    • getCreditNotes

      public CreditNotes getCreditNotes​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Allows you to retrieve any credit notes

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      CreditNotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCreditNotesForHttpResponse

      public com.google.api.client.http.HttpResponse getCreditNotesForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Throws:
      IOException
    • getCurrencies

      public Currencies getCurrencies​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Allows you to retrieve currencies for your organisation

      200 - Success - return response of type Currencies array with all Currencies

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      Currencies
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getCurrenciesForHttpResponse

      public com.google.api.client.http.HttpResponse getCurrenciesForHttpResponse​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Throws:
      IOException
    • getEmployee

      public Employees getEmployee​(String accessToken, String xeroTenantId, UUID employeeID) throws IOException
      Allows you to retrieve a specific employee used in Xero payrun

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      employeeID - Unique identifier for a Employee
      accessToken - Authorization token for user set in header of each request
      Returns:
      Employees
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getEmployeeForHttpResponse

      public com.google.api.client.http.HttpResponse getEmployeeForHttpResponse​(String accessToken, String xeroTenantId, UUID employeeID) throws IOException
      Throws:
      IOException
    • getEmployees

      public Employees getEmployees​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Allows you to retrieve employees used in Xero payrun

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      Employees
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getEmployeesForHttpResponse

      public com.google.api.client.http.HttpResponse getEmployeesForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • getExpenseClaim

      public ExpenseClaims getExpenseClaim​(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOException
      Allows you to retrieve a specified expense claim

      200 - Success - return response of type ExpenseClaims array with specified ExpenseClaim

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      expenseClaimID - Unique identifier for a ExpenseClaim
      accessToken - Authorization token for user set in header of each request
      Returns:
      ExpenseClaims
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getExpenseClaimForHttpResponse

      public com.google.api.client.http.HttpResponse getExpenseClaimForHttpResponse​(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOException
      Throws:
      IOException
    • getExpenseClaimHistory

      public HistoryRecords getExpenseClaimHistory​(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOException
      Allows you to retrieve a history records of an ExpenseClaim

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      expenseClaimID - Unique identifier for a ExpenseClaim
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getExpenseClaimHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getExpenseClaimHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID expenseClaimID) throws IOException
      Throws:
      IOException
    • getExpenseClaims

      public ExpenseClaims getExpenseClaims​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Allows you to retrieve expense claims

      200 - Success - return response of type ExpenseClaims array with all ExpenseClaims

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      ExpenseClaims
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getExpenseClaimsForHttpResponse

      public com.google.api.client.http.HttpResponse getExpenseClaimsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • getInvoice

      public Invoices getInvoice​(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp) throws IOException
      Allows you to retrieve a specified sales invoice or purchase bill

      200 - Success - return response of type Invoices array with specified Invoices

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Invoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, Integer unitdp) throws IOException
      Throws:
      IOException
    • getInvoiceAsPdf

      public ByteArrayInputStream getInvoiceAsPdf​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Allows you to retrieve invoices or purchase bills as PDF files

      200 - Success - return response of byte array pdf version of specified Invoices

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceAsPdfForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceAsPdfForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Throws:
      IOException
    • getInvoiceAttachmentByFileName

      public ByteArrayInputStream getInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachment on invoices or purchase bills by it's filename

      200 - Success - return response of attachment for Invoice as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      fileName - Name of the file you are attaching
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getInvoiceAttachmentById

      public ByteArrayInputStream getInvoiceAttachmentById​(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID

      200 - Success - return response of attachment for Invoice as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      attachmentID - Unique identifier for an Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getInvoiceAttachments

      public Attachments getInvoiceAttachments​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Allows you to retrieve Attachments on invoices or purchase bills

      200 - Success - return response of type Attachments array of Attachments for specified Invoices

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Throws:
      IOException
    • getInvoiceHistory

      public HistoryRecords getInvoiceHistory​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Allows you to retrieve a history records of an invoice

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Throws:
      IOException
    • getInvoiceReminders

      public InvoiceReminders getInvoiceReminders​(String accessToken, String xeroTenantId) throws IOException
      Allows you to retrieve invoice reminder settings

      200 - Success - return response of Invoice Reminders

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      InvoiceReminders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoiceRemindersForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoiceRemindersForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getInvoices

      public Invoices getInvoices​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, List<String> invoiceNumbers, List<UUID> contactIDs, List<String> statuses, Integer page, Boolean includeArchived, Boolean createdByMyApp, Integer unitdp) throws IOException
      Allows you to retrieve any sales invoices or purchase bills

      200 - Success - return response of type Invoices array with all Invoices

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      ids - Filter by a comma-separated list of InvoicesIDs.
      invoiceNumbers - Filter by a comma-separated list of InvoiceNumbers.
      contactIDs - Filter by a comma-separated list of ContactIDs.
      statuses - Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
      page - e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
      includeArchived - e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
      createdByMyApp - When set to true you'll only retrieve Invoices created by your app
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Invoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getInvoicesForHttpResponse

      public com.google.api.client.http.HttpResponse getInvoicesForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, List<UUID> ids, List<String> invoiceNumbers, List<UUID> contactIDs, List<String> statuses, Integer page, Boolean includeArchived, Boolean createdByMyApp, Integer unitdp) throws IOException
      Throws:
      IOException
    • getItem

      public Items getItem​(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp) throws IOException
      Allows you to retrieve a specified item

      200 - Success - return response of type Items array with specified Item

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      itemID - Unique identifier for an Item
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Items
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getItemForHttpResponse

      public com.google.api.client.http.HttpResponse getItemForHttpResponse​(String accessToken, String xeroTenantId, UUID itemID, Integer unitdp) throws IOException
      Throws:
      IOException
    • getItemHistory

      public HistoryRecords getItemHistory​(String accessToken, String xeroTenantId, UUID itemID) throws IOException
      Allows you to retrieve history for items

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      itemID - Unique identifier for an Item
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getItemHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getItemHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID itemID) throws IOException
      Throws:
      IOException
    • getItems

      public Items getItems​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
      Allows you to retrieve any items

      200 - Success - return response of type Items array with all Item

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Items
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getItemsForHttpResponse

      public com.google.api.client.http.HttpResponse getItemsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
      Throws:
      IOException
    • getJournal

      public Journals getJournal​(String accessToken, String xeroTenantId, UUID journalID) throws IOException
      Allows you to retrieve a specified journals.

      200 - Success - return response of type Journals array with specified Journal

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      journalID - Unique identifier for a Journal
      accessToken - Authorization token for user set in header of each request
      Returns:
      Journals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getJournalForHttpResponse

      public com.google.api.client.http.HttpResponse getJournalForHttpResponse​(String accessToken, String xeroTenantId, UUID journalID) throws IOException
      Throws:
      IOException
    • getJournals

      public Journals getJournals​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly) throws IOException
      Allows you to retrieve any journals.

      200 - Success - return response of type Journals array with all Journals

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      offset - Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
      paymentsOnly - Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.
      accessToken - Authorization token for user set in header of each request
      Returns:
      Journals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getJournalsForHttpResponse

      public com.google.api.client.http.HttpResponse getJournalsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, Integer offset, Boolean paymentsOnly) throws IOException
      Throws:
      IOException
    • getLinkedTransaction

      public LinkedTransactions getLinkedTransaction​(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOException
      Allows you to retrieve a specified linked transactions (billable expenses)

      200 - Success - return response of type LinkedTransactions array with a specified LinkedTransaction

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      linkedTransactionID - Unique identifier for a LinkedTransaction
      accessToken - Authorization token for user set in header of each request
      Returns:
      LinkedTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getLinkedTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse getLinkedTransactionForHttpResponse​(String accessToken, String xeroTenantId, UUID linkedTransactionID) throws IOException
      Throws:
      IOException
    • getLinkedTransactions

      public LinkedTransactions getLinkedTransactions​(String accessToken, String xeroTenantId, Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID) throws IOException
      Retrieve linked transactions (billable expenses)

      200 - Success - return response of type LinkedTransactions array with all LinkedTransaction

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      page - Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
      linkedTransactionID - The Xero identifier for an Linked Transaction
      sourceTransactionID - Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice
      contactID - Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
      status - Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status
      targetTransactionID - Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      LinkedTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getLinkedTransactionsForHttpResponse

      public com.google.api.client.http.HttpResponse getLinkedTransactionsForHttpResponse​(String accessToken, String xeroTenantId, Integer page, String linkedTransactionID, String sourceTransactionID, String contactID, String status, String targetTransactionID) throws IOException
      Throws:
      IOException
    • getManualJournal

      public ManualJournals getManualJournal​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Allows you to retrieve a specified manual journals

      200 - Success - return response of type ManualJournals array with a specified ManualJournals

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      accessToken - Authorization token for user set in header of each request
      Returns:
      ManualJournals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Throws:
      IOException
    • getManualJournalAttachmentByFileName

      public ByteArrayInputStream getManualJournalAttachmentByFileName​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType) throws IOException
      Allows you to retrieve specified Attachment on ManualJournal by file name

      200 - Success - return response of attachment for Manual Journal as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      fileName - The name of the file being attached to a ManualJournal
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getManualJournalAttachmentById

      public ByteArrayInputStream getManualJournalAttachmentById​(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve specified Attachment on ManualJournals

      200 - Success - return response of attachment for Manual Journal as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      attachmentID - Unique identifier for a Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getManualJournalAttachments

      public Attachments getManualJournalAttachments​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Allows you to retrieve Attachment for manual journals

      200 - Success - return response of type Attachments array with all Attachments for a ManualJournals

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Throws:
      IOException
    • getManualJournals

      public ManualJournals getManualJournals​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
      Allows you to retrieve any manual journals

      200 - Success - return response of type ManualJournals array with a all ManualJournals

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      ManualJournals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalsForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
      Throws:
      IOException
    • getManualJournalsHistory

      public HistoryRecords getManualJournalsHistory​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Allows you to retrieve history from a manual journal

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Xero generated unique identifier for a manual journal
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getManualJournalsHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getManualJournalsHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID) throws IOException
      Throws:
      IOException
    • getOnlineInvoice

      public OnlineInvoices getOnlineInvoice​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Allows you to retrieve a URL to an online invoice

      200 - Success - return response of type OnlineInvoice array with one OnlineInvoice

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      OnlineInvoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOnlineInvoiceForHttpResponse

      public com.google.api.client.http.HttpResponse getOnlineInvoiceForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID) throws IOException
      Throws:
      IOException
    • getOrganisationActions

      public Actions getOrganisationActions​(String accessToken, String xeroTenantId) throws IOException
      Retrieve a list of the key actions your app has permission to perform in the connected organisation.

      200 - Success - return response of type Actions array with all key actions

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      Actions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOrganisationActionsForHttpResponse

      public com.google.api.client.http.HttpResponse getOrganisationActionsForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getOrganisationCISSettings

      public CISOrgSetting getOrganisationCISSettings​(String accessToken, String xeroTenantId, UUID organisationID) throws IOException
      Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.

      200 - Success - return response of type Organisation array with specified Organisation

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      organisationID - The unique Xero identifier for an organisation
      accessToken - Authorization token for user set in header of each request
      Returns:
      CISOrgSetting
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOrganisationCISSettingsForHttpResponse

      public com.google.api.client.http.HttpResponse getOrganisationCISSettingsForHttpResponse​(String accessToken, String xeroTenantId, UUID organisationID) throws IOException
      Throws:
      IOException
    • getOrganisations

      public Organisations getOrganisations​(String accessToken, String xeroTenantId) throws IOException
      Allows you to retrieve Organisation details

      200 - Success - return response of type Organisation array with all Organisation

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      Organisations
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOrganisationsForHttpResponse

      public com.google.api.client.http.HttpResponse getOrganisationsForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getOverpayment

      public Overpayments getOverpayment​(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOException
      Allows you to retrieve a specified overpayments

      200 - Success - return response of type Overpayments array with specified Overpayments

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      overpaymentID - Unique identifier for a Overpayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      Overpayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOverpaymentForHttpResponse

      public com.google.api.client.http.HttpResponse getOverpaymentForHttpResponse​(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOException
      Throws:
      IOException
    • getOverpaymentHistory

      public HistoryRecords getOverpaymentHistory​(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOException
      Allows you to retrieve a history records of an Overpayment

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      overpaymentID - Unique identifier for a Overpayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOverpaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getOverpaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID overpaymentID) throws IOException
      Throws:
      IOException
    • getOverpayments

      public Overpayments getOverpayments​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Allows you to retrieve overpayments

      200 - Success - return response of type Overpayments array with all Overpayments

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Overpayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getOverpaymentsForHttpResponse

      public com.google.api.client.http.HttpResponse getOverpaymentsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Throws:
      IOException
    • getPayment

      public Payments getPayment​(String accessToken, String xeroTenantId, UUID paymentID) throws IOException
      Allows you to retrieve a specified payment for invoices and credit notes

      200 - Success - return response of type Payments array for specified Payment

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      paymentID - Unique identifier for a Payment
      accessToken - Authorization token for user set in header of each request
      Returns:
      Payments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPaymentForHttpResponse

      public com.google.api.client.http.HttpResponse getPaymentForHttpResponse​(String accessToken, String xeroTenantId, UUID paymentID) throws IOException
      Throws:
      IOException
    • getPaymentHistory

      public HistoryRecords getPaymentHistory​(String accessToken, String xeroTenantId, UUID paymentID) throws IOException
      Allows you to retrieve history records of a payment

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      paymentID - Unique identifier for a Payment
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getPaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID paymentID) throws IOException
      Throws:
      IOException
    • getPaymentServices

      public PaymentServices getPaymentServices​(String accessToken, String xeroTenantId) throws IOException
      Allows you to retrieve payment services

      200 - Success - return response of type PaymentServices array for all PaymentService

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      PaymentServices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPaymentServicesForHttpResponse

      public com.google.api.client.http.HttpResponse getPaymentServicesForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getPayments

      public Payments getPayments​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
      Allows you to retrieve payments for invoices and credit notes

      200 - Success - return response of type Payments array for all Payments

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - Up to 100 payments will be returned in a single API call
      accessToken - Authorization token for user set in header of each request
      Returns:
      Payments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPaymentsForHttpResponse

      public com.google.api.client.http.HttpResponse getPaymentsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page) throws IOException
      Throws:
      IOException
    • getPrepayment

      public Prepayments getPrepayment​(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOException
      Allows you to retrieve a specified prepayments

      200 - Success - return response of type Prepayments array for a specified Prepayment

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      prepaymentID - Unique identifier for a PrePayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      Prepayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPrepaymentForHttpResponse

      public com.google.api.client.http.HttpResponse getPrepaymentForHttpResponse​(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOException
      Throws:
      IOException
    • getPrepaymentHistory

      public HistoryRecords getPrepaymentHistory​(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOException
      Allows you to retrieve a history records of an Prepayment

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      prepaymentID - Unique identifier for a PrePayment
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPrepaymentHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getPrepaymentHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID prepaymentID) throws IOException
      Throws:
      IOException
    • getPrepayments

      public Prepayments getPrepayments​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Allows you to retrieve prepayments

      200 - Success - return response of type Prepayments array for all Prepayment

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      page - e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Prepayments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPrepaymentsForHttpResponse

      public com.google.api.client.http.HttpResponse getPrepaymentsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer page, Integer unitdp) throws IOException
      Throws:
      IOException
    • getPurchaseOrder

      public PurchaseOrders getPurchaseOrder​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Allows you to retrieve a specified purchase orders

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for a PurchaseOrder
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Throws:
      IOException
    • getPurchaseOrderAsPdf

      public ByteArrayInputStream getPurchaseOrderAsPdf​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Allows you to retrieve purchase orders as PDF files

      200 - Success - return response of byte array pdf version of specified Purchase Orders

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for an Purchase Order
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderAsPdfForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderAsPdfForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Throws:
      IOException
    • getPurchaseOrderAttachmentByFileName

      public ByteArrayInputStream getPurchaseOrderAttachmentByFileName​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachment on a Purchase Order by Filename

      200 - Success - return response of attachment for Purchase Order as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      fileName - Name of the attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getPurchaseOrderAttachmentById

      public ByteArrayInputStream getPurchaseOrderAttachmentById​(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve specific Attachment on purchase order

      200 - Success - return response of attachment for Account as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      attachmentID - Unique identifier for Attachment object
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getPurchaseOrderAttachments

      public Attachments getPurchaseOrderAttachments​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Allows you to retrieve attachments for purchase orders

      200 - Success - return response of type Attachments array of Purchase Orders

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Orders object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Throws:
      IOException
    • getPurchaseOrderByNumber

      public PurchaseOrders getPurchaseOrderByNumber​(String accessToken, String xeroTenantId, String purchaseOrderNumber) throws IOException
      Allows you to retrieve a specified purchase orders

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderNumber - Unique identifier for a PurchaseOrder
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderByNumberForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderByNumberForHttpResponse​(String accessToken, String xeroTenantId, String purchaseOrderNumber) throws IOException
      Throws:
      IOException
    • getPurchaseOrderHistory

      public HistoryRecords getPurchaseOrderHistory​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Allows you to retrieve history for PurchaseOrder

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for a PurchaseOrder
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrderHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrderHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID) throws IOException
      Throws:
      IOException
    • getPurchaseOrders

      public PurchaseOrders getPurchaseOrders​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page) throws IOException
      Allows you to retrieve purchase orders

      200 - Success - return response of type PurchaseOrder array of all PurchaseOrder

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      status - Filter by purchase order status
      dateFrom - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
      dateTo - Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
      order - Order by an any element
      page - To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getPurchaseOrdersForHttpResponse

      public com.google.api.client.http.HttpResponse getPurchaseOrdersForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String status, String dateFrom, String dateTo, String order, Integer page) throws IOException
      Throws:
      IOException
    • getQuote

      public Quotes getQuote​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Allows you to retrieve a specified quote

      200 - Success - return response of type Quotes array with specified Quote

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for an Quote
      accessToken - Authorization token for user set in header of each request
      Returns:
      Quotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Throws:
      IOException
    • getQuoteAsPdf

      public ByteArrayInputStream getQuoteAsPdf​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Allows you to retrieve quotes as PDF files

      200 - Success - return response of byte array pdf version of specified Quotes

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for an Quote
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteAsPdfForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteAsPdfForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Throws:
      IOException
    • getQuoteAttachmentByFileName

      public ByteArrayInputStream getQuoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachment on Quote by Filename

      200 - Success - return response of attachment for Quote as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      fileName - Name of the attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getQuoteAttachmentById

      public ByteArrayInputStream getQuoteAttachmentById​(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve specific Attachment on Quote

      200 - Success - return response of attachment for Quote as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      attachmentID - Unique identifier for Attachment object
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getQuoteAttachments

      public Attachments getQuoteAttachments​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Allows you to retrieve Attachments for Quotes

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Throws:
      IOException
    • getQuoteHistory

      public HistoryRecords getQuoteHistory​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Allows you to retrieve a history records of an quote

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for an Quote
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuoteHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getQuoteHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID) throws IOException
      Throws:
      IOException
    • getQuotes

      public Quotes getQuotes​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, org.threeten.bp.LocalDate dateFrom, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate expiryDateFrom, org.threeten.bp.LocalDate expiryDateTo, UUID contactID, String status, Integer page, String order, String quoteNumber) throws IOException
      Allows you to retrieve any sales quotes

      200 - Success - return response of type quotes array with all quotes

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      dateFrom - Filter for quotes after a particular date
      dateTo - Filter for quotes before a particular date
      expiryDateFrom - Filter for quotes expiring after a particular date
      expiryDateTo - Filter for quotes before a particular date
      contactID - Filter for quotes belonging to a particular contact
      status - Filter for quotes of a particular Status
      page - e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote
      order - Order by an any element
      quoteNumber - Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001)
      accessToken - Authorization token for user set in header of each request
      Returns:
      Quotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getQuotesForHttpResponse

      public com.google.api.client.http.HttpResponse getQuotesForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, org.threeten.bp.LocalDate dateFrom, org.threeten.bp.LocalDate dateTo, org.threeten.bp.LocalDate expiryDateFrom, org.threeten.bp.LocalDate expiryDateTo, UUID contactID, String status, Integer page, String order, String quoteNumber) throws IOException
      Throws:
      IOException
    • getReceipt

      public Receipts getReceipt​(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp) throws IOException
      Allows you to retrieve a specified draft expense claim receipts

      200 - Success - return response of type Receipts array for a specified Receipt

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Receipts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, Integer unitdp) throws IOException
      Throws:
      IOException
    • getReceiptAttachmentByFileName

      public ByteArrayInputStream getReceiptAttachmentByFileName​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType) throws IOException
      Allows you to retrieve Attachments on expense claim receipts by file name

      200 - Success - return response of attachment for Receipt as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      fileName - The name of the file being attached to the Receipt
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getReceiptAttachmentById

      public ByteArrayInputStream getReceiptAttachmentById​(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve Attachments on expense claim receipts by ID

      200 - Success - return response of attachment for Receipt as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      attachmentID - Unique identifier for a Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getReceiptAttachments

      public Attachments getReceiptAttachments​(String accessToken, String xeroTenantId, UUID receiptID) throws IOException
      Allows you to retrieve Attachments for expense claim receipts

      200 - Success - return response of type Attachments array of Attachments for a specified Receipt

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID) throws IOException
      Throws:
      IOException
    • getReceiptHistory

      public HistoryRecords getReceiptHistory​(String accessToken, String xeroTenantId, UUID receiptID) throws IOException
      Allows you to retrieve a history records of an Receipt

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID) throws IOException
      Throws:
      IOException
    • getReceipts

      public Receipts getReceipts​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
      Allows you to retrieve draft expense claim receipts for any user

      200 - Success - return response of type Receipts array for all Receipt

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Receipts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReceiptsForHttpResponse

      public com.google.api.client.http.HttpResponse getReceiptsForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order, Integer unitdp) throws IOException
      Throws:
      IOException
    • getRepeatingInvoice

      public RepeatingInvoices getRepeatingInvoice​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Allows you to retrieve a specified repeating invoice

      200 - Success - return response of type Repeating Invoices array with a specified Repeating Invoice

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      RepeatingInvoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoiceForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoiceForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Throws:
      IOException
    • getRepeatingInvoiceAttachmentByFileName

      public ByteArrayInputStream getRepeatingInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType) throws IOException
      Allows you to retrieve specified attachment on repeating invoices by file name

      200 - Success - return response of attachment for Repeating Invoice as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      fileName - The name of the file being attached to a Repeating Invoice
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, String contentType) throws IOException
      Throws:
      IOException
    • getRepeatingInvoiceAttachmentById

      public ByteArrayInputStream getRepeatingInvoiceAttachmentById​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType) throws IOException
      Allows you to retrieve a specified Attachments on repeating invoices

      200 - Success - return response of attachment for Repeating Invoice as binary data

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      attachmentID - Unique identifier for a Attachment
      contentType - The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
      accessToken - Authorization token for user set in header of each request
      Returns:
      File
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoiceAttachmentByIdForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentByIdForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, UUID attachmentID, String contentType) throws IOException
      Throws:
      IOException
    • getRepeatingInvoiceAttachments

      public Attachments getRepeatingInvoiceAttachments​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Allows you to retrieve Attachments on repeating invoice

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoiceAttachmentsForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoiceAttachmentsForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Throws:
      IOException
    • getRepeatingInvoiceHistory

      public HistoryRecords getRepeatingInvoiceHistory​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Allows you to retrieve history for a repeating invoice

      200 - Success - return response of HistoryRecords array of 0 to N HistoryRecord

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      accessToken - Authorization token for user set in header of each request
      Returns:
      HistoryRecords
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoiceHistoryForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoiceHistoryForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID) throws IOException
      Throws:
      IOException
    • getRepeatingInvoices

      public RepeatingInvoices getRepeatingInvoices​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Allows you to retrieve any repeating invoices

      200 - Success - return response of type Repeating Invoices array for all Repeating Invoice

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      RepeatingInvoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getRepeatingInvoicesForHttpResponse

      public com.google.api.client.http.HttpResponse getRepeatingInvoicesForHttpResponse​(String accessToken, String xeroTenantId, String where, String order) throws IOException
      Throws:
      IOException
    • getReportAgedPayablesByContact

      public ReportWithRows getReportAgedPayablesByContact​(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Allows you to retrieve report for AgedPayablesByContact

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactId - Unique identifier for a Contact
      date - The date of the Aged Payables By Contact report
      fromDate - The from date of the Aged Payables By Contact report
      toDate - The to date of the Aged Payables By Contact report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportAgedPayablesByContactForHttpResponse

      public com.google.api.client.http.HttpResponse getReportAgedPayablesByContactForHttpResponse​(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Throws:
      IOException
    • getReportAgedReceivablesByContact

      public ReportWithRows getReportAgedReceivablesByContact​(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Allows you to retrieve report for AgedReceivablesByContact

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactId - Unique identifier for a Contact
      date - The date of the Aged Receivables By Contact report
      fromDate - The from date of the Aged Receivables By Contact report
      toDate - The to date of the Aged Receivables By Contact report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportAgedReceivablesByContactForHttpResponse

      public com.google.api.client.http.HttpResponse getReportAgedReceivablesByContactForHttpResponse​(String accessToken, String xeroTenantId, UUID contactId, org.threeten.bp.LocalDate date, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Throws:
      IOException
    • getReportBASorGST

      public ReportWithRows getReportBASorGST​(String accessToken, String xeroTenantId, String reportID) throws IOException
      Allows you to retrieve report for BAS only valid for AU orgs

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      reportID - Unique identifier for a Report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportBASorGSTForHttpResponse

      public com.google.api.client.http.HttpResponse getReportBASorGSTForHttpResponse​(String accessToken, String xeroTenantId, String reportID) throws IOException
      Throws:
      IOException
    • getReportBASorGSTList

      public ReportWithRows getReportBASorGSTList​(String accessToken, String xeroTenantId) throws IOException
      Allows you to retrieve report for BAS only valid for AU orgs

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportBASorGSTListForHttpResponse

      public com.google.api.client.http.HttpResponse getReportBASorGSTListForHttpResponse​(String accessToken, String xeroTenantId) throws IOException
      Throws:
      IOException
    • getReportBalanceSheet

      public ReportWithRows getReportBalanceSheet​(String accessToken, String xeroTenantId, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
      Allows you to retrieve report for BalanceSheet

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      date - The date of the Balance Sheet report
      periods - The number of periods for the Balance Sheet report
      timeframe - The period size to compare to (MONTH, QUARTER, YEAR)
      trackingOptionID1 - The tracking option 1 for the Balance Sheet report
      trackingOptionID2 - The tracking option 2 for the Balance Sheet report
      standardLayout - The standard layout boolean for the Balance Sheet report
      paymentsOnly - return a cash basis for the Balance Sheet report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportBalanceSheetForHttpResponse

      public com.google.api.client.http.HttpResponse getReportBalanceSheetForHttpResponse​(String accessToken, String xeroTenantId, String date, Integer periods, String timeframe, String trackingOptionID1, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
      Throws:
      IOException
    • getReportBankSummary

      public ReportWithRows getReportBankSummary​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Allows you to retrieve report for BankSummary

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      fromDate - The from date for the Bank Summary report e.g. 2018-03-31
      toDate - The to date for the Bank Summary report e.g. 2018-03-31
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportBankSummaryForHttpResponse

      public com.google.api.client.http.HttpResponse getReportBankSummaryForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate) throws IOException
      Throws:
      IOException
    • getReportBudgetSummary

      public ReportWithRows getReportBudgetSummary​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer period, Integer timeframe) throws IOException
      Allows you to retrieve report for Budget Summary

      200 - success- return a Report with Rows object

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      date - The date for the Bank Summary report e.g. 2018-03-31
      period - The number of periods to compare (integer between 1 and 12)
      timeframe - The period size to compare to (1=month, 3=quarter, 12=year)
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportBudgetSummaryForHttpResponse

      public com.google.api.client.http.HttpResponse getReportBudgetSummaryForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Integer period, Integer timeframe) throws IOException
      Throws:
      IOException
    • getReportExecutiveSummary

      public ReportWithRows getReportExecutiveSummary​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date) throws IOException
      Allows you to retrieve report for ExecutiveSummary

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      date - The date for the Bank Summary report e.g. 2018-03-31
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportExecutiveSummaryForHttpResponse

      public com.google.api.client.http.HttpResponse getReportExecutiveSummaryForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date) throws IOException
      Throws:
      IOException
    • getReportProfitAndLoss

      public ReportWithRows getReportProfitAndLoss​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
      Allows you to retrieve report for ProfitAndLoss

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      fromDate - The from date for the ProfitAndLoss report e.g. 2018-03-31
      toDate - The to date for the ProfitAndLoss report e.g. 2018-03-31
      periods - The number of periods to compare (integer between 1 and 12)
      timeframe - The period size to compare to (MONTH, QUARTER, YEAR)
      trackingCategoryID - The trackingCategory 1 for the ProfitAndLoss report
      trackingCategoryID2 - The trackingCategory 2 for the ProfitAndLoss report
      trackingOptionID - The tracking option 1 for the ProfitAndLoss report
      trackingOptionID2 - The tracking option 2 for the ProfitAndLoss report
      standardLayout - Return the standard layout for the ProfitAndLoss report
      paymentsOnly - Return cash only basis for the ProfitAndLoss report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportProfitAndLossForHttpResponse

      public com.google.api.client.http.HttpResponse getReportProfitAndLossForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate fromDate, org.threeten.bp.LocalDate toDate, Integer periods, String timeframe, String trackingCategoryID, String trackingCategoryID2, String trackingOptionID, String trackingOptionID2, Boolean standardLayout, Boolean paymentsOnly) throws IOException
      Throws:
      IOException
    • getReportTenNinetyNine

      public Reports getReportTenNinetyNine​(String accessToken, String xeroTenantId, String reportYear) throws IOException
      Allows you to retrieve report for TenNinetyNine

      200 - Success - return response of type Reports

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      reportYear - The year of the 1099 report
      accessToken - Authorization token for user set in header of each request
      Returns:
      Reports
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportTenNinetyNineForHttpResponse

      public com.google.api.client.http.HttpResponse getReportTenNinetyNineForHttpResponse​(String accessToken, String xeroTenantId, String reportYear) throws IOException
      Throws:
      IOException
    • getReportTrialBalance

      public ReportWithRows getReportTrialBalance​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly) throws IOException
      Allows you to retrieve report for TrialBalance

      200 - Success - return response of type ReportWithRows

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      date - The date for the Trial Balance report e.g. 2018-03-31
      paymentsOnly - Return cash only basis for the Trial Balance report
      accessToken - Authorization token for user set in header of each request
      Returns:
      ReportWithRows
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getReportTrialBalanceForHttpResponse

      public com.google.api.client.http.HttpResponse getReportTrialBalanceForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.LocalDate date, Boolean paymentsOnly) throws IOException
      Throws:
      IOException
    • getTaxRates

      public TaxRates getTaxRates​(String accessToken, String xeroTenantId, String where, String order, String taxType) throws IOException
      Allows you to retrieve Tax Rates

      200 - Success - return response of type TaxRates array with TaxRates

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      where - Filter by an any element
      order - Order by an any element
      taxType - Filter by tax type
      accessToken - Authorization token for user set in header of each request
      Returns:
      TaxRates
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getTaxRatesForHttpResponse

      public com.google.api.client.http.HttpResponse getTaxRatesForHttpResponse​(String accessToken, String xeroTenantId, String where, String order, String taxType) throws IOException
      Throws:
      IOException
    • getTrackingCategories

      public TrackingCategories getTrackingCategories​(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived) throws IOException
      Allows you to retrieve tracking categories and options

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      where - Filter by an any element
      order - Order by an any element
      includeArchived - e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingCategories
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getTrackingCategoriesForHttpResponse

      public com.google.api.client.http.HttpResponse getTrackingCategoriesForHttpResponse​(String accessToken, String xeroTenantId, String where, String order, Boolean includeArchived) throws IOException
      Throws:
      IOException
    • getTrackingCategory

      public TrackingCategories getTrackingCategory​(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOException
      Allows you to retrieve tracking categories and options for specified category

      200 - Success - return response of type TrackingCategories array of specified TrackingCategory

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingCategories
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getTrackingCategoryForHttpResponse

      public com.google.api.client.http.HttpResponse getTrackingCategoryForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID) throws IOException
      Throws:
      IOException
    • getUser

      public Users getUser​(String accessToken, String xeroTenantId, UUID userID) throws IOException
      Allows you to retrieve a specified user

      200 - Success - return response of type Users array of specified User

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      userID - Unique identifier for a User
      accessToken - Authorization token for user set in header of each request
      Returns:
      Users
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getUserForHttpResponse

      public com.google.api.client.http.HttpResponse getUserForHttpResponse​(String accessToken, String xeroTenantId, UUID userID) throws IOException
      Throws:
      IOException
    • getUsers

      public Users getUsers​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Allows you to retrieve users

      200 - Success - return response of type Users array of all User

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      ifModifiedSince - Only records created or modified since this timestamp will be returned
      where - Filter by an any element
      order - Order by an any element
      accessToken - Authorization token for user set in header of each request
      Returns:
      Users
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • getUsersForHttpResponse

      public com.google.api.client.http.HttpResponse getUsersForHttpResponse​(String accessToken, String xeroTenantId, org.threeten.bp.OffsetDateTime ifModifiedSince, String where, String order) throws IOException
      Throws:
      IOException
    • postSetup

      public ImportSummary postSetup​(String accessToken, String xeroTenantId, Setup setup) throws IOException
      Allows you to set the chart of accounts, the conversion date and conversion balances

      200 - Success - returns a summary of the chart of accounts updates

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      setup - Object including an accounts array, a conversion balances array and a conversion date object in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      ImportSummary
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • postSetupForHttpResponse

      public com.google.api.client.http.HttpResponse postSetupForHttpResponse​(String accessToken, String xeroTenantId, Setup setup) throws IOException
      Throws:
      IOException
    • updateAccount

      public Accounts updateAccount​(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts) throws IOException
      Allows you to update a chart of accounts

      200 - Success - update existing Account and return response of type Accounts array with updated Account

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for retrieving single object
      accounts - Request of type Accounts array with one Account
      accessToken - Authorization token for user set in header of each request
      Returns:
      Accounts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateAccountForHttpResponse

      public com.google.api.client.http.HttpResponse updateAccountForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, Accounts accounts) throws IOException
      Throws:
      IOException
    • updateAccountAttachmentByFileName

      public Attachments updateAccountAttachmentByFileName​(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachment on Account by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateAccountAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateAccountAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateAccountAttachmentByFileName

      public Attachments updateAccountAttachmentByFileName​(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOException
      Allows you to update Attachment on Account by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      accountID - Unique identifier for Account object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateAccountAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateAccountAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID accountID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateBankTransaction

      public BankTransactions updateBankTransaction​(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp) throws IOException
      Allows you to update a single spend or receive money transaction

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      bankTransactions - The bankTransactions parameter
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateBankTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse updateBankTransactionForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, BankTransactions bankTransactions, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateBankTransactionAttachmentByFileName

      public Attachments updateBankTransactionAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update an Attachment on BankTransaction by Filename

      200 - Success - return response of Attachments array of Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      fileName - The name of the file being attached
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateBankTransactionAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateBankTransactionAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateBankTransactionAttachmentByFileName

      public Attachments updateBankTransactionAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOException
      Allows you to update an Attachment on BankTransaction by Filename

      200 - Success - return response of Attachments array of Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactionID - Xero generated unique identifier for a bank transaction
      fileName - The name of the file being attached
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateBankTransactionAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateBankTransactionAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransactionID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateBankTransferAttachmentByFileName

      public Attachments updateBankTransferAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType) throws IOException
      200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      fileName - The name of the file being attached to a Bank Transfer
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateBankTransferAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateBankTransferAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateBankTransferAttachmentByFileName

      public Attachments updateBankTransferAttachmentByFileName​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException
      200 - Success - return response of Attachments array of 0 to N Attachment for a Bank Transfer

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransferID - Xero generated unique identifier for a bank transfer
      fileName - The name of the file being attached to a Bank Transfer
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateBankTransferAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateBankTransferAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID bankTransferID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateContact

      public Contacts updateContact​(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts) throws IOException
      200 - Success - return response of type Contacts array with an updated Contact

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      contacts - an array of Contacts containing single Contact object with properties to update
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateContactForHttpResponse

      public com.google.api.client.http.HttpResponse updateContactForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, Contacts contacts) throws IOException
      Throws:
      IOException
    • updateContactAttachmentByFileName

      public Attachments updateContactAttachmentByFileName​(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType) throws IOException
      200 - Success - return response of type Attachments array with an updated Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      fileName - Name for the file you are attaching
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateContactAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateContactAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateContactAttachmentByFileName

      public Attachments updateContactAttachmentByFileName​(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException
      200 - Success - return response of type Attachments array with an updated Attachment

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactID - Unique identifier for a Contact
      fileName - Name for the file you are attaching
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateContactAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateContactAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID contactID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateContactGroup

      public ContactGroups updateContactGroup​(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups) throws IOException
      Allows you to update a Contact Group

      200 - Success - return response of type Contact Groups array of updated Contact Group

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contactGroupID - Unique identifier for a Contact Group
      contactGroups - an array of Contact groups with Name of specific group to update
      accessToken - Authorization token for user set in header of each request
      Returns:
      ContactGroups
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateContactGroupForHttpResponse

      public com.google.api.client.http.HttpResponse updateContactGroupForHttpResponse​(String accessToken, String xeroTenantId, UUID contactGroupID, ContactGroups contactGroups) throws IOException
      Throws:
      IOException
    • updateCreditNote

      public CreditNotes updateCreditNote​(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp) throws IOException
      Allows you to update a specific credit note

      200 - Success - return response of type Credit Notes array with updated CreditNote

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      creditNotes - an array of Credit Notes containing credit note details to update
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      CreditNotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateCreditNoteForHttpResponse

      public com.google.api.client.http.HttpResponse updateCreditNoteForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, CreditNotes creditNotes, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateCreditNoteAttachmentByFileName

      public Attachments updateCreditNoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachments on CreditNote by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      fileName - Name of the file you are attaching to Credit Note
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateCreditNoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateCreditNoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateCreditNoteAttachmentByFileName

      public Attachments updateCreditNoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body) throws IOException
      Allows you to update Attachments on CreditNote by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNoteID - Unique identifier for a Credit Note
      fileName - Name of the file you are attaching to Credit Note
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateCreditNoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateCreditNoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID creditNoteID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateExpenseClaim

      public ExpenseClaims updateExpenseClaim​(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims) throws IOException
      Allows you to update specified expense claims

      200 - Success - return response of type ExpenseClaims array with updated ExpenseClaim

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      expenseClaimID - Unique identifier for a ExpenseClaim
      expenseClaims - The expenseClaims parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      ExpenseClaims
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateExpenseClaimForHttpResponse

      public com.google.api.client.http.HttpResponse updateExpenseClaimForHttpResponse​(String accessToken, String xeroTenantId, UUID expenseClaimID, ExpenseClaims expenseClaims) throws IOException
      Throws:
      IOException
    • updateInvoice

      public Invoices updateInvoice​(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp) throws IOException
      Allows you to update a specified sales invoices or purchase bills

      200 - Success - return response of type Invoices array with updated Invoice

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      invoices - The invoices parameter
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Invoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateInvoiceForHttpResponse

      public com.google.api.client.http.HttpResponse updateInvoiceForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, Invoices invoices, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateInvoiceAttachmentByFileName

      public Attachments updateInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachment on invoices or purchase bills by it's filename

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      fileName - Name of the file you are attaching
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateInvoiceAttachmentByFileName

      public Attachments updateInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body) throws IOException
      Allows you to update Attachment on invoices or purchase bills by it's filename

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoiceID - Unique identifier for an Invoice
      fileName - Name of the file you are attaching
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID invoiceID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateItem

      public Items updateItem​(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp) throws IOException
      Allows you to update a specified item

      200 - Success - return response of type Items array with updated Item

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      itemID - Unique identifier for an Item
      items - The items parameter
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Items
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateItemForHttpResponse

      public com.google.api.client.http.HttpResponse updateItemForHttpResponse​(String accessToken, String xeroTenantId, UUID itemID, Items items, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateLinkedTransaction

      public LinkedTransactions updateLinkedTransaction​(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions) throws IOException
      Allows you to update a specified linked transactions (billable expenses)

      200 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

      400 - Success - return response of type LinkedTransactions array with updated LinkedTransaction

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      linkedTransactionID - Unique identifier for a LinkedTransaction
      linkedTransactions - The linkedTransactions parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      LinkedTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateLinkedTransactionForHttpResponse

      public com.google.api.client.http.HttpResponse updateLinkedTransactionForHttpResponse​(String accessToken, String xeroTenantId, UUID linkedTransactionID, LinkedTransactions linkedTransactions) throws IOException
      Throws:
      IOException
    • updateManualJournal

      public ManualJournals updateManualJournal​(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals) throws IOException
      Allows you to update a specified manual journal

      200 - Success - return response of type ManualJournals array with an updated ManualJournal

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      manualJournals - The manualJournals parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      ManualJournals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateManualJournalForHttpResponse

      public com.google.api.client.http.HttpResponse updateManualJournalForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, ManualJournals manualJournals) throws IOException
      Throws:
      IOException
    • updateManualJournalAttachmentByFileName

      public Attachments updateManualJournalAttachmentByFileName​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update a specified Attachment on ManualJournal by file name

      200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      fileName - The name of the file being attached to a ManualJournal
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateManualJournalAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateManualJournalAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateManualJournalAttachmentByFileName

      public Attachments updateManualJournalAttachmentByFileName​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOException
      Allows you to update a specified Attachment on ManualJournal by file name

      200 - Success - return response of type Attachments array with an update Attachment for a ManualJournals

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournalID - Unique identifier for a ManualJournal
      fileName - The name of the file being attached to a ManualJournal
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateManualJournalAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateManualJournalAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID manualJournalID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateOrCreateBankTransactions

      public BankTransactions updateOrCreateBankTransactions​(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to update or create one or more spend or receive money transaction

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      bankTransactions - The bankTransactions parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      BankTransactions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateBankTransactionsForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateBankTransactionsForHttpResponse​(String accessToken, String xeroTenantId, BankTransactions bankTransactions, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateOrCreateContacts

      public Contacts updateOrCreateContacts​(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOException
      Allows you to update OR create one or more contacts in a Xero organisation

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      contacts - The contacts parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Contacts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateContactsForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateContactsForHttpResponse​(String accessToken, String xeroTenantId, Contacts contacts, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • updateOrCreateCreditNotes

      public CreditNotes updateOrCreateCreditNotes​(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to update OR create one or more credit notes

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      creditNotes - an array of Credit Notes with a single CreditNote object.
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      CreditNotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateCreditNotesForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateCreditNotesForHttpResponse​(String accessToken, String xeroTenantId, CreditNotes creditNotes, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateOrCreateEmployees

      public Employees updateOrCreateEmployees​(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOException
      Allows you to create a single new employees used in Xero payrun

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      employees - Employees with array of Employee object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Employees
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateEmployeesForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateEmployeesForHttpResponse​(String accessToken, String xeroTenantId, Employees employees, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • updateOrCreateInvoices

      public Invoices updateOrCreateInvoices​(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to update OR create one or more sales invoices or purchase bills

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      invoices - The invoices parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Invoices
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateInvoicesForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateInvoicesForHttpResponse​(String accessToken, String xeroTenantId, Invoices invoices, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateOrCreateItems

      public Items updateOrCreateItems​(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOException
      Allows you to update or create one or more items

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      items - The items parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Items
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateItemsForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateItemsForHttpResponse​(String accessToken, String xeroTenantId, Items items, Boolean summarizeErrors, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateOrCreateManualJournals

      public ManualJournals updateOrCreateManualJournals​(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOException
      Allows you to create a single manual journal

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      manualJournals - ManualJournals array with ManualJournal object in body of request
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      ManualJournals
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateManualJournalsForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateManualJournalsForHttpResponse​(String accessToken, String xeroTenantId, ManualJournals manualJournals, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • updateOrCreatePurchaseOrders

      public PurchaseOrders updateOrCreatePurchaseOrders​(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOException
      Allows you to update or create one or more purchase orders

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrders - The purchaseOrders parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreatePurchaseOrdersForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreatePurchaseOrdersForHttpResponse​(String accessToken, String xeroTenantId, PurchaseOrders purchaseOrders, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • updateOrCreateQuotes

      public Quotes updateOrCreateQuotes​(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOException
      Allows you to update OR create one or more quotes

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quotes - The quotes parameter
      summarizeErrors - If false return 200 OK and mix of successfully created objects and any with validation errors
      accessToken - Authorization token for user set in header of each request
      Returns:
      Quotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateOrCreateQuotesForHttpResponse

      public com.google.api.client.http.HttpResponse updateOrCreateQuotesForHttpResponse​(String accessToken, String xeroTenantId, Quotes quotes, Boolean summarizeErrors) throws IOException
      Throws:
      IOException
    • updatePurchaseOrder

      public PurchaseOrders updatePurchaseOrder​(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders) throws IOException
      Allows you to update a specified purchase order

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for a PurchaseOrder
      purchaseOrders - The purchaseOrders parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      PurchaseOrders
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updatePurchaseOrderForHttpResponse

      public com.google.api.client.http.HttpResponse updatePurchaseOrderForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, PurchaseOrders purchaseOrders) throws IOException
      Throws:
      IOException
    • updatePurchaseOrderAttachmentByFileName

      public Attachments updatePurchaseOrderAttachmentByFileName​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachment on Purchase Order by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updatePurchaseOrderAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updatePurchaseOrderAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updatePurchaseOrderAttachmentByFileName

      public Attachments updatePurchaseOrderAttachmentByFileName​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOException
      Allows you to update Attachment on Purchase Order by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      purchaseOrderID - Unique identifier for Purchase Order object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updatePurchaseOrderAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updatePurchaseOrderAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID purchaseOrderID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateQuote

      public Quotes updateQuote​(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes) throws IOException
      Allows you to update a specified quote

      200 - Success - return response of type Quotes array with updated Quote

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for an Quote
      quotes - The quotes parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      Quotes
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateQuoteForHttpResponse

      public com.google.api.client.http.HttpResponse updateQuoteForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, Quotes quotes) throws IOException
      Throws:
      IOException
    • updateQuoteAttachmentByFileName

      public Attachments updateQuoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachment on Quote by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateQuoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateQuoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateQuoteAttachmentByFileName

      public Attachments updateQuoteAttachmentByFileName​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOException
      Allows you to update Attachment on Quote by Filename

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

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

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      quoteID - Unique identifier for Quote object
      fileName - Name of the attachment
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateQuoteAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateQuoteAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID quoteID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateReceipt

      public Receipts updateReceipt​(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp) throws IOException
      Allows you to retrieve a specified draft expense claim receipts

      200 - Success - return response of type Receipts array for updated Receipt

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      receipts - The receipts parameter
      unitdp - e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
      accessToken - Authorization token for user set in header of each request
      Returns:
      Receipts
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateReceiptForHttpResponse

      public com.google.api.client.http.HttpResponse updateReceiptForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, Receipts receipts, Integer unitdp) throws IOException
      Throws:
      IOException
    • updateReceiptAttachmentByFileName

      public Attachments updateReceiptAttachmentByFileName​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update Attachment on expense claim receipts by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      fileName - The name of the file being attached to the Receipt
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateReceiptAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateReceiptAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateReceiptAttachmentByFileName

      public Attachments updateReceiptAttachmentByFileName​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOException
      Allows you to update Attachment on expense claim receipts by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      receiptID - Unique identifier for a Receipt
      fileName - The name of the file being attached to the Receipt
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateReceiptAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateReceiptAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID receiptID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateRepeatingInvoiceAttachmentByFileName

      public Attachments updateRepeatingInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType) throws IOException
      Allows you to update specified attachment on repeating invoices by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      fileName - The name of the file being attached to a Repeating Invoice
      body - Byte array of file in body of request
      mimeType - The type of file being attached
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateRepeatingInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateRepeatingInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, byte[] body, String mimeType) throws IOException
      Throws:
      IOException
    • updateRepeatingInvoiceAttachmentByFileName

      public Attachments updateRepeatingInvoiceAttachmentByFileName​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOException
      Allows you to update specified attachment on repeating invoices by file name

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      repeatingInvoiceID - Unique identifier for a Repeating Invoice
      fileName - The name of the file being attached to a Repeating Invoice
      body - Byte array of file in body of request
      accessToken - Authorization token for user set in header of each request
      Returns:
      Attachments
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateRepeatingInvoiceAttachmentByFileNameForHttpResponse

      public com.google.api.client.http.HttpResponse updateRepeatingInvoiceAttachmentByFileNameForHttpResponse​(String accessToken, String xeroTenantId, UUID repeatingInvoiceID, String fileName, File body) throws IOException
      Throws:
      IOException
    • updateTaxRate

      public TaxRates updateTaxRate​(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOException
      Allows you to update Tax Rates

      200 - Success - return response of type TaxRates array updated TaxRate

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      taxRates - The taxRates parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      TaxRates
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateTaxRateForHttpResponse

      public com.google.api.client.http.HttpResponse updateTaxRateForHttpResponse​(String accessToken, String xeroTenantId, TaxRates taxRates) throws IOException
      Throws:
      IOException
    • updateTrackingCategory

      public TrackingCategories updateTrackingCategory​(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory) throws IOException
      Allows you to update tracking categories

      200 - Success - return response of type TrackingCategories array of updated TrackingCategory

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      trackingCategory - The trackingCategory parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingCategories
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateTrackingCategoryForHttpResponse

      public com.google.api.client.http.HttpResponse updateTrackingCategoryForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID, TrackingCategory trackingCategory) throws IOException
      Throws:
      IOException
    • updateTrackingOptions

      public TrackingOptions updateTrackingOptions​(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption) throws IOException
      Allows you to update options for a specified tracking category

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

      400 - A failed request due to validation error

      Parameters:
      xeroTenantId - Xero identifier for Tenant
      trackingCategoryID - Unique identifier for a TrackingCategory
      trackingOptionID - Unique identifier for a Tracking Option
      trackingOption - The trackingOption parameter
      accessToken - Authorization token for user set in header of each request
      Returns:
      TrackingOptions
      Throws:
      IOException - if an error occurs while attempting to invoke the API
    • updateTrackingOptionsForHttpResponse

      public com.google.api.client.http.HttpResponse updateTrackingOptionsForHttpResponse​(String accessToken, String xeroTenantId, UUID trackingCategoryID, UUID trackingOptionID, TrackingOption trackingOption) throws IOException
      Throws:
      IOException
    • convertInputToByteArray

      public ByteArrayInputStream convertInputToByteArray​(InputStream is) throws IOException
      Throws:
      IOException