VirtueMart  3.2.14.9808
Public Member Functions | Private Attributes | List of all members
GetTaxRequest Class Reference

Public Member Functions

 __construct ()
 
 prepare ()
 
 registerAddress (&$address)
 
 postFetch ()
 
 setAddressCode ($value)
 
 setLine1 ($value)
 
 setLine2 ($value)
 
 setLine3 ($value)
 
 setCity ($value)
 
 setRegion ($value)
 
 setPostalCode ($value)
 
 setCountry ($value)
 
 setDocDate ($value)
 
 setCompanyCode ($value)
 
 setDocType ($value)
 
 setDetailLevel ($value)
 
 setDocCode ($value)
 
 setSalespersonCode ($value)
 
 setCustomerCode ($value)
 
 setCustomerUsageType ($value)
 
 setPurchaseOrderNo ($value)
 
 setExemptionNo ($value)
 
 setLocationCode ($value)
 
 setBatchCode ($value)
 
 setDiscount ($value)
 
 setAddresses ($value)
 
 setLines ($value)
 
 setHashCode ($value)
 
 setCommit ($value)
 
 setOriginAddress ($value)
 
 setDestinationAddress ($value)
 
 setExchangeRate ($value)
 
 setCurrencyCode ($value)
 
 setServiceMode ($value)
 
 setPaymentDate ($value)
 
 setExchangeRateEffDate ($value)
 
 setBusinessIdentificationNo ($value)
 
 setPosLaneCode ($value)
 
 setTaxOverride ($value)
 
 setReferenceCode ($value)
 
 getCompanyCode ()
 
 getDocType ()
 
 getDocCode ()
 
 getDocDate ()
 
 salespersonCode ()
 
 getCustomerCode ()
 
 getCustomerUsageType ()
 
 getDiscount ()
 
 getPurchaseOrderNo ()
 
 getExemptionNo ()
 
 getAddresses ()
 
 getLines ()
 
 getDetailLevel ()
 
 getHashCode ()
 
 getLocationCode ()
 
 getBatchCode ()
 
 getCommit ()
 
 getOriginAddress ()
 
 getDestinationAddress ()
 
 getExchangeRate ()
 
 getCurrencyCode ()
 
 getServiceMode ()
 
 getPaymentDate ()
 
 getExchangeRateEffDate ()
 
 getBusinessIdentificationNo ()
 
 getPosLaneCode ()
 
 getTaxOverride ()
 
 getReferenceCode ()
 
 getLine ($lineNo)
 

Private Attributes

 $CompanyCode
 
 $DocCode
 
 $DocType
 
 $DocDate
 
 $SalespersonCode
 
 $CustomerCode
 
 $CustomerUsageType
 
 $Discount
 
 $PurchaseOrderNo
 
 $ExemptionNo
 
 $OriginCode
 
 $DestinationCode
 
 $Addresses
 
 $Lines
 
 $DetailLevel
 
 $ReferenceCode
 
 $LocationCode
 
 $Commit =false
 
 $BatchCode
 
 $OriginAddress
 
 $DestinationAddress
 
 $TaxOverride
 
 $CurrencyCode
 
 $ServiceMode
 
 $PaymentDate
 
 $ExchangeRate
 
 $BusinessIdentificationNo
 
 $ExchangeRateEffDate
 
 $PosLaneCode
 

Constructor & Destructor Documentation

GetTaxRequest::__construct ( )

Member Function Documentation

GetTaxRequest::getAddresses ( )
GetTaxRequest::getBatchCode ( )
GetTaxRequest::getBusinessIdentificationNo ( )
GetTaxRequest::getCommit ( )
GetTaxRequest::getCompanyCode ( )

#+ Accessor public

