eBay Trading APIVersion 1423

GetAccount

Use this call to retrieve a seller's invoice data for their eBay account, including the account's summary data.

Usage Details

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers, including GetAccount. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

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), BetweenSpecifiedDates (returns entries posted between specific dates), or OrderId (returns entries related to a specific order)

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).

  1. Inspect the contents of each AccountEntries.AccountEntry container to get the values for each invoice.
  2. 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.
  3. 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:
Account Information
Testing Applications



Input Output Detail Controls Samples Change History

Input

See also Samples.

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 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>
 <IncludeNettedEntries> boolean </IncludeNettedEntries>
 <ItemID> ItemIDType (string) </ItemID>
 <OrderID> string </OrderID>
 <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: See AccountEntrySortType.
AccountHistorySelection AccountHistorySelectionCodeType Conditional Specifies the report format in which to return account entries.
Default: LastInvoice.

Applicable values:

BetweenSpecifiedDates
(in) This value should be used if the eBay user wants to see account entries for a customized date range that can overlap multiple formal eBay invoices. If this value is used, then you also must specify BeginDate and EndDate to set the date range for which to retrieve account entries. If this value is used, then InvoiceDate is no longer applicable and will be ignored if it is included in the call request.
CustomCode
(in) Reserved for internal or future use.
LastInvoice
(in) This value should be used if the eBay user wants to see the account entries posted to the last invoice that was sent to the user by eBay. If this value is used, the InvoiceDate, BeginDate, and EndDate fields of the GetAccount request are no longer applicable and will be ignored if they are included in the call request.
OrderId
(in) This value should be used if the eBay user wants to see the account entries related to a specific eBay order. If this value is used, the user must also include the OrderID field and sets its value to the identifier of the order for which they wish to retrieve account entries.
BeginDate dateTime Conditional 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.
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 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.
ExcludeBalance boolean Optional 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 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.
IncludeNettedEntries boolean Optional Include this field and set it to true to retrieve the total net amount of all charges/fees that have been deducted from seller payouts instead of being invoiced to the seller. The total net amount of any seller credits related to these fees is also shown. These fees and credit amounts will be shown in the AccountSummary.NettedTransactionSummary container in the response.
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.
OrderID string Conditional The unique identifier of an eBay order. This field must be included if the value of the AccountHistorySelection filter is set to OrderId. A user can filter by order ID to see if there are specific account entries related to a specific eBay order.

It is possible that no account entries will be found directly related to the specified order ID, and if this is the case, no AccountEntries container will be returned, and the ack value will still be Success.

Note: Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as request filters/parameters, including the GetAccount call, will support the identifiers for both unpaid and paid orders.

Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.
Pagination PaginationType Optional 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.
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.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.
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 the 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. Below are some examples from different countries.

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States
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 a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.

For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: 

 If the following output selectors are used: 

...
 <OutputSelector>ViewItemURL</OutputSelector>
 <OutputSelector>BuyItNowPrice</OutputSelector> 
... 

 ...the response might look like the following 

  <Item>
 <BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
 <ListingDetails>
 <ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL>
 </ListingDetails>
 </Item>

See OutputSelector.
Version string Conditional The version number of the API code that you are programming against (e.g., 1149). 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:
HTTP headers
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 performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Input Output Detail Controls Samples Change History

Output

