Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetAccountRequestType.h
Trading_GetAccountRequestType.m

Overview

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

@ingroup EBayAPIInterface

Tasks

  •   accountHistorySelection

    Specifies the report format in which to return account entries.

         property
  •   invoiceDate

    Specifies the month and year of the invoice requested. The report includes
    only the entries that appear on the seller’s invoice in the specified month
    and year. An entry can occur in one month and appear on the next month's
    invoice. Used with SpecifiedInvoice reports.

         property
  •   beginDate

    Specifies the beginning of a date range during which a credit or debit
    occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value
    must be less than or equal to the value specified in EndDate. The allowed
    date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. You can retrieve
    information that is up to 4 months old.

         property
  •   endDate

    Specifies the end of a date range during which a credit or debit occurred.
    Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be
    greater than or equal to the value specified in BeginDate. The allowed date
    formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.

         property
  •   pagination

    Controls pagination of the response. For this request, the valid values of
    Pagination.EntriesPerPage are 0 to 2000, with a default of 500.

         property
  •   excludeBalance

    Specifies whether to calculate balances. Default is false, which calculates
    balances. The value true means do not calculate balances. If true,
    AccountEntry.Balance and AccountSummary.CurrentBalance are never returned
    in the response.

         property
  •   excludeSummary

    Specifies whether to return account summary information in an
    AccountSummary node. Default is true, to return AccountSummary.

         property
  •   includeConversionRate

    Specifies whether to retrieve the rate used for the currency conversion for usage transactions.

         property
  •   accountEntrySortType

    Specifies how account entries should be sorted in the response, by an
    element and then in ascending or descending order.

         property
  •   currency

    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.

         property
  •   itemID

    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.

         property

Properties

accountEntrySortType

Specifies how account entries should be sorted in the response, by an
element and then in ascending or descending order.

@property (nonatomic, retain) NSString *accountEntrySortType

Discussion

Specifies how account entries should be sorted in the response, by an
element and then in ascending or descending order.

type: string constant in Trading_AccountEntrySortTypeCodeType.h

Declared In

Trading_GetAccountRequestType.h

accountHistorySelection

Specifies the report format in which to return account entries.

@property (nonatomic, retain) NSString *accountHistorySelection

Discussion

Specifies the report format in which to return account entries.

type: string constant in Trading_AccountHistorySelectionCodeType.h

Declared In

Trading_GetAccountRequestType.h

beginDate

Specifies the beginning of a date range during which a credit or debit
occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value
must be less than or equal to the value specified in EndDate. The allowed
date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. You can retrieve
information that is up to 4 months old.

@property (nonatomic, retain) NSDate *beginDate

Discussion

Specifies the beginning of a date range during which a credit or debit
occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value
must be less than or equal to the value specified in EndDate. The allowed
date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. You can retrieve
information that is up to 4 months old.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetAccountRequestType.h

currency

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.

@property (nonatomic, retain) NSString *currency

Discussion

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.

type: string constant in Trading_CurrencyCodeType.h

Declared In

Trading_GetAccountRequestType.h

endDate

Specifies the end of a date range during which a credit or debit occurred.
Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be
greater than or equal to the value specified in BeginDate. The allowed date
formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.

@property (nonatomic, retain) NSDate *endDate

Discussion

Specifies the end of a date range during which a credit or debit occurred.
Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be
greater than or equal to the value specified in BeginDate. The allowed date
formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetAccountRequestType.h

excludeBalance

Specifies whether to calculate balances. Default is false, which calculates
balances. The value true means do not calculate balances. If true,
AccountEntry.Balance and AccountSummary.CurrentBalance are never returned
in the response.

@property (nonatomic, retain) NSNumber *excludeBalance

Discussion

Specifies whether to calculate balances. Default is false, which calculates
balances. The value true means do not calculate balances. If true,
AccountEntry.Balance and AccountSummary.CurrentBalance are never returned
in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetAccountRequestType.h

excludeSummary

Specifies whether to return account summary information in an
AccountSummary node. Default is true, to return AccountSummary.

@property (nonatomic, retain) NSNumber *excludeSummary

Discussion

Specifies whether to return account summary information in an
AccountSummary node. Default is true, to return AccountSummary.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetAccountRequestType.h

includeConversionRate

Specifies whether to retrieve the rate used for the currency conversion for usage transactions.

@property (nonatomic, retain) NSNumber *includeConversionRate

Discussion

Specifies whether to retrieve the rate used for the currency conversion for usage transactions.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetAccountRequestType.h

invoiceDate

Specifies the month and year of the invoice requested. The report includes
only the entries that appear on the seller’s invoice in the specified month
and year. An entry can occur in one month and appear on the next month's
invoice. Used with SpecifiedInvoice reports.

@property (nonatomic, retain) NSDate *invoiceDate

Discussion

Specifies the month and year of the invoice requested. The report includes
only the entries that appear on the seller’s invoice in the specified month
and year. An entry can occur in one month and appear on the next month's
invoice. Used with SpecifiedInvoice reports.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetAccountRequestType.h

itemID

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.

@property (nonatomic, retain) NSString *itemID

Discussion

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.

type : NSString, wrapper for primitive string

Declared In

Trading_GetAccountRequestType.h

pagination

Controls pagination of the response. For this request, the valid values of
Pagination.EntriesPerPage are 0 to 2000, with a default of 500.

@property (nonatomic, retain) Trading_PaginationType *pagination

Discussion

Controls pagination of the response. For this request, the valid values of
Pagination.EntriesPerPage are 0 to 2000, with a default of 500.

type : class Trading_PaginationType

Declared In

Trading_GetAccountRequestType.h