You are here: Transaction Rules > Transaction Elements > Disbursement Element

Disbursement Element

Description

The Disbursement element triggers the creation of the AsDisbursementRecord.

Disbursement Element/Attribute Table
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 all pending disbursements will be displayed in the Disbursement Approval screen No: indicates that Disbursement Approval will not be used
		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.	Element Value	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: Added for Client level transactions. Cannot coexist with DisbursementRole. This is 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.
<DisbursementClient>		DISBURSEMENTAMOUNT	Final Disbursement. Math variable or field defining the disbursement amount.
<DisbursementFields>	Required:
<DisbursementField>	Required:
<From>	Required Sets the From value of the Disbursement field.
<To>	Required Sets the To value of the Disbursement field.
<DataType>	Required Sets the data type value of the Disbursement field.		Allowable values: Check / Combo / Date / Decimal / Integer / Money / Percent / Radio / 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>

<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>

Disbursement Element

Description

Yes or No

Optional element:

Optional element:

Required:

Required:

Required

Required

Required

Allowable values:

Check / Combo / Date / Decimal / Integer / Money / Percent / Radio / Text / TextArea

XML Example

OR