See also Samples.

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 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 currencyID="CurrencyCodeType"> AmountType (double) </Balance>
 <ConversionRate currencyID="CurrencyCodeType"> AmountType (double) </ConversionRate>
 <Date> dateTime </Date>
 <Description> string </Description>
 <DiscountDetail> DiscountDetailType
 <Discount> DiscountType
 <Amount currencyID="CurrencyCodeType"> AmountType (double) </Amount>
 <DiscountType> string </DiscountType>
 </Discount>
 <!-- ... more Discount nodes allowed here ... -->
 </DiscountDetail>
 <GrossDetailAmount currencyID="CurrencyCodeType"> AmountType (double) </GrossDetailAmount>
 <ItemID> ItemIDType (string) </ItemID>
 <Memo> string </Memo>
 <NetDetailAmount currencyID="CurrencyCodeType"> AmountType (double) </NetDetailAmount>
 <Netted> boolean </Netted>
 <OrderId> string </OrderId>
 <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 currencyID="CurrencyCodeType"> AmountType (double) </Balance>
 <Currency> CurrencyCodeType </Currency>
 </AdditionalAccount>
 <!-- ... more AdditionalAccount nodes allowed here ... -->
 <AmountPastDue currencyID="CurrencyCodeType"> AmountType (double) </AmountPastDue>
 <BankAccountInfo> string </BankAccountInfo>
 <BankModifyDate> dateTime </BankModifyDate>
 <BillingCycleDate> int </BillingCycleDate>
 <CreditCardExpiration> dateTime </CreditCardExpiration>
 <CreditCardInfo> string </CreditCardInfo>
 <CreditCardModifyDate> dateTime </CreditCardModifyDate>
 <CurrentBalance currencyID="CurrencyCodeType"> AmountType (double) </CurrentBalance>
 <InvoiceBalance currencyID="CurrencyCodeType"> AmountType (double) </InvoiceBalance>
 <InvoiceCredit currencyID="CurrencyCodeType"> AmountType (double) </InvoiceCredit>
 <InvoiceDate> dateTime </InvoiceDate>
 <InvoiceNewFee currencyID="CurrencyCodeType"> AmountType (double) </InvoiceNewFee>
 <InvoicePayment currencyID="CurrencyCodeType"> AmountType (double) </InvoicePayment>
 <LastAmountPaid currencyID="CurrencyCodeType"> AmountType (double) </LastAmountPaid>
 <LastPaymentDate> dateTime </LastPaymentDate>
 <NettedTransactionSummary> NettedTransactionSummaryType
 <TotalNettedChargeAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalNettedChargeAmount>
 <TotalNettedCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalNettedCreditAmount>
 </NettedTransactionSummary>
 <PastDue> boolean </PastDue>
 <PaymentMethod> SellerPaymentMethodCodeType </PaymentMethod>
 </AccountSummary>
 <Currency> CurrencyCodeType </Currency>
 <EntriesPerPage> int </EntriesPerPage>
 <FeeNettingStatus> FeenettingStatusCodeType </FeeNettingStatus>
 <HasMoreEntries> boolean </HasMoreEntries>
 <PageNumber> int </PageNumber>
 <PaginationResult> PaginationResultType
 <TotalNumberOfEntries> int </TotalNumberOfEntries>
 <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 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 no entries exist for an order (if OrderId value is used).
AccountEntries.AccountEntry AccountEntryType Conditionally,
repeatable: [0..*] Container consisting of detailed information for each debit or credit transaction that occurs on an eBay user's account.
AccountEntries.AccountEntry
.AccountDetailsEntryType AccountDetailEntryCodeType Conditionally This enumeration value indicates the type of transaction or administrative action that occurred on the eBay user's account. Possible values are defined in the AccountDetailEntryCodeType enumerated type.

Applicable values: See AccountDetailsEntryType.
Code so that your app gracefully handles any future changes to this list.
AccountEntries.AccountEntry
.Balance AmountType (double) Conditionally This field is no longer returned. If the eBay user has an outstanding balance owed to eBay, the owed amount will be displayed in the AccountSummary.CurrentBalance field in the GetAccount response.
AccountEntries.AccountEntry
.Balance
[ attribute currencyID ] CurrencyCodeType Always This field is no longer returned. If the eBay user has an outstanding balance owed to eBay, the owed amount will be displayed in the AccountSummary.CurrentBalance field in the GetAccount response.

For a list of possible enumeration values, see CurrencyCodeType.
AccountEntries.AccountEntry
.ConversionRate AmountType (double) Conditionally The rate used for the currency conversion for a transaction.
AccountEntries.AccountEntry
.ConversionRate
[ attribute currencyID ] CurrencyCodeType Always The rate used for the currency conversion for a transaction.

For a list of possible enumeration values, see CurrencyCodeType.
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 The category of the monetary transaction or administrative action applied to an eBay account.
AccountEntries.AccountEntry
.DiscountDetail DiscountDetailType Conditionally This container is an array of one or more discounts applied to the corresponding accounty entry. This container will not be returned if there are no discounts applied to the corresponding accounty entry.
AccountEntries.AccountEntry
.DiscountDetail.Discount DiscountType Conditionally,
repeatable: [0..*] This container indicates the discount type and amount applied to an account entry.

Note: The discount type will be shown for any account entry where a discount applies, but the discount amount will only be shown if the corresponding fee was deducted from a seller payout.
AccountEntries.AccountEntry
.DiscountDetail.Discount
.Amount AmountType (double) Conditionally The amount of the discount in the currency indicated in the currencyID attribute.

Note: The discount amount will only be shown if the corresponding fee was deducted from a seller payout.
AccountEntries.AccountEntry
.DiscountDetail.Discount
.Amount
[ attribute currencyID ] CurrencyCodeType Always The amount of the discount in the currency indicated in the currencyID attribute.

Note: The discount amount will only be shown if the corresponding fee was deducted from a seller payout.

For a list of possible enumeration values, see CurrencyCodeType.
AccountEntries.AccountEntry
.DiscountDetail.Discount
.DiscountType string Conditionally The value in this field indicates the type of discount applied to the corresponding account entry.
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
.GrossDetailAmount
[ attribute currencyID ] CurrencyCodeType Always 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.

