Roles
objectRole type
Allowed values:38360-1-2-3-4-5-6-7-8-9-10-11-12-13-14-15-16-17-18-19-20-21-22-23-24-25-26-50-51-60-70-71-72-80-81-82-83-84-85-86-87-88-89-90-91-999
Example:0
Role Option associated with the respective Role Type
Allowed values:-6-5-101234567
Allowed values:YN
Allowed values:COINOTTRUG
First name of the party role
Example:firstName when name type is Natural/Individual
Moddle name of the party role
Example:B
Last name of the party role
Example:Doe
Prefix
Example:Dr
Suffix
Example:Sr
Date of birth of party role. Applicable in case of Individual. (with pattern “yyyy-mm-dd”). Regex Expression ^\d{4}-((0\d)|(1[012]))-(([012]\d)|3[01])$.
Example:2023-12-19
Any one of the possible value for the gender.
Allowed values:MFO
9 digit Social Security number
Match pattern:\d{9}
>= 9 characters<= 9 characters
Example:123456789
CRD number for the party role, used as Agent Identifier.
Example:when party is an agent and one of the agent specific identifier in MCS is mandatory
NPN number for the agent, used as Agent Identifier.
Example:when party is an agent and one of the agent specific identifier in MCS is mandatory
Distributor assigned Id for an agent, used as Agent Identifier.
Example:when party is an agent and one of the agent specific identifier in MCS is mandatory
Internal identifier assigned to the agent by carrier, used as Agent Identifier.
Example:when party is an agent and one of the agent specific identifier in MCS is mandatory
Unique number assigned by the MCS system, used as Agent Identifier.
Example:when party is an agent and one of the agent specific identifier in MCS is mandatory
Show Child Parameters
Relationship code
Allowed values:-99912345678910111213141516171819202122232425100101102103104105106
Show Child Parameters
Type of trust & TrustType is required when the role is a trust
Allowed values:12
Example:1
eDelivery is required/not for the role
Allowed values:YN
Email for associated party
Example:email when eDelivery is 'Y'
Show Child Parameters
Date of Death. (with pattern “yyyy-mm-dd”). Regex Expression ^\d{4}-((0\d)|(1[012]))-(([012]\d)|3[01])$.
SpecialPrograms
objectspecialProgramType selected
Allowed values:01234568910
Example:0
Effective date of Special program
Frequency of special program
Allowed values:AMQSW24T910
amountType of special program
Allowed values:-101234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
Stores the allocated percent to the specific fund
Distribution Code
Allowed values:123456789ADEFGHJLMPRSAAABAC2G4G4HADAEAFAGAHAKTNZAZBZCZDZEZFZGZHZIZJZKZLZMZNZOZPZQZRZSZTZVZU6AALAMW
Specifies how many times special program will be run
Example:5
Show Child Parameters
Show Child Parameters
Allowed values:0123456789
Derived by Zinnia
Derived by Zinnia
ExchangeReplaces
objectFor any payment that is a replacement/exchange
Name of the Company
Company Tax ID
Match pattern:\d{9}
Example:123456789
Type of the company
Allowed values:COINOTTRUG
Company email address
Show Child Parameters
This field stores the requested amount.
Agent submit date
This field stores the source policy number
This field stores the plan type which was used on previous policy - Refer qualificationflag for types
This field stores determines whether to apply Rate Lock or not
Agent submit date
If Rate Lock is not followed and needs override
This field gets enable when advance commission is true.
Allowed values:YN
This is a flag to selected when the advance commision to agent is applicable.
Allowed values:YN
Withholdings
objectThe amount to be withheld if withholding is selected
Example:0
Qualifies the withholding amount. Either as dollars or a percentage
Allowed values:DP
This will be used to indicate the type of withholding information for this instance of the Withholding Amount. This is in reference to the IRS W-4P and W-4R tax withholding forms
Allowed values:ABCDEFGH
Defines the withholding authority for which is being withheld
Allowed values:StateFederal
Payments
objectUnique Id to tag to respective payment records
Payment methods
Allowed values:CWE
Money Source
Allowed values:-9991234567891011171819202122232425
Gross Amount for the individual payment
Example:238500
Net Amount for the individual payment
Show Child Parameters
Funds to be considered for Future Allocations or not
Allowed values:YN
Allowed values:0123456789
waivePremium
Unique number assigned to the application by broker
This is a flag to checked and unchecked depending upon the Cost basis.
For any payment that is a replacement/exchange