Package com.xero.api.client

Class FinanceApi

java.lang.Object

com.xero.api.client.FinanceApi

public class FinanceApi
extends Object

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

Constructor Summary

Constructors

Constructor	Description
FinanceApi()	FinanceApi
FinanceApi(ApiClient apiClient)	FinanceApi

Method Summary

Modifier and Type	Method	Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
AccountUsageResponse	getAccountingActivityAccountUsage(String accessToken, String xeroTenantId, String startMonth, String endMonth)	Get account usage A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
com.google.api.client.http.HttpResponse	getAccountingActivityAccountUsageForHttpResponse(String accessToken, String xeroTenantId, String startMonth, String endMonth)	Get account usage A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
LockHistoryResponse	getAccountingActivityLockHistory(String accessToken, String xeroTenantId, String endDate)	Get lock history Provides a history of locking of accounting books.
com.google.api.client.http.HttpResponse	getAccountingActivityLockHistoryForHttpResponse(String accessToken, String xeroTenantId, String endDate)	Get lock history Provides a history of locking of accounting books.
ReportHistoryResponse	getAccountingActivityReportHistory(String accessToken, String xeroTenantId, String endDate)	Get report history For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.
com.google.api.client.http.HttpResponse	getAccountingActivityReportHistoryForHttpResponse(String accessToken, String xeroTenantId, String endDate)	Get report history For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.
UserActivitiesResponse	getAccountingActivityUserActivities(String accessToken, String xeroTenantId, String dataMonth)	Get user activities For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions.
com.google.api.client.http.HttpResponse	getAccountingActivityUserActivitiesForHttpResponse(String accessToken, String xeroTenantId, String dataMonth)	Get user activities For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions.
ApiClient	getApiClient()	get ApiClient
BankStatementAccountingResponse	getBankStatementAccounting(String accessToken, String xeroTenantId, UUID bankAccountID, String fromDate, String toDate, Boolean summaryOnly)	Get Bank Statement Accounting For lenders that prefer using bank statement data as the source of truth.
com.google.api.client.http.HttpResponse	getBankStatementAccountingForHttpResponse(String accessToken, String xeroTenantId, UUID bankAccountID, String fromDate, String toDate, Boolean summaryOnly)	Get Bank Statement Accounting For lenders that prefer using bank statement data as the source of truth.
List<CashValidationResponse>	getCashValidation(String accessToken, String xeroTenantId, String balanceDate, String asAtSystemDate, String beginDate)	Get cash validation Summarizes the total cash position for each account for an org
com.google.api.client.http.HttpResponse	getCashValidationForHttpResponse(String accessToken, String xeroTenantId, String balanceDate, String asAtSystemDate, String beginDate)	Get cash validation Summarizes the total cash position for each account for an org
BalanceSheetResponse	getFinancialStatementBalanceSheet(String accessToken, String xeroTenantId, String balanceDate)	Get Balance Sheet report The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
com.google.api.client.http.HttpResponse	getFinancialStatementBalanceSheetForHttpResponse(String accessToken, String xeroTenantId, String balanceDate)	Get Balance Sheet report The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.
CashflowResponse	getFinancialStatementCashflow(String accessToken, String xeroTenantId, String startDate, String endDate)	Get Cash flow report The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation.
com.google.api.client.http.HttpResponse	getFinancialStatementCashflowForHttpResponse(String accessToken, String xeroTenantId, String startDate, String endDate)	Get Cash flow report The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation.
IncomeByContactResponse	getFinancialStatementContactsExpense(String accessToken, String xeroTenantId, List<UUID> contactIds, Boolean includeManualJournals, String startDate, String endDate)	Get expense by contacts report The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
com.google.api.client.http.HttpResponse	getFinancialStatementContactsExpenseForHttpResponse(String accessToken, String xeroTenantId, List<UUID> contactIds, Boolean includeManualJournals, String startDate, String endDate)	Get expense by contacts report The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
IncomeByContactResponse	getFinancialStatementContactsRevenue(String accessToken, String xeroTenantId, List<UUID> contactIds, Boolean includeManualJournals, String startDate, String endDate)	Get revenue by contacts report The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
com.google.api.client.http.HttpResponse	getFinancialStatementContactsRevenueForHttpResponse(String accessToken, String xeroTenantId, List<UUID> contactIds, Boolean includeManualJournals, String startDate, String endDate)	Get revenue by contacts report The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.
ProfitAndLossResponse	getFinancialStatementProfitAndLoss(String accessToken, String xeroTenantId, String startDate, String endDate)	Get Profit & Loss report The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
com.google.api.client.http.HttpResponse	getFinancialStatementProfitAndLossForHttpResponse(String accessToken, String xeroTenantId, String startDate, String endDate)	Get Profit & Loss report The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.
TrialBalanceResponse	getFinancialStatementTrialBalance(String accessToken, String xeroTenantId, String endDate)	Get Trial Balance report The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
com.google.api.client.http.HttpResponse	getFinancialStatementTrialBalanceForHttpResponse(String accessToken, String xeroTenantId, String endDate)	Get Trial Balance report The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.
static FinanceApi	getInstance(ApiClient apiClient)	FinanceApi getInstance
String	getUserAgent()	get user agent
void	setApiClient(ApiClient apiClient)	set ApiClient
void	setUserAgent(String userAgent)	set user agent