For a list of possible enumeration values, see CurrencyCodeType.
AccountEntries.AccountEntry
.ItemID ItemIDType (string) Conditionally If the account entry is associated with an eBay listing, this field shows the eBay ItemID value. If there is no correlation between the account entry and one of the user's eBay listings, '0' is returned in this field.
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 surcharges and 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
.NetDetailAmount
[ attribute currencyID ] CurrencyCodeType Always Net fees that are assessed by eBay, excluding additional surcharges and 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).

For a list of possible enumeration values, see CurrencyCodeType.
AccountEntries.AccountEntry
.Netted boolean Conditionally This boolean field is returned with each account entry if the IncludeNettedEntries field is included in the request and set to true. The value indicates whether or not the corresponding account entry value (charge or credit) is a part of the 'Total Netted Charge Amount' or 'Total Netted Credit Amount' values returned in the AccountSummary.NettedTransactionSummary container.

If this value is true, it indicates that the corresponding fee was deducted from a seller payout. If the value is false, it indicates that the fee or credit was invoiced to the seller instead.
AccountEntries.AccountEntry
.OrderId string Conditionally This field is returned if the account fee or credit is associated with an entire (single or multiple line item) order, and not necessarily for a single line item within the order.
AccountEntries.AccountEntry
.OrderLineItemID string Conditionally OrderLineItemID is a unique identifier for an eBay order line item. This field is only returned if the account entry is associated with an order line item.
AccountEntries.AccountEntry
.ReceivedTopRatedDiscount boolean Conditionally This boolean field is returned as true if the seller received a discount on the Final Value Fee for the order line item. Only Top-Rated sellers are eligible for this Final Value Fee discount. The Final Value Fee discount percentage varies by country. For more information on becoming a Top-Rated Seller in the US and the requirements for Top-Rated Plus listings, see the Becoming a Top Rated Seller help topic.

This field will not be returned until eBay bills the seller for the Final Value Fee for the eligible order line item.
AccountEntries.AccountEntry
.RefNumber string Conditionally This value is the unique identifier for the account entry. This value is created by eBay once the transaction occurs on the user's account.
AccountEntries.AccountEntry
.Title string Conditionally A description or comment about the monetary transaction or administrative action applied to an eBay user account.
AccountEntries.AccountEntry
.TransactionID string Conditionally The unique identifier of an order line item. This field is only returned if the account entry is associated with an order line item.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.

Note: Historically, TransactionID values have been '0' for auction listings, and some developers may have built logic around this. However, non-zero TransactionID values for auction listings started being used for some eBay marketplaces beginning in July 2024, and all eBay marketplaces are expected to start using non-zero TransactionID values for auction listings in the near future. If necessary, developers should update code to handle non-zero transaction IDs for auction transactions.
AccountEntries.AccountEntry
.VATPercent decimal Conditionally The applicable rate that was used to calculate the VAT (Value-Added Tax) for the transaction. When the VATPercent is specified for a listing, the item's VAT information appears on the View Item 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. VAT is only applicable to sellers located in a European Union (EU) country. If VAT does not apply to the account entry, this field is still returned but it's value will be '0'.
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 AccountStateCodeType.

Applicable values:

Active
(out) This value indicates that the eBay user account is active.
CustomCode
(out) Reserved for internal or future use.
Inactive
(out) This value indicates that the eBay user account is inactive. No new seller account entries would be posted by eBay to the account.
Pending
(out) This value indicates that the eBay user account has been created, but is not yet active, pending additional information or processing by eBay.

Code so that your app gracefully handles any future changes to this list.
AccountSummary
.AdditionalAccount AdditionalAccountType Conditionally,
repeatable: [0..*] This container shows the identifier and current balance for another eBay account associated with the eBay user. This container will appear under the AccountSummary container for each additional account that the eBay user owns.
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.Balance
[ attribute currencyID ] CurrencyCodeType Always Indicates the current balance of the additional account.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary
.AdditionalAccount.Currency CurrencyCodeType Conditionally Indicates the currency in which monetary amounts for the additional account are expressed.

