com.xero.api.client

Class BankFeedsApi

java.lang.Object

com.xero.api.client.BankFeedsApi

public class BankFeedsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BankFeedsApi()
BankFeedsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)
FeedConnections	createFeedConnections(String accessToken, String xeroTenantId, FeedConnections feedConnections) create one or more new feed connection By passing in the FeedConnections array object in the body, you can create one or more new feed connections
com.google.api.client.http.HttpResponse	createFeedConnectionsForHttpResponse(String accessToken, String xeroTenantId, FeedConnections feedConnections)
Statements	createStatements(String accessToken, String xeroTenantId, Statements statements) 202 - Success returns Statements array of objects in response
com.google.api.client.http.HttpResponse	createStatementsForHttpResponse(String accessToken, String xeroTenantId, Statements statements)
FeedConnections	deleteFeedConnections(String accessToken, String xeroTenantId, FeedConnections feedConnections) Delete an exsiting feed connection By passing in FeedConnections array object in the body, you can delete a feed connection.
com.google.api.client.http.HttpResponse	deleteFeedConnectionsForHttpResponse(String accessToken, String xeroTenantId, FeedConnections feedConnections)
ApiClient	getApiClient()
FeedConnection	getFeedConnection(String accessToken, String xeroTenantId, UUID id) Retrive single feed connection based on unique id provided By passing in a FeedConnection Id options, you can search for matching feed connections
com.google.api.client.http.HttpResponse	getFeedConnectionForHttpResponse(String accessToken, String xeroTenantId, UUID id)
FeedConnections	getFeedConnections(String accessToken, String xeroTenantId, Integer page, Integer pageSize) searches feed connections By passing in the appropriate options, you can search for available feed connections in the system.
com.google.api.client.http.HttpResponse	getFeedConnectionsForHttpResponse(String accessToken, String xeroTenantId, Integer page, Integer pageSize)
static BankFeedsApi	getInstance(ApiClient apiClient)
Statement	getStatement(String accessToken, String xeroTenantId, UUID statementId) Retrive single statement based on unique id provided By passing in a statement id, you can search for matching statements
com.google.api.client.http.HttpResponse	getStatementForHttpResponse(String accessToken, String xeroTenantId, UUID statementId)
Statements	getStatements(String accessToken, String xeroTenantId, Integer page, Integer pageSize, String xeroApplicationId, String xeroUserId) Retrive all statements based on unique search criteria By passing in parameters, you can search for matching statements
com.google.api.client.http.HttpResponse	getStatementsForHttpResponse(String accessToken, String xeroTenantId, Integer page, Integer pageSize, String xeroApplicationId, String xeroUserId)
String	getUserAgent()
void	setApiClient(ApiClient apiClient)
void	setUserAgent(String userAgent)

Methods inherited from class java.lang.Object

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

Constructor Detail

BankFeedsApi

public BankFeedsApi()

BankFeedsApi

public BankFeedsApi(ApiClient apiClient)

Method Detail

getInstance

public static BankFeedsApi getInstance(ApiClient apiClient)

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

setUserAgent

public void setUserAgent(String userAgent)

getUserAgent

public String getUserAgent()

createFeedConnections

public FeedConnections createFeedConnections(String accessToken,
                                             String xeroTenantId,
                                             FeedConnections feedConnections)
                                      throws IOException

create one or more new feed connection By passing in the FeedConnections array object in the body, you can create one or more new feed connections

201 - success new feed connection(s)response

400 - invalid input, object invalid

409 - failed to create new feed connection(s)response

Parameters:

xeroTenantId - Xero identifier for Tenant

feedConnections - Feed Connection(s) array object in the body

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

Returns:

FeedConnections

Throws:

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

createFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse createFeedConnectionsForHttpResponse(String accessToken,
                                                                                    String xeroTenantId,
                                                                                    FeedConnections feedConnections)
                                                                             throws IOException

Throws:

IOException

createStatements

public Statements createStatements(String accessToken,
                                   String xeroTenantId,
                                   Statements statements)
                            throws IOException

202 - Success returns Statements array of objects in response

400 - Statement failed validation

403 - Invalid application or feed connection

409 - Duplicate statement received

413 - Statement exceeds size limit

422 - Unprocessable Entity

500 - Intermittent Xero Error

Parameters:

xeroTenantId - Xero identifier for Tenant

