GrossFullWithdrawalWithAllocations

The GrossFullWithdrawalWithAllocations assignment type, located in the transaction XML, is used to withdraw money from funds. Allocations on the activity at the time of assignment are used to reduce the contract value first. Any remaining amount that must be assigned is distributed among the remaining funds on the contract at a ratio of the fund value to the total remaining fund value %. This is similar to GrossFullWithdrawal.

Assignment Type: GrossFullWithdrawalWithAllocations

Type= GrossFullWithdrawalWithAllocations
Allocations needed?	Yes
Element	Attributes	Parent Element	Description	Element/Attribute Value
Allocations needed?	Yes
<Assignment>			Required: Opening and closing tag for an Assignment
	TYPE	<Assignment>	Required: The GrossFullWithdrawalWithAllocations assignment defines a withdrawal using a set of allocation instructions. When a fund does not have sufficient cash value to meet the allocated amount, the excess is accumulated in an overflow. The overflow will later be taken from the remaining fund cash value on a pro rata basis using no allocation instructions.	Values: GrossFullWithdrawalWithAllocations
	IGNORENEGATIVECASHVALUES	<Assignment>	Optional	Values: Yes, No Yes: Funds with a negative cash value are dropped during the pro rata calculation and dropped from the fund removal. No: Allows funds with negative cash value to be included in the pro rata calculation. The absolute value of the funds is used in the pro rata formula. The default is No.
<MoneyType>		<Assignment>	Required, Repeatable: Identifies the money type code for the money change records. This money type code applies while the fund's or deposit's cash value is 0 or positive.
	NAME	<MoneyType>	Required: The attribute provides the name of the math variable holding the amount of change for this money type code.	Values: A math variable containing an amount
	BUCKET	<MoneyType>	Optional: This attribute identifies the bucket from which to pull the money from funds where buckets are part of the fund hierarchy. The bucket is identified by the integer value provided by this attribute. Note: For funds where a bucket has not been established, the bucket value is ignored.	Values: A math variable containing an integer
	EXCLUDEFUNDTYPES	<MoneyType>	Optional: Comma-separated list of fund types. Allows funds to be excluded from the allocations that are moving money into a fund, based on the type of fund.	Values: list of fund types
	MVACHARGE	<MoneyType>	Optional: Indicates whether there is an MVA Charge.	Values: Yes, No, literal, field, or a math variable
	MVAMONEYTYPE	<MoneyType>	Optional: Provides the money type code for MVA charge values.	Values: money type code
	REDEMPTIONFEE	<MoneyType>	Optional: Indicates whether there is a Redemption Fee.	Values: Yes, No, literal, field, or a math variable
	REDEMPTIONMONEYTYPE	<MoneyType>	Optional: Provides the money type code for Redemption fees.	Values: money type code
	FUNDOVERFLOWMONEYTYPE	<MoneyType>	Optional: Specifies the money type code of the fund overflow.	Values: money type code
Element Value
Note: Assignment fields must be negative (removals). Allocations on the activity at the time of assignment are used to reduce the contract value first. Any remaining amount that must be assigned is distributed among the remaining funds on the contract at a ratio of the fund value to the total remaining fund value percent. This is similar to GrossFullWithdrawal.
Used when	Total Money-out
Examples	FreeLook

XML Schema

<Assignment TYPE="GrossFullWithdrawalWithAllocations" IGNORENEGATIVECASHVALUES="[Yes|No]">
    <MoneyType NAME="[math variable]" BUCKET="[integer]" EXCLUDEFUNDTYPES="[fund types]" MVACHARGE="[Yes|No]" MVAMONEYTYPE="[money type code]" REDEMPTIONFEE="[Yes|No]" REDEMPTIONMONEYTYPE="[money type code]" FUNDOVERFLOWMONEYTYPE="[money type code]">[money type code]</MoneyType>
    <MoneyType>...</MoneyType>
</Assignment>

XML Example

<Transaction>

<EffectiveDate STATUS="Enabled" TITLE="Activity Date" TYPE="SYSTEM"/>

<Allocation FUNDLIMIT="10" EXCLUDETYPE="05,06,07" ALLOWMIXEDMETHODS="Yes" ALLOCATIONTYPES="Percent,Amount,Units"/>

<FundAllocation FUNDLIMIT="10" SHOWVALUATION="Yes" AMOUNTPRECISION="3" PERCENTPRECISION="7" UNITPRECISION="3" REPEATFUND="No" ALWAYSEQUALPERCENT="No" ALLOCATIONTYPES="Percent,Amount,Units">Yes</FundAllocation>

<Valuation POLICYVALUES="No">

<EffectiveDateNUVMustExist>Yes</EffectiveDateNUVMustExist>

<SystemDateNUVMustExist>No</SystemDateNUVMustExist>

</Valuation>

<CopyBook>CopyBook-FundRelation</CopyBook>

<Fields>

<Field>

<Name>WithdrawalAmount</Name>

<Display>Withdrawal Amount</Display>

<DataType>Money</DataType>

<DefaultValue>0.0</DefaultValue>

</Field>

</Fields>

<Math>

<MathVariables>

<MathVariable VARIABLENAME="ActivityWithdrawalAmount" TYPE="FIELD" DATATYPE="DECIMAL">Activity:WithdrawalAmount</MathVariable>

<MathVariable VARIABLENAME="ActivityWithdrawalAmount" TYPE="EXPRESSION" DATATYPE="DECIMAL">ActivityWithdrawalAmount * -1</MathVariable>

</MathVariables>

<Assignment TYPE="GrossFullWithdrawalWithAllocations">

<MoneyType NAME="ActivityWithdrawalAmount">01</MoneyType>

</Assignment>

</Math>

</Transaction>