Line Class Reference

Public Member Functions
	__construct ($no=1, $qty=1, $amount=100.00)
	setNo ($value)
	setItemCode ($value)
	setDescription ($value)
	setTaxCode ($value)
	setRevAcct ($value)
	setRef1 ($value)
	setRef2 ($value)
	setExemptionNo ($value)
	setCustomerUsageType ($value)
	setBatchCode ($value)
	setQty ($value)
	setAmount ($value)
	setTaxOverride ($value)
	setDiscounted ($value)
	setOriginAddress (&$value)
	setDestinationAddress (&$value)
	setTaxIncluded ($value)
	getTaxIncluded ($value)
	setBusinessIdentificationNo ($value)
	getBusinessIdentificationNo ()
	registerAddressesIn (&$getTaxRequest)
	postFetchWithAddresses ($addresses)
	getNo ()
	getItemCode ()
	getDescription ()
	getTaxCode ()
	getRevAcct ()
	getRef1 ()
	getRef2 ()
	getExemptionNo ()
	getCustomerUsageType ()
	getBatchCode ()
	getQty ()
	getAmount ()
	getTaxOverride ()
	getDiscounted ()
	getOriginAddress ()
	getDestinationAddress ()

Private Attributes
	$No
	$OriginCode
	$DestinationCode
	$ItemCode
	$Description
	$TaxCode
	$Qty
	$Amount
	$Discounted
	$RevAcct
	$Ref1
	$Ref2
	$ExemptionNo
	$CustomerUsageType
	$BatchCode
	$TaxOverride
	$OriginAddress
	$DestinationAddress
	$BusinessIdentificationNo
	$TaxIncluded

Constructor & Destructor Documentation

Line::__construct	(		$no = 1,
			$qty = 1,
			$amount = 100.00
	)

Member Function Documentation

Line::getAmount

(

)

Line::getBatchCode

(

)

Line::getBusinessIdentificationNo

(

)

Gets BusinessIdentificationNo .

Returns

string

Line::getCustomerUsageType

(

)

Line::getDescription

(

)

Line::getDestinationAddress

(

)

Line::getDiscounted

(

)

Line::getExemptionNo

(

)

Line::getItemCode

(

)

Line::getNo

(

)

#+ Accessor public

Returns

string

Line::getOriginAddress

(

)

Line::getQty

(

)

Line::getRef1

(

)

Line::getRef2

(

)

Line::getRevAcct

(

)

Line::getTaxCode

(

)

Line::getTaxIncluded

(

$value

)

True if tax is included in the line.

Returns

boolean

Line::getTaxOverride

(

)

Line::postFetchWithAddresses

(

$addresses

)

Line::registerAddressesIn

(

&

$getTaxRequest

)

Line::setAmount

(

$value

)

The total amount for this line item (Qty * UnitPrice).

Parameters

string

$value

Line::setBatchCode

(

$value

)

Enter description here...

Parameters

string

$value

Line::setBusinessIdentificationNo

(

$value

)

Sets BusinessIdentificationNo in the line.

Parameters

string

Line::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

string

$value

Line::setDescription

(

$value

)

Sets the description which defines the description for the product or item.

Parameters

string

$value

Line::setDestinationAddress

(

&

$value

)

Sets the Address used as the "Ship To" location for a specific line item.

Parameters

string

$value

Line::setDiscounted

(

$value

)

True if the document discount should be applied to this line

Parameters

string

$value

Line::setExemptionNo

(

$value

)

Exemption number for this line

Parameters

string

$value

Line::setItemCode

(

$value

)

Item Code (SKU)

Parameters

string

$value

Line::setNo

(

$value

)

Line Number.

Parameters

string

$value

Line::setOriginAddress

(

&

$value

)

Sets the Address used as the "Ship From" location for a specific line item.

Parameters

string

$value

Line::setQty

(

$value

)

The quantity represented by this line.

Parameters

string

$value

Line::setRef1

(

$value

)

Client specific reference field.

Parameters

string

$value

Line::setRef2

(

$value

)

Client specific reference field.

Parameters

string

$value

Line::setRevAcct

(

$value

)

Revenue Account.

Parameters

string

$value

Line::setTaxCode

(

$value

)

System or Custom Tax Code.

Parameters

string

$value

Line::setTaxIncluded

(

$value

)

True if tax is included in the line.

Parameters

boolean

Line::setTaxOverride

(

$value

)

TaxOverride for the document at line level.

Parameters

string

$value

Member Data Documentation

Line::$Amount

private

Line::$BatchCode

private

Line::$BusinessIdentificationNo

private

Line::$CustomerUsageType

private

Line::$Description

private

Line::$DestinationAddress

private

Line::$DestinationCode

private

Line::$Discounted

private

Line::$ExemptionNo

private

Line::$ItemCode

private

Line::$No

private

Line::$OriginAddress

private

Line::$OriginCode

private

Line::$Qty

private

Line::$Ref1

private

Line::$Ref2

private

Line::$RevAcct

private

Line::$TaxCode

private

Line::$TaxIncluded

private

Line::$TaxOverride

private

---

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

• plugins/vmcalculation/avalara/classes/Line.class.php