Disbursement Element
The Disbursement element triggers the creation of the AsDisbursementRecord.
| Element/Tag | Description | Attribute | Attribute/Element Value and Description |
|---|---|---|---|
|
<Disbursement> |
The start and end tag used to enable this functionality. |
|
|
| OVERRIDABLE |
Yes or No |
||
|
APPROVALSTATUS |
String. Disbursement status. Approved, Disapproved, or Unapproved. From a math variable. |
||
|
APPROVAL |
Yes: indicates that the pending disbursement will be displayed on the Disbursement Approval screen No: indicates that the pending disbursement will not be displayed on the Disbursement Approval screen
|
||
|
CheckEFTInformation |
Yes: Processing is determined by CheckEFTInformation business rule No: Assumed. This is the default value. |
||
|
DisbursementType |
String. (As defined in AsCodeDisbursementMethod). Variable defining the disbursement type
|
||
| METHOD |
Unbalanced - Outstanding disbursement adjustment exists as a result of reversal/recycle processing. Balanced - Reversal/recycle processing did not result in any disbursement adjustment. |
||
|
RECOVERABLE |
Yes or No Note: Unlike recovery processing at a policy level where the shadowed disbursement for a RoleGUID on the policy is summed, for recovery processing on a client, the shadowed disbursements for the ClientGUID will be summed. |
||
|
TAXABLEAMOUNT |
Amount that is taxable. Default is the disbursement amount. |
||
|
<AddressDisplay> |
|
|
Defines the field containing the address of the disbursement. |
|
<DisbursementRole> |
Optional element:Identifies the disbursement payee. Variable defining RoleGUID. This is ignored if present in the configuration of a client level transaction. Cannot coexist with DisbursementClient. |
|
The RoleGUID or RoleCode to use for disbursements. In addition, can contain the address GUID field name, separated from RoleGUID by a comma |
| TYPE | |||
| DISBURSEMENTAMOUNT |
Final Disbursement. Variable defining the disbursement amount |
||
|
<DisbursementClient>
|
Optional element:In client level transactions, indicates that the recipient of the disbursement must exist as a role on the policy. This element cannot be used in conjunction with <DisbursementRole>. <DisbursementClient> will be ignored if present in the configuration of a policy level transaction. If not present in the client disbursement activity configuration, a stack trace is expected. |
|
Math variable or field name that holds the ClientGUID of the recipient of the disbursement.
|
| DISBURSEMENTAMOUNT | Final Disbursement. Math variable or field defining the disbursement amount. | ||
|
<DisbursementFields> |
Required:
|
|
|
|
<DisbursementField> |
Required:
|
||
|
<From> |
RequiredSets the From value of the Disbursement field. |
|
|
|
<To> |
RequiredSets the To value of the Disbursement field. |
|
|
|
<DataType> |
RequiredSets the data type value of the Disbursement field. |
|
Allowable values:Combo / Date / Decimal / Integer / Money / Text / TextArea
|
|
<WithholdingFields> |
|
|
String - Variable defining Federal or State Withholding amounts. Must be Fields or MathVariables contained in transaction. Comma separated list. |
XML Example
<Transaction>
<EffectiveDate STATUS="Enabled" TITLE="Effective Date" TYPE="SYSTEM"></EffectiveDate>
<Math>
<Disbursement OVERRIDABLE="No" AUTOENTRY="Yes" METHOD=”[Balanced|Unbalanced]” APPROVAL=”[Yes|No]”> </Disbursement>
</Math>
</Transaction>
OR
<Disbursement CheckEFTInformation="Yes" DisbursementType="DisbursementIndicator" APPROVAL="Yes">
<WithholdingFields>TotalFederalWithholding,TotalStateWithholding</WithholdingFields>
<AddressDisplay TYPE="GUID">Activity:AddressGUID</AddressDisplay>
<DisbursementRole TYPE="GUID" DISBURSEMENTAMOUNT="FinalDisbursement">Activity:RoleGUID</DisbursementRole>
<DisbursementFields>
<DisbursementField>
<From>TotalFederalWithholding</From>
<To>TotalFederalWithholding</To>
<DataType>Money</DataType>
</DisbursementField>
<DisbursementField>
<From>TotalStateWithholding</From>
<To>TotalStateWithholding</To>
<DataType>Money</DataType>
</DisbursementField>
</DisbursementFields>
</Disbursement>
OR
<Disbursement APPROVALSTATUS="mvDisbursementApproval" APPROVAL="Yes" METHOD="Unbalanced" RECOVERABLE="No" DisbursementType="DisbursementMethod" TAXABLEAMOUNT="ZERO" CheckEFTInformation="No">
<DisbursementClient DISBURSEMENTAMOUNT="">MV or field name that holds the GUID</DisbursementClient>
<DisbursementFields>
<DisbursementField>
<From>fldFieldTest3</From>
<To>FieldTest3</To>
<DataType>Integer</DataType>
</DisbursementField>
</DisbursementFields>
</Disbursement>
