|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetAccountCall
public class GetAccountCall
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.
ViewType
- Specifies the report format in which to return account entries.
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.
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.
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.
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.
ExcludeSummary
- Specifies whether to return account summary information in an
AccountSummary node. Default is true, to return AccountSummary.
IncludeConversionRate
- Specifies whether to retrieve the rate used for the currency conversion for usage transactions.
AccountEntrySortType
- Specifies how account entries should be sorted in the response, by an
element and then in ascending or descending order.
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.
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.
AccountID
- Specifies the seller's unique account number.
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.
ReturnedCurrency
- Indicates the currency used for monetary amounts in the report.
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).
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.
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.
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.
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.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetAccountCall()
public GetAccountCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public AccountEntryType[] getAccount() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public AccountEntrySortTypeCodeType getAccountEntrySortType()
public void setAccountEntrySortType(AccountEntrySortTypeCodeType accountEntrySortType)
accountEntrySortType
- AccountEntrySortTypeCodeTypepublic CurrencyCodeType getCurrency()
public void setCurrency(CurrencyCodeType currency)
currency
- CurrencyCodeTypepublic java.lang.Boolean getExcludeBalance()
public void setExcludeBalance(java.lang.Boolean excludeBalance)
excludeBalance
- Booleanpublic java.lang.Boolean getExcludeSummary()
public void setExcludeSummary(java.lang.Boolean excludeSummary)
excludeSummary
- Booleanpublic java.lang.Boolean getIncludeConversionRate()
public void setIncludeConversionRate(java.lang.Boolean includeConversionRate)
includeConversionRate
- Booleanpublic java.util.Calendar getInvoiceDate()
public void setInvoiceDate(java.util.Calendar invoiceDate)
invoiceDate
- Calendarpublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic TimeFilter getViewPeriod()
public void setViewPeriod(TimeFilter viewPeriod)
viewPeriod
- TimeFilterpublic AccountHistorySelectionCodeType getViewType()
public void setViewType(AccountHistorySelectionCodeType viewType)
viewType
- AccountHistorySelectionCodeTypepublic AccountEntryType[] getAccountEntries()
public java.lang.String getAccountID()
public AccountSummaryType getAccountSummary()
public boolean getHasMoreEntries()
public PaginationResultType getPaginationResult()
public CurrencyCodeType getReturnedCurrency()
public java.lang.Integer getReturnedEntriesPerPage()
public java.lang.Integer getReturnedPageNumber()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.