Applicable values: See Currency.
Code so that your app gracefully handles any future changes to this list.
AccountSummary.AmountPastDue AmountType (double) Conditionally This value indicates the amount of money that is past due on the user's account. If no money is past due, this value will be 0.0.
AccountSummary.AmountPastDue
[ attribute currencyID ] CurrencyCodeType Always This value indicates the amount of money that is past due on the user's account. If no money is past due, this value will be 0.0.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.BankAccountInfo string Conditionally This string value represents the first four digits of the bank account the associated with the user account. This field is only applicable if a bank account is being used to pay monthly invoices.
Max length: 4.
AccountSummary.BankModifyDate dateTime Conditionally This timestamp indicates the date and time when the owner of the account last changed the bank account on file as the primary payment method. This field may not be returned if the bank account on file has never been changed, or if the primary payment method is not a bank account.
AccountSummary
.BillingCycleDate int Conditionally This integer value indicates the day of the month on which eBay sends a billing invoice to the user. A value of 0 indicates that an invoice is sent on the last day of each month. A value of 1515 indicates that an invoice is sent on the 15th day of each month.
AccountSummary
.CreditCardExpiration dateTime Conditionally This timestamp indicates the expiration date for the credit card that is currently on file and used to pay monthly invoices. This field may not be returned if the primary method is not a credit card.
AccountSummary.CreditCardInfo string Conditionally This string value represents the last four digits of the credit card that the user selected as payment method for the account. This field is only applicable if a credit card is being used to pay monthly invoices.
AccountSummary
.CreditCardModifyDate dateTime Conditionally This timestamp indicates the date and time when the owner of the account last changed the credit card on file as the primary payment method. This field may not be returned if the credit card on file has never been changed, or if the primary payment method is not a credit card.
AccountSummary.CurrentBalance AmountType (double) Conditionally This field shows the current balance for the user's account. This value can be 0.0, a positive amount (debit), or a negative amount (credit).

This field is only returned if the ExcludeBalance flag is included in the call request and set to false.
AccountSummary.CurrentBalance
[ attribute currencyID ] CurrencyCodeType Always This field shows the current balance for the user's account. This value can be 0.0, a positive amount (debit), or a negative amount (credit).

This field is only returned if the ExcludeBalance flag is included in the call request and set to false.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.InvoiceBalance AmountType (double) Conditionally This field specifies the balance for the invoice. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. The value is positive for debits and negative for credits.
AccountSummary.InvoiceBalance
[ attribute currencyID ] CurrencyCodeType Always This field specifies the balance for the invoice. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. The value is positive for debits and negative for credits.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.InvoiceCredit AmountType (double) Conditionally This field specifies the credit amount that has been issued to the user's account by eBay for the invoice. This field is only returned if a credit has been issued towards the invoice, and if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. If a payment was made by the user instead, this payment amount will be shown in the InvoicePayment field.
AccountSummary.InvoiceCredit
[ attribute currencyID ] CurrencyCodeType Always This field specifies the credit amount that has been issued to the user's account by eBay for the invoice. This field is only returned if a credit has been issued towards the invoice, and if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. If a payment was made by the user instead, this payment amount will be shown in the InvoicePayment field.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.InvoiceDate dateTime Conditionally This timestamp indicates the date and time of the invoice. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified.
AccountSummary.InvoiceNewFee AmountType (double) Conditionally This field specifies the balance of any new fees that have been assessed toward the user's account since the last invoice was created. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates or OrderId. If there have been no fees since the last invoice was created, this value will be 0.0.
AccountSummary.InvoiceNewFee
[ attribute currencyID ] CurrencyCodeType Always This field specifies the balance of any new fees that have been assessed toward the user's account since the last invoice was created. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates or OrderId. If there have been no fees since the last invoice was created, this value will be 0.0.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.InvoicePayment AmountType (double) Conditionally This field specifies the payment amount that has been made by the user for the invoice. This field is only returned if a payment has been made towards the invoice, and if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. If a credit was issued by eBay to the user instead, this credit will be shown in the InvoiceCredit field.
AccountSummary.InvoicePayment
[ attribute currencyID ] CurrencyCodeType Always This field specifies the payment amount that has been made by the user for the invoice. This field is only returned if a payment has been made towards the invoice, and if the AccountHistorySelection input field's value was set to LastInvoice. This field is not returned if the AccountHistorySelection input field's value was set to BetweenSpecifiedDates and a custom time period (overlapping multiple billing cycles) was specified. If a credit was issued by eBay to the user instead, this credit will be shown in the InvoiceCredit field.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.LastAmountPaid AmountType (double) Conditionally This field shows the amount of the last payment that was made by the user.
AccountSummary.LastAmountPaid
[ attribute currencyID ] CurrencyCodeType Always This field shows the amount of the last payment that was made by the user.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.LastPaymentDate dateTime Conditionally This timestamp shows the date and time of the last payment that was made by the user.
AccountSummary
.NettedTransactionSummary NettedTransactionSummaryType Conditionally This container shows the total amount of fees (and credits if applicable) that have already been paid through seller payout deductions. The seller must include the IncludeNettedEntries field in the request and set it to true in order for this container to be returned.
AccountSummary
.NettedTransactionSummary
.TotalNettedChargeAmount AmountType (double) Conditionally The amount in this field is the total amount of all charges/fees that have been deducted from seller payouts, and not invoiced to the seller. This value should equal the total sum of all the 'netted' fees in the AccountEntries array. The corresponding Netted boolean field for each fee in AccountEntries array will show as true if the fee has already been deducted from a seller payout.

