GetAccount

This call returns a seller's invoice data for their eBay account, including the account's summary data.

GetAccount returns account data in one of three report formats, depending on the inputs used for the call. Specify the type of report to generate with AccountHistorySelection. The types of reports you can request are LastInvoice (returns entries since last invoice sent), SpecifiedInvoice (filters by a specific month and year), and BetweenSpecifiedDates (returns invoices posted between specific dates).

You can sort the response by specifying a AccountEntrySortType in the request. Sort the response by AccountEntry.Date, AccountEntry.ItemID, or AccountEntry.Description, in either ascending or descending order.

You can also use Pagination values to specify how to break the result set into smaller, more manageable chunks. Pagination.EntriesPerPage controls the number of account entries returned from the call, and Pagination.PageNumber (a value between 1 and 200) specifies which page of data to retrieve in the current call.

Working with the Response

GetAccount returns individual account entries in the AccountEntries field, and summary account data in the AccountSummary field.

The AccountEntries property is an array containing a set of AccountEntry objects, each of which represents one transaction posted to the seller's account. Each AccountEntry contains information about the respective transaction, such as the transaction type, the amount of the transaction, the date the transaction was posted to the account, and the associated item ID (if an item listing is associated with the transaction, such as a charge for listing fees).

Inspect the contents of each AccountEntries.AccountEntry container to get the values for each invoice.
Inspect AccountSummary to obtain the account's summary data (such as the current balance and the last amount paid), and for data relating to any additional accounts associated with the requesting user.
Store the appropriate response data as applicable for your application.

You can uniquely identify entries in the AccountEntries container by combining the following fields to form a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber.

In the output, Pagination.TotalNumberOfEntries indicates the total number of account entries that can be returned with multiple calls (given the report type and date range). Pagination.TotalNumberOfPages indicates the total number of pages of data that can be returned.

There are no limits on the number of account entries that can be returned using GetAccount. However, eBay only returns records posted within the last four months. This is due to the way eBay archives user data.

Testing GetAccount

Because of certain restrictions, GetAccount is not fully functional in the Sandbox environment. To test GetAccount in the Sandbox, use the following test users:

bssmb_us_03
bssmb_us_06
bssmb_us_07
bssmb_us_10
invoice_us_01
rabc_reg_us_05
vas_multy_uk_eur_gbp
vas_multy_uk_usd_gbp
vas_us_suspend_02

Each of these special test users has a Password value of p@ss123.

Additionally, the Sandbox supports only the following currency codes: EUR, USD, GBP.

It is recommended that you test GetAccount with several of the test users because their account information is regularly updated with test data and each user has different account information (for example, Currency values and invoice information differs between the different test users).

Related Information

See:
Getting Account Information
Testing Applications

See also the reference documentation for these calls:

GetSellerDashboard - Retrieves a brief summary of the requester's status as an eBay seller.
GetUser - Retrieves data pertaining to a single eBay user.

GetAccount Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetAccountRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <AccountEntrySortType> AccountEntrySortTypeCodeType </AccountEntrySortType>
  <AccountHistorySelection> AccountHistorySelectionCodeType </AccountHistorySelection>
  <BeginDate> dateTime </BeginDate>
  <Currency> CurrencyCodeType </Currency>
  <EndDate> dateTime </EndDate>
  <ExcludeBalance> boolean </ExcludeBalance>
  <ExcludeSummary> boolean </ExcludeSummary>
  <IncludeConversionRate> boolean </IncludeConversionRate>
  <InvoiceDate> dateTime </InvoiceDate>
  <ItemID> ItemIDType (string) </ItemID>
  <Pagination> PaginationType
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector values allowed here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetAccountRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

