Generic Tax Interface Messages

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 topic:

• 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
Message
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
TaxInterfaceRequest
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
CustomerShipTo
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
OrderDetail
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
ShipFromWarehouse
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

</OrderDetail>

</OrderDetails>

</TaxInterfaceRequest>

</Message>

Sample CWTaxRequest Message: Quotation

</OrderDetail>

</OrderDetails>

</TaxInterfaceRequest>

</Message>

Sample CWTaxRequest Message: Invoice

</OrderDetail>

</OrderDetails>

</TaxInterfaceRequest>

</Message>

Sample CWTaxRequestMessage: Distribute

</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
Message
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
TaxInterfaceResponse
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
CustomerShipTo
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
OrderDetail
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
JurisdictionLevel
jurisdiction_level	alpha
jurisdiction_level_desc	alpha
jurisdiction_level_tax_amt	numeric
jurisdiction_level_tax_rate	numeric
SuggestedTaxAreaID
suggested_tax_area_ID	numeric
SuggestedTaxJurisdiction
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