WithholdingScreen
This business rule defines the layout of the Withholding screen, which signifies the amount or percentage of federal and state taxes to be withheld from taxable disbursements defined by the policy owner.
This screen may be configured to disable entry into withholding fields for specified policy statuses. When the policy Withholding fields are disabled, no further direct modification of these fields is allowed
Additional Information:
The Withholding screen can be built to address withholding at the Policy and Activity level. The following are some of the basic dynamic fields that are recommended to be present in the WithholdingScreen.
- Federal Percent
- Federal Amount
- State Percent
- State Amount
- Opt-out
- State Form Returned (radio button)
WithholdingScreen Element/Attribute Table
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<WithholdingScreen> | The required opening and closing elements of this business rule. |
|
|
<DisableWithholdingFields> | Optional element: This section lists policy statuses that will lock down withholding fields at the policy level if the policy status is one of those listed. |
|
|
<DisablePolicyStatus> | Required if DisableWithholdingFields is present; repeatable element: This element identifies a policy status that will lock down withholding if the policy status matches it. |
| A single Policy Status code. No comma delimited lists are to be used. |
<Fields> | See Fields Elements. |
|
|
<Field> | Required element. |
XML Example
<WithholdingScreen>
<DisableWithholdingFields>
<DisablePolicyStatus>01</DisablePolicyStatus>
<DisablePolicyStatus>09</DisablePolicyStatus>
</DisableWithholdingFields>
<Fields>
<Field>
<Name>FederalPercent</Name>
<Display>Federal Percent</Display>
<DataType>Percent</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>FederalAmount</Name>
<Display>Federal Amount</Display>
<DataType>Money</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>StatePercent</Name>
<Display>State Percent</Display>
<DataType>Percent</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>StateAmount</Name>
<Display>State Amount</Display>
<DataType>Money</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>OptOut</Name>
<Display>Opt-Out</Display>
<DataType>Radio</DataType>
<DefaultValue>01</DefaultValue>
<Disabled>No</Disabled>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>01</OptionValue>
<OptionText>No</OptionText>
</Option>
<Option>
<OptionValue>02</OptionValue>
<OptionText>Yes</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>StateForm</Name>
<Display>State Form Returned</Display>
<DataType>Radio</DataType>
<DefaultValue>01</DefaultValue>
<Disabled>No</Disabled>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>01</OptionValue>
<OptionText>No</OptionText>
</Option>
<Option>
<OptionValue>02</OptionValue>
<OptionText>Yes</OptionText>
</Option>
</Options>
</Query>
</Field>
</Fields>