AccountEntrySortType	AccountEntrySortTypeCodeType	Optional	Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order. Applicable values: • AccountEntryCreatedTimeAscending (in) Sort by the AccountEntry.Date value in the response, in ascending order. • AccountEntryCreatedTimeDescending (in) Sort by the AccountEntry.Date value in the response, in descending order. • AccountEntryFeeTypeAscending (in) Sort by the value returned in AccountEntry.Description, with entries starting with lowercase letters before entries starting with uppercase letters and each group in alphabetical order. • AccountEntryFeeTypeDescending (in) Sort by the value returned in AccountEntry.Description, with entries starting with uppercase letters before entries starting with lowercase letters and each group in reverse alphabetical order. • AccountEntryItemNumberAscending (in) Sort by the AccountEntry.ItemID value in the response, in ascending order. • AccountEntryItemNumberDescending (in) Sort by the AccountEntry.ItemID value in the response, in descending order. • CustomCode (in) Reserved for internal or future use. • None (in) Sort by the AccountEntry.Date value in the response, in ascending order. Same as AccountEntryCreatedTimeAscending.
AccountHistorySelection	AccountHistorySelectionCodeType	Conditional	Specifies the report format in which to return account entries. Applicable values: • BetweenSpecifiedDates (in) Contains entries that were posted to the seller's account between two dates. The period covered may cross the boundaries of formal invoices. If you use BetweenSpecifiedDates, then you also must specify BeginDate and EndDate. If you use BetweenSpecifiedDates, then InvoiceDate is ignored. • CustomCode (in) Reserved for internal or future use. • LastInvoice (in) Contains the entries since the last invoice eBay sent to the seller. If you use LastInvoice, then InvoiceDate, BeginDate and EndDate are ignored. • SpecifiedInvoice (in) Contains the entries for a specific invoice, identified by the invoice month and year. If you use SpecifiedInvoice, then you must also use InvoiceDate. If you use SpecifiedInvoice, then BeginDate and EndDate are ignored.
BeginDate	dateTime	Conditional	Specifies the beginning of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be less than or equal to the value specified in EndDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. You can retrieve information that is up to 4 months old.
Currency	CurrencyCodeType	Optional	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. Applicable values: See Currency.
EndDate	dateTime	Conditional	Specifies the end of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be greater than or equal to the value specified in BeginDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.
ExcludeBalance	boolean	Optional	Specifies whether to calculate balances. Default is false, which calculates balances. The value true means do not calculate balances. If true, AccountEntry.Balance and AccountSummary.CurrentBalance are never returned in the response.
ExcludeSummary	boolean	Optional	Specifies whether to return account summary information in an AccountSummary node. Default is true, to return AccountSummary.
IncludeConversionRate	boolean	Optional	Specifies whether to retrieve the rate used for the currency conversion for usage transactions.
InvoiceDate	dateTime	Conditional	Specifies the month and year of the invoice requested. The report includes only the entries that appear on the seller's invoice in the specified month and year. An entry can occur in one month and appear on the next month's invoice. Used with SpecifiedInvoice reports.
ItemID	ItemIDType (string)	Optional	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.
Pagination	PaginationType	Optional	Controls pagination of the response. For this request, the valid values of Pagination.EntriesPerPage are 0 to 2000, with a default of 500.
Pagination.EntriesPerPage	int	Optional	This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored.
Pagination.PageNumber	int	Optional	Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. Min: 1. Default: 1.

Standard Input Fields

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string	Optional, repeatable: [0..*]	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

