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

NAME

eBay::API::XML::DataType::AmountType

DESCRIPTION

Basic type for specifying monetary amounts. A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. Details such as prices, fees, costs, and payments are specified as amount types.

SYNOPSIS

INHERITANCE

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

Subroutines:

setValue()

# Argument: 'xs:double'

getValue()

# Returns: 'xs:double'

setCurrencyID()

Currency in which the monetary amount is specified.<br> <br> In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

  Calls: AddOrder
  RequiredInput: Yes
  Context: Order.Total

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally

  Calls: RespondToBestOffer
         ReviseCheckoutStatus
  RequiredInput: No

  Calls: AddItem
         RelistItem
         ReviseItem
         VerifyAddItem
  RequiredInput: No
  Returned: Always

  Calls: AddLiveAuctionItem
         ReviseLiveAuctionItem
  RequiredInput: No
  Returned: Always

  Calls: GetAllBidders
         GetStoreOptions
  RequiredInput: Yes
  Returned: Always

  Calls: RelistItem
  RequiredInput: No

  Calls: AddTransactionConfirmationItem
  RequiredInput: Yes

  Calls: SendInvoice
  RequiredInput: No
  ExcludeFromContext: ShippingInsuranceCost, ShippingServiceCost,
								ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee

# Argument: 'ns:CurrencyCodeType'

getCurrencyID()

Calls: GetBidderList
       GetItemRecommendations
       GetItemShipping
       GetMyeBaySelling
Returned: Conditionally

Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll

Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll

Calls: GetShippingDiscountProfiles
Returned: Conditionally

Calls:   Returned: Always
ExcludeFromContext: InternationalShippingServiceOption
                    ShippingServiceOptions
                    ShippingServiceSelected


Calls: GetBestOffers
Returned: Always
Details: DetailLevel: none, ReturnAll

Calls: GetOrders
Returned: Always
Details: DetailLevel: none
ExcludeFromContext: InternationalShippingServiceOption
                    ShippingServiceOptions
                    ShippingServiceSelected


Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Context: InternationalShippingServiceOption
         ShippingServiceOptions
         ShippingServiceSelected

Calls: GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none
Context: InternationalShippingServiceOption
         ShippingServiceOptions
         ShippingServiceSelected

Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Context: InternationalShippingServiceOption
         ShippingServiceOptions
         ShippingServiceSelected

Calls: PlaceOffer
Returned: Always
Context: ConvertedCurrentPrice
         CurrentPrice

Calls: PlaceOffer
Returned: Conditionally
Context: MinimumToBid

Calls: AddItem
       RelistItem
       ReviseItem
       VerifyAddItem
RequiredInput: No
Returned: Always

Calls: AddLiveAuctionItem
       ReviseLiveAuctionItem
RequiredInput: No
Returned: Always

Calls: GetAllBidders
       GetStoreOptions
RequiredInput: Yes
Returned: Always

# Returns: 'ns:CurrencyCodeType'