| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | org.mule.modules.avalara.TaxRequestType | |
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TaxRequestType | CancelTax | CancelTax provides a mechanism to recover from posting problems, or completely remove an invoice from tax reporting. | |||||||||
| TaxRequestType | CommitTax | CommitTax can be used to set the document status to several states during a SalesInvoice process (SalesOrder processes are not saved). | |||||||||
| TaxRequestType | GetTax | GetTax is the core of the Avalara Service. | |||||||||
| TaxRequestType | GetTaxHistory | GetTaxHistory provides a means to report or retrieve data on historical invoices (or Document ID's). | |||||||||
| TaxRequestType | PostTax | PostTax can be used to set the document status to several states during a SalesInvoice process (SalesOrder processes are not saved). | |||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| type | |||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
| |||||||||||
CancelTax provides a mechanism to recover from posting problems, or completely remove an invoice from tax reporting. The effect of CancelTax depends upon the current state of an invoice (uncommitted, saved, or committed).
An invoice with a state of saved is one which has not been posted or committed (last operation = GetTax). Calling CancelTax on such an invoice has no effect.
An invoice with a state of committed is one which has been committed (and appears in Sales Tax Reporting). Calling CancelTax on a committed invoice has the effect of removing it from reporting, but moves it to a fourth state Voided.
A Voided invoice cannot have its status changed (and the invoice number cannot be re-used).
CommitTax can be used to set the document status to several states during a SalesInvoice process (SalesOrder processes are not saved). Invoices appear initially as "uncommitted" on the Admin Console and do not appear at all on Avalara reporting until they are committed. CommitTax completes the two stage process and sets the Document Status to Committed on mm/dd/yyyy however it cannot be overwritten as the PostTax operation was.
GetTax is the core of the Avalara Service. It is capable of collecting a string of elements contained in a single object contained in a transaction document (invoice, quote, sales order, etc.) including the origin (shipped from address), destination (shipped to address), and line item (products, Freight, Service, etc.) information. The return of a successful GetTax call is at a minimum Total Amount and Total Tax. By setting the DetailLevel property - for example - from "Tax" to "Line" a much greater set of results will be returned.
GetTaxHistory provides a means to report or retrieve data on historical invoices (or Document ID's). GetTaxHistory provides a mechanism to write custom reports.
GetTaxHistory returns both the original GetTaxRequest object, as well as the GetTaxResult object. The GetTaxResult object shows the current state of the invoice in the Avalara system.
PostTax can be used to set the document status to several states during a SalesInvoice process (SalesOrder processes are not saved). Invoices appear initially as "uncommitted" on the Admin Console and do not appear at all on Avalara reporting until they are committed. A posted document can be changed (overwritten not amended) with subsequent GetTax calls to the same DocCode (Document Number). The typical integration point for PostTax/CommitTax process is when it is required by the ERP or a business process requires that an invoice is posted indicating that it has been reviewed by a second level of management, the "committed" indicating that it has been certified to be ready for tax reporting.