List of all merge fields

Below are listed the merge fields that can be used for variable documents.

To paste after having right-click on the desired merge field -> Field modifications -> in Field name

Dates can be formatted mm/dd/yyyy as follows: $formatUtils.formatDate (your merge field to format).

Regarding products/operations

The "user" table

Use the following fields for a variable document to be completed at registration:

  • The first name: $extractUtils.extract($user, 'first_name')
  • The last name: $extractUtils.extract($user, 'last_name')
  • The phone number: $extractUtils.extract($user, 'phone')
  • The email address: $extractUtils.extract($user, 'email')
  • Gender: $extractUtils.extract($user, 'gender')
  • Date of birth: $extractUtils.extract($user, 'birthday')
  • Place of birth: $extractUtils.extract($user, 'birth_place')
  • Country of birth: $extractUtils.extract($user, 'birth_country')
  • Nationality: $extractUtils.extract($user, 'nationality')
  • The type of investor: $extractUtils.extract($user, 'investor_type'), NATURAL for natural person and LEGAL for legal person

The "address" and "tax_address" tables

Regarding the address, if the tax address is the same as the correspondence address:
  • Number in the street (house number, ...): $extractUtils.extract($tax_address, 'number')
  • Type of road (street, avenue, ...): $extractUtils.extract($tax_address, 'street')
  • City: $extractUtils.extract($tax_address, 'city')
  • Postal code: $extractUtils.extract($tax_address, 'zip')
  • Country: $extractUtils.extract($tax_address, 'country')
If the tax address is different from the correspondence address, retrieve the tax address information from the $tax_address table (using the fields above).

To retrieve information on the correspondence address:

  • Number in the street (house number, ...): $extractUtils.extract($address, 'number')
  • Type of street (street, avenue, ...): $extractUtils.extract($address, 'street')
  • City: $extractUtils.extract($address, 'city')
  • Postal code: $extractUtils.extract($address, 'zip')
  • Country: $extractUtils.extract($address, 'country')

See also this document. 

The "lender" table

This is information relating to the investor.

Use the following fields for a variable document to be completed upon subscription:

  • The first name: $extractUtils.extract($lender, 'first_name')
  • The last name: $extractUtils.extract($lender, 'last_name')
  • The phone number: $extractUtils.extract($lender, 'phone')
  • The email address: $extractUtils.extract($lender, 'email')
  • Gender: $extractUtils.extract($lender, 'gender')
  • Date of birth: $extractUtils.extract($lender, 'birthday')
  • Place of birth: $extractUtils.extract($lender, 'birth_place')
  • Nationality: $extractUtils.extract($lender, 'nationality')
  • The type of investor: $extractUtils.extract($lender, 'investor_type'), NATURAL for natural person and LEGAL for legal person

The "transaction" table

Information about a transaction can be found in this table.

Also refer to this document. 

  • The fundraising id: $extractUtils.extract($transaction, 'fundraise_id')
  • The type of fundraising: $extractUtils.extract($transaction, 'fundraise_type')(FUNDRAISE_EQUITY, FUNDRAISE_REWARD, FUNDRAISE_LOAN)
  • The investor's id: $extractUtils.extract($transaction, 'issuer_id')
  • The transaction currency: $extractUtils.extract($transaction, 'currency')
  • The amount of the transaction: $extractUtils.extractDouble($transaction, 'amount')
  • Transaction fees (if any): $extractUtils.extractDouble($transaction, 'fees')
  • The status of the transaction (in progress, validated, ...): $extractUtils.extract($transaction, 'status')
  • Whether the transaction was passed online or not: $extractUtils.extractDouble($transaction, 'handled_offline')
  • The dismemberment duration: $extractUtils.extractDouble($transaction, 'dismemberment_duration')
  • The dismemberment rate: $extractUtils.extractDouble($transaction, 'dismemberment_rate')

The "custom" column contains information relating to the investor's bank account.

  • The name of the investor's bank: $extractUtils.extractDeepInObj($transaction, 'custom', 'bank_name', 0)
  • IBAN of the investor's account: $extractUtils.extractDeepInObj($transaction, 'custom', 'iban', 0)
  • The BIC of the investor's account: $extractUtils.extractDeepInObj($transaction, 'custom', 'bic', 0)
  • The type of bank account: $extractUtils.extractDeepInObj($transaction, 'custom', 'account_type', 0)
  • The name of the account holder: $extractUtils.extractDeepInObj($transaction, 'custom', 'holder_name', 0)

