eBay Trading APIVersion 1149

AccountEntryType

Type defining the AccountEntry container returned in the GetAccount response. Each AccountEntry container consists of detailed information for a single credit or debit transaction, or an administrative action which occurred on the eBay user's account.

Type that uses AccountEntryType:

Call that uses AccountEntryType:

Fields



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

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

ConversionRate ( AmountType (double) ) [0..1]
The rate used for the currency conversion for a transaction.
See the Field Index to learn which calls use ConversionRate.

Date ( dateTime ) [0..1]
Timestamp indicating the date and time that the entry was posted to the account, in GMT.
See the Field Index to learn which calls use Date.

Description ( string ) [0..1]
The category of the monetary transaction or administrative action applied to an eBay account.
See the Field Index to learn which calls use Description.

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

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

Memo ( string ) [0..1]
Memo line for the account entry. It can be an empty string.
See the Field Index to learn which calls use Memo.

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

OrderId ( string ) [0..1]
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.

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

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

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

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

Title ( string ) [0..1]
A description or comment about the monetary transaction or administrative action applied to an eBay user account.
See the Field Index to learn which calls use Title.

TransactionID ( string ) [0..1]
The unique identifier of an order line item. This field is only returned if the account entry is associated with an order line item.
See the Field Index to learn which calls use TransactionID.

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