Methods inherited from class java.lang.Object

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

Constructor Details

FinanceApi

public FinanceApi()

FinanceApi

FinanceApi

public FinanceApi(ApiClient apiClient)

FinanceApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Details

getInstance

public static FinanceApi getInstance(ApiClient apiClient)

FinanceApi getInstance

Parameters:

apiClient - ApiClient pass into the new instance of this class

Returns:

instance of this class

getApiClient

public ApiClient getApiClient()

get ApiClient

Returns:

apiClient the current ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

set ApiClient

Parameters:

apiClient - ApiClient pass into the new instance of this class

setUserAgent

public void setUserAgent(String userAgent)

set user agent

Parameters:

userAgent - string to override the user agent

getUserAgent

public String getUserAgent()

get user agent

Returns:

String of user agent

getAccountingActivityAccountUsage

public AccountUsageResponse getAccountingActivityAccountUsage(String accessToken,
 String xeroTenantId,
 String startMonth,
 String endMonth)
                                                       throws IOException

Get account usage A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startMonth - date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned.

endMonth - date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned.

Returns:

AccountUsageResponse

Throws:

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

getAccountingActivityAccountUsageForHttpResponse

public com.google.api.client.http.HttpResponse getAccountingActivityAccountUsageForHttpResponse(String accessToken,
 String xeroTenantId,
 String startMonth,
 String endMonth)
                                                                                         throws IOException

Get account usage A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startMonth - date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned.

endMonth - date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned.

Returns:

HttpResponse

Throws:

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

getAccountingActivityLockHistory

public LockHistoryResponse getAccountingActivityLockHistory(String accessToken,
 String xeroTenantId,
 String endDate)
                                                     throws IOException

Get lock history Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API.

Returns:

LockHistoryResponse

Throws:

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

getAccountingActivityLockHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getAccountingActivityLockHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 String endDate)
                                                                                        throws IOException

Get lock history Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API.

Returns:

HttpResponse

Throws:

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

getAccountingActivityReportHistory

public ReportHistoryResponse getAccountingActivityReportHistory(String accessToken,
 String xeroTenantId,
 String endDate)
                                                         throws IOException

Get report history For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.

Returns:

ReportHistoryResponse

Throws:

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

getAccountingActivityReportHistoryForHttpResponse

public com.google.api.client.http.HttpResponse getAccountingActivityReportHistoryForHttpResponse(String accessToken,
 String xeroTenantId,
 String endDate)
                                                                                          throws IOException

Get report history For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.

Returns:

HttpResponse

Throws:

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

getAccountingActivityUserActivities

public UserActivitiesResponse getAccountingActivityUserActivities(String accessToken,
 String xeroTenantId,
 String dataMonth)
                                                           throws IOException

Get user activities For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

dataMonth - date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.

Returns:

UserActivitiesResponse

Throws:

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

getAccountingActivityUserActivitiesForHttpResponse

public com.google.api.client.http.HttpResponse getAccountingActivityUserActivitiesForHttpResponse(String accessToken,
 String xeroTenantId,
 String dataMonth)
                                                                                           throws IOException

Get user activities For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

dataMonth - date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.

Returns:

HttpResponse

Throws:

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

getBankStatementAccounting

public BankStatementAccountingResponse getBankStatementAccounting(String accessToken,
 String xeroTenantId,
 UUID bankAccountID,
 String fromDate,
 String toDate,
 Boolean summaryOnly)
                                                           throws IOException

Get Bank Statement Accounting For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

bankAccountID - string, GUID Bank account Id

fromDate - date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.

toDate - date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected.