This field is returned even if 0.0.
AccountSummary
.NettedTransactionSummary
.TotalNettedChargeAmount
[ attribute currencyID ] CurrencyCodeType Always The amount in this field is the total amount of all charges/fees that have been deducted from seller payouts, and not invoiced to the seller. This value should equal the total sum of all the 'netted' fees in the AccountEntries array. The corresponding Netted boolean field for each fee in AccountEntries array will show as true if the fee has already been deducted from a seller payout.

This field is returned even if 0.0.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary
.NettedTransactionSummary
.TotalNettedCreditAmount AmountType (double) Conditionally The amount in this field is the total amount of all credits for fees that have been deducted from seller payouts, and not invoiced to the seller. This value should equal the total sum of all the 'netted' credit in the AccountEntries array. The corresponding Netted boolean field for each credit in AccountEntries array will show as true if the credit is for a fee that has already been deducted from a seller payout.

This field is returned even if 0.0.
AccountSummary
.NettedTransactionSummary
.TotalNettedCreditAmount
[ attribute currencyID ] CurrencyCodeType Always The amount in this field is the total amount of all credits for fees that have been deducted from seller payouts, and not invoiced to the seller. This value should equal the total sum of all the 'netted' credit in the AccountEntries array. The corresponding Netted boolean field for each credit in AccountEntries array will show as true if the credit is for a fee that has already been deducted from a seller payout.

This field is returned even if 0.0.

For a list of possible enumeration values, see CurrencyCodeType.
AccountSummary.PastDue boolean Conditionally This boolean field indicates whether or not the account has a past due balance. A value of true indicates that the account is past due, and a value of false indicates that the account is current. If the account is past due, the amount past due can be found in the AmountPastDue field.
AccountSummary.PaymentMethod SellerPaymentMethodCodeType Conditionally This enumeration value indicates the primary payment method used by the user to pay monthly eBay invoices.

Applicable values: See PaymentMethod.
Code so that your app gracefully handles any future changes to this list.
Currency CurrencyCodeType Always Indicates the currency used for monetary amounts in the report.

Applicable values: See Currency.
Code so that your app gracefully handles any future changes to this list.
EntriesPerPage int Always 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.
FeeNettingStatus FeenettingStatusCodeType Always This enumeration value indicates the current status of the seller's account for the fee netting mechanism. If the Enabled value is returned, the seller may include the IncludeNettedEntries field in the request to retrieve the total net amount of all charges/fees that have been deducted from seller payouts instead of being invoiced to the seller. The total net amount of any seller credits related to these fees is also shown in the AccountSummary.NettedTransactionSummary container in the response.

Applicable values:

Disabled
(out) This value indicates that the account is not enabled for the fee netting mechanism. .
Enabled
(out) This value indicates that the account is enabled for the fee netting mechanism. If a user sees this value, the GetAccount response will include the AccountSummary.NettedTransactionSummary container and the AccountEntry.Netted boolean field for each account entry.
Exempted
(out) This value indicates that the account is exempted from the fee netting mechanism.

Code so that your app gracefully handles any future changes to this list.
HasMoreEntries boolean Conditionally 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.
PageNumber int Always 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.
PaginationResult PaginationResultType Always 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.
PaginationResult
.TotalNumberOfEntries int Always Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
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 the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
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.
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.

Code so that your app gracefully handles any future changes to this list.
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 Errors By Number.

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 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.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Error handling section of the Making a Trading API call guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Input Output Detail Controls Samples Change History

Detail Controls


DetailLevel

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



Input Output Detail Controls Samples Change History

Samples

New to making API calls? Please see Making a Call.

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.
<?xml version="1.0" encoding="utf-8"?>
<GetAccountRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <RequesterCredentials>
 <eBayAuthToken>A*******3</eBayAuthToken>
 </RequesterCredentials>
 <AccountEntrySortType>AccountEntryFeeTypeAscending</AccountEntrySortType>
 <AccountHistorySelection>LastInvoice</AccountHistorySelection>
</GetAccountRequest>

Output