GetAccount Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetAccountResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AccountEntries> AccountEntriesType
    <AccountEntry> AccountEntryType
      <AccountDetailsEntryType> AccountDetailEntryCodeType </AccountDetailsEntryType>
      <Balance> AmountType (double) </Balance>
      <ConversionRate> AmountType (double) </ConversionRate>
      <Date> dateTime </Date>
      <Description> string </Description>
      <GrossDetailAmount> AmountType (double) </GrossDetailAmount>
      <ItemID> ItemIDType (string) </ItemID>
      <Memo> string </Memo>
      <NetDetailAmount> AmountType (double) </NetDetailAmount>
      <OrderLineItemID> string </OrderLineItemID>
      <ReceivedTopRatedDiscount> boolean </ReceivedTopRatedDiscount>
      <RefNumber> string </RefNumber>
      <Title> string </Title>
      <TransactionID> string </TransactionID>
      <VATPercent> decimal </VATPercent>
    </AccountEntry>
    <!-- ... more AccountEntry nodes allowed here ... -->
  </AccountEntries>
  <AccountID> string </AccountID>
  <AccountSummary> AccountSummaryType
    <AccountState> AccountStateCodeType </AccountState>
    <AdditionalAccount> AdditionalAccountType
      <AccountCode> string </AccountCode>
      <Balance> AmountType (double) </Balance>
      <Currency> CurrencyCodeType </Currency>
    </AdditionalAccount>
    <!-- ... more AdditionalAccount nodes allowed here ... -->
    <AmountPastDue> AmountType (double) </AmountPastDue>
    <BankAccountInfo> string </BankAccountInfo>
    <BankModifyDate> dateTime </BankModifyDate>
    <BillingCycleDate> int </BillingCycleDate>
    <CreditCardExpiration> dateTime </CreditCardExpiration>
    <CreditCardInfo> string </CreditCardInfo>
    <CreditCardModifyDate> dateTime </CreditCardModifyDate>
    <CurrentBalance> AmountType (double) </CurrentBalance>
    <InvoiceBalance> AmountType (double) </InvoiceBalance>
    <InvoiceCredit> AmountType (double) </InvoiceCredit>
    <InvoiceDate> dateTime </InvoiceDate>
    <InvoiceNewFee> AmountType (double) </InvoiceNewFee>
    <InvoicePayment> AmountType (double) </InvoicePayment>
    <LastAmountPaid> AmountType (double) </LastAmountPaid>
    <LastPaymentDate> dateTime </LastPaymentDate>
    <PastDue> boolean </PastDue>
    <PaymentMethod> SellerPaymentMethodCodeType </PaymentMethod>
  </AccountSummary>
  <Currency> CurrencyCodeType </Currency>
  <EntriesPerPage> int </EntriesPerPage>
  <HasMoreEntries> boolean </HasMoreEntries>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetAccountResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

