Suspense Elements

The <Suspense> and <MultiSuspense> elements control the ability to apply suspense to an activity.

A transaction can have a <Suspense> element or a <MultiSuspense> element, but not both.

If a <Suspense> element is present in the transaction, a Suspense tab will be available on the Activity Details screen with a Suspense field, and a suspense record will be written in AsSuspense when the activity processes.

If a <MultiSuspense> element is present in the transaction, a Suspense tab will be available on the Activity Details screen with a Suspense section, and multiple suspense records will be written in AsSuspense when the activity processes.

Note: In order to use GenerateSuspense with the Suspense element, the Suspense element should have AUTOENTRY set to No and REQUIRED set to No like: <Suspense REQUIRED="No" AUTOENTRY="No" VALUE="Sufficient">

Suspense Elements and Attributes

Element/Tag	Definition	Attribute	Element/Attribute Value and Description
<Suspense>	The start and end tags of the element. Cannot be used with <MultiSuspense> element.		Activity field containing the amount of the suspense that will be attached.
		OVERRIDABLE	Yes: Errors when received may be overridden by the user. No: Errors may not be overridden by the user. Ignore: Ignore errors
		VALUE	Sufficient: The value of the suspense record must be at least the value of the activity field. Equals: The value of the suspense record must equal the value of the activity field.
		REQUIRED	Yes: A suspense record must be selected from the Suspense tab of the Activity Detail screen. This is the default behavior that occurs if this attribute is omitted. No: No suspense record needs to be selected from the Suspense tab of the Activity Detail screen. If a suspense record is not selected, then no suspense record will be attached to the activity.
		AUTOENTRY	Yes No

 

MultiSuspense Elements and Attributes

Element/Tag	Definition	Attribute	Element/Attribute Value and Description
<MultiSuspense>	The start and end tags of the element.		This element is used so multiple suspense items can be attached to the Activity. Cannot be used with <Suspense> element Defines the amount field to apply to suspense. Activity field containing the total amount of suspense that will be attached.
		FIELD	numeric or currency data type Transaction field
		AUTOENTRY	Yes No

XML Schema - MultiSuspense

<Transaction>

…

<MultiSuspense>[FieldName]</MultiSuspense>

…

<Transaction>

XML Example - MultiSuspense

<Transaction>

…

MultiSuspense>PremiumAmount</MultiSuspense>

<Fields>

<Field>

<Name>PremiumAmount</Name>

<Display>Premium Amount</Display>

<DataType>Decimal</DataType>

</Field>

</Fields>

…

</Transaction>

 

Example Suspense Activity Detail Screen