NAME

eBay::API::XML::DataType::SalesTaxType

DESCRIPTION

Type for expressing sales tax data.

SYNOPSIS

INHERITANCE

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

Subroutines:

setSalesTaxAmount()

(US only) The amount of sales tax, calculated for a transaction based on the SalesTaxPercent and pricing information. Also returned for Half.com (for GetOrders). GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the ItemID and TransactionID to call GetOrderTransactions.

  Calls: SendInvoice
  RequiredInput: No

# Argument: 'ns:AmountType'

getSalesTaxAmount()

  Calls: GetItemShipping
  Returned: Conditionally

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setSalesTaxPercent()

Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Also applicable to Half.com (for GetOrders).

  Calls: AddItem
         AddOrder
         GetItemRecommendations
         RelistItem
         ReviseItem
         SendInvoice
         VerifyAddItem
  RequiredInput: No

# Argument: 'xs:float'

getSalesTaxPercent()

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


  Calls: GetBidderList
         GetItemShipping
         GetTaxTable
  Returned: Conditionally

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

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:float'

setSalesTaxState()

State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Also returned for Half.com (for GetOrders).

  Calls: AddItem
         AddOrder
         GetItemRecommendations
         RelistItem
         ReviseItem
         SendInvoice
         VerifyAddItem
  RequiredInput: No

# Argument: 'xs:string'

getSalesTaxState()

  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

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

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

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

# Returns: 'xs:string'

setShippingIncludedInTax()

(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Also returned for Half.com (for GetOrders).

  Calls: AddItem
         AddOrder
         GetItemRecommendations
         RelistItem
         ReviseItem
         SendInvoice
         VerifyAddItem
  RequiredInput: No

# Argument: 'xs:boolean'

isShippingIncludedInTax()

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


  Calls: GetBidderList
         GetItemShipping
  Returned: Conditionally

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

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:boolean'

cpanm eBay::API

perl -MCPAN -e shell
install eBay::API