summaryOnly - boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.

Returns:

BankStatementAccountingResponse

Throws:

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

getBankStatementAccountingForHttpResponse

public com.google.api.client.http.HttpResponse getBankStatementAccountingForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID bankAccountID,
 String fromDate,
 String toDate,
 Boolean summaryOnly)
                                                                                  throws IOException

Get Bank Statement Accounting For lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well. As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures.

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

bankAccountID - string, GUID Bank account Id

fromDate - date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.

toDate - date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected.

summaryOnly - boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.

Returns:

HttpResponse

Throws:

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

getCashValidation

public List<CashValidationResponse> getCashValidation(String accessToken,
 String xeroTenantId,
 String balanceDate,
 String asAtSystemDate,
 String beginDate)
                                               throws IOException

Get cash validation Summarizes the total cash position for each account for an org

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

balanceDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. The user has discretion as to which accounting period the transaction relates to. The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified)

asAtSystemDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’. The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement. Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted.

beginDate - date, yyyy-MM-dd If no parameter is provided, the aggregate results will be drawn from the user’s total history. The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. The user has discretion as to which accounting period the transaction relates to.

Returns:

List<CashValidationResponse>

Throws:

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

getCashValidationForHttpResponse

public com.google.api.client.http.HttpResponse getCashValidationForHttpResponse(String accessToken,
 String xeroTenantId,
 String balanceDate,
 String asAtSystemDate,
 String beginDate)
                                                                         throws IOException

Get cash validation Summarizes the total cash position for each account for an org

200 - Success

400 - BadRequest

Parameters:

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

xeroTenantId - Xero identifier for Tenant

balanceDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘balance date’ will return transactions based on the accounting date entered by the user. Transactions before the balanceDate will be included. The user has discretion as to which accounting period the transaction relates to. The ‘balance date’ will control the latest maximum date of transactions included in the aggregate numbers. Balance date does not affect the CurrentStatement object, as this will always return the most recent statement before asAtSystemDate (if specified)

asAtSystemDate - date, yyyy-MM-dd If no parameter is provided, the current date will be used. The ‘as at’ date will return transactions based on the creation date. It reflects the date the transactions were entered into Xero, not the accounting date. The ‘as at’ date can not be overridden by the user. This can be used to estimate a ‘historical frequency of reconciliation’. The ‘as at’ date will affect the current statement in the response, as any candidate statements created after this date will be filtered out. Thus the current statement returned will be the most recent statement prior to the specified ‘as at’ date. Be aware that neither the begin date, nor the balance date, will affect the current statement. Note; information is only presented when system architecture allows, meaning historical cash validation information will be an estimate. In addition, delete events are not aware of the ‘as at’ functionality in this endpoint, meaning that transactions deleted at the time the API is accessed will be considered to always have been deleted.

beginDate - date, yyyy-MM-dd If no parameter is provided, the aggregate results will be drawn from the user’s total history. The ‘begin date’ will return transactions based on the accounting date entered by the user. Transactions after the beginDate will be included. The user has discretion as to which accounting period the transaction relates to.

Returns:

HttpResponse

Throws:

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

getFinancialStatementBalanceSheet

public BalanceSheetResponse getFinancialStatementBalanceSheet(String accessToken,
 String xeroTenantId,
 String balanceDate)
                                                       throws IOException

Get Balance Sheet report The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.

200 - Success

400 - Bad Request

503 - Server Error

Parameters:

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

xeroTenantId - Xero identifier for Tenant

balanceDate - Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.

Returns:

BalanceSheetResponse

Throws:

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

getFinancialStatementBalanceSheetForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementBalanceSheetForHttpResponse(String accessToken,
 String xeroTenantId,
 String balanceDate)
                                                                                         throws IOException

Get Balance Sheet report The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time.

200 - Success

400 - Bad Request

503 - Server Error

Parameters:

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

xeroTenantId - Xero identifier for Tenant

balanceDate - Specifies the date for balance sheet report. Format yyyy-MM-dd. If no parameter is provided, the current date will be used.

Returns:

HttpResponse

Throws:

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

getFinancialStatementCashflow

public CashflowResponse getFinancialStatementCashflow(String accessToken,
 String xeroTenantId,
 String startDate,
 String endDate)
                                               throws IOException

Get Cash flow report The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.

200 - Success

400 - Bad Request

503 - Server Error

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startDate - Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.

endDate - Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.

Returns:

CashflowResponse

Throws:

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

getFinancialStatementCashflowForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementCashflowForHttpResponse(String accessToken,
 String xeroTenantId,
 String startDate,
 String endDate)
                                                                                     throws IOException

Get Cash flow report The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation. Cashflow statement is not available in US region at this stage.

200 - Success

400 - Bad Request

503 - Server Error

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startDate - Date e.g. yyyy-MM-dd Specifies the start date for cash flow report. If no parameter is provided, the date of 12 months before the end date will be used.

endDate - Date e.g. yyyy-MM-dd Specifies the end date for cash flow report. If no parameter is provided, the current date will be used.

Returns:

HttpResponse

Throws:

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

getFinancialStatementContactsExpense

public IncomeByContactResponse getFinancialStatementContactsExpense(String accessToken,
 String xeroTenantId,
 List<UUID> contactIds,
 Boolean includeManualJournals,
 String startDate,
 String endDate)
                                                             throws IOException

Get expense by contacts report The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

contactIds - Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included

includeManualJournals - Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.

startDate - Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

endDate - Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

Returns:

IncomeByContactResponse

Throws:

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

getFinancialStatementContactsExpenseForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementContactsExpenseForHttpResponse(String accessToken,
 String xeroTenantId,
 List<UUID> contactIds,
 Boolean includeManualJournals,
 String startDate,
 String endDate)
                                                                                            throws IOException

Get expense by contacts report The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

contactIds - Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included

includeManualJournals - Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.

startDate - Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

endDate - Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

Returns:

HttpResponse

Throws:

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

getFinancialStatementContactsRevenue

public IncomeByContactResponse getFinancialStatementContactsRevenue(String accessToken,
 String xeroTenantId,
 List<UUID> contactIds,
 Boolean includeManualJournals,
 String startDate,
 String endDate)
                                                             throws IOException

Get revenue by contacts report The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

contactIds - Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included

includeManualJournals - Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.

startDate - Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

endDate - Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

Returns:

IncomeByContactResponse

Throws:

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

getFinancialStatementContactsRevenueForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementContactsRevenueForHttpResponse(String accessToken,
 String xeroTenantId,
 List<UUID> contactIds,
 Boolean includeManualJournals,
 String startDate,
 String endDate)
                                                                                            throws IOException

Get revenue by contacts report The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact information.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

contactIds - Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included

includeManualJournals - Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.

startDate - Date yyyy-MM-dd Specifies the start date for the report. If no parameter is provided, the date of 12 months before the end date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

endDate - Date yyyy-MM-dd Specifies the end date for the report. If no parameter is provided, the current date will be used. It is recommended to always specify both a start date and end date; While the initial range may be set to 12 months, this may need to be reduced for high volume organisations in order to improve latency.

Returns:

HttpResponse

Throws:

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

getFinancialStatementProfitAndLoss

public ProfitAndLossResponse getFinancialStatementProfitAndLoss(String accessToken,
 String xeroTenantId,
 String startDate,
 String endDate)
                                                         throws IOException

Get Profit & Loss report The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startDate - Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.

endDate - Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.

Returns:

ProfitAndLossResponse

Throws:

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

getFinancialStatementProfitAndLossForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementProfitAndLossForHttpResponse(String accessToken,
 String xeroTenantId,
 String startDate,
 String endDate)
                                                                                          throws IOException

Get Profit & Loss report The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

startDate - Date e.g. yyyy-MM-dd Specifies the start date for profit and loss report If no parameter is provided, the date of 12 months before the end date will be used.

endDate - Date e.g. yyyy-MM-dd Specifies the end date for profit and loss report If no parameter is provided, the current date will be used.

Returns:

HttpResponse

Throws:

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

getFinancialStatementTrialBalance

public TrialBalanceResponse getFinancialStatementTrialBalance(String accessToken,
 String xeroTenantId,
 String endDate)
                                                       throws IOException

Get Trial Balance report The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.

Returns:

TrialBalanceResponse

Throws:

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

getFinancialStatementTrialBalanceForHttpResponse

public com.google.api.client.http.HttpResponse getFinancialStatementTrialBalanceForHttpResponse(String accessToken,
 String xeroTenantId,
 String endDate)
                                                                                         throws IOException

Get Trial Balance report The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date.

200 - Success

400 - Bad Request

Parameters:

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

xeroTenantId - Xero identifier for Tenant

endDate - Date e.g. yyyy-MM-dd Specifies the end date for trial balance report If no parameter is provided, the current date will be used.

Returns:

HttpResponse

Throws:

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

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations