Changes since
the last release

com.ebay.sdk.call
Class GetAccountCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetAccountCall

public class GetAccountCall
extends ApiCall

Wrapper class of the GetAccount call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ViewType - Specifies the report format in which to return account entries.
Input property: InvoiceDate - This field is used to retrieve all account entries from a specific invoice, which is identified through this InvoiceDate field with the timestamp of the account invoice. This field is only applicable if the AccountHistorySelection value is set to 'SpecifiedInvoice'; otherwise, this field will be ignored.
Input property: ViewPeriod - Helper wrapper to set GetAccountRequestType BeginDate, EndDate: TimeFrom sets GetAccountRequestType.BeginDate: This field is used to retrieve all account entries dating back to the timestamp passed into this BeginDate field up until the timestamp passed into the EndDate field. The BeginDate value can not be set back any further than four months into the past.

The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss The BeginDate value must be less than or equal to the EndDate value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if YYYY-MM-DD format used) or wanted to retrieve a specific account entry (if YYYY-MM-DD HH:mm:ss format used).

This field is only applicable if the AccountHistorySelection value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. fiedDates' is used, both the BeginDate and EndDate must be included. TimeTo sets GetAccountRequestType.EndDate: This field is used to retrieve all account entries dating up to the timestamp passed into this EndDate field dating back to the timestamp passed into the BeginDate field. The EndDate value can not be set for a future date.

The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss The EndDate value must be more than or equal to the BeginDate value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if YYYY-MM-DD format used) or wanted to retrieve a specific account entry (if YYYY-MM-DD HH:mm:ss format used).

This field is only applicable if the AccountHistorySelection value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. If 'BetweenSpecifiedDates' is used, both the BeginDate and EndDate must be included.
Input property: Pagination - This container is used to control how many account entries are returned on each page of data in the response. PaginationType is used by numerous Trading API calls, and the default and maximum values for the EntriesPerPage field differs with each call. For the GetAccount call, the default value is 500 (account entries) per page, and maximum allowed value is 2000 (account entries) per page.
Input property: ExcludeBalance - By default, the current balance of the user's account will not be returned in the call response. To retrieve the current balance of their account, the user should include the ExcludeBalance flag in the request and set its value to 'false'. The current balance on the account will be shown in the AccountSummary.CurrentBalance field in the call response.
Input property: ExcludeSummary - Specifies whether to return account summary information in an AccountSummary node. Default is true, to return AccountSummary.
Input property: IncludeConversionRate - Specifies whether to retrieve the rate used for the currency conversion for usage transactions.
Input property: AccountEntrySortType - Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order.
Input property: Currency - Specifies the currency used in the account report. Do not specify Currency in the request unless the following conditions are met. First, the user has or had multiple accounts under the same UserID. Second, the account identified in the request uses the currency you specify in the request. An error is returned if no account is found that uses the currency you specify in the request.
Input property: ItemID - Specifies the item ID for which to return account entries. If ItemID is used, all other filters in the request are ignored. If the specified item does not exist or if the requesting user is not the seller of the item, an error is returned.
Output property: AccountID - Specifies the seller's unique account number.
Output property: AccountSummary - Contains summary data for the seller's account, such as the overall balance, bank account and credit card information, and amount and date of any past due balances. Can also contain data for one or more additional accounts, if the user has changed country of residence.
Output property: ReturnedCurrency - Indicates the currency used for monetary amounts in the report.
Output property: AccountEntries - This container holds an array of account entries. The account entries that are returned are dependent on the selection that the user made in the AccountHistorySelection field in the call request. Each AccountEntry container consists of one credit, one debit, or one administrative action on the account. It is possible that no AccountEntry containers will be returned if no account entries exist since the last invoice (if 'LastInvoice' value is used), between the specified dates (if 'BetweenSpecifiedDates' value is used), or on a specified invoice (if 'SpecifiedInvoice' value is used).
Output property: PaginationResult - This container shows the total number of account entries and the total number of account entry pages that exist based on the filters used in the GetAccount call request. The total number of account entry pages is partly controlled by the Pagination.EntriesPerPage value that is set in the request.
Output property: HasMoreEntries - If this boolean value is returned as 'true', there are more account entries to view on one or more pages of data. To view additional entries, the user would have to make additional GetAccount calls and increment the value of the Pagination.PageNumber field by '1' to view additional pages of account entries.
Output property: ReturnedEntriesPerPage - This integer value indicates the number of account entries that are being returned per virtual page of data. This value will be the same value passed into the Pagination.EntriesPerPage field in the request.
Output property: ReturnedPageNumber - This integer value indicates the current page number of account entries that is currently being shown. This value will be the same value passed into the Pagination.PageNumber field in the request.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetAccountCall()
          Constructor.
GetAccountCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 AccountEntryType[] getAccount()
          Returns a seller's invoice data for their eBay account, including the account's summary data.
 AccountEntryType[] getAccountEntries()
          Valid after executing the API.
 AccountEntrySortTypeCodeType getAccountEntrySortType()
          Gets the GetAccountRequestType.accountEntrySortType.
 java.lang.String getAccountID()
          Valid after executing the API.
 AccountSummaryType getAccountSummary()
          Valid after executing the API.
 CurrencyCodeType getCurrency()
          Gets the GetAccountRequestType.currency.
 java.lang.Boolean getExcludeBalance()
          Gets the GetAccountRequestType.excludeBalance.
 java.lang.Boolean getExcludeSummary()
          Gets the GetAccountRequestType.excludeSummary.
 boolean getHasMoreEntries()
          Valid after executing the API.
 java.lang.Boolean getIncludeConversionRate()
          Gets the GetAccountRequestType.includeConversionRate.
 java.util.Calendar getInvoiceDate()
          Gets the GetAccountRequestType.invoiceDate.
 java.lang.String getItemID()
          Gets the GetAccountRequestType.itemID.
 PaginationType getPagination()
          Gets the GetAccountRequestType.pagination.
 PaginationResultType getPaginationResult()
          Valid after executing the API.
 CurrencyCodeType getReturnedCurrency()
          Valid after executing the API.
 java.lang.Integer getReturnedEntriesPerPage()
          Valid after executing the API.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 TimeFilter getViewPeriod()
          Gets the GetAccountRequestType.viewPeriod.
 AccountHistorySelectionCodeType getViewType()
          Gets the GetAccountRequestType.viewType.
 void setAccountEntrySortType(AccountEntrySortTypeCodeType accountEntrySortType)
          Sets the GetAccountRequestType.accountEntrySortType.
 void setCurrency(CurrencyCodeType currency)
          Sets the GetAccountRequestType.currency.
 void setExcludeBalance(java.lang.Boolean excludeBalance)
          Sets the GetAccountRequestType.excludeBalance.
 void setExcludeSummary(java.lang.Boolean excludeSummary)
          Sets the GetAccountRequestType.excludeSummary.
 void setIncludeConversionRate(java.lang.Boolean includeConversionRate)
          Sets the GetAccountRequestType.includeConversionRate.
 void setInvoiceDate(java.util.Calendar invoiceDate)
          Sets the GetAccountRequestType.invoiceDate.
 void setItemID(java.lang.String itemID)
          Sets the GetAccountRequestType.itemID.
 void setPagination(PaginationType pagination)
          Sets the GetAccountRequestType.pagination.
 void setViewPeriod(TimeFilter viewPeriod)
          Sets the GetAccountRequestType.viewPeriod.
 void setViewType(AccountHistorySelectionCodeType viewType)
          Sets the GetAccountRequestType.viewType.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetAccountCall

public GetAccountCall()
Constructor.


GetAccountCall

public GetAccountCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getAccount

public AccountEntryType[] getAccount()
                              throws ApiException,
                                     SdkException,
                                     java.lang.Exception
Returns a seller's invoice data for their eBay account, including the account's summary data.

Returns:
The AccountEntryType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getAccountEntrySortType

public AccountEntrySortTypeCodeType getAccountEntrySortType()
Gets the GetAccountRequestType.accountEntrySortType.

Returns:
AccountEntrySortTypeCodeType

setAccountEntrySortType

public void setAccountEntrySortType(AccountEntrySortTypeCodeType accountEntrySortType)
Sets the GetAccountRequestType.accountEntrySortType.

