Chapter 45: Using the QAS Address Interface | Contents | SCVs | Search | Glossary | Reports | XML | Index | System Operations |
Chapter 46: Generic Tax Interface Messages
Purpose: If you use the generic tax interface, as indicated by the Tax Interface Values (J29), the system generates the CWTaxRequest message and receives the CWTaxResponse message.
The TAX_INT process in Working with Integration Layer Processes (IJCT) indicates the MQSeries queues to use when generating and receiving these messages.
In this chapter:
• Generic Outbound Tax Request Message (CWTaxRequest)
• Sample CWTaxRequest Message: Tax Area ID
• Sample CWTaxRequest Message: Quotation
• Sample CWTaxRequest Message: Invoice
• Sample CWTaxRequestMessage: Distribute
• Generic Inbound Tax Response Message (CWTaxResponse)
• Sample CWTaxResponse Message: Tax Area ID
• Sample CWTaxResponse Message: Quotation
• Sample CWTaxResponse Message: Invoice
Generic Outbound Tax Request Message (CWTaxRequest)
The system generates this message if indicated by the settings of the Tax Interface Values (J29).
For more information: See XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.
Attribute Name |
Type |
Length |
Comments |
|
|||
source |
alpha |
|
Set to CWDirect |
target |
alpha |
|
Set to CWIntegrate |
type |
alpha |
|
Set to CWTaxRequest |
date_created |
numeric |
|
YYYY-MM-DD format |
time_created |
numeric |
|
HH:MM:SS format |
|
|||
request_type |
alpha |
10 |
Possible types are: • TAXAREAID • QUOTATION • INVOICE • DISTRIBUTE |
company |
numeric |
3 |
The company where the order is being placed. |
entity |
numeric |
3 |
The entity associated with the division assigned to the source code on the order header. Sent only if the Pass Entity Code to Vertex (F69) system control value is set to Y. |
order_nbr |
numeric |
8 |
|
order_shipto_nbr |
numeric |
3 |
|
tax_area_ID |
numeric |
11 |
Tax area ID for the shipping address. |
order_addl_charge_seq |
numeric |
2 |
Used for QUOTATION only. |
resale_exemption_nbr |
numeric |
15 |
From customer’s Exempt certif number or the Resale/exempt # in the Customer Tax file |
sold_to_cust_class |
alpha |
2 |
|
sold_to_cust_class_desc |
alpha |
30 |
|
|
|||
ship_to_addr1 through ship_to_addr4 |
alpha |
32 each |
|
ship_to_city |
alpha |
25 |
|
ship_to_state |
alpha |
2 |
|
ship_to_state_name |
alpha |
25 |
|
ship_to_postal |
alpha |
10 |
|
ship_to_country |
alpha |
3 |
|
ship_to_country_name |
alpha |
30 |
|
|
|||
odt_line_nbr |
numeric |
3 |
|
odt_line_item_type |
alpha |
2 |
Valid values are: LM = line merchandise LH = handling LF = line-level freight LD = duty AF = additional freight OF = order freight OA = order-level additional charge (not currently implemented) |
odt_item |
alpha |
12 |
The item code. |
odt_item_desc |
alpha |
30 |
|
odt_SKU |
alpha |
14 |
The SKU code. |
odt_SKU_desc |
alpha |
30 |
|
odt_arrival_date |
numeric |
8 |
YYYYMMDD format. |
odt_item_class |
alpha |
3 |
|
odt_item_class_desc |
alpha |
30 |
|
odt_long_SKU_dept |
numeric |
4 |
|
odt_long_SKU_dept_desc |
alpha |
30 |
|
odt_long_SKU_class |
numeric |
3 |
|
odt_long_SKU_class_desc |
alpha |
30 |
|
odt_long_SKU_division |
numeric |
3 |
|
odt_long_SKU_division_ desc |
alpha |
30 |
|
odt_qty |
numeric |
5 |
|
odt_price |
numeric |
7.2 |
|
odt_extended_price |
numeric |
9.2 |
|
odt_tax_override |
alpha |
1 |
|
odt_tax_override_amt |
numeric |
10.5 |
|
|
|||
ship_from_warehouse |
numeric |
3 |
|
ship_from_country |
alpha |
3 |
|
ship_from_country_name |
alpha |
30 |
|
ship_from_addr1 through ship_from_addr4 |
alpha |
32 each |
|
ship_from_city |
alpha |
25 |
|
ship_from_state |
alpha |
2 |
|
ship_from_state_name |
alpha |
25 |
|
ship_from_postal |
alpha |
10 |
|
Sample CWTaxRequest Message: Tax Area ID
<Message source="CWDirect" target="CWIntegrate" type="CWTaxRequest" date_created="2005-10-13" time_created="18:12:37">
<TaxInterfaceRequest request_type="TAXAREAID" company="242" entity=" " order_nbr="00005485" order_shipto_nbr="001" resale_exemption_nbr=" " sold_to_cust_class="">
<CustomerShipTo ship_to_addr1="24 PRIME PARK WAY" ship_to_city="NATICK" ship_to_state="MA" ship_to_postal="01760" ship_to_country="USA"/>
<OrderDetails>
<OrderDetail odt_arrival_date="2005-10-13">
</OrderDetail>
</OrderDetails>
</TaxInterfaceRequest>
</Message>
Sample CWTaxRequest Message: Quotation
<Message source="CWDirect" target="CWIntegrate" type="CWTaxRequest" date_created="2005-10-13" time_created="18:12:58">
<TaxInterfaceRequest request_type="QUOTATION" company="242" entity=" " order_nbr="00005485" order_shipto_nbr="001" tax_area_ID="220170630" resale_exemption_nbr=" " sold_to_cust_class="">
<CustomerShipTo ship_to_addr1="24 PRIME PARK WAY" ship_to_city="NATICK" ship_to_state="MA" ship_to_postal="01760" ship_to_country="USA"/>
<OrderDetails>
<OrderDetail odt_line_nbr="00001" odt_line_item_type="LM" odt_item="CP10000" odt_SKU=" " odt_arrival_date="2005-10-13" odt_item_class="HG" odt_long_SKU_dept="0033" odt_long_SKU_class="0810" odt_long_SKU_division=" " odt_qty="00001" odt_price="0001450" odt_extended_price="000001450">
<ShipFromWarehouse ship_from_warehouse="004" ship_from_addr1="10 SPEEN STREET" ship_from_city="FRAMINGHAM" ship_from_state="MA" ship_from_postal="01701" ship_from_country="USA"/>
</OrderDetail>
</OrderDetails>
</TaxInterfaceRequest>
</Message>
Sample CWTaxRequest Message: Invoice
<Message source="CWDirect" target="CWIntegrate" type="CWTaxRequest" date_created="2005-10-24" time_created="10:51:08">
<TaxInterfaceRequest request_type="INVOICE" company="025" entity="001" order_nbr="00011634" order_shipto_nbr="001" tax_area_ID="30130210" resale_exemption_nbr=" " sold_to_cust_class="CC">
<CustomerShipTo ship_to_addr1="123 E BUCKEYE RD" ship_to_city="PHOENIX" ship_to_state="AZ" ship_to_postal="85004-2720" ship_to_country="USA"/>
<OrderDetails>
<OrderDetail odt_line_nbr="00001" odt_line_item_type="LM" odt_item="FI257" odt_SKU=" " odt_arrival_date="2005-10-24" odt_item_class="BL" odt_long_SKU_dept="0555" odt_long_SKU_class="5555" odt_long_SKU_division="1" odt_qty="00001" odt_price="0002000" odt_extended_price="000002000">
<ShipFromWarehouse ship_from_warehouse="100" ship_from_addr1="10 SPEENE ST" ship_from_addr2="WAREHOUSE ADDRESS LINE 2" ship_from_city="NATICK" ship_from_state="MA" ship_from_postal="01760" ship_from_country="USA"/>
</OrderDetail>
</OrderDetails>
</TaxInterfaceRequest>
</Message>
Sample CWTaxRequestMessage: Distribute
<Message source="CWDirect" target="CWIntegrate" type="CWTaxRequest" date_created="2005-10-26" time_created="15:56:57">
<TaxInterfaceRequest request_type="DISTRIBUTE" company="025" entity=" " order_nbr="00011708" order_shipto_nbr="001" tax_area_ID="30130210" resale_exemption_nbr=" " sold_to_cust_class="CC">
<CustomerShipTo ship_to_addr1="123 E BUCKEYE RD" ship_to_city="PHOENIX" ship_to_state="AZ" ship_to_postal="85004-2720" ship_to_country="USA"/>
<OrderDetails>
<OrderDetail odt_line_nbr="00002" odt_line_item_type="DT" odt_arrival_date="2005-10-26" odt_tax_override="Y" odt_tax_override_amt="0000020">
<ShipFromWarehouse ship_from_warehouse="100" ship_from_addr1="10 SPEENE ST" ship_from_addr2="WAREHOUSE ADDRESS LINE 2" ship_from_city="NATICK" ship_from_state="MA" ship_from_postal="01760" ship_from_country="USA"/>
</OrderDetail>
</OrderDetails>
</TaxInterfaceRequest>
</Message>
Generic Inbound Tax Response Message (CWTaxResponse)
For more information: See XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.
Attribute Name |
Type |
Length |
Comments |
|
|||
source |
alpha |
8 |
Set to CWIntegrate |
target |
alpha |
11 |
Set to CWDirect |
type |
alpha |
12 |
Set to CWTaxResponse |
date_created |
numeric |
8 |
YYYY-MM-DD format |
time_created |
numeric |
6 |
HH:MM:SS format |
|
|||
request_type |
alpha |
10 |
Valid values are: • TAXAREAID • QUOTATION • INVOICE |
company |
numeric |
3 |
|
entity |
numeric |
3 |
|
order_nbr |
numeric |
8 |
|
order_shipto_nbr |
numeric |
3 |
|
tax_type |
alpha |
60 |
Valid values are: • SALES • SELLER_USE |
tax_area |
numeric |
8 |
|
order_addl_charge_seq |
numeric |
2 |
|
lookup_result |
alpha |
60 |
Valid values include: • TAXABLE • EXEMPT |
|
|||
ship_to_addr1 through ship_to_addr4 |
alpha |
32 each |
|
ship_to_city |
alpha |
25 |
|
ship_to_state |
alpha |
2 |
|
ship_to_state_name |
alpha |
25 |
|
ship_to_postal |
alpha |
10 |
|
ship_to_country |
alpha |
3 |
|
ship_to_country_name |
alpha |
30 |
|
|
|||
odt_line_nbr |
numeric |
3 |
|
odt_line_item_type |
alpha |
2 |
Valid values are: LM = line merchandise LH = handling LF = line-level freight LD = duty AF = additional freight OF = order freight OA = order-level additional charge (not currently implemented) |
odt_total_tax_amt |
numeric |
10.5 |
Total tax for all jurisdictions for the order detail line |
odt_total_tax_rate |
numeric |
6.4 |
Total tax rate for all jurisdictions for the order detail line |
|
|||
jurisdiction_level |
alpha |
|
|
jurisdiction_level_desc |
alpha |
|
|
jurisdiction_level_tax_amt |
numeric |
|
|
jurisdiction_level_tax_rate |
numeric |
|
|
|
|||
suggested_tax_area_ID |
numeric |
|
|
|
|||
suggested_tax_jurisdiction |
alpha |
10 |
Valid values are: • COUNTRY • STATE • COUNTY • CITY |
suggested_tax_ jurisdiction_desc |
alpha |
60 |
|
suggested_tax_effective_ date |
numeric |
8 |
YYYY-MM-DD format |
suggested_tax_expiration_ date |
numeric |
8 |
YYYY-MM-DD format |
Sample CWTaxResponse Message: Tax Area ID
<Message source="CWIntegrate" target="CWDirect" type="CWTaxResponse" date_created="2005-10-13" time_created="18:12:23">
<TaxInterfaceResponse request_type="TAXAREAID" company="242" order_nbr="00005485" order_shipto_nbr="001">
<SuggestedTaxAreaIDs>
<SuggestedTaxAreaID suggested_tax_area_ID="220170630">
<SuggestedTaxJurisdictions>
<SuggestedTaxJurisdiction suggested_tax_jurisdiction="COUNTRY" suggested_tax_jurisdiction_desc="UNITED STATES" suggested_tax_effective_date="1900-01-01" suggested_tax_expiration_date="9999-12-31" />
<SuggestedTaxJurisdiction suggested_tax_jurisdiction="STATE" suggested_tax_jurisdiction_desc="MASSACHUSETTS" suggested_tax_effective_date="1900-01-01" suggested_tax_expiration_date="9999-12-31" />
<SuggestedTaxJurisdiction suggested_tax_jurisdiction="COUNTY" suggested_tax_jurisdiction_desc="MIDDLESEX" suggested_tax_effective_date="1900-01-01" suggested_tax_expiration_date="9999-12-31" />
<SuggestedTaxJurisdiction suggested_tax_jurisdiction="CITY" suggested_tax_jurisdiction_desc="NATICK" suggested_tax_effective_date="1900-01-01" suggested_tax_expiration_date="9999-12-31" />
</SuggestedTaxJurisdictions>
</SuggestedTaxAreaID>
</SuggestedTaxAreaIDs>
</TaxInterfaceResponse>
</Message>
Sample CWTaxResponse Message: Quotation
<Message source="CWIntegrate" target="CWDirect" type="CWTaxResponse" date_created="2005-10-13" time_created="18:15:13">
<TaxInterfaceResponse request_type="QUOTATION" company="242" order_nbr="00005485" order_shipto_nbr="001" tax_type="SELLER_USE" tax_area_ID="220170630">
<OrderDetails>
<OrderDetail odt_line_nbr="00001" odt_line_item_type="LM" odt_total_tax_amt="1450" odt_total_tax_rate="500">
<JurisdictionLevels>
<JurisdictionLevel jurisdiction_level="STATE" jurisdiction_level_desc="MASSACHUSETTS" jurisdiction_level_tax_amt="72500" jurisdiction_level_tax_rate="500" />
</JurisdictionLevels>
</OrderDetail>
</OrderDetails>
</TaxInterfaceResponse>
</Message>
Sample CWTaxResponse Message: Invoice
<Message source="CWIntegrate" target="CWDirect" type="CWTaxResponse" date_created="2005-10-24" time_created="10:50:40">
<TaxInterfaceResponse request_type="INVOICE" company="025" order_nbr="00011634" order_shipto_nbr="001" tax_type="SELLER_USE" tax_area_ID="30130210">
<OrderDetails>
<OrderDetail odt_line_nbr="00001" odt_line_item_type="LM" odt_total_tax_amt="2000" odt_total_tax_rate="740">
<JurisdictionLevels>
<JurisdictionLevel jurisdiction_level="STATE" jurisdiction_level_desc="ARIZONA" jurisdiction_level_tax_amt="112000" jurisdiction_level_tax_rate="560" />
<JurisdictionLevel jurisdiction_level="CITY" jurisdiction_level_desc="PHOENIX" jurisdiction_level_tax_amt="36000" jurisdiction_level_tax_rate="180" />
</JurisdictionLevels>
</OrderDetail>
</OrderDetails>
</TaxInterfaceResponse>
</Message>
Chapter 45: Using the QAS Address Interface | Contents | SCVs | Search | Glossary | Reports | XML | Index | System Operations |
OE_APP_F CWDirect 18.0 August 2015 OTN