GetTaxResult Class Reference

Public Member Functions
	getDocId ()
	getDocCode ()
	getAdjustmentDescription ()
	getAdjustmentReason ()
	getDocDate ()
	getTaxDate ()
	getDocType ()
	getDocStatus ()
	getIsReconciled ()
	getLocked ()
	getTimestamp ()
	getTotalAmount ()
	getTotalDiscount ()
	getTotalExemption ()
	getTotalTaxable ()
	getTotalTax ()
	getHashCode ()
	getVersion ()
	getTaxLines ()
	getTotalTaxCalculated ()
	getTaxSummary ()
	getTaxLine ($lineNo)
	getTransactionId ()
	getResultCode ()
	getMessages ()

Private Attributes
	$DocCode
	$DocId
	$AdjustmentDescription
	$DocDate
	$TaxDate
	$DocType
	$DocStatus
	$Reconciled
	$Locked
	$Timestamp
	$TotalAmount
	$TotalDiscount
	$TotalExemption
	$TotalTaxable
	$TotalTax
	$AdjustmentReason
	$Version
	$TaxLines
	$TotalTaxCalculated
	$TaxSummary
	$TransactionId
	$ResultCode = 'Success'
	$Messages = array()

Member Function Documentation

GetTaxResult::getAdjustmentDescription

(

)

AdjustmentDescription set while making AdjustTax call.

Returns

string

GetTaxResult::getAdjustmentReason

(

)

AdjustmentReason set while making AdjustTax call. It is a high level classification of why an Original Document is being modified.

Returns

int

GetTaxResult::getDocCode

(

)

Gets the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

See GetTaxRequest#getDocCode on GetTaxRequest for more information about this member.

Returns

string

GetTaxResult::getDocDate

(

)

Gets the date on the invoice, purchase order, etc.

See GetTaxRequest#getDocDate on GetTaxRequest for more information about this member.

Returns

date

GetTaxResult::getDocId

(

)

Gets the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

See GetTaxRequest#getDocId on GetTaxRequest for more information about this member.

Returns

string

GetTaxResult::getDocStatus

(

)

Gets the document's status after the tax calculation.

Returns

DocStatus

GetTaxResult::getDocType

(

)

Gets the Document Type.

See GetTaxRequest#DocType on GetTaxRequest for more information about this member.

Returns

DocumentType

GetTaxResult::getHashCode

(

)

HashCode to support Reconciliation.

Returns

hashCode

GetTaxResult::getIsReconciled

(

)

True if the document has been reconciled; Only committed documents can be reconciled.

For information on committing documents, see the TaxSvc's TaxSvcSoap#commitTax method. For information on reconciling documents, see the TaxSvcSoap#reconcileTaxHistory method.

Returns

boolean

GetTaxResult::getLocked

(

)

Flag indicating if a Document has been locked by Avalara's MRS process. Locked documents can not be modified and can not be cancelled because they have been reported on Tax Return.

Returns

boolean

GetTaxResult::getMessages

(

)

Accessor

Returns

array

GetTaxResult::getResultCode

(

)

Accessor

Returns

string

GetTaxResult::getTaxDate

(

)

Tax Date is the date used to calculate tax on the Document.

See GetTaxRequest#taxDate on GetTaxRequest for more information about this member.

Returns

date

GetTaxResult::getTaxLine

(

$lineNo

)

GetTaxResult::getTaxLines

(

)

Gets the Tax broken down by individual TaxLine.

Returns

taxLines

GetTaxResult::getTaxSummary

(

)

TaxSummary is now returned when GetTaxRequest.DetailLevel == DetailLevel.Line in addition to DetailLevel.Summary. It is not returned for DetailLevel.Document or DetailLevel.TaxDetail.

Returns

ArrayOfTaxDetail

GetTaxResult::getTimestamp

(

)

Date of the last status change on the document (i.e. Save date, Post date, Commit date, Cancel date).

Returns

dateTime

GetTaxResult::getTotalAmount

(

)

The sum of all line Line#getAmount values.

Parameters

decimal

GetTaxResult::getTotalDiscount

(

)

Gets the sum of all TaxLine TaxLine#getDiscount amounts; Typically it will equal the requested Discount, but, but it is possible that no lines were marked as discounted.

Returns

decimal

GetTaxResult::getTotalExemption

(

)

Gets the sum of all TaxLine TaxLine#getExemption amounts.

Returns

decimal

Deprecated:

See TaxDetail#getExemption.

GetTaxResult::getTotalTax

(

)

Gets the total tax for the document.

Returns

decimal

GetTaxResult::getTotalTaxable

(

)

Gets the amount the tax is based on; This is the total of all Line Base amounts; Typically it will be equal to the document GetTaxResult#getTotalAmount - GetTaxRequest#getDiscount - getTotalExemption.

Returns

decimal

Deprecated:

See TaxDetail#getTaxable.

GetTaxResult::getTotalTaxCalculated

(

)

TotalTaxCalculated indicates the total tax calculated by AvaTax. This is usually the same as the TotalTax, except when a tax override amount is specified. This is for informational purposes.The TotalTax will still be used for reporting

Returns

unknown

GetTaxResult::getTransactionId

(

)

Accessor

Returns

string

GetTaxResult::getVersion

(

)

Current version of the document.

Returns

int

Member Data Documentation

GetTaxResult::$AdjustmentDescription

private

GetTaxResult::$AdjustmentReason

private

GetTaxResult::$DocCode

private

GetTaxResult::$DocDate

private

GetTaxResult::$DocId

private

GetTaxResult::$DocStatus

private

GetTaxResult::$DocType

private

GetTaxResult::$Locked

private

GetTaxResult::$Messages = array()

private

GetTaxResult::$Reconciled

private

GetTaxResult::$ResultCode = 'Success'

private

GetTaxResult::$TaxDate

private

GetTaxResult::$TaxLines

private

GetTaxResult::$TaxSummary

private

GetTaxResult::$Timestamp

private

GetTaxResult::$TotalAmount

private

GetTaxResult::$TotalDiscount

private

GetTaxResult::$TotalExemption

private

GetTaxResult::$TotalTax

private

GetTaxResult::$TotalTaxable

private

GetTaxResult::$TotalTaxCalculated

private

GetTaxResult::$TransactionId

private

GetTaxResult::$Version

private

---

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

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