The " co_issuers" column contains information relating to the co-subscriber and / or to the usufructuary attached to the transaction if there is one.

With: foreach($co_issuer in $extractUtils.extractList($transaction, 'co_issuers'))

The fields available for a usufructuary:

The legal type (co-subscriber or usufructuary): $extractUtils.extract($co_issuer, 'legal_type')

The email of the co-subscriber / usufructuary: $extractUtils.extract($co_issuer, 'email')

The fields available for a co-subscriber:

  • The legal type (co-subscriber or usufructuary): $extractUtils.extract($co_issuer, 'legal_type')
  • The email of the co-subscriber / usufructuary: $extractUtils.extract($co_issuer, 'email')
  • The first name of the co-subscriber: $extractUtils.extract($co_issuer, 'first_name')
  • The co-subscriber's last name: $extractUtils.extract($co_issuer, 'last_name')
  • The gender of the co-subscriber: $extractUtils.extract($co_issuer, 'gender')
  • The date of birth of the co-subscriber: $extractUtils.extract($co_issuer, 'birthday')
  • The place of birth of the co-subscriber: $extractUtils.extract($co_issuer, 'birth_place')
  • The country of birth of the co-subscriber: $extractUtils.extract($co_issuer, 'birth_country')
  • The postal code of the co-subscriber's place of birth: $extractUtils.extract($co_issuer, 'birth_department')

The "partner_company" table

To be used to retrieve the registration information of a partner/distributor.

Refer to this document.

  • Company name: $extractUtils.extract($partner_company, 'company_business_name')
  • RCS city: $extractUtils.extract($partner_company, 'rcs_city')
  • Year of entry into RCS: $extractUtils.extract($partner_company, 'rcs_registration_year')
  • Regulatory status (CIF, PSI, SDG, ALPSI): $extractUtils.extract($partner_company, 'regulatory_status')
  • Legal status: $extractUtils.extract($partner_company, 'legal_status')
  • The ORIAS number (if it's CIF or ALPSI): $extractUtils.extract($partner_company, 'orias_number')
  • The REGAFI number (if PSI): $extractUtils.extract($partner_company, 'regafi_number')
  • The GECO number (if SDG): $extractUtils.extract($partner_company, 'geco_number')
  • The legal representative: $extractUtils.extract($partner_company, 'legal_representative')
  • The SIREN number: $extractUtils.extract($partner_company, 'siren')
  • The SIRET number: $extractUtils.extract($partner_company, 'siret')
  • The intra-community VAT number: $extractUtils.extract($partner_company, 'tva_intra')

The "usufructuary" table

Contains the information of the usufructuary when it is entered.

Refer to this document. 

  • The usufructuary's first name: $extractUtils.extract($usufructuary, 'first_name')
  • The last name of the usufructuary: $extractUtils.extract($usufructuary, 'last_name')
  • Usufructuary's phone number: $extractUtils.extract($usufructuary, 'phone')
  • The email address of the usufructuary: $extractUtils.extract($usufructuary, 'email')

For the address, refer to the address section above. Simply replace:

tax_address by usufructuary_tax_address

address by usufructuary_address

The "bank_account" and "bank_account_address" tables

The "bank_account_address" table contains information relating to the address of the investor's bank.

  • Number in the street (house number, ...): $extractUtils.extract($bank_account_address, 'number')
  • Type of street (street, avenue, ...): $extractUtils.extract($bank_account_address, 'street')
  • City: $extractUtils.extract($bank_account_address, 'city')
  • Postal code: $extractUtils.extract($bank_account_address, 'zip')
  • Country: $extractUtils.extract($bank_account_address, 'country')

The "bank_account" table contains all the information relating to the investor's bank account

  • The type of account: $extractUtils.extract($bank_account, 'account_type')
  • The name of the account holder: $extractUtils.extract($bank_account, 'holder_name')
  • The name of the bank: $extractUtils.extract($bank_account, 'bank_name')
  • The BIC: $extractUtils.extract($bank_account, 'bic')
  • IBAN: $extractUtils.extract($bank_account, 'iban')

Refer to this document.

Still need help? Contact Us Contact Us