Purpose: This article will list out how to gather the data that is listed in Portfolio View at the household level on the Summary tab. This will allow you to pull the same data per household for use in other applications. Please keep in mind that this is for the raw data and you will need to determine how to display it if that is your goal.
Simple Use Case: You would like to gather Portfolio Value VS Net Amount Invest data listed for Household in the Portfolio View to display in your own Client Portal.
Scopes and Output: Data payload for each of the 6 main tiles that are shown for the Household in Portfolio View on the Summary Tab.
Process Overview: Use the POST function for Reporting/Scope endpoint with the appropriate payload to get the data for the Portfolio View Summary tiles for the desired Household.
Asset Category Allocation
Asset Class Allocation
Activity Summary
Portfolio Value VS Net Amount Invested
Performance VS Benchmark
Portfolio Detail
Process Steps: POST to Reporting/Scope the Payload for the correlating tile
Asset Category Allocation
{
"entity": 5,
"entityIds": [54],
"asOfDate": "7/13/2021",
"calculations": [{
"id": "AllocationDetail",
"$type": "grouping",
"grouping": "90",
"contextChange": {
"reportCategoryId": 0
},
"filter": {
"$type": "filter-collection",
"filters": [{
"$type": "currency-not-equal",
"haystack": [null, 0],
"context": "Self",
"path": "Activity.Value",
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
}],
"method": "All"
},
"calculations": [{
"id": "Ticker",
"$type": "group-info",
"property": "ticker"
}, {
"id": "BeginningMarketValue",
"$type": "activity",
"contextChange": {
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningMarketValue"
},
"dateRange": {
"$type": "date-range",
"startDate": "1/1/2021",
"endDate": "7/13/2021"
}
}
}, {
"id": "EndingMarketValue",
"$type": "activity",
"contextChange": {
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
}
}, {
"id": "color",
"$type": "group-info",
"property": "color"
},
{
"id": "Product Type",
"$type": "group-info",
"entity": "Product Type",
"property": "Name"
}, {
"id": "AllocationDetail",
"$type": "grouping",
"grouping": "9",
"contextChange": {
"reportCategoryId": 0
},
"filter": {
"$type": "filter-collection",
"filters": [{
"$type": "currency-not-equal",
"haystack": [null, 0],
"context": "Self",
"path": "Activity.Value",
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
}],
"method": "All"
},
"calculations": [{
"id": "Ticker",
"$type": "group-info",
"property": "ticker"
}, {
"id": "BeginningMarketValue",
"$type": "activity",
"contextChange": {
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningMarketValue"
},
"dateRange": {
"$type": "date-range",
"startDate": "1/1/2021",
"endDate": "7/13/2021"
}
}
}, {
"id": "EndingMarketValue",
"$type": "activity",
"contextChange": {
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
}
}, {
"id": "color",
"$type": "group-info",
"property": "color"
},
{
"id": "Product Type",
"$type": "group-info",
"entity": "Product Type",
"property": "Name"
}
],
"orderBy": [{
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
},
{
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}
]
}
],
"orderBy": [{
"order": "Ascending",
"path": "Group.SortOrder",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}]
}],
"AccountManagementOverrides": []
}
Asset Class Allocation
{
"entity": 5,
"entityIds": [54],
"asOfDate": "7/13/2021",
"calculations": [{
"id": "AllocationOverTime-9",
"$type": "grouping",
"grouping": "81",
"filter": {
"$type": "filter-collection",
"filters": [{
"$type": "currency-not-equal",
"haystack": [null, 0],
"context": "Self",
"path": "Activity.Value",
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
}],
"method": "All"
},
"contextChange": {
"reportCategoryId": 0,
"quickDate": "inception",
"dateRange": {
"$type": "date-range",
"startDate": "1/1/2021",
"endDate": "7/13/2021"
}
},
"calculations": [{
"id": "EndingMarketValue",
"$type": "activity-series",
"contextChange": {
"activityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue"
}
},
"returnStyle": {
"context": "Self",
"frequency": "Automatic",
"basedOn": "Calendar",
"cumulative": true,
"breakBehavior": "AllowPartialPeriods"
}
},
{
"id": "color",
"$type": "group-info",
"property": "color"
}
],
"orderBy": [{
"order": "Ascending",
"path": "Group.SortOrder",
"globalsSynced": null
},
{
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}
]
}],
"AccountManagementOverrides": []
}
Activity Summary
{
"entity": 5,
"entityIds": [54],
"asOfDate": "1/31/2022",
"calculations": [{
"id": "BeginningBondAccrual",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningBondAccrual",
"inceptionValueMethod": "New Money"
},
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "BeginningMarketValue",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningMarketValue",
"IncludeAccruedInterest": false,
"inceptionValueMethod": "New Money"
},
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "EndingMarketValue",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue",
"IncludeAccruedInterest": false,
"inceptionValueMethod": "New Money"
}
}
}, {
"id": "EndingBondAccrual",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "EndingBondAccrual",
"inceptionValueMethod": "New Money"
}
}
}, {
"id": "Activity Summary",
"$type": "grouping",
"grouping": "ActivityOptions",
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
},
"contextChanges": [{
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "16"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "32"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "512"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "1024"
}],
"inceptionValueMethod": "New Money"
}
}],
"calculations": [{
"id": "Transaction Total",
"$type": "activity",
"inceptionValueMethod": "New Money"
}]
}],
"clientPerformanceInclude": "All accounts",
"AccountManagementOverrides": []
}
Portfolio Value VS Net Amount Invested
{
"entity": 5,
"entityIds": [54],
"asOfDate": "1/31/2022",
"calculations": [{
"id": "Net Amount Invested",
"$type": "activity-series",
"contextChange": {
"activityOption": {
"$type": "activity-type",
"inceptionValueMethod": "NewMoney",
"activityTypes": ["Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MergeIn", "MergeOut", "JournalIn", "JournalOut"]
},
"reportCategoryId": 0,
"quickDate": "inception",
"dateRange": null
},
"returnStyle": {
"context": "Self",
"frequency": "Daily",
"basedOn": "Calendar",
"cumulative": true,
"breakBehavior": "AllowPartialPeriods"
}
}, {
"id": "Ending Market Value",
"$type": "activity-series",
"contextChange": {
"activityOption": {
"$type": "market-value",
"valuationMethod": "EndingMarketValue",
"inceptionValueMethod": "NewMoney"
},
"reportCategoryId": 0,
"quickDate": "inception",
"dateRange": null
},
"returnStyle": {
"context": "Self",
"frequency": "Daily",
"basedOn": "Calendar",
"cumulative": true,
"breakBehavior": "AllowPartialPeriods"
}
}],
"clientPerformanceInclude": "All accounts",
"AccountManagementOverrides": []
}
Performance VS Benchmark
{
"entity": 5,
"entityIds": [54],
"asOfDate": "1/31/2022",
"calculations": [{
"id": "Performance vs Benchmark",
"$type": "grouping",
"grouping": "5",
"filter": {
"filters": []
},
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
},
"calculations": [{
"id": "group-performance",
"$type": "performance-series",
"returnStyle": {
"context": "Parent",
"frequency": "Automatic",
"basedOn": "Calendar",
"cumulative": true,
"breakBehavior": "AllowPartialPeriods"
}
}, {
"id": "color",
"$type": "group-info",
"property": "color"
}, {
"id": "benchmarks",
"$type": "grouping",
"grouping": "Comparison",
"calculations": [{
"id": "benchmark-performance",
"$type": "benchmark-performance-series",
"returnStyle": {
"context": "Parent",
"frequency": "Automatic",
"basedOn": "Calendar",
"cumulative": true,
"breakBehavior": "AllowPartialPeriods"
}
}, {
"id": "color",
"$type": "group-info",
"property": "color"
}]
}],
"orderBy": [{
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}]
}],
"clientPerformanceInclude": "All accounts",
"AccountManagementOverrides": []
}
Portfolio Detail
{
"entity": 5,
"entityIds": [54],
"asOfDate": "1/31/2022",
"calculations": [{
"id": "PortfolioDetailForGrouping",
"$type": "grouping",
"grouping": "90",
"calculations": [{
"$type": "activity",
"id": "Activity",
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "Group Info",
"$type": "group-info",
"property": "ticker"
}, {
"id": "Product Type",
"$type": "group-info",
"entity": "Product Type",
"property": "Name"
}, {
"id": "Cost Basis For Grouping",
"$type": "cost-basis",
"contextChange": {
"reportCategoryId": 0,
"costBasisOption": {
"$type": "cost-basis",
"realizationType": "Unrealized",
"includeAmortization": "false",
"includeDividends": "false",
"includeMoneyMarkets": "false",
"includeQualifiedAccounts": "false",
"includeUnknownCostBasis": "false"
},
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "period",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "qtd",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"quickDate": "QTD"
}
}, {
"id": "ytd",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"quickDate": "YTD"
}
}, {
"id": "Estimated Income For Grouping",
"$type": "estimated-annual-income",
"contextChange": {
"reportCategoryId": 0,
"incomeOption": {
"$type": "income",
"modifiedDurationMarketDate": null,
"annualDividendRateMethod": "IDSIIndicatedAnnualDividend",
"prorateIncomeToMaturity": "false",
"showZeroYieldForZeroCouponBonds": "false",
"dividendDate": "ExDate"
}
}
}, {
"id": "Current Yield For Grouping",
"$type": "current-yield",
"contextChange": {
"reportCategoryId": 0,
"incomeOption": {
"$type": "income",
"modifiedDurationMarketDate": null,
"annualDividendRateMethod": "IDSIIndicatedAnnualDividend",
"prorateIncomeToMaturity": "false",
"showZeroYieldForZeroCouponBonds": "false",
"dividendDate": "ExDate"
}
}
}, {
"id": "PortfolioDetailForGrouping",
"$type": "grouping",
"grouping": "9",
"calculations": [{
"$type": "activity",
"id": "Activity",
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "Group Info",
"$type": "group-info",
"property": "ticker"
}, {
"id": "Product Type",
"$type": "group-info",
"entity": "Product Type",
"property": "Name"
}, {
"id": "Cost Basis For Grouping",
"$type": "cost-basis",
"contextChange": {
"reportCategoryId": 0,
"costBasisOption": {
"$type": "cost-basis",
"realizationType": "Unrealized",
"includeAmortization": "false",
"includeDividends": "false",
"includeMoneyMarkets": "false",
"includeQualifiedAccounts": "false",
"includeUnknownCostBasis": "false"
},
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "period",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"dateRange": {
"$type": "date-range",
"startDate": "2022-01-01T06:00:00.000Z",
"endDate": "1/31/2022"
}
}
}, {
"id": "qtd",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"quickDate": "QTD"
}
}, {
"id": "ytd",
"$type": "performance",
"contextChange": {
"reportCategoryId": 0,
"quickDate": "YTD"
}
}, {
"id": "Estimated Income For Grouping",
"$type": "estimated-annual-income",
"contextChange": {
"reportCategoryId": 0,
"incomeOption": {
"$type": "income",
"modifiedDurationMarketDate": null,
"annualDividendRateMethod": "IDSIIndicatedAnnualDividend",
"prorateIncomeToMaturity": "false",
"showZeroYieldForZeroCouponBonds": "false",
"dividendDate": "ExDate"
}
}
}, {
"id": "Current Yield For Grouping",
"$type": "current-yield",
"contextChange": {
"reportCategoryId": 0,
"incomeOption": {
"$type": "income",
"modifiedDurationMarketDate": null,
"annualDividendRateMethod": "IDSIIndicatedAnnualDividend",
"prorateIncomeToMaturity": "false",
"showZeroYieldForZeroCouponBonds": "false",
"dividendDate": "ExDate"
}
}
}],
"orderBy": [{
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}]
}],
"orderBy": [{
"order": "Ascending",
"path": "Group.SortOrder",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.EntityId",
"globalsSynced": null
}, {
"order": "Ascending",
"path": "Group.Id",
"globalsSynced": null
}]
}],
"AccountManagementOverrides": [],
"clientPerformanceInclude": "All accounts"
}
Process Tips or Controls:
1. Household ID 54 is used in all examples.
2. Default settings are used for all examples. If you have edited your Portfolio View cards you may need to adjust the payload accordingly. For instance, Update “order” to “descending” if you have made such an edit to your card.