Portfolios
flAggregatePortfolio
Get an aggregation view of a portfolio's holdings
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio you wish to aggregate | Yes | String | "US-Corporate-Bond" |
parameters | Populated table from flAggregationParameters_Template | Yes | Cell reference | See template |
flAggregatePortfolioGroup
Aggregate the holdings across all portfolios in a group
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio group | Yes | String | "FinbourneExamples" |
code | Unique identifier of the portfolio group you wish to aggregate | Yes | String | "US-Corporate-Bond" |
parameters | Populated table from flAggregationParameters_Template | Yes | Cell reference | See template |
flHoldingsAdjust
Create transactions to adjust holdings for a portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
effective_date | Specify EffectiveDate | Yes | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
holdings | Populated table from flHoldings_Template | Yes | Cell reference | See template |
flHoldingsGet
Get holdings for a portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
effective_date | Specify EffectiveDate | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
as_at_date | Specify AsAt date | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
filter | Filter results based on filering expression | No | filtering expression | id.code eq 'test-code' |
holding_property_keys | List of property keys to paint onto holdings | No | Cell reference | A set of cells containing values in the format "domain/scope/code" |
columns | Select your result columns | No | Comma delimited list of strings | "Column1,Column2" |
flPortfoliosAdd
Add one or more portfolios
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope to which you wish to add the portfolio | Yes | String | "FinbourneExamples" |
portfolios | Populated table from flPortfoliosAdd_Template | Yes | Cell reference | See template |
flPortfoliosAddDerived
Add one or more derived portfolios
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope to which you wish to add the derived portfolio | Yes | String | "FinbourneExamples" |
portfolios | Populated table from flPortfoliosAddDerived_Template | Yes | Cell reference | See template |
flPortfoliosDelete
Delete one or more portfolios from their inception date
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope from which you wish to delete portfolios | Yes | String | "FinbourneExamples" |
portfolio_ids | Unique identifiers of the portfolios you wish to delete | Yes | Cell reference or comma delimited list of strings | See template |
flPortfoliosGet
Get the details of a specific portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
effective_date | Specify EffectiveDate | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
as_at_date | Specify AsAt date | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
columns | Select your result columns | No | Comma delimited list of strings | "Column1,Column2" |
flPortfoliosList
Get a list of all portfolios in a scope
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio | Yes | String | "FinbourneExamples" |
effective_date | Specify EffectiveDate | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
as_at_date | Specify AsAt date | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
limit | Limit the number of returned results to this many | No | Whole number | 50 |
filter | Filter results based on filering expression | No | filtering expression | id.code eq 'test-code' |
porfolio property keys | List of property keys to paint onto portfolios | No | Cell reference | A set of cells containing values in the format "domain/scope/code" |
columns | Select your result columns | No | Comma delimited list of strings | "Column1,Column2" |
flTransactionsAdd
Add transactions to a portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio to which you wish to add transactions | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
transactions | Populated table from flTransactionsAdd_Template | Yes | Cell reference | See template |
flTransactionsDelete
Delete one or more transactions from a portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio from which you wish to delete transactions | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
transaction_ids | Unique identifiers of the transactions you wish to delete | Yes | String or comma delimited list of strings | "UST100011" |
flTransactionsGet
Get transactions for a portfolio
Parameters
Name | Description | Required Field | Format | Example |
---|---|---|---|---|
scope | Scope of the portfolio from which you wish to get transactions | Yes | String | "FinbourneExamples" |
portfolio_code | Unique identifier of the portfolio | Yes | String | "US-Corporate-Bond" |
start_date | Specify date lower bound (date type based on query_mode) | Yes | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
end_date | Specify date upper bound (date type based on query_mode) | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
query_mode | The query mode to use - one of ( TradeDate | SettleDate ) with a default of TradeDate | No | String | "SettleDate" |
show_cancelled | Whether to show cancelled transactions with a default of FALSE | No | Boolean (TRUE |FALSE ) | TRUE |
as_at_date | Specify AsAt date | No | YYYY-MM-DD T HH:MM:SS.ms | 2019-04-10 T 13:30:45.55 |
filter | Filter results based on filering expression | No | filtering expression | id.code eq 'test-code' |
transaction_property_keys | List of property keys to paint onto transactions | No | Cell reference | A set of cells containing values in the format "domain/scope/code" |
columns | Select your result columns | No | Comma delimited list of strings | "Column1,Column2" |