Parameters:
accountEntrySortType - AccountEntrySortTypeCodeType

getCurrency

public CurrencyCodeType getCurrency()
Gets the GetAccountRequestType.currency.

Returns:
CurrencyCodeType

setCurrency

public void setCurrency(CurrencyCodeType currency)
Sets the GetAccountRequestType.currency.

Parameters:
currency - CurrencyCodeType

getExcludeBalance

public java.lang.Boolean getExcludeBalance()
Gets the GetAccountRequestType.excludeBalance.

Returns:
Boolean

setExcludeBalance

public void setExcludeBalance(java.lang.Boolean excludeBalance)
Sets the GetAccountRequestType.excludeBalance.

Parameters:
excludeBalance - Boolean

getExcludeSummary

public java.lang.Boolean getExcludeSummary()
Gets the GetAccountRequestType.excludeSummary.

Returns:
Boolean

setExcludeSummary

public void setExcludeSummary(java.lang.Boolean excludeSummary)
Sets the GetAccountRequestType.excludeSummary.

Parameters:
excludeSummary - Boolean

getIncludeConversionRate

public java.lang.Boolean getIncludeConversionRate()
Gets the GetAccountRequestType.includeConversionRate.

Returns:
Boolean

setIncludeConversionRate

public void setIncludeConversionRate(java.lang.Boolean includeConversionRate)
Sets the GetAccountRequestType.includeConversionRate.

Parameters:
includeConversionRate - Boolean

getInvoiceDate

public java.util.Calendar getInvoiceDate()
Gets the GetAccountRequestType.invoiceDate.

Returns:
Calendar

setInvoiceDate

public void setInvoiceDate(java.util.Calendar invoiceDate)
Sets the GetAccountRequestType.invoiceDate.

Parameters:
invoiceDate - Calendar

getItemID

public java.lang.String getItemID()
Gets the GetAccountRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetAccountRequestType.itemID.

Parameters:
itemID - String

getPagination

public PaginationType getPagination()
Gets the GetAccountRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetAccountRequestType.pagination.

Parameters:
pagination - PaginationType

getViewPeriod

public TimeFilter getViewPeriod()
Gets the GetAccountRequestType.viewPeriod.

Returns:
TimeFilter

setViewPeriod

public void setViewPeriod(TimeFilter viewPeriod)
Sets the GetAccountRequestType.viewPeriod.

Parameters:
viewPeriod - TimeFilter

getViewType

public AccountHistorySelectionCodeType getViewType()
Gets the GetAccountRequestType.viewType.

Returns:
AccountHistorySelectionCodeType

setViewType

public void setViewType(AccountHistorySelectionCodeType viewType)
Sets the GetAccountRequestType.viewType.

Parameters:
viewType - AccountHistorySelectionCodeType

getAccountEntries

public AccountEntryType[] getAccountEntries()
Valid after executing the API. Gets the returned GetAccountResponseType.accountEntries.

Returns:
AccountEntryType[]

getAccountID

public java.lang.String getAccountID()
Valid after executing the API. Gets the returned GetAccountResponseType.accountID.

Returns:
String

getAccountSummary

public AccountSummaryType getAccountSummary()
Valid after executing the API. Gets the returned GetAccountResponseType.accountSummary.

Returns:
AccountSummaryType

getHasMoreEntries

public boolean getHasMoreEntries()
Valid after executing the API. Gets the returned GetAccountResponseType.hasMoreEntries.

Returns:
boolean

getPaginationResult

public PaginationResultType getPaginationResult()
Valid after executing the API. Gets the returned GetAccountResponseType.paginationResult.

Returns:
PaginationResultType

getReturnedCurrency

public CurrencyCodeType getReturnedCurrency()
Valid after executing the API. Gets the returned GetAccountResponseType.returnedCurrency.

Returns:
CurrencyCodeType

getReturnedEntriesPerPage

public java.lang.Integer getReturnedEntriesPerPage()
Valid after executing the API. Gets the returned GetAccountResponseType.returnedEntriesPerPage.

Returns:
Integer

getReturnedPageNumber

public java.lang.Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetAccountResponseType.returnedPageNumber.

Returns:
Integer

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.