Share via


RequiredTaxCy

Use the RequiredTaxCy pipeline component to verify that total tax and tax included appear in the order form.

For more information, see Currency Enhancements.

Intended use: Order Processing pipeline, Tax stage.

Configuration Values

None.

Values Read

TheRequiredTaxCy pipeline component reads the following values from the indicated dictionaries.

Key

Dictionary

Description

_cy_tax_total

Order

The total tax for the order.

_cy_tax_included

Order

The amount of tax included in the order.

MessageManager.pur_badtax

Context

The error message text (optional).

Values Written

The RequiredTaxCy pipeline component writes the following value to the Order dictionary.

Key

Description

_Purchase_Errors

Error messages are written to this SimpleList object.

Errors

The RequiredTaxCy pipeline component returns error level 2 (OPPERRORLEV_WARN) when one of the tax items is missing. Other errors return error level 3 (OPPERRORLEV_FAIL).

The RequiredTaxCy pipeline component also writes an error message to the _Purchase_Errors collection. The component use a MessageManager object to retrieve error message text.

Constant

Condition

pur_badtax

One of the tax items is missing.

Remarks

The RequiredTaxCy pipeline component verifies that the _cy_tax_total and _cy_tax_included keys exist in the order form. If either value does not exist, the RequiredTaxCy pipeline component uses the pur_badtax constant to retrieve error message text from the MessageManager object and stores this message in the _Purchase_Errors collection of the Order dictionary.

See Also

Other Resources

Pipeline Component Reference