XML format.
<GetAccountResponse xmlns="urn:ebay:apis:eBLBaseComponents">
 <Timestamp>2019年11月04日T17:49:51.095Z</Timestamp>
 <Ack>Success</Ack>
 <Version>1131</Version>
 <Build>E1131_CORE_API6_19105226_R1</Build>
 <AccountID>E***********1-**D</AccountID>
 <AccountSummary>
 <AccountState>Active</AccountState>
 <AmountPastDue currencyID="USD">0.0</AmountPastDue>
 <BillingCycleDate>15</BillingCycleDate>
 <InvoiceBalance currencyID="USD">11.22</InvoiceBalance>
 <InvoiceDate>2019年10月15日T06:59:59.000Z</InvoiceDate>
 <LastAmountPaid currencyID="USD">-7.49</LastAmountPaid>
 <LastPaymentDate>2019年09月30日T21:55:43.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>2019年10月23日T15:35:11.000Z</Date>
 <GrossDetailAmount currencyID="USD">0.05</GrossDetailAmount>
 <ItemID>1**********3</ItemID>
 <NetDetailAmount currencyID="USD">0.05</NetDetailAmount>
 <RefNumber>2***********0</RefNumber>
 <VATPercent>0</VATPercent>
 <Title>Marilyn Monroe \x93Sultry Yet Regal\x93 Porcelain Collectors Plate Bradford Exchange</Title>
 </AccountEntry>
 <AccountEntry>
 <AccountDetailsEntryType>FeeFinalValue</AccountDetailsEntryType>
 <Description>Final Value Fee</Description>
 <Date>2019年10月24日T18:33:36.000Z</Date>
 <GrossDetailAmount currencyID="USD">0.96</GrossDetailAmount>
 <ItemID>1**********0</ItemID>
 <Memo>Final price: 12ドル.00 (Auction)</Memo>
 <NetDetailAmount currencyID="USD">0.96</NetDetailAmount>
 <RefNumber>2***********0</RefNumber>
 <VATPercent>0</VATPercent>
 <Title>Jonathon Byron Floating Swans 3-D Hand-Painted Porcelain Collector Plate</Title>
 <OrderLineItemID>1**********0-0</OrderLineItemID>
 <TransactionID>0</TransactionID>
 </AccountEntry>
 <AccountEntry>
 <AccountDetailsEntryType>FeeFinalValueShipping</AccountDetailsEntryType>
 <Description>Final Value Fee on Shipping</Description>
 <Date>2019年10月24日T20:09:11.000Z</Date>
 <GrossDetailAmount currencyID="USD">0.7</GrossDetailAmount>
 <ItemID>1**********0</ItemID>
 <Memo>Shipping and other costs less sales tax: 8ドル.75 (Auction)</Memo>
 <NetDetailAmount currencyID="USD">0.7</NetDetailAmount>
 <RefNumber>2***********0</RefNumber>
 <VATPercent>0</VATPercent>
 <Title>Jonathon Byron Floating Swans 3-D Hand-Painted Porcelain Collector Plate</Title>
 <OrderLineItemID>1**********0-0</OrderLineItemID>
 <TransactionID>0</TransactionID>
 </AccountEntry>
 <AccountEntry>
 <AccountDetailsEntryType>PaymentIntermediationFee</AccountDetailsEntryType>
 <Description>Payments processing fee</Description>
 <Date>2019年10月24日T20:09:17.000Z</Date>
 <GrossDetailAmount currencyID="USD">0.45</GrossDetailAmount>
 <ItemID>1**********0</ItemID>
 <Memo>Fee collected by eBay Inc. on behalf of eBay Commerce Inc. (+1 (800) 456-3229)</Memo>
 <NetDetailAmount currencyID="USD">0.45</NetDetailAmount>
 <RefNumber>2***********0</RefNumber>
 <VATPercent>0</VATPercent>
 <Title>Jonathon Byron Floating Swans 3-D Hand-Painted Porcelain Collector Plate</Title>
 </AccountEntry>
 </AccountEntries>
 <PaginationResult>
 <TotalNumberOfPages>1</TotalNumberOfPages>
 </PaginationResult>
 <EntriesPerPage>4</EntriesPerPage>
 <PageNumber>1</PageNumber>
</GetAccountResponse>



Input Output Detail Controls Samples Change History

Change History

Change Date Description
1357
2024年04月08日
  • AccountDetailEntryCodeType (modified): Four new enumeration values were added: RegulatoryOperatingFee, RegulatoryOperatingFeeCredit, DHLPaymentProcessingFee, DHLPaymentProcessingFeeCredit.
1331
2023年10月23日
  • AccountDetailEntryCodeType (modified): Four new enumeration values were added: HermesReturnLblSellerPaidShpFee, HermesReturnLblSellerPaidShpFeeCr, DHLReturnLblShippingFee, DHLReturnLblShippingFeeCredit.
