Add an External Party Recipient to the collection.

This function is used instead of AddClient as this function includes the External Party information needed to resolve the message.

Syntax

finMessageRecipients.AddExternalParty(externalPartyId, description, clientId, clientName, value, [comment], [include], [emailBCC], [emailCC], [fee], [feeAccountPk], [feeElementPk], [feeReference], [feeNotes], [workflowPk], [workflowItemPk])

Parameters

NameTypeOptionalByRefDescription
externalPartyId String The External Party Id.
description String The External Party Description.
clientId String The Client Id of the External Party.
clientName String The Client Name.
value String The Value, e.g. an SMS-capable Phone Number or an Email Address.
comment String Optional A Comment.
include Boolean Optional Indicates whether to include this Recipient when publishing. If omitted, a value of True is assumed.
emailBCC String Optional A list of Blind Carbon Copy Email Addresses.
emailCC String Optional A list of Carbon Copy Email Addresses.
fee Decimal Optional The Fee to be charged. If omitted, a value of 0 is assumed.
feeAccountPk Integer Optional The Primary Key of the Account to charge. If omitted, a value of 0 is assumed.
feeElementPk Integer Optional The Primary Key of the Fee Element. If omitted, a value of 0 is assumed.
feeReference String Optional The Fee Reference.
feeNotes String Optional The Fee Notes.
workflowPk Integer Optional If omitted, a value of 0 is assumed.
workflowItemPk Integer Optional If omitted, a value of 0 is assumed.

Return Value

finMessageRecipient

<param name="fee"> The Fee to be charged. </param> <param name="feeAccountPk"> The Primary Key of the Account to charge. </param> <param name="feeElementPk"> The Primary Key of the Fee Element. </param> <param name="feeNotes"> The Fee Notes. </param> <param name="feeReference"> The Fee Reference. </param> A finMessageRecipient value.

Member of:
finMessageRecipients
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0