Function DisplayDepositHolder

Function DisplayDepositHolder

Outputs the deposit holder scheme and scheme type.

DisplayDepositHolder([HOLDER],[TYPE],[SEPARATOR])

Parameters

#TypePassingDefaultNameDescription/Comments
1integeroptionaln/aHOLDERThe deposit holder
2integeroptionaln/aTYPEThe deposit holder type
3string/charoptional-SEPARATORThe separator to add if both values are provided

Returns

The deposit holder scheme and scheme type name.


Examples

Example of outputting the deposit holder AND type from a tenancy.

{{DisplayDepositHolder(ALIAS.DEPOSITTO,ALIAS.DEPOSITTP)}}

Will return "Agent - Custodial", "DPS - Insured" etc..


Example of outputting the deposit holder only.

{{DisplayDepositHolder(ALIAS.DEPOSITTO)}}

Will return "Agent", "Landlord", "DPS" etc..


Example of outputting the deposit holder type only.

{{DisplayDepositHolder(null,ALIAS.DEPOSITTP)}}

Will return "Custodial" or "Insured"