AccountEntries	AccountEntriesType	Conditionally	Contains individual account entries, according to the report's scope and date range. Each account entry represents one credit, debit, or administrative account action.
AccountEntries.AccountEntry	AccountEntryType	Conditionally, repeatable: [0..*]	Contains the data for one account entry. (See the schema documentation for AccountEntryType for details on its properties.)
AccountEntries.AccountEntry .AccountDetailsEntryType	AccountDetailEntryCodeType	Conditionally	Indicates the type of transaction or reason for the transaction. For example, a value of FeeGallery indicates a debit for listing an item in the Gallery. Possible values are enumerated in the AccountDetailEntryCodeType code list. Applicable values: See AccountDetailsEntryType.
AccountEntries.AccountEntry .Balance	AmountType (double)	Conditionally	Balance after the account entry's credit or debit amount has been applied. Can be 0.00. The value is positive for debits and negative for credits.
AccountEntries.AccountEntry .ConversionRate	AmountType (double)	Conditionally	The rate used for the currency conversion for a transaction.
AccountEntries.AccountEntry .Date	dateTime	Conditionally	Timestamp indicating the date and time that the entry was posted to the account, in GMT.
AccountEntries.AccountEntry .Description	string	Conditionally	A description of the monetary transaction or administrative action applied to an eBay account.
AccountEntries.AccountEntry .GrossDetailAmount	AmountType (double)	Conditionally	Gross fees that are assessed by eBay (net fees plus VAT, if any). Returned even if VAT does not apply. The value is positive for debits and negative for credits.
AccountEntries.AccountEntry .ItemID	ItemIDType (string)	Conditionally	If the account detail entry is associated with an item listing, this field shows the eBay ItemID value. Otherwise, 0 is returned in this field. Max length: 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits).
AccountEntries.AccountEntry .Memo	string	Conditionally	Memo line for the account entry. It can be an empty string.
AccountEntries.AccountEntry .NetDetailAmount	AmountType (double)	Conditionally	Net fees that are assessed by eBay, excluding additional surchargesand VAT (if any). Returned even if VAT does not apply. The value is positive for debits (user pays eBay) and negative for credits (eBay pays user).
AccountEntries.AccountEntry .OrderLineItemID	string	Conditionally	OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. If the account detail entry is associated with an order line item, this field shows the OrderLineItemID value. Otherwise, 0 is returned in this field. Max length: 100.
AccountEntries.AccountEntry .ReceivedTopRatedDiscount	boolean	Conditionally	This boolean is returned as 'true' if the seller received a top-rated seller 20 percent discount on the final value fee for the order line item.
AccountEntries.AccountEntry .RefNumber	string	Conditionally	eBay reference number for the account entry. May return no value for some account transactions, such as an administrative action like placing the user's credit card on file. You can uniquely identify the entries that the GetAccount call returns within the AccountEntries tag. Specifically, the following fields, returned within the AccountEntries tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber.
AccountEntries.AccountEntry .Title	string	Conditionally	Title of the entry, or explanation of why the debit or credit was applied.
AccountEntries.AccountEntry .TransactionID	string	Conditionally	The unique identifier of an order line item (transaction). If the account detail entry is associated with an order line item, this field shows the eBay TransactionID value. Otherwise, 0 is returned in this field. Max length: 19.
AccountEntries.AccountEntry .VATPercent	decimal	Conditionally	VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Returned for all users, not just VAT users, with GetAccountResponse.
AccountID	string	Always	Specifies the seller's unique account number.
AccountSummary	AccountSummaryType	Conditionally	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.
AccountSummary.AccountState	AccountStateCodeType	Conditionally	Indicates the current state of the account (such as active or inactive). Possible values are enumerated in the AccountStateCodeType code list. Applicable values: • Active (out) The account is active. • CustomCode (out) Reserved for internal or future use. • Inactive (out) The account is inactive. No new seller account entries would be posted by eBay to the account. • Pending (out) The account has been created but is not yet active, pending additional information or processing by eBay.
AccountSummary .AdditionalAccount	AdditionalAccountType	Conditionally, repeatable: [0..*]	Contains the data for one additional account. An AccountSummaryType object may return zero, one, or multiple additional accounts. See the schema documentation for AdditionalAccountType for details on additional accounts. The value is positive for debits and negative for credits.
AccountSummary .AdditionalAccount.AccountCode	string	Conditionally	Indicates the unique identifier for the additional account (the account ID).
AccountSummary .AdditionalAccount.Balance	AmountType (double)	Conditionally	Indicates the current balance of the additional account.
AccountSummary .AdditionalAccount.Currency	CurrencyCodeType	Conditionally	Indicates the currency in which monetary amounts for the additional account are expressed. Applicable values: See Currency.
AccountSummary.AmountPastDue	AmountType (double)	Conditionally	Amount past due, 0.00 if not past due. The value is positive for debits and negative for credits.
AccountSummary.BankAccountInfo	string	Conditionally	First four digits of the bank account the user associated with the seller account (with remainder Xed-out). This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified). Max length: 4.
AccountSummary.BankModifyDate	dateTime	Conditionally	Indicates the date and time BankAccountInfo was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified).
AccountSummary .BillingCycleDate	int	Conditionally	Indicates the billing cycle in which eBay sends a billing invoice to the user. A value of 0 (zero) indicates an invoice sent on the last day of the month. A value of 15 indicates an invoice sent on the 15th day of the month.
AccountSummary .CreditCardExpiration	dateTime	Conditionally	Expiration date for the credit card selected by the user as payment method for the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no credit card is on file or if the account is inactive - even if there is a credit card on file.
AccountSummary.CreditCardInfo	string	Conditionally	Last four digits of the credit card the user selected as payment method for the account. Empty string if no credit is on file.
AccountSummary .CreditCardModifyDate	dateTime	Conditionally	Indicates the date and time credit card or credit card expiration date was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending on the payment method the user selected for the account (e.g., Empty string if no credit card is on file.)
AccountSummary.CurrentBalance	AmountType (double)	Conditionally	Current balance for the account. Can be 0.00, positive, or negative. The value is positive for debits and negative for credits.
AccountSummary.InvoiceBalance	AmountType (double)	Conditionally	Amount of last invoice. 0.00 if account not yet invoiced. The value is positive for debits and negative for credits.
AccountSummary.InvoiceCredit	AmountType (double)	Conditionally	Specifies credits granted since the previous invoice, but is only returned AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.
AccountSummary.InvoiceDate	dateTime	Conditionally	Date of last invoice sent by eBay to the user, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if this account has not been invoiced yet.
AccountSummary.InvoiceNewFee	AmountType (double)	Conditionally	Specifies fees incurred since the last invoice, including tax if applicable. Returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.
AccountSummary.InvoicePayment	AmountType (double)	Conditionally	Specifies payment made since the previous invoice, but is returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.
AccountSummary.LastAmountPaid	AmountType (double)	Conditionally	Amount of last payment posted, 0.00 if no payments posted. The value is positive for debits and negative for credits.
AccountSummary.LastPaymentDate	dateTime	Conditionally	Date of last payment by the user to eBay, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no payments have been posted.
AccountSummary.PastDue	boolean	Conditionally	Indicates whether the account has past due amounts outstanding. A value of true indicates that the account is past due. A value of false indicates the account is current.
AccountSummary.PaymentMethod	SellerPaymentMethodCodeType	Conditionally	Indicates the method the user selected to pay eBay with for the account. The values for PaymentMethod vary from one global eBay site to the next. Payment methods are enumerated in the SellerPaymentMethodCodeType code list. Applicable values: • CreditCard (out) Credit Card • CustomCode (out) Reserved for internal or future use • DirectDebit (out) Direct Debit • DirectDebitPendingSignatureMandate (out) Direct Debit, pending signature mandate • DirectDebitPendingVerification (out) Direct Debit, pending verification • eBayDirectPay (out) eBay Direct Pay • NothingOnFile (out) Used for all other payment methods which are not specifically listed in other columns. • PayPal (out) PayPal
Currency	CurrencyCodeType	Always	Indicates the currency used for monetary amounts in the report. Applicable values: See Currency.
EntriesPerPage	int	Always	Specifies the number of items that are being returned per virtual page of date. Value is the same as that specified in Pagination.EntriesPerPage.
HasMoreEntries	boolean	Conditionally	Indicates whether there are more items yet to be retrieved. Additional calls must be made to retrieve those items.
PageNumber	int	Always	Indicates which page of data was just returned. Value is the same as the value specified in Pagination.PageNumber. If PageNumber in the request is higher than the total number of pages, the call fails with an error.)
PaginationResult	PaginationResultType	Always	Contains the total number of pages (TotalNumberOfPages) and the total number of account entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria.
PaginationResult .TotalNumberOfPages	int	Always	Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

