User Tools

Site Tools


taxengine:windows:tax_engine_interface_window

KampData TaxEngine Interface window

We created the TaxEngine Interface window for testing purposes. This window is representative of how the KampData TaxEngine can be utilized by your application.

Functionality

To assist us in testing the KampData TaxEngine, this window functions in the following way:

  • When a field in the window is modified, the KampData TaxEngine property that it represents is also modified.
  • If the modified field can affect the tax, TaxEngine.DocCalcuateTax() is called.
  • The entire window is then refreshed with the values contained in the KampData TaxEngine.

In a production environment, you could wait to calculate the tax and retrieve values from the KampData TaxEngine until all of the values for the line-item or (depending on your requirements) until all of the values for the entire document have been set.

Values that you would normally retrieve from the TaxEngine include:

  • The tax location address. This address can be used to assist in address entry, or to verify that the KampData TaxEngine is in agreement with your application. Be aware that the tax location may be your inventory site rather than the customer's ship-to address (Based on the shipping method - Pickup or Delivery).
  • LineTaxAmount and/or DocTaxAmount.
  • LineExtendedPrice can be used to verify that the KampData TaxEngine is in sync with your application.
  • DocTotalAmount can be used to verify that the KampData TaxEngine is in sync with your application.

DocTransactionNumber is an integer assigned to each document to uniquely identify them. The combination of DocModule, DocNumber and DocType also provides a unique identification of each document. As a result, retrieving and storing the DocTransactionNumber is not required.

Transaction History

This window can be used to browse through the tax transaction history records created by the KampData TaxEngine. It can also be used, when appropriate, to modify your tax history. Modifying accounting history is not recommended, but there may be times when it is appropriate. A better policy is to do a return document to offset the offending invoice, and then recreate the invoice the way it should have been done originally (credit and re-bill). This credit and re bill policy will provide a complete audit trail, while modifying the history will not. For this reason, you may want to restrict access to this window.

TaxEngine Interface Fields

The fields on the TaxEngine Interface window call the same API methods and properties that would be used in a live TaxEngine integration. For this reason, we found it easier to explain the fields by presenting them alongside with the public methods they call.


TaxEngine Windows
TaxEngine Interface window fields

taxengine/windows/tax_engine_interface_window.txt · Last modified: 2015/06/29 20:32 by conni