Portal Methods |
The Portal type exposes the following members.
Name | Description | |
---|---|---|
AddressingEnabled |
Returns true if Zip Addressing is enabled for the postalCode
and countryCode sent in.
| |
CreateDynamicsSopModule |
This method automatically creates the default settings
to work with the Microsoft Dynamics GP Sales Transaction
Entry (SOP) module.
| |
CreateTables |
Create the KampData™ TaxEngine's
Microsoft SQL Server® tables.
| |
DateCheck |
This method will convert a string value to a .NET date string. For
example, a newValue of 12505 will return 1/25/2005. The day can be one
or two characters. The month must be 2 characters. The year can be two
or four characters. Slashes are not required. To modify an existing date,
all that is required is to enter the day or the day and month. For example
if the originalValue = "1/25/2005" and newValue = "7" the return value
will be 1/7/2005.
| |
DecimalFromString |
This method will convert a string value such as $350.95 or 7.125% to
its decimal equivalent.
| |
DetailAdd |
Add a Microsoft Dynamics® GP type tax detail record to
the current line.
| |
DocCalculateTax |
Calculate the document tax (all details for all lines)
| |
DocChangesReset |
This method resets the changes tracked for the document
including lines and details. Calling this method will result in
the DocChanged property returning false until the document is
subsequently modified.
As a general rule, this method should only be called after
creating a new document and supplying all of your default
values.
| |
DocClear |
This method discards the document currently held in the TaxEngine.
If the document has been saved previously, it simply releases it.
If the document has never been saved, it deletes it.
| |
DocDelete |
Delete the current document from the TaxEngine tables.
| |
DocGetDefaultJurisdictionID |
This method will attempt to identify and update each line-item's
Jurisdiction ID based on the default tax schedule for that
tax location.
| |
DocLoaded |
This method returns true if the TaxEngine.Document is not null.
| |
DocPost |
Flag a document as posted. This is used primarily for reporting purposes.
Post the document when the transaction is final and should be included
in your tax reports. This method will also save the document.
| |
DocPrint |
This method will print out the current document. This report
is extracted from SQL Server and will therefore reflect the
values that have been saved to the server. It is recommended that
your code check to see if DocChanged = true and if so to save
the document before printing.
| |
DocSave |
Saves the document if all requirements have been met, and
then clears the TaxEngine Document.
| |
DocSave(Boolean, Boolean) |
Allows you to save the document to the TaxEngine's SQL Tables
without meeting requirements. Allows you to save without clearing.
| |
DocTaxDetail |
This method returns a single TrxTaxDetail record from the
DocTaxDetails() array list. Added to assist
with COM or other applications that do not support array lists.
| |
DocTaxDetails |
An ArrayList of the current document's tax details. The list is available in
various forms as specified in the detailLevel. Available choices are as
follows:
Detail = Each tax detail in the document will be included.
LineItem = Each tax detail in the current line will be included.
Order = A summary of the tax details for the document (If multiple lines
include the same detail, then they will be combined into a single detail).
ShipTo = A summary of the tax details for the destination geocode (If
multiple lines include the same detail, then they will be combined into
a single detail).
Prior = For KampData TaxEngine internal use only.
| |
DocTaxDetailsCount |
A count of the TrxTaxDetail records in DocTaxDetails();
| |
DocTaxDetailsRemove |
Removes all tax details associated with the current document.
| |
DocTaxScheduleDefault |
This method will reassign the default tax schedule from the
customer/vendor address record to the document header and then
call LineTaxScheduleDefault() for each line in the document.
| |
DocTaxScheduleRefresh |
This method will remove the current tax details from this document and replace
them with fresh tax details based on each line's effective tax schedule.
| |
DocTaxScheduleSelect |
This method calls LineTaxScheduleSelect() for each line in the document.
This method then calls DocCalculateTax() to complete the process.
| |
Document(Int32) |
This method will load an existing document identified by the
transaction number provided. This method cannot be used to create
new documents.
| |
Document(String, Int16, String) |
This method will load a document identified by the
document number, document type and module provided.
This method can be used to create
new documents as well as to load existing documents.
| |
Enabled |
This method returns true if the Optional Feature is enabled.
| |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ItemCategories |
All existing item categories.
| |
LineAdd |
Add a line-item to the document.
| |
LineAddressesInZip |
Number of city, county, state combinations in the current ZIP code.
| |
LineAddressList |
The city, county, state combinations in the current ZIP code.
| |
LineAddressValidate |
This method will compare the current address with the addresses
included in the ZipAddress table. If the current address is found,
this method will update the LineGeocode based on the match found and
return true;
If the current address is not
found then this method will
terminate and return false.
| |
LineCitiesInStateAndZip |
Cities in the current state and ZIP code.
| |
LineCitiesInStateAndZipCount |
Number of cities in the current state and ZIP code.
| |
LineCityInStateAndZip |
Provides a way to iterate through the City array list. Added to assist
with COM applications or other applications that do not support array lists.
| |
LineCountiesInState |
Counties in the current state.
| |
LineCountiesInStateCount |
Returns a count of the counties in the current city, state and zip.
| |
LineCountyInState |
Provides a way to iterate through the County array list. Added to assist
with COM applications or other applications that do not support array lists.
| |
LineGetDefaultJurisdictionID |
This method will attempt to identify and update this line-item's
Jurisdiction ID based on the default tax schedule for this
line-item's tax location.
| |
LineMoveNext |
Make the next (higher) LineIndex the current line.
| |
LineMovePrev |
Make the previous (lower) LineIndex the current line.
| |
LineRemove |
Delete the current line.
| |
LineStatesInZip |
States in the current ZIP code.
| |
LineStatesInZipCount |
Returns a count of the states in the zip code.
| |
LineTaxDetailsRemove |
Removes all tax details associated with the current document.
| |
LineTaxScheduleDefault |
This method will start with the tax schedule from the
customer/vendor address or IV site record for the line-item, and
when appropriate, run the tax schedule selection process to replace it.
| |
LineTaxScheduleRefresh |
This method will remove the current tax details from this line and replace
them with fresh tax details based on the effective tax schedule.
| |
LineTaxScheduleSelect |
This method will select a tax schedule based on
the Tax Location, Customer and Item settings.
This feature is not available for the KampData TaxEngine Lite.
| |
LineUseIvSiteAddress |
This method will return true if
DocTransactionType = Sales and the LineShippingType = Pickup
or if
DocTransactionType = Purchases and the LineShippingType = Delivery.
| |
Login(Connection) |
This Login method enables the creation of new instances of
the TaxEngine based on an existing connection.
| |
Login(String, String, String, String, Int16, Boolean) |
This Login method is retained for backward compatibility. It uses
DYNAMICS as the system database and uses encrypted Dynamics passwords.
| |
Login(String, String, String, String, Int16, Boolean, Boolean) |
This Login method is retained for backward compatibility. It uses
DYNAMICS as the system database.
| |
Login(String, String, String, String, String, Int16, Boolean) |
This login works with Dynamics encrypted passwords.
| |
Login(String, String, String, String, String, Int16, Boolean, Boolean) |
This method creates and validates the connection to SQL Server. It also
verifies the existence and checks the state of the TaxEngine tables.
If the
tables do not exist and the user has create rights, this method will
create the missing tables.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MissingTables |
This method checks for missing Microsoft SQL Server® tables.
| |
ModuleDocTypes |
Document types designated to a Transaction Source Module.
| |
Modules |
Transaction Source Modules that have been created using the
KDControlCenter.exe application.
| |
NextDocumentNumber |
Whenever a value is returned for this property,
the document number stored in the KD Module Setup
table is incremented.
Optimistic concurrency is used to insure that each
document number returned is unique.
| |
OnRowUpdated |
This method is used in conjunction with optimistic concurrency checking.
| |
RegistrationStatusUpdate |
This method reads the registration keys from the table and sets
the RegistrationStatus accordingly.
| |
TaxScheduleSelectionEnabled |
Returns true of Tax Schedule Selection is enabled for the
countryCode sent in.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
ValidateTables |
Checks the KampData TaxEngine's Microsoft SQL Server® tables
for invalid or missing fields.
|