GetAccount Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

GetAccount Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Retrieves the account data for the authenticated user.

Description

This call returns a user's account data, including a summary report. The call returns all account entries since the last account invoice request. Entries are sorted by the value specified in AccountEntrySortType.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetAccountRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <AccountEntrySortType>AccountEntryFeeTypeAscending</AccountEntrySortType>
  <AccountHistorySelection>LastInvoice</AccountHistorySelection>
</GetAccountRequest>

Output

XML format. Also available is the .txt version of this XML.

<GetAccountResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2010-02-26T19:37:50.219Z</Timestamp>
   <Ack>Success</Ack>
   <Version>657</Version>
   <Build>E657_CORE_BUNDLED_10685945_R1</Build>
   <AccountID>E29243276001-USD</AccountID>
   <AccountSummary>
      <AccountState>Active</AccountState>
      <AmountPastDue currencyID="USD">0.0</AmountPastDue>
      <BillingCycleDate>15</BillingCycleDate>
      <InvoiceBalance currencyID="USD">0.0</InvoiceBalance>
      <InvoiceDate>2010-01-15T06:59:59.000Z</InvoiceDate>
      <LastAmountPaid currencyID="USD">-12.84</LastAmountPaid>
      <LastPaymentDate>2009-12-30T17:04:36.000Z</LastPaymentDate>
      <PastDue>false</PastDue>
      <PaymentMethod>NothingOnFile</PaymentMethod>
   </AccountSummary>
   <Currency>USD</Currency>
   <AccountEntries>
      <AccountEntry>
         <AccountDetailsEntryType>BuyItNowFee</AccountDetailsEntryType>
         <Description>Buy It Now Listing Fee</Description>
         <Date>2010-02-18T03:30:57.000Z</Date>
         <GrossDetailAmount currencyID="USD">0.2</GrossDetailAmount>
         <ItemID>220439083273</ItemID>
         <NetDetailAmount currencyID="USD">0.2</NetDetailAmount>
         <RefNumber>52594285636</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Cleveland XLS 4i 25 degree STIFF Graphite, EXCELLENT!</Title>
      </AccountEntry>
      <AccountEntry>
         <AccountDetailsEntryType>BuyItNowFee</AccountDetailsEntryType>
         <Description>Buy It Now Listing Fee</Description>
         <Date>2010-02-21T19:40:13.000Z</Date>
         <GrossDetailAmount currencyID="USD">0.25</GrossDetailAmount>
         <ItemID>220440760002</ItemID>
         <NetDetailAmount currencyID="USD">0.25</NetDetailAmount>
         <RefNumber>52713267436</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Titleist 735-CM Chrome, P-5 (6 irons) BEAUTIES!!! Stiff</Title>
      </AccountEntry>
      <AccountEntry>
         <AccountDetailsEntryType>FeeFinalValue</AccountDetailsEntryType>
         <Description>Final Value Fee</Description>
         <Date>2010-02-21T04:30:34.000Z</Date>
         <GrossDetailAmount currencyID="USD">3.94</GrossDetailAmount>
         <ItemID>220439083273</ItemID>
         <Memo>Final price: $45.00 (Auction)</Memo>
         <NetDetailAmount currencyID="USD">3.94</NetDetailAmount>
         <RefNumber>52692166426</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Cleveland XLS 4i 25 degree STIFF Graphite, EXCELLENT!</Title>
      </AccountEntry>
      <AccountEntry>
         <AccountDetailsEntryType>FeeFinalValue</AccountDetailsEntryType>
         <Description>Final Value Fee</Description>
         <Date>2010-02-22T05:30:39.000Z</Date>
         <GrossDetailAmount currencyID="USD">10.06</GrossDetailAmount>
         <ItemID>220440760002</ItemID>
         <Memo>Final price: $115.00 (Auction)</Memo>
         <NetDetailAmount currencyID="USD">10.06</NetDetailAmount>
         <RefNumber>52727310416</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Titleist 735-CM Chrome, P-5 (6 irons) BEAUTIES!!! Stiff</Title>
      </AccountEntry>
      <AccountEntry>
         <AccountDetailsEntryType>FeeIPIXPhoto</AccountDetailsEntryType>
         <Description>Picture Fee</Description>
         <Date>2010-02-21T19:40:13.000Z</Date>
         <GrossDetailAmount currencyID="USD">0.6</GrossDetailAmount>
         <ItemID>220440760002</ItemID>
         <NetDetailAmount currencyID="USD">0.6</NetDetailAmount>
         <RefNumber>52713267426</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Titleist 735-CM Chrome, P-5 (6 irons) BEAUTIES!!! Stiff</Title>
      </AccountEntry>
      <AccountEntry>
         <AccountDetailsEntryType>FeeIPIXPhoto</AccountDetailsEntryType>
         <Description>Picture Fee</Description>
         <Date>2010-02-21T20:11:48.000Z</Date>
         <GrossDetailAmount currencyID="USD">0.75</GrossDetailAmount>
         <ItemID>220440776662</ItemID>
         <NetDetailAmount currencyID="USD">0.75</NetDetailAmount>
         <RefNumber>52714914476</RefNumber>
         <VATPercent>0</VATPercent>
         <Title>Titleist 909 D3 9.5* Driver - Exotic Rombax 6X07 Stiff</Title>
      </AccountEntry>
   </AccountEntries>
   <PaginationResult>
      <TotalNumberOfPages>1</TotalNumberOfPages>
   </PaginationResult>
   <EntriesPerPage>6</EntriesPerPage>
   <PageNumber>1</PageNumber>