Returns
string
GetTaxRequest::getCurrencyCode ( )
GetTaxRequest::getCustomerCode ( )
GetTaxRequest::getCustomerUsageType ( )
GetTaxRequest::getDestinationAddress ( )
GetTaxRequest::getDetailLevel ( )
GetTaxRequest::getDiscount ( )
GetTaxRequest::getDocCode ( )
GetTaxRequest::getDocDate ( )
GetTaxRequest::getDocType ( )
GetTaxRequest::getExchangeRate ( )
GetTaxRequest::getExchangeRateEffDate ( )
GetTaxRequest::getExemptionNo ( )
GetTaxRequest::getHashCode ( )
GetTaxRequest::getLine (   $lineNo)
GetTaxRequest::getLines ( )
GetTaxRequest::getLocationCode ( )
GetTaxRequest::getOriginAddress ( )
GetTaxRequest::getPaymentDate ( )
GetTaxRequest::getPosLaneCode ( )
GetTaxRequest::getPurchaseOrderNo ( )
GetTaxRequest::getReferenceCode ( )
GetTaxRequest::getServiceMode ( )
GetTaxRequest::getTaxOverride ( )
GetTaxRequest::postFetch ( )
GetTaxRequest::prepare ( )
GetTaxRequest::registerAddress ( $address)
GetTaxRequest::salespersonCode ( )
GetTaxRequest::setAddressCode (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setAddresses (   $value)

Set addresses

Parameters
array$value
GetTaxRequest::setBatchCode (   $value)
GetTaxRequest::setBusinessIdentificationNo (   $value)

Sets the value for BusinessIdentificationNo

Parameters
string$value
GetTaxRequest::setCity (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setCommit (   $value)

This has been defaulted to False ; invoice will be committed if this flag has been set to True.

Parameters
boolean$value
GetTaxRequest::setCompanyCode (   $value)

Sets the client application company reference code.

Parameters
string$value
GetTaxRequest::setCountry (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setCurrencyCode (   $value)

3 character ISO 4217 currency code.

Parameters
string$value
GetTaxRequest::setCustomerCode (   $value)

The client application customer reference code.

Parameters
string$value
GetTaxRequest::setCustomerUsageType (   $value)

The client application customer or usage type.

This is used to determine the exempt status of the transaction based on the exemption tax rules for the jurisdictions involved. This may also be set at the line level.

The standard values for the CustomerUsageType (A-L).
A Federal Government
B State/Local Govt.
C Tribal Government
D Foreign Diplomat
E Charitable Organization
F Religious/Education
G Resale
H Agricultural Production
I Industrial Prod/Mfg.
J Direct Pay Permit
K Direct Mail
L - Other

Parameters
customerUsageType
GetTaxRequest::setDestinationAddress (   $value)

set ship to address

Parameters
Address$value
GetTaxRequest::setDetailLevel (   $value)

Specifies the level of detail to return.

Parameters
DetailLevel$value
GetTaxRequest::setDiscount (   $value)

The discount amount to apply to the document.

Parameters
decimal$value
GetTaxRequest::setDocCode (   $value)

Sets the Document Code, i.e. the internal reference code used by the client application.

Parameters
string$value
GetTaxRequest::setDocDate (   $value)

Mutator public

Parameters
integerDocDate should be in the format yyyy-mm-dd
date$value
GetTaxRequest::setDocType (   $value)

The document type specifies the category of the document and affects how the document is treated after a tax calculation; see DocumentType for more information about the specific document types.

Parameters
DocumentType$value
GetTaxRequest::setExchangeRate (   $value)

ExchangeRate indicates the currency exchange rate from the transaction currency (indicated by CurrencyCode) to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0.

Parameters
decimal$value
GetTaxRequest::setExchangeRateEffDate (   $value)

ExchangeRateEffDate indicates the effective date of the exchange rate. It should be set in conjunction with ExchangeRate. It will default to the DocDate if not set.

Parameters
date$value
GetTaxRequest::setExemptionNo (   $value)

Exemption Number for this document

Parameters
string$value
GetTaxRequest::setHashCode (   $value)
GetTaxRequest::setLine1 (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setLine2 (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setLine3 (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setLines (   $value)

Set tax lines

Parameters
array$value
GetTaxRequest::setLocationCode (   $value)

Also referred to as a Store Location, Outlet Id, or Outlet code is a number assigned by the State which identifies a Store location. Some state returns require taxes are broken out separatly for Store Locations.

Parameters
string$value
GetTaxRequest::setOriginAddress (   $value)

Set ship from address

Parameters
Address$value
GetTaxRequest::setPaymentDate (   $value)

PaymentDate indicates the date when payment was received for the document. It is only applicable for cash-basis accounting and does not need to be set otherwise. It defaults to 1/1/1900 which indicates no payment. The new TaxSvc.ApplyPayment method may be used to apply a payment to an existing invoice.

Parameters
date$value
GetTaxRequest::setPosLaneCode (   $value)

Sets POS Lane Code.

Parameters
string$value
GetTaxRequest::setPostalCode (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setPurchaseOrderNo (   $value)

Purchase Order Number for this document.

Parameters
string$value
GetTaxRequest::setReferenceCode (   $value)
GetTaxRequest::setRegion (   $value)

Enter description here...

Parameters
string$value
GetTaxRequest::setSalespersonCode (   $value)

The client application salesperson reference code.

Parameters
string$value
GetTaxRequest::setServiceMode (   $value)

It provides the ability to controls whether tax is calculated locally or remotely when using an AvaLocal server. The default is Automatic which calculates locally unless remote is necessary for non-local addresses.

Parameters
ServiceMode$value
GetTaxRequest::setTaxOverride (   $value)

TaxOverride for the document.

Parameters
TaxOverride$value

Member Data Documentation

GetTaxRequest::$Addresses
private
GetTaxRequest::$BatchCode
private
GetTaxRequest::$BusinessIdentificationNo
private
GetTaxRequest::$Commit =false
private
GetTaxRequest::$CompanyCode
private
GetTaxRequest::$CurrencyCode
private
GetTaxRequest::$CustomerCode
private
GetTaxRequest::$CustomerUsageType
private
GetTaxRequest::$DestinationAddress
private
GetTaxRequest::$DestinationCode
private
GetTaxRequest::$DetailLevel
private
GetTaxRequest::$Discount
private
GetTaxRequest::$DocCode
private
GetTaxRequest::$DocDate
private
GetTaxRequest::$DocType
private
GetTaxRequest::$ExchangeRate
private
GetTaxRequest::$ExchangeRateEffDate
private
GetTaxRequest::$ExemptionNo
private
GetTaxRequest::$Lines
private
GetTaxRequest::$LocationCode
private
GetTaxRequest::$OriginAddress
private
GetTaxRequest::$OriginCode
private
GetTaxRequest::$PaymentDate
private
GetTaxRequest::$PosLaneCode
private
GetTaxRequest::$PurchaseOrderNo
private
GetTaxRequest::$ReferenceCode
private
GetTaxRequest::$SalespersonCode
private
GetTaxRequest::$ServiceMode
private
GetTaxRequest::$TaxOverride
private

The documentation for this class was generated from the following file: