AdjustTaxResult Class Reference

Public Member Functions
	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
	From GetTaxResult- Bug in soapclient requires this copy. More...
	$AdjustmentDescription
	$DocDate
	$TaxDate
	$DocType
	$DocStatus
	$Reconciled
	$Locked
	$Timestamp
	$TotalAmount
	$TotalDiscount
	$TotalExemption
	$TotalTaxable
	$TotalTax
	$HashCode
	$AdjustmentReason
	$Version
	$TaxLines
	$TotalTaxCalculated
	$TaxSummary
	$TransactionId
	$ResultCode = 'Success'
	$Messages = array()

Member Function Documentation

AdjustTaxResult::getAdjustmentDescription

(

)

AdjustmentDescription set while making AdjustTax call.

Returns

string

AdjustTaxResult::getAdjustmentReason

(

)

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

Returns

int

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

AdjustTaxResult::getDocDate

(

)

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

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

Returns

date

AdjustTaxResult::getDocStatus

(

)

Gets the document's status after the tax calculation.

Returns

DocStatus

AdjustTaxResult::getDocType

(

)

Gets the Document Type.

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

Returns

DocumentType

AdjustTaxResult::getHashCode

(

)

HashCode to support Reconciliation.

Returns

hashCode

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

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

AdjustTaxResult::getMessages

(

)

Accessor

Returns

array

AdjustTaxResult::getResultCode

(

)

Accessor

Returns

string

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

AdjustTaxResult::getTaxLine

(

$lineNo

)

AdjustTaxResult::getTaxLines

(

)

Gets the Tax broken down by individual TaxLine.

Returns

taxLines

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

AdjustTaxResult::getTimestamp

(

)

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

Returns

dateTime

AdjustTaxResult::getTotalAmount

(

)

The sum of all line Line#getAmount values.

Parameters

decimal

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

AdjustTaxResult::getTotalExemption

(

)

Gets the sum of all TaxLine TaxLine#getExemption amounts.

Returns

decimal

Deprecated:

See TaxDetail#getExemption.

AdjustTaxResult::getTotalTax

(

)

Gets the total tax for the document.

Returns

decimal

AdjustTaxResult::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.

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

AdjustTaxResult::getTransactionId

(

)

Accessor

Returns

string

AdjustTaxResult::getVersion

(

)

Current version of the document.

Returns

int

Member Data Documentation

AdjustTaxResult::$AdjustmentDescription

private

AdjustTaxResult::$AdjustmentReason

private

AdjustTaxResult::$DocCode

private

From GetTaxResult- Bug in soapclient requires this copy.

AdjustTaxResult::$DocDate

private

AdjustTaxResult::$DocStatus

private

AdjustTaxResult::$DocType

private

AdjustTaxResult::$HashCode

private

AdjustTaxResult::$Locked

private

AdjustTaxResult::$Messages = array()

private

AdjustTaxResult::$Reconciled

private

AdjustTaxResult::$ResultCode = 'Success'

private

AdjustTaxResult::$TaxDate

private

AdjustTaxResult::$TaxLines

private

AdjustTaxResult::$TaxSummary

private

AdjustTaxResult::$Timestamp

private

AdjustTaxResult::$TotalAmount

private

AdjustTaxResult::$TotalDiscount

private

AdjustTaxResult::$TotalExemption

private

AdjustTaxResult::$TotalTax

private

AdjustTaxResult::$TotalTaxable

private

AdjustTaxResult::$TotalTaxCalculated

private

AdjustTaxResult::$TransactionId

private

AdjustTaxResult::$Version

private

---

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

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