File format for importing corporate actions
This article describes the file format used for importing corporate actions to FA. The file format is a semicolon-separated text file (CSV). You can configure the file delimiter of you CSV files in the Importing preferences.
Download the CSV file template:
FAFormat_corporate_actions.csv
Updating corporate actions
You can update existing corporate actions in the same way that you create new ones. For each row in the CSV file, the corporate action importer checks, if there is already a matching corporate action in the system. If there is, it will update that corporate action instead of creating a new one. The matching logic is:
Security matches
AND type matches
AND date matches
The date to be used depends on the corporate action type:
Issues, splits and subscriptions use the date1 field
Capital returns, dividends, dividends as shares, and exchanges use the date2 field
Coupons: a matching date1 or date2 is enough to be considered a match
Updating existing corporate actions with corporate action runs (see below) is not currently supported.
FA Format for importing corporate actions
One row in the CSV file represents one corporate action. The table shows how to fill in the fields for each corporate action type. Required values are underlined.
Formats to use:
Dates: yyyy-MM-dd
Date and time: yyyy-MM-dd HH:mm:ss, for example, 2021-09-20 15:00:00.
Numbers: 123.45
Securities: security code in FA
Transaction types: transaction type codes in FA
# | Corporate action | Required | Asset management fee | Capital call | Capital return | Coupon payment | Dividend | Dividend as shares | Exchange | Issue | Split | Subscription |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | ca.type | Mandatory | ASSET_MANAGEMENT_FEE | CAPITAL_CALL | CAPITAL_RETURN | COUPON_PAYMENT | DIVIDEND | DIVIDEND_AS_SHARE | EXCHANGE | ISSUE | SPLIT | SUBSCRIPTION |
2 | ca.currency | Mandatory | Currency code | Currency code | Currency code | |||||||
3 | ca.date1 | Mandatory | Capital call ex-date | Annual meeting date | Next coupon date/ Next coupon record date | Annual meeting date | Annual meeting date | Issue date/ Issue record date | Split date | Subscription date/ Subscription record date | ||
4 | ca.date2 | Mandatory | Calculation date | Settlement date | Expiration date/ Expiration record date | Payment date | Dividend ex-date/ Dividend record date | Dividend ex-date/ Dividend record date | Exchange date/Exchange record date | |||
5 | ca.date3 | Mandatory | Settlement date | Settlement date | Settlement date | Settlement date | ||||||
6 | ca.memo | Mandatory | Memo | Memo | Memo | Memo | Memo | Memo | Memo | Memo | Memo | |
7 | ca.value1 | Mandatory | Interest rate | Unit price per share | ||||||||
8 | ca.value2 | Mandatory | feeFixedValue | Capital call % | Capital return per share | Coupon rate | Dividend per share | Dividend per share | Price/unit | |||
9 | ca.value3 | Mandatory | Unit price per share | Subscription price | ||||||||
10 | ca.text1 | Mandatory | Ratio | Split ratio | Ratio | |||||||
11 | ca.text2 | Mandatory | ||||||||||
12 | ca.text3 | Mandatory |
| |||||||||
13 | ca.security1 | Mandatory | Security code | Security code | Security code | Security code | Security code | Security code | Security code | Security code | Security code | |
14 | ca.security2 | Mandatory | Dividend security | Removed security | Issued security | Issued security | ||||||
15 | ca.transactionType | Mandatory | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type | Transaction type |
16 | ca.transactionType2 | Mandatory |
| Transaction type 2 | ||||||||
17 | ca.portfolioId | Optional | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID | Portfolio ID |
18 | ca.contactId | Optional | Contact ID | Contact ID | Contact ID | Contact ID | Contact ID | Contact ID | Contact ID | Contact ID | Contact ID | |
19 | ca.groupCode | Optional | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code | Portfolio group code |
20 | ca.generateTax | Optional | Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
| Apply taxes based on tax rules defined in FA:
|
21 | ca.run_time | Optional | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. | The date and time of corporate action run. If not given, or if the given date is in the past, then the corporate action is run immediately. |
22 | ca.RunBasedOn | Optional | Run based on. Enter one of the options:
| Run based on. Enter one of the options:
| Run based on. Enter one of the options:
| Run based on. Enter one of the options:
| Run based on. Enter one of the options:
| Run based on. Enter one of the options:
| Run based on. Enter one of the options:
|
Corporate action runs
You can enter settings for a corporate action run in the CSV file alongside the corporate action. Only one corporate action run can be imported per corporate action, and it must be imported at the same time as the corporate action itself.
To specify a corporate action run, add the following information in the CSV file:
Porfolios to run the corporate action against: enter Portfolio ID, Contact ID and/or a Portfolio group code in the ca.portfolioId, ca.contactId, ca.groupCode fields.
Tax application in the ca.generateTax field.
The time of corporate action run in the ca.run_time.