ApplyByFund
The ApplyByFund Assignment type, located in the transaction XML, is used to direct deposits to specific funds.
Note: The allocation records should be positive and must match total money-in amount/units or 100%. This allows the apply to be fund specific.
Type = ApplyByFund | ||
---|---|---|
Allocations needed? |
No |
|
Attributes |
BUCKET |
The current bucket. Must be a integer value. |
RATELOCKDATE |
Date of rate lock. |
|
Element Value |
One or more MoneyType tags that define the amount and type of money to be applied. Each MoneyType must have a FUND attribute set to a FundGUID. |
|
Note: The allocation records should be positive and must match total money-in amount/units or 100%. This allows the apply to be fund specific. |
||
Used when |
To direct deposits to specific funds. |
|
Examples |
LoanRepayment |
Element | Attribute Value | Element Value | Definition |
---|---|---|---|
<Assignment> | |||
TYPE |
ApplyByFund |
Required: Defines the type of assignment to be performed with the allocation |
|
<MoneyType> |
AsCodeMoneyType - A literal code value |
Required & Repeatable: Defines the money type of the resulting valuation records. |
|
ASSIGNMENTFUNDCOLLECTION |
A math collection of fund GUIDs and amounts |
Defines a collection of parent fund GUIDs and amounts to use in the assignment. Takes precedence over legacy NAME and FUND attributes for these assignments. |
|
BUCKET |
Math variable containing an integer value. |
Optional: Defines the bucket for the deposit |
|
RATELOCKDATE |
Math variable containing a Date value |
Optional: Defines the date of the rate lock for the deposit |
|
NAME |
Math variable containing a numeric value. |
Legacy attribute defines the amount to use in the assignment. Requires FUND attribute for these assignments. |
|
FUND |
Math variable containing a fund GUID. |
Legacy attribute defines the Fund to use in the assignment. Requires NAME attribute for these assignments. |
|
PRIMARYCOSTBASISCOLLECTION |
Math variable |
Optional: This attribute provides a collection of parent FundGUID/amount pairs. It indicates the amount of value to add to the fund's Primary Cost Basis from funds and their deposits. |
|
SECONDARYCOSTBASISCOLLECTION |
Math variable |
Optional: This attribute provides a collection of parent FundGUID/amount pairs. It indicates the amount of value to add to the fund's Secondary Cost Basis from funds and their deposits. |
|
FRACTIONALVALUES |
Math variable containing a conditional variable. |
Optional: The attribute controls whether a higher scaled value greater than a fund's currency definition would be allowed. Values: Yes | No Yes: Funds with floating values will not be rounded off to the fund's currency definition. No: Funds with floating values will be rounded off the fund's currency definition. The default value is No. Note: An error is thrown when the attribute FRACTIONVALUES does not contain a value of Yes/No or also when the math variable does not recognize a value Yes/No.
|
XML Schema
<Assignment TYPE="ApplyByFund">
<MoneyType ASSIGNMENTFUNDCOLLECTION="[collection]" BUCKET="[integer]" RATELOCKDATE="[date]" PRIMARYCOSTBASISCOLLECTION="[collection]" SECONDARYCOSTBASISCOLLECTION="[collection]">[money type code]</MoneyType> <MoneyType>. . .</MoneyType> <MoneyType NAME="[amount]" FUND="[fundguid]" BUCKET="[integer]" RATELOCKDATE="[date]" PRIMARYCOSTBASISCOLLECTION="[collection]" SECONDARYCOSTBASISCOLLECTION="[collection]">[money type code]</MoneyType> <MoneyType>. . .</MoneyType>
</Assignment>
XML Example
<Assignment TYPE="ApplyByFund">
<MoneyType NAME="GrossAmountMV" FUND="InterimFund" BUCKET="CurrentBucket" RATELOCKDATE="Date" FRACTIONALVALUES="Yes">63</MoneyType>
</Assignment>