Skip to main content

Portfolios

flAggregatePortfolio

Get an aggregation view of a portfolio's holdings

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolioYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolio you wish to aggregateYesString"US-Corporate-Bond"
parametersPopulated table from flAggregationParameters_TemplateYesCell referenceSee template

flAggregatePortfolioGroup

Aggregate the holdings across all portfolios in a group

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolio groupYesString"FinbourneExamples"
codeUnique identifier of the portfolio group you wish to aggregateYesString"US-Corporate-Bond"
parametersPopulated table from flAggregationParameters_TemplateYesCell referenceSee template

flHoldingsAdjust

Create transactions to adjust holdings for a portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolioYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
effective_dateSpecify EffectiveDateYesYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
holdingsPopulated table from flHoldings_TemplateYesCell referenceSee template

flHoldingsGet

Get holdings for a portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolioYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
effective_dateSpecify EffectiveDateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
as_at_dateSpecify AsAt dateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
filterFilter results based on filering expressionNofiltering expressionid.code eq 'test-code'
holding_property_keysList of property keys to paint onto holdingsNoCell referenceA set of cells containing values in the format "domain/scope/code"
columnsSelect your result columnsNoComma delimited list of strings"Column1,Column2"

flPortfoliosAdd

Add one or more portfolios

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope to which you wish to add the portfolioYesString"FinbourneExamples"
portfoliosPopulated table from flPortfoliosAdd_TemplateYesCell referenceSee template

flPortfoliosAddDerived

Add one or more derived portfolios

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope to which you wish to add the derived portfolioYesString"FinbourneExamples"
portfoliosPopulated table from flPortfoliosAddDerived_TemplateYesCell referenceSee template

flPortfoliosDelete

Delete one or more portfolios from their inception date

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope from which you wish to delete portfoliosYesString"FinbourneExamples"
portfolio_idsUnique identifiers of the portfolios you wish to deleteYesCell reference or comma delimited list of stringsSee template

flPortfoliosGet

Get the details of a specific portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolioYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
effective_dateSpecify EffectiveDateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
as_at_dateSpecify AsAt dateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
columnsSelect your result columnsNoComma delimited list of strings"Column1,Column2"

flPortfoliosList

Get a list of all portfolios in a scope

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolioYesString"FinbourneExamples"
effective_dateSpecify EffectiveDateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
as_at_dateSpecify AsAt dateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
limitLimit the number of returned results to this manyNoWhole number50
filterFilter results based on filering expressionNofiltering expressionid.code eq 'test-code'
porfolio property keysList of property keys to paint onto portfoliosNoCell referenceA set of cells containing values in the format "domain/scope/code"
columnsSelect your result columnsNoComma delimited list of strings"Column1,Column2"

flTransactionsAdd

Add transactions to a portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolio to which you wish to add transactionsYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
transactionsPopulated table from flTransactionsAdd_TemplateYesCell referenceSee template

flTransactionsDelete

Delete one or more transactions from a portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolio from which you wish to delete transactionsYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
transaction_idsUnique identifiers of the transactions you wish to deleteYesString or comma delimited list of strings"UST100011"

flTransactionsGet

Get transactions for a portfolio

Parameters

NameDescriptionRequired FieldFormatExample
scopeScope of the portfolio from which you wish to get transactionsYesString"FinbourneExamples"
portfolio_codeUnique identifier of the portfolioYesString"US-Corporate-Bond"
start_dateSpecify date lower bound (date type based on query_mode)YesYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
end_dateSpecify date upper bound (date type based on query_mode)NoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
query_modeThe query mode to use - one of ( TradeDate | SettleDate ) with a default of TradeDateNoString"SettleDate"
show_cancelledWhether to show cancelled transactions with a default of FALSENoBoolean (TRUE|FALSE)TRUE
as_at_dateSpecify AsAt dateNoYYYY-MM-DD T HH:MM:SS.ms2019-04-10 T 13:30:45.55
filterFilter results based on filering expressionNofiltering expressionid.code eq 'test-code'
transaction_property_keysList of property keys to paint onto transactionsNoCell referenceA set of cells containing values in the format "domain/scope/code"
columnsSelect your result columnsNoComma delimited list of strings"Column1,Column2"