eBay Trading APIVersion 1125

AccountSummaryType

Summary data for the requesting user's seller account as a whole. This includes a balance for the account, any past due amount and date, and defining data for additional accounts (if the user has changed country of residency while having an active eBay account).

Type that uses AccountSummaryType:

Call that uses AccountSummaryType:

Fields



AccountState ( AccountStateCodeType ) [0..1]
Indicates the current state of the account (such as active or inactive). Possible values are enumerated in AccountStateCodeType.
See the Field Index to learn which calls use AccountState.

AdditionalAccount ( AdditionalAccountType ) [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.
See the Field Index to learn which calls use AdditionalAccount.

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

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

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

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

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

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

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

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

Email ( string ) [0..1]
Not used by any call.

Email address on file for the user account. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created.
See the Field Index to learn which calls use Email.

InvoiceBalance ( AmountType (double) ) [0..1]
This field specifies the balance for the specified/last invoice. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice or SpecifiedInvoice. 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.
See the Field Index to learn which calls use InvoiceBalance.

InvoiceCredit ( AmountType (double) ) [0..1]
This field specifies the credit amount that has been issued to the user's account by eBay for the specified/last 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 or SpecifiedInvoice. 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.
See the Field Index to learn which calls use InvoiceCredit.

InvoiceDate ( dateTime ) [0..1]
This timestamp indicates the date and time of the specified/last invoice. This field is only returned if the AccountHistorySelection input field's value was set to LastInvoice or SpecifiedInvoice. 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.
See the Field Index to learn which calls use InvoiceDate.

InvoiceNewFee ( AmountType (double) ) [0..1]
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 SpecifiedInvoice. If there have been no fees since the last invoice was created, this value will be 0.0.
See the Field Index to learn which calls use InvoiceNewFee.

InvoicePayment ( AmountType (double) ) [0..1]
This field specifies the payment amount that has been made by the user for the specified/last 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 or SpecifiedInvoice. 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.
See the Field Index to learn which calls use InvoicePayment.

LastAmountPaid ( AmountType (double) ) [0..1]
This field shows the amount of the last payment that was made by the user.
See the Field Index to learn which calls use LastAmountPaid.

LastPaymentDate ( dateTime ) [0..1]
This timestamp shows the date and time of the last payment that was made by the user.
See the Field Index to learn which calls use LastPaymentDate.

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

This enumeration value indicates the primary payment method used by the user to pay monthly eBay invoices.
See the Field Index to learn which calls use PaymentMethod.