KampData Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Calling DynamicZip from another 3rd party product ======

===== Procedure DynamicZipCall_External =====
This procedure has been designed to make it possible to call the DynamicZip [[dynamiczip:features:zip_addressing|ZipAddressing]] and [[dynamiczip:features:schedule_assignment:tax_schedule_selection|Tax Schedule Selection]] from another 3rd Party Integrating Dictionary.

This procedure can be called using the Dexterity statement:
<code>
call with name "DynamicZipCall_External" in dictionary 581 {, parameter, parameter,...}
</code>
Be sure to include all parameters. The optional parameters can be included simply as a comma with no associated value.
==== Build 74 and later ====
=== Parameters ===
**Note:** When the parameter iTaxOnPurchases = true, parameters labeled as Customer become Vendor.
  * in boolean iTaxOnPurchases;	
  * in 'Customer Number' iCustomerNumber;
  * in 'Address Code' iShipToAddressId;
  * inout City ioShipToCity;
  * inout 'KD County' ioShipToCounty;
  * inout State ioShipToState;
  * inout Zip ioShipToZip;
  * inout 'Country Code' ioShipToCountry;
  * in boolean iCorrectAddress;	{Run ZipAddressing}
  * inout 'Tax Schedule ID' ioDocTaxScheduleId;	{Customer's tax schedule id for this doc or line-item}
  * in boolean iAssignTaxSchedule;	{Run tax schedule selection}
  * in 'Location Code' iIVSite;
  * in 'Shipping Method' iShippingMethod;
  * in 'Item Number' iItemNumber;
  * optional inout string [[dynamiczip:glossary:item_category|ioItemCategory]];((If iItemNumber is not blank, ioItemCategory should be left blank and the setting from TBIC setup will be used. Alternately leave iItemNumber blank and specify the desired ioItemCategory.))
  * inout 'Tax Options' [[dynamiczip:glossary:tax_option|ioItemTaxOption]];((Leave blank to use setting from the Item Maintenance window.))
  * inout 'Tax Schedule ID' ioItemTaxScheduleId;((Leave blank to use setting from the Item Maintenance window.))
  * inout KDGeoCode [[dynamiczip:glossary:geocode|ioShipToGeocode]];((If provided, the geocode will override the ship-to address. ioShipToGeocode should normally be left blank.))
  * optional inout boolean ioOutsideCityLimits = false; ((This parameter changed as of Build 74.)) 
  * optional in boolean iUnsued1 = false;  ((This parameter changed as of Build 74.))
  * optional in boolean iUnused2; ((This parameter changed as of Build 74.))
  * optional in boolean iUnused3; ((This parameter changed as of Build 74.))
  * optional in boolean [[dynamiczip:glossary:select_default|iSelectDefaultSchedule]];((If not provided, the setting in the DynamicZip Setup window is used.))
  * optional in boolean iTaxByItemCatagory;((If not provided, the setting in the DynamicZip Setup window is used.))
  * optional in boolean iUseUspsCity;((If not provided, the setting in the DynamicZip Setup window is used.))
  * optional in integer iWindowCalledFrom;((This is used when automatically opening the address or tax schedule lookup window. This should normally not be used by another 3rd party product.))
  * out string oMessage;((This will be blank unless an address or tax schedule could not be selected.))
  * out integer [[dynamiczip:features:addressing:zip_addressing_status|oAddressStatus]];
  * out integer [[dynamiczip:features:schedule_assignment:tax_schedule_selection_status|oScheduleStatus]];
  * optional out KDTaxStatus [[dynamiczip:glossary:taxable_status|oCustomerTaxableStatus]];
  * optional out boolean oTaxByItemCatRecordFound;
  * optional in date iTaxDate; {Not used}
  * optional in integer [[dynamiczip:glossary:tax_location_type|iTaxLocationType]] = KD_LOCATION_CUSTOMER; ((This parameter added with Build 74.))

==== Prior to Build 74 ====
=== Parameters ===
**Note:** When the parameter iTaxOnPurchases = true, parameters labeled as Customer become Vendor.
  * in boolean iPurchaseTax; {defaults to false (sales)}\\ 
  * in 'Customer Number' iCustomerNumber;\\ 
  * in 'Address Code' iShipToAddressId;\\ 
  * inout City ioShipToCity;\\ 
  * inout 'KD County' ioShipToCounty;\\ 
  * inout State ioShipToState; {two character state code}\\ 
  * in Zip iShipToZip;\\ 
  * inout 'Country Code' ioShipToCountry;\\ 
  * in boolean iCorrectAddress; {used to control whether or not DynamicZip should perform [[dynamiczip:features:Zip Addressing|address validation & correction]]}\\ 
  * inout 'Tax Schedule ID' ioDocTaxScheduleId; {Customer's tax schedule id for this doc or line-item}\\ 
  * in boolean iAssignTaxSchedule; {used to control whether or not DynamicZip should perform [[dynamiczip:features:schedule_assignment:Tax Schedule Selection|tax schedule ID validation & reselection]]}\\ 
  * in 'Location Code' iIVSite;\\ 
  * in 'Shipping Method' iShippingMethod;\\ 
  * in 'Item Number' iItemNumber;\\ 
  * optional inout string ioItemCategory; {used only if non-blank value sent and item number is blank}\\ 
  * inout 'Tax Options' ioTaxOptions; {the item tax option; Base on Customers, Taxable, Nontaxable}\\ 
  * inout 'Tax Schedule ID' ioItemTaxScheduleId; {Item's tax schedule id used if item's tax option is 'Taxable'}\\ 
  * inout KDGeoCode ioGeocode;\\ 
  * optional in boolean iInsideCityLimits;\\ 
  * optional in boolean iPreserveCityLimitsSelection;\\ 
  * optional in boolean iAssumeInCityLimits; {defaults to the setting in the [[dynamiczip:windows:DynamicZip Setup window]] }\\ 
  * optional in boolean iAssumeTaxable; {defaults to the setting in the [[dynamiczip:windows:DynamicZip Setup window]] }\\ 
  * optional in boolean iBaseOnMajority; {defaults to the setting in the [[dynamiczip:windows:DynamicZip Setup window]] }\\ 
  * optional in boolean iTaxByItemClass; {defaults to the setting in the [[dynamiczip:windows:DynamicZip Setup window]] }\\ 
  * optional in boolean iUseUspsCity; {defaults to the setting in the [[dynamiczip:windows:DynamicZip Setup window]] }\\ 
  * optional in integer iWindowCalledFrom;\\ 
  * out string oMessage;\\ 
  * out integer oAddressStatus;\\ 
  * out integer [[dynamiczip:features:schedule_assignment:tax_schedule_selection_status|oScheduleStatus]]\\ 
  * optional out KDTaxStatus oCustomerTaxableStatus;\\ 
  * optional out boolean oTaxByItemCatRecordFound;\\ 
  * optional in date iTaxDate; {Not used}


----

[[dynamiczip:integration_points:Integration Points]]