Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Create a Folio
This request creates a folio for a brokerage account.
The folio you create will be identified by the client's brokerage account number followed by a two digit number that is assigned sequentially starting with 03 and cannot be changed. Once a folio is created it cannot be deleted, only closed after all positions have been removed from it.
Trades may only be placed in a folio. See Create a Folio Order for supported trades.
A folio is a collection of securities (i.e., stocks, mutual funds and ETFs) that can be bought, sold, rebalanced, or customized in a single transaction. A folio may be viewed as something similar to a sub-account, for which we will track activities and performance. The weights of the securities that make up a folio will add up to 100% of the folio, and there may be as few as 1 security in a folio. Investors generally use folios to segregate investing goals and/or strategies within an account (e.g., college, car, house, vacation, high risk, low risk, core, domestic small cap, large cap, etc.), and advisors also use folios to support multiple model managers running separate strategies in their client accounts.
Every new account will automatically have two folios upon creation of the account, Cash (folio 01) and Non-Folio Holdings (folio 02). Trades may not be placed in the Cash folio. Only direct trades for whole shares (market, limit, stop, and stop-limit) may be placed in the Non-Folio Holdings folio (i.e., no window trades, no fractional share or dollar-based order in folio 02).
The Non-Folio Holdings folio is generally used for receiving securities transferred in from other investments firms, and for holding securities which cannot be traded in our trading windows, such as unlisted and or unregistered securities that we support (e.g., private securities) and for securities that are only tradable in specified lot sizes, such as HOLDRS and certain preferred stocks. See a list of tradable securities, and select "Direct Trade Only" to view the securities unable to be traded in a Window Trade.
Request URL
| Syntax | POST /restapi/accounts/{accountnumber}/folios |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios |
Request Data Fields
| Field | Required? | Description |
|---|---|---|
| folioName | Yes | The folio name. The maximum length of folioName is 50 characters. |
| accountNumber | Yes | The brokerage account number where the folio is created. |
| dividendReinvest | Yes | An indicator whether dividend of $1 or more will be reinvested in the securities that paid the dividend. “true” or “false”. |
| benchmark | No | The security, index, or composite to be used by default when comparing performance. This should be a ticker. |
| prepackagedFolioId | No | The Ready-to-Go folio’s foliooid to associate this folio with. See RTG. |
| dividendPayToAccount | No | An indicator of whether dividend should be paid to account. Default value is “true”. “true” or “false”. |
Request Example
POST /restapi/accounts/RA1234ABCD/folios HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost:6880
Content-Length: 189
Content-Type: application/json
{
"folioName":"My new folio",
"accountNumber":"RA1234ABCD",
"dividendReinvest":true,
"dividendPayToAccount":true,
"benchmark":"^DJI",
"prepackagedFolioId":null
}
Response Example
HTTP/1.1 201 Created
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03
Content-Type: text/html; charset=iso-8859-1
Content-Length: 0
Date: Wed, 06 Aug 2014 18:19:41 GMT
Change Log
10/08/2015
- New field: “dividendPayToAccount”