1313
2023年06月02日
  • AccountDetailEntryCodeType (modified): Sixteen new enumeration values added to support return shipping label fees: PromotedDisplayFee,PromotedDisplayFeeCredit,USWHTFederal,USWHTFederalCredit,USWHTState,USWHTStateCredit,EPRFee,EPRFeeCredit,CAPostReturnLabelFee,CAPostReturnLabelFeeCredit,HermesReturnLabelFee,HermesReturnLabelFeeCredit,BankPayoutFee,BankPayoutFeeCredit,CharityDonation,CharityDonationCredit.
1281
2022年10月21日
  • AccountDetailEntryCodeType (modified): Sixteen new enumeration values added (FedExReturnLabelFee,FedExReturnLabelFeeCredit,AUPostReturnLabelFee,AUPostReturnLabelFeeCredit,UpsCaLabelFee,UpsCaLabelFeeCredit,FedExCaLabelFee,FedExCaLabelFeeCredit,HubbedReturnLabelFee,HubbedReturnLabelFeeCredit,RoyalMailReturnLabelFee,RoyalMailReturnLabelFeeCredit,ParcelForcePostReturnLabelFee,ParcelForcePostReturnLabelFeeCredit,OffsiteAdsFee,OffsiteAdsFeeCredit) to support shipping fees.
1225
2021年09月24日
  • AccountHistorySelectionCodeType (modified): The SpecifiedInvoice was marked as deprecated and removed from public docs.
1209
2021年06月04日
  • AccountDetailEntryCodeType (modified): DepositProcessingVariableFee, DepositProcessingVariableFeeCredit, DepositProcessingFixedFee, and DepositProcessingFixedFeeCredit enums added to support new deposit processing fees.
1201
2021年04月09日
  • AccountDetailEntryCodeType (modified): AdFeeExpress and AdFeeExpressCredit enums added to support Promoted Listing Express fee.
1157
2020年06月05日
  • Request.IncludeNettedEntries (added): This field is included and set to true if a managed payments seller wishes to see a breakdown of fees that have already been paid through seller payout deductions.
  • AccountDetailEntryCodeType (modified): The following enum values were added to support final value and other fees that will start getting deducted from the seller payouts of managed payments sellers. See the type definition for more details on these new enums. FinalValueFee, FinalValueFeeCredit, InternationalFee, InternationalFeeCredit, FinalValueFeeFixedFeePerOrder, FinalValueFeeFixedFeePerOrderCredit.
  • Response.FeeNettingStatus (added): The enumeration value in this field indicates whether or not seller fees will be deducted from a seller's payout.
  • AccountSummary.NettedTransactionSummary (added): This container shows the total amount of fees (and credits if applicable) that have already been paid through seller payout deductions.
  • AccountEntry.Netted (added): This boolean field indicates if the corresponding account entry value (charge or credit) relates to a fee that was deducted from a seller payout.
  • AccountEntry.DiscountDetail (added): This container is an array of one or more discounts applied to the corresponding accounty entry.
  • AccountEntry.OrderId (modified): Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.
1145
2020年03月13日
  • AccountDetailEntryCodeType (modified): The following enum values were added to support eBay/seller 'co-funding' coupons and shipping label fees charged to managed payment sellers. See the type definition for more details on these new enums. UspsLabelFee, UspsLabelFeeCredit, ShippingInsuranceFee, ShippingInsuranceFeeCredit, UspsShortpaidFee, UspsShortpaidFeeCredit.
  • OrderID (doc change): Updated the OrderID request field description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads. Note that with the new order ID format, the unique identifier of an order will change as the order goes from unpaid to paid status. For Trading API calls that support OrderID as a request filter, the OrderID request field will still accept order ID values for unpaid orders, but once payment has been made for an order, sellers are advised to use the unique identifier for the paid order, as this will be the permanent identifier of the order once payment occurs, and the order ID that is also known to the buyer.
  • AccountHistorySelectionCodeType (doc change): Updated OrderId enum value description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads.
  • AccountEntry.OrderId (doc change): Updated OrderId field description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads.
1131
2019年10月25日
  • AccountHistorySelectionCodeType (modified): OrderId was added as an enum to search for account entries related to a specific order. If this enum value is used, the user must also include the OrderID field in the request and specify the unique identifier of the order in this field.
  • GetAccountRequest.OrderID (added): This field must be included and set if the AccountHistorySelection field is set to OrderId. A unique order ID (old or new format) is passed into the OrderID field to identify the order.
1129
2019年10月11日
  • AccountDetailEntryCodeType (modified): The following enum values were added: EbaySendLabelFee, EbaySendLabelFeeCredit, PaymentIntermediationFeeCredit, USInternetSalesTax, USInternetSalesTaxCredit, NewZealandGST, NewZealandGSTCredit, AustraliaGST, AustraliaGSTCredit.
  • AccountEntry.OrderId (added): This field is returned if the account fee or credit is associated with an entire (single or multiple line item) order, and not necessarily for a single line item within the order.
