/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::AccountSummaryType

NAME

eBay::API::XML::DataType::AccountSummaryType

DESCRIPTION

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

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::AccountSummaryType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAccountState()

Indicates the current state of the account (such as active or inactive). Possible values are enumerated in the AccountStateCodeType code list.

# Argument: 'ns:AccountStateCodeType'

getAccountState()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AccountStateCodeType'

setAdditionalAccount()

Contains the data for one additional account. An AccountSummaryType object may return zero, one, or multiple additional accounts. See the schema documentation for AdditionalAccountType for details on additional accounts. The value is positive for debits and negative for credits.

# Argument: reference to an array of 'ns:AdditionalAccountType'

getAdditionalAccount()

Calls: GetAccount
Returned: Conditionally

# Returns: reference to an array of 'ns:AdditionalAccountType'

setAmountPastDue()

Amount past due, 0.00 if not past due. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getAmountPastDue()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setBankAccountInfo()

First four digits of the bank account the user associated with the seller account (with remainder Xed-out). This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified).

MaxLength: 4

# Argument: 'xs:string'

getBankAccountInfo()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:string'

setBankModifyDate()

Indicates the date and time BankAccountInfo was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified).

# Argument: 'xs:dateTime'

getBankModifyDate()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:dateTime'

setBillingCycleDate()

Indicates the billing cycle in which eBay sends a billing invoice to the user. A value of 0 (zero) indicates an invoice sent on the last day of the month. A value of 15 indicates an invoice sent on the 15th day of the month.

# Argument: 'xs:int'

getBillingCycleDate()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:int'

setCreditCardExpiration()

Expiration date for the credit card selected by the user as payment method for the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no credit card is on file or if the account is inactive - even if there is a credit card on file.

# Argument: 'xs:dateTime'

getCreditCardExpiration()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:dateTime'

setCreditCardInfo()

Last four digits of the credit card the user selected as payment method for the account. Empty string if no credit is on file.

# Argument: 'xs:string'

getCreditCardInfo()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:string'

setCreditCardModifyDate()

Indicates the date and time credit card or credit card expiration date was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending on the payment method the user selected for the account (e.g., Empty string if no credit card is on file.)

# Argument: 'xs:dateTime'

getCreditCardModifyDate()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:dateTime'

setCurrentBalance()

Current balance for the account. Can be 0.00, positive, or negative. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getCurrentBalance()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setEmail()

(out) Email address for the user. 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.

# Argument: 'xs:string'

getEmail()

# Returns: 'xs:string'

setInvoiceBalance()

Amount of last invoice. 0.00 if account not yet invoiced. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getInvoiceBalance()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setInvoiceCredit()

Specifies credits granted since the previous invoice, but is only returned AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getInvoiceCredit()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setInvoiceDate()

Date of last invoice sent by eBay to the user, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if this account has not been invoiced yet.

# Argument: 'xs:dateTime'

getInvoiceDate()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:dateTime'

setInvoiceNewFee()

Specifies fees incurred since the last invoice, including tax if applicable. Returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getInvoiceNewFee()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setInvoicePayment()

Specifies payment made since the previous invoice, but is returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getInvoicePayment()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setLastAmountPaid()

Amount of last payment posted, 0.00 if no payments posted. The value is positive for debits and negative for credits.

# Argument: 'ns:AmountType'

getLastAmountPaid()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:AmountType'

setLastPaymentDate()

Date of last payment by the user to eBay, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no payments have been posted.

# Argument: 'xs:dateTime'

getLastPaymentDate()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:dateTime'

setPastDue()

Indicates whether the account has past due amounts outstanding. A value of true indicates that the account is past due. A value of false indicates the account is current.

# Argument: 'xs:boolean'

isPastDue()

Calls: GetAccount
Returned: Conditionally

# Returns: 'xs:boolean'

setPaymentMethod()

Indicates the method the user selected to pay eBay with for the account. The values for PaymentMethod vary from one global eBay site to the next. Payment methods are enumerated in the SellerPaymentMethodCodeType code list.

# Argument: 'ns:SellerPaymentMethodCodeType'

getPaymentMethod()

Calls: GetAccount
Returned: Conditionally

# Returns: 'ns:SellerPaymentMethodCodeType'