ePages 7.28.0 - DE_EPAGES/AvaTax/API/OrderExtractor.pm

Package DE_EPAGES::AvaTax::API::OrderExtractor

Database Wrapper for BasketOrOrder Object

Functions

extractDataFrom
getAvaTaxCompanyCode
getAvataxGuidMap
getAvataxTaxExemption
getBasketOrOrder
getContainerAttributes
getCustomerAddress
getCustomerCode
getCustomerVATID
getDiscountValue
getErrorMessage
getLineItemContainer
getLines
getOrderAlias
getShop
getShopAddress
hasChanged
isPaid
new
updateHash

extractDataFrom

Extract Data from Basket or Order and return if it was successful or not

Syntax
extractDataFrom( $BasketOrOrder );
Input
$BasketOrOrder (Object)
BasketOrOrder
Return
$WasSuccessful (boolean)
Status

getAvaTaxCompanyCode

Return hash with some attributes of the TaxMethodAvatax needed for the Request

Syntax
getAvaTaxCompanyCode();
Return
$self->{'AvaTax_CompanyCode'} (hashref)
hash with attributes of the TaxMethodAvatax

getAvataxGuidMap

Getter for AvataxGuidMap

Syntax
getAvataxGuidMap();
Return
(DE_EPAGES::AvaTax::API::AvataxGuidMap)
return AvataxGuidMap

getAvataxTaxExemption

Returns the tax exemption of the customer of the order

Syntax
getAvataxTaxExemption();
Return
(DE_EPAGES::Object::API::Object::PreDefAttribute)
AvataxTaxExemption

getBasketOrOrder

Return Basket or CustomerOrder Object

Syntax
getBasketOrOrder();
Return
$self->{'BasketOrOrder'} (Object)
Basket or CustomerOrder Object

getContainerAttributes

Return hash with some attributes of the container needed for the Request

Syntax
getContainerAttributes();
Return
$self->{'hContainerAttributes'} (hashref)
hash with attributes of the container

getCustomerAddress

Return CustomerAddress Object

Syntax
getCustomerAddress();
Return
$self->{'AvaTaxCustomerAddress'} (DE_EPAGES::AvaTax::API::DTO::BaseAddress)
Address Object

getCustomerCode

Return CustomerCode

Syntax
getCustomerCode();
Return
(string)
CustomerCode

getCustomerVATID

Return Customer VATID

Syntax
getCustomerVATID();
Return
$self->{'CustomerVATID'} (String)
Customer VATID

getDiscountValue

Return DiscountValue

Syntax
getDiscountValue();
Return
$self->{'DiscountValue'} (float)
DiscountValue

getErrorMessage

Return ErrorMessage if case of fail

Syntax
getErrorMessage();
Return
$self->{'ErrorMessage'} (hashref)
ErrorMessage

getLineItemContainer

Return LineItemContainer associated to the OrderExtractor

Syntax
getLineItemContainer();
Return
(DE_EPAGES::Order::API::Object::LineItemContainer)
LineItemContainer

getLines

Return array with Avatax Line

Syntax
getLines();
Return
$self->{'aLine'} (array)
Array with avatax line

getOrderAlias

Returns the alias of the order

Syntax
getOrderAlias();
Return
(string)
OrderAlias

getShop

Returns the shop object

Syntax
getShop();
Return
(DE_EPAGES::Shop::API::Object::Shop)
Shop object

getShopAddress

Return ShopAddress Object

Syntax
getShopAddress();
Return
$self->{'AvaTaxShopAddress'} (DE_EPAGES::AvaTax::API::DTO::BaseAddress)
Address Object

hasChanged

Calculates a hash over the underlying basket or order and compares it with attribute AvaTaxHash in the object.

Syntax
hasChanged();
Return
(Boolean)
return change flag

isPaid

Returns paid status

Syntax
isPaid();
Return
(boolean)
PaidOn

new

constuctor

Syntax
new( );
Return
$self (DE_EPAGES::AvaTax::API::OrderExtractor)
self

updateHash

Calculates a hash over the underlying basket or order stores it in the attribute AvaTaxHash.

Syntax
updateHash();