1125
2019年09月13日
  • AccountDetailEntryCodeType (modified): The following enum values were added: AdFeePremium, AdFeePremiumCredit, PerListingPaymentsFee, PerListingPaymentsFeeCredit, VehiclesListingBasicPackageFee, VehiclesListingBasicPackageCredit, VehiclesListingPlusPackageFee, VehiclesListingPlusPackageCredit, VehiclesListingPremiumPackageFee, VehiclesListingPremiumPackageCredit, SendLabelFee, SendLabelFeeCredit, UpsLabelFee, UpsLabelFeeCredit, CanadaPostLabelFee, CanadaPostLabelFeeCredit.
1101
2019年03月29日
  • AccountDetailEntryCodeType (modified): Six new enumeration values (SnadOutlierFinalValueFee, SnadOutlierFinalValueFeeCredit, SnadOutlierFinalValueFeeOnShipping, SnadOutlierFinalValueFeeOnShippingCredit, HighlineSearchFee and HighlineSearchFeeCredit) added to represent SNAD Final Value fees and credits, and to represent the fee and credit for the new 'Highline Search' feature.
1077
2018年08月31日
  • AccountDetailEntryCodeType (modified): Four new enumeration values (PaymentIntermediationFee, FeePaymentIntermediationRVI, FeePaymentIntermediationChargeback, and FeePaymentIntermediationChargebackRVI) added to represent eBay payment intermediation fees and credits. These fees and credits are only applicable for sellers in the eBay Payments beta program.
0975
2016年07月01日
  • AccountEntry.ReceivedTopRatedDiscount (doc change): Field description was updated to state that the field is only returned after eBay bills the seller for the Final Value Fee for the eligible order line item.
0947
2015年10月29日
  • AccountDetailEntryCodeType (modified): Two new enumeration values, FeeeBayPlusSubscription and CrediteBayPlusSubscription, represent a fee charged or a credit granted, respectively, for an eBay Plus subscription on the eBay Germany site.
0945
2015年10月15日
  • AccountDetailEntryCodeType (modified): Two new enumeration values, FeeUBIShippingLabel and CreditUBIShippingLabel, were added to account for Universal Business Integration (UBI) shipping labels that are used by sellers in China.
0893
2014年09月23日
  • AccountDetailEntryCodeType (modified): FeePromotedListingFeature and CreditPromotedListingFeature added as new enumeration values. These two account entry values represent a fee charged or a credit granted, respectively, for the Promoted Listing feature.
0847
2013年10月22日
  • AccountDetailEntryCodeType (modified): FeeEBPReimbursement and CreditEBPReimbursement added as new enumeration values. These two account entry values represent a fee charged or a credit granted, respectively, by eBay to the account of a buyer or seller in connection with an eBay Buyer Protection case.
0841
2013年09月19日
  • AccountDetailEntryCodeType (modified): FeeAPACFedExShippingLabel, CreditAPACFedExShippingLabel, FeeAPACTNTShippingLabel, CreditAPACTNTShippingLabel, FeeAUPostShippingLabel and CreditAUPostShippingLabel added as new enumeration values. These six values handle fees and credits to the seller for printing out and using APAC FedEx, APAC TNT and AU Post shipping labels from eBay.
0837
2013年08月29日
  • AccountDetailEntryCodeType (modified): FeeVehicleSubscriptionEarlyTermination, CreditVehicleSubscriptionEarlyTermination, FeeVehicleSubscription, and CreditVehicleSubscription added as new enumeration values. These four values handle the fees and credits for monthly subscriptions and early termination fees for National Vehicle subsriptions for sellers.
0803
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.
0795
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.
0793
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.
0787
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.
0785
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.
0775
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.
0771
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.
0685
2010年08月25日
  • GetAccountRequestType.IncludeConversionRate, AccountEntryType.ConversionRate (added): Enable you to retrieve the rate used for the currency conversion for a transaction.
0681
2010年08月04日
  • AccountEntry.Title, AccountDetailsEntryType.Discount (doc change): Explained the meaning of Discount and updated explanation of Title.
0679
2010年07月21日
  • AccountDetailsEntryType (modified): Added Discount as a type of entry.
0551
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.
0499
2007年02月07日
  • Credit, Debit (modified): Deleted previously deprecated objects from the latest schema. Use NetDetailAmount instead.
0453
2006年03月22日
  • AccountDetailEntryCodeType (added): Enum values added to this element.

AltStyle によって変換されたページ (->オリジナル) /