statements - Statements array of objects in the body

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

Returns:

Statements

Throws:

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

createStatementsForHttpResponse

public com.google.api.client.http.HttpResponse createStatementsForHttpResponse(String accessToken,
                                                                               String xeroTenantId,
                                                                               Statements statements)
                                                                        throws IOException

Throws:

IOException

deleteFeedConnections

public FeedConnections deleteFeedConnections(String accessToken,
                                             String xeroTenantId,
                                             FeedConnections feedConnections)
                                      throws IOException

Delete an exsiting feed connection By passing in FeedConnections array object in the body, you can delete a feed connection.

202 - Success response for deleted feed connection

400 - bad input parameter

Parameters:

xeroTenantId - Xero identifier for Tenant

feedConnections - Feed Connections array object in the body

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

Returns:

FeedConnections

Throws:

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

deleteFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse deleteFeedConnectionsForHttpResponse(String accessToken,
                                                                                    String xeroTenantId,
                                                                                    FeedConnections feedConnections)
                                                                             throws IOException

Throws:

IOException

getFeedConnection

public FeedConnection getFeedConnection(String accessToken,
                                        String xeroTenantId,
                                        UUID id)
                                 throws IOException

Retrive single feed connection based on unique id provided By passing in a FeedConnection Id options, you can search for matching feed connections

200 - success returns a FeedConnection object matching the id in response

400 - bad input parameter

Parameters:

xeroTenantId - Xero identifier for Tenant

id - Unique identifier for retrieving single object

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

Returns:

FeedConnection

Throws:

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

getFeedConnectionForHttpResponse

public com.google.api.client.http.HttpResponse getFeedConnectionForHttpResponse(String accessToken,
                                                                                String xeroTenantId,
                                                                                UUID id)
                                                                         throws IOException

Throws:

IOException

getFeedConnections

public FeedConnections getFeedConnections(String accessToken,
                                          String xeroTenantId,
                                          Integer page,
                                          Integer pageSize)
                                   throws IOException

searches feed connections By passing in the appropriate options, you can search for available feed connections in the system.

201 - search results matching criteria returned with pagination and items array

400 - validation error response

Parameters:

xeroTenantId - Xero identifier for Tenant

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 10. Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?page=1 to get the second set of the records. When page value is not a number or a negative number, by default, the first set of records is returned.

pageSize - Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?pageSize=100 to specify page size of 100.

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

Returns:

FeedConnections

Throws:

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

getFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse getFeedConnectionsForHttpResponse(String accessToken,
                                                                                 String xeroTenantId,
                                                                                 Integer page,
                                                                                 Integer pageSize)
                                                                          throws IOException

Throws:

IOException

getStatement

public Statement getStatement(String accessToken,
                              String xeroTenantId,
                              UUID statementId)
                       throws IOException

Retrive single statement based on unique id provided By passing in a statement id, you can search for matching statements

200 - search results matching id for single statement

404 - Statement not found

Parameters:

xeroTenantId - Xero identifier for Tenant

statementId - statement id for single object

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

Returns:

Statement

Throws:

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

getStatementForHttpResponse

public com.google.api.client.http.HttpResponse getStatementForHttpResponse(String accessToken,
                                                                           String xeroTenantId,
                                                                           UUID statementId)
                                                                    throws IOException

Throws:

IOException

getStatements

public Statements getStatements(String accessToken,
                                String xeroTenantId,
                                Integer page,
                                Integer pageSize,
                                String xeroApplicationId,
                                String xeroUserId)
                         throws IOException

Retrive all statements based on unique search criteria By passing in parameters, you can search for matching statements

200 - success returns Statements array of objects response

400 - bad input parameter

Parameters:

xeroTenantId - Xero identifier for Tenant

page - unique id for single object

pageSize - Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/Statements?pageSize=100 to specify page size of 100.

xeroApplicationId - The xeroApplicationId parameter

xeroUserId - The xeroUserId parameter

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

Returns:

Statements

Throws:

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

getStatementsForHttpResponse

public com.google.api.client.http.HttpResponse getStatementsForHttpResponse(String accessToken,
                                                                            String xeroTenantId,
                                                                            Integer page,
                                                                            Integer pageSize,
                                                                            String xeroApplicationId,
                                                                            String xeroUserId)
                                                                     throws IOException

Throws:

IOException

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

Throws:

IOException