eBay Trading APIVersion 1179

GetAccountRequestType ( AbstractRequestType )

Returns a seller's invoice data for their eBay account, including the account's summary data.

Call that uses GetAccountRequestType:

Fields



AccountEntrySortType ( AccountEntrySortTypeCodeType ) [0..1]
Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order.
See the Field Index to learn which calls use AccountEntrySortType.

AccountHistorySelection ( AccountHistorySelectionCodeType ) [0..1]
Specifies the report format in which to return account entries.
See the Field Index to learn which calls use AccountHistorySelection.

BeginDate ( dateTime ) [0..1]
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.
See the Field Index to learn which calls use BeginDate.

Currency ( CurrencyCodeType ) [0..1]
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.
See the Field Index to learn which calls use Currency.

EndDate ( dateTime ) [0..1]
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.
See the Field Index to learn which calls use EndDate.

ExcludeBalance ( boolean ) [0..1]
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.
See the Field Index to learn which calls use ExcludeBalance.

ExcludeSummary ( boolean ) [0..1]
Specifies whether to return account summary information in an AccountSummary node. Default is true, to return AccountSummary.
See the Field Index to learn which calls use ExcludeSummary.

IncludeConversionRate ( boolean ) [0..1]
Specifies whether to retrieve the rate used for the currency conversion for usage transactions.
See the Field Index to learn which calls use IncludeConversionRate.

IncludeNettedEntries ( boolean ) [0..1]
An eBay managed payments seller includes this field and sets 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.

The seller's account has to be enabled for managed payments and the fee netting mechanism must be enabled for the managed payments account in order to retrieve the fee netted amounts. A seller can check their status for the fee netting mechanism by checking the value in the FeeNettingStatus field.

Note: For a limited number of managed payments sellers, final value fees and payment processing fees will start getting deducted from seller payouts as early as mid-June 2020, but for many other managed payments sellers, these fees won't start getting deducted from seller payouts until mid-July 2020.
See the Field Index to learn which calls use IncludeNettedEntries.

InvoiceDate ( dateTime ) [0..1]
This field is used to retrieve all account entries from a specific invoice, which is identified through this InvoiceDate field with the timestamp of the account invoice. This field is only applicable if the AccountHistorySelection value is set to 'SpecifiedInvoice'; otherwise, this field will be ignored.
See the Field Index to learn which calls use InvoiceDate.

ItemID ( ItemIDType (string) ) [0..1]
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.
See the Field Index to learn which calls use ItemID.

OrderID ( string ) [0..1]
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: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. 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.

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 filters in the request payload, including the GetAccount call, will support the identifiers for both unpaid and paid orders. The new order ID format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

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 or GetOrderTransactions 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.
See the Field Index to learn which calls use OrderID.

Pagination ( PaginationType ) [0..1]
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.
See the Field Index to learn which calls use Pagination.