</GetAccountResponse>

GetAccount Change History

Version	Description
803 2012-12-12	AccountEntry.AccountDetailsEntryType.CreditReturnRefund (added): A credit issued to the seller's account by eBay as part of the auto-refund process, which is initiated if the seller does not refund the buyer within seven business days after receiving the returned item from the buyer. AccountEntry.AccountDetailsEntryType.FeeReturnRefund (added): The fee charged to the seller's account to compensate eBay for issuing the refund that was supposed to be issued by the seller.
795 2012-10-10	AccountEntry.AccountDetailsEntryType.FeeFedExShippingLabel (added): The fee charged to the seller for using a FedEx shipping label. AccountEntry.AccountDetailsEntryType.CreditFedExShippingLabel (added): A credit issued by eBay to reimburse the seller for a FedEx shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer.
793 2012-09-26	AccountEntry.AccountDetailsEntryType.CreditAuctionEndEarly (added): A credit issued by eBay to the seller's account if a duplicate auction listing is ended administratively by eBay. A seller is only eligible for this credit if the auction listing had zero bids and the listing was never surfaced in Search. AccountEntry.AccountDetailsEntryType.FeeAuctionEndEarly (added): A fee charged to the seller's account if the seller ends an auction (with one or more bids) early.
787 2012-08-15	AccountEntry.AccountDetailsEntryType.FeeGlobalShippingProgram (modified): The name of this enumeration value has changed from FeeGlobalShipping to FeeGlobalShippingProgram. AccountEntry.AccountDetailsEntryType.CreditGlobalShippingProgram (modified): The name of this enumeration value has changed from CreditGlobalShipping to CreditGlobalShippingProgram.
785 2012-08-01	AccountEntry.AccountDetailsEntryType.FeeGlobalShipping (added): New enumeration value that indicates that the user's account was debited for Global Shipping charge. AccountEntry.AccountDetailsEntryType.CreditGlobalShipping (added): New enumeration value that indicates that the user's account was credited for Global Shipping charge.
775 2012-05-23	AccountEntry.ReceivedTopRatedDiscount (added): This flag indicates that the seller received a top-rated seller discount on the final value fee for the item.
771 2012-04-29	AccountDetailEntryCodeType.CreditReturnShipping (added): New enumeration value that indicates that the user's account was credited for return shipping charge. AccountDetailEntryCodeType.FeeReturnShipping (added): New enumeration value that indicates that the user's account was debited for return shipping charge.
685 2010-08-25	GetAccountRequestType.IncludeConversionRate, AccountEntryType.ConversionRate (added): Enable you to retrieve the rate used for the currency conversion for a transaction.
681 2010-08-04	AccountEntry.Title, AccountDetailsEntryType.Discount (doc change): Explained the meaning of Discount and updated explanation of Title.
679 2010-07-21	AccountDetailsEntryType (modified): Added Discount as a type of entry.
551 2008-02-07	GetAccount.ItemID (added): Use ItemID to retrieve all account information incurred as a result of the item specified by GetAccount.ItemID. Whenever you use the ItemID field, all other available filters in the request are ignored. If the item specified by ItemID does not exist or if the requesting user is not the seller of the item, an error is returned in the response. The response of GetAccount remains unchanged.
499 2007-02-07	Credit, Debit (modified): Deleted previously deprecated objects from the latest schema. Use NetDetailAmount instead.
453 2006-03-22	AccountDetailEntryCodeType (added): Enum values added to this element.

User-Contributed Notes

eBay Trading API Call Reference Version 821