PrimaryBeneficiaryEntity

Application > Accounts > Account > IRABeneficiaries > PrimaryBeneficiaryEntity

  • Specify entity beneficiaries for a retirement account.

  • Fully Disclosed Client (Retirement)

  • Advisor Client (Retirement)

  • User must specify at least one beneficiary (maximum of six)

  • Error will be thrown if PrimaryBeneficiary and PrimaryBeneficiaryEntity are provided.

  • XSD

    Copy 
    <xsd:element name="PrimaryBeneficiaryEntity" use="Required" minOccurs="0" maxOccurs="6" />
    <xsd:attribute name="same_mail_address" type="Boolean" use="Required" />
     <xsd:attribute name="external_id" type="String" use="Required" />
    <xsd:sequence>
    <xsd:element name="EntityType" type="EntityType" use="Required" />
    <xsd:element name="Name" use="Required" />
     <xsd:attribute name="name" type="String" use="Required" />
    <xsd:element name="ExecutionDate" type="YYYY-MM-DD" use="Required" />
    <xsd:element name="Location" use="Required for Trust and Charity Beneficiaries"/>
     <xsd:attribute name="country" type="country" use="Required" />
     <xsd:attribute name="state" type="state" use="Required" />
     <xsd:attribute name="city" type="String" use="Required" />
     <xsd:attribute name="street_1" type="String" use="Required" />
     <xsd:attribute name="postal_code" type="String" use="Required" />
    <xsd:element name="Ownership" use="Required" />
     <xsd:attribute name="percentage" type="Non-Negative Integer Value" use="Required" />
    <xsd:element name="ArticleOfWill" use="Required for Entity Trust Beneficiaries" type="String" minOccurs="0" maxOccurs="1" />
    <xsd:element name="Executor" use="Required for Entity Trust" />
    <xsd:element name="external_id" type="String" />
    <xsd:element name="Name" use="Required for Entity Trust Beneficiaries" minOccurs="0" maxOccurs="1" />
     <xsd:attribute name="first" type="String" use="Required" />
     <xsd:attribute name="last" type="String" use="Required" />
    </xsd:sequence>
     

    Parameters

    Name

    Type

    Description

    same_mail_address

    true

    false

     

    Indicate if the mailing address of the beneficiary is different from the residential address. 

    EntityType

    Trust

    Entity beneficiary type.

    name

    String; Max characters =50

    Name of the beneficiary.

    ExecutionDate

    YYYY-MM-DD

    Date established.

    country

    3 Digit ISO Code

    Country which the beneficiary resides.

    state

    3166-2 ISO Code

    State which the beneficiary resides.

    city

    String; Max Characters = 100

    City which the beneficiary resides.

    street_1

    String; Max Characters = 200

    Street which the beneficiary resides.

    postal_code

    String; Max Characters = 10

     

    percentage

    Non-Negative Integer Value

    Total percentage must = 100

    ArticleOfWill

    String; Max characters =100

    This is requesting the location of the article of will in the Trust document. If this is unknown, we will accept NA.

    first

    String; Max Characters = 50

    First name of the executor of the trust..

    last

    String; Max Characters = 50

    Last name of the executor of the trust..
  • Copy 
    <PrimaryBeneficiaryEntity external_id="TRUSTBENEPB1">
       <EntityType>Trust</EntityType> 
       <Name name="Test Truster"/>
       <Location city="Stamford" country="USA" postal_code="06901" state="CT" street_1="355 Atlantic"/>
       <Ownership percentage="100"/>
       <ExecutionDate>1993-04-30</ExecutionDate>
       <ArticleOfWill>Article of Will</ArticleOfWill>
       <Executor external_id="TRUSTBENEEX1">
           <Name first="Tester" last="Orr" salutation="Mr."/>
       </Executor>
    </PrimaryBeneficiaryEntity>

  • XSD

    Copy 
    <xsd:element name="PrimaryBeneficiaryEntity" use="Required" minOccurs="0" maxOccurs="6" />
    <xsd:attribute name="external_id" type="String" use="Required" />
    <xsd:sequence>
    <xsd:element name="EntityType" type="EntityType" use="Required" />
    <xsd:element name="Name" use="Required" />
     <xsd:attribute name="name" type="String" use="Required" />
    <xsd:element name="ExecutionDate" type="YYYY-MM-DD" use="Required" />
    <xsd:element name="Location" use="Required for Trust and Charity Beneficiaries"/>
     <xsd:attribute name="country" type="country" use="Required" />
     <xsd:attribute name="state" type="state" use="Required" />
     <xsd:attribute name="city" type="String" use="Required" />
     <xsd:attribute name="street_1" type="String" use="Required" />
     <xsd:attribute name="postal_code" type="String" use="Required" />
    <xsd:element name="Ownership" use="Required" />
     <xsd:attribute name="percentage" type="Non-Negative Integer Value" use="Required" />

    Parameters

    Name

    Type

    Description

    same_mail_address

    true

    false

     

    Indicate if the mailing address of the beneficiary is different from the residential address. 

    EntityType

    Charity

    Entity beneficiary type.

    name

    String; Max characters =50

    Name of the beneficiary.

    ExecutionDate

    YYYY-MM-DD

    Date established.

    country

    3 Digit ISO Code

    Country which the beneficiary resides.

    state

    3166-2 ISO Code

    State which the beneficiary resides.

    city

    String; Max Characters = 100

    City which the beneficiary resides.

    street_1

    String; Max Characters = 200

    Street which the beneficiary resides.

    postal_code

    String; Max Characters = 10

     

    percentage

    Non-Negative Integer Value

    Total percentage must = 100
  • Copy 
    <PrimaryBeneficiaryEntity external_id="CharityBenePB1">
       <EntityType>Charity</EntityType> 
       <Name name="Test Truster"/>
       <Location city="Stamford" country="USA" postal_code="06901" state="CT" street_1="355 Atlantic"/>
       <Ownership percentage="100"/>
       <ExecutionDate>1993-04-30</ExecutionDate>
    </PrimaryBeneficiaryEntity>

  • XSD

    Copy 
    <xsd:element name="PrimaryBeneficiaryEntity" use="Required" minOccurs="0" maxOccurs="6" />
    <xsd:attribute name="external_id" type="String" use="Required" />
    <xsd:sequence>
    <xsd:element name="EntityType" type="EntityType" use="Required" />
    <xsd:element name="Name" use="Required" />
     <xsd:attribute name="name" type="String" use="Required" />
    <xsd:element name="ExecutionDate" type="YYYY-MM-DD" use="Required" />
    <xsd:element name="Ownership" use="Required" />
     <xsd:attribute name="percentage" type="Non-Negative Integer Value" use="Required" />

    Parameters

    Name

    Type

    Description

    same_mail_address

    true

    false

     

    Indicate if the mailing address of the beneficiary is different from the residential address. 

    EntityType

    Estate

    Entity beneficiary type.

    name

    String; Max characters =50

    Name of the beneficiary.

    ExecutionDate

    YYYY-MM-DD

    Date established.

    percentage

    Non-Negative Integer Value

    Total percentage must = 100
  • Copy 
    <PrimaryBeneficiaryEntity external_id="EstateBENEPB1">
       <EntityType>Estate</EntityType> 
        <Name name="Test Estate"/>
        <Ownership percentage="100"/>
       <ExecutionDate>1993-04-30</ExecutionDate>
    </PrimaryBeneficiaryEntity>