Purpose: This is a sample of a simple request for a basic Activity Summary. Please be sure to reference the exhaustive Reporting/Scope document for detailed instructions on how to gather additional data or to see what Activity Types are available. Reporting Scope – Performance/Allocation/Activity Summary – Exhaustive
Simple Use Case: If you would like to get an activity summary for a Household, Registration, or Account.
Scope and Outputs: This example is for a Household level Activity Summary that includes Contributions, Distributions, Advisory Fees Paid, and Dividends and Interest. The Market Value Increase/Decrease section of the activity summary is something that you would calculate by totaling the Beginning Market Value, with all the activity types you selected, and subtracting that from the Ending Market Value.
Process Overview: The below is a POST example to the /Reporting/Scope endpoint along with the return and a breakdown of how you would then calculate the Market Value Increase/Decrease.
Process steps:
1. POST request
2. Review Response
3. Calculate Market Value Increase/Decrease (optional)
- POST payload with requested activity. POST: /Reporting/Scope
{
"entity": 5,
"entityIds": [1031],
"asOfDate": "8/25/2022",
"calculations": [{
"id": "BeginningBondAccrual",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningBondAccrual",
"inceptionValueMethod": "New Money"
},
"dateRange": {
"$type": "date-range",
"startDate": "1/1/2022",
"endDate": "8/25/2022"
}
}
}, {
"id": "BeginningMarketValue",
"$type": "activity",
"contextChange": {
"reportCategoryId": 0,
"ActivityOption": {
"$type": "market-value",
"valuationMethod": "BeginningMarketValue",
"IncludeAccruedInterest": false,
"inceptionValueMethod": "New Money"
},
"dateRange": {
"$type": "date-range",
"startDate": "1/1/2022",
"endDate": "8/25/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": "1/1/2022",
"endDate": "8/25/2022"
}
},
"contextChanges": [{
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "Contributions"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "Distributions"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "Advisory Fees Paid"
}],
"inceptionValueMethod": "New Money"
}
}, {
"activityOption": {
"$type": "activity",
"details": [{
"$type": "activity",
"isManaged": true,
"flipSign": false,
"activityType": "Net Dividends/Interest/Gains Withdrawn"
}],
"inceptionValueMethod": "New Money"
}
}],
"calculations": [{
"id": "Transaction Total",
"$type": "activity",
"inceptionValueMethod": "New Money"
}]
}],
"clientPerformanceInclude": "All accounts",
"AccountManagementOverrides": []
}
2. Review Response with requested activity:
{
"sessionId": "298c3ca1-5e61-40a9-8b0b-c66235617f95",
"asOfDate": "2022-08-25",
"dataLastUpdated": "2022-08-26T09:16:34.6164322-05:00",
"calculations": [
{
"$type": "calculated-activity",
"id": "BeginningBondAccrual",
"value": 0,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "$0.00",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
},
{
"$type": "calculated-activity",
"id": "BeginningMarketValue",
"units": 189289.154,
"value": 1335099.46,
"formattedUnits": "189,289.15",
"formattedPrice": null,
"formattedValue": "$1,335,099.46",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
},
{
"$type": "calculated-activity",
"id": "EndingMarketValue",
"units": 178602.412,
"value": 1399894.61,
"formattedUnits": "178,602.41",
"formattedPrice": null,
"formattedValue": "$1,399,894.61",
"startDate": "2022-08-25",
"endDate": "2022-08-25"
},
{
"$type": "calculated-activity",
"id": "EndingBondAccrual",
"value": 0,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "$0.00",
"startDate": "2022-08-25",
"endDate": "2022-08-25"
},
{
"$type": "calculated-list",
"id": "Activity Summary",
"calculations": [
{
"$type": "calculated-context-change",
"contextChange": {
"activityOption": {
"$type": "activity",
"name": null,
"includeUnmanagedJournals": false,
"inceptionValueMethod": "New Money",
"details": [
{
"$type": "activity",
"activityType": "Contributions",
"isManaged": true,
"flipSign": false
}
]
},
"globalsSynced": null
},
"calculations": [
{
"$type": "calculated-activity",
"id": "Transaction Total",
"value": 150000,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "$150,000.00",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
}
]
},
{
"$type": "calculated-context-change",
"contextChange": {
"activityOption": {
"$type": "activity",
"name": null,
"includeUnmanagedJournals": false,
"inceptionValueMethod": "New Money",
"details": [
{
"$type": "activity",
"activityType": "Distributions",
"isManaged": true,
"flipSign": false
}
]
},
"globalsSynced": null
},
"calculations": [
{
"$type": "calculated-activity",
"id": "Transaction Total",
"value": -932.95,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "-$932.95",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
}
]
},
{
"$type": "calculated-context-change",
"contextChange": {
"activityOption": {
"$type": "activity",
"name": null,
"includeUnmanagedJournals": false,
"inceptionValueMethod": "New Money",
"details": [
{
"$type": "activity",
"activityType": "Advisory Fees Paid",
"isManaged": true,
"flipSign": false
}
]
},
"globalsSynced": null
},
"calculations": [
{
"$type": "calculated-activity",
"id": "Transaction Total",
"value": -5790.95,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "-$5,790.95",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
}
]
},
{
"$type": "calculated-context-change",
"contextChange": {
"activityOption": {
"$type": "activity",
"name": null,
"includeUnmanagedJournals": false,
"inceptionValueMethod": "New Money",
"details": [
{
"$type": "activity",
"activityType": "Net Dividends/Interest/Gains Withdrawn",
"isManaged": true,
"flipSign": false
}
]
},
"globalsSynced": null
},
"calculations": [
{
"$type": "calculated-activity",
"id": "Transaction Total",
"value": 13595.6,
"formattedUnits": null,
"formattedPrice": null,
"formattedValue": "$13,595.60",
"startDate": "2022-01-01",
"endDate": "2022-08-25"
}
]
}
]
}
]
}
3. Calculate Market Value Increase/Decrease with formula below
Beginning Market Value(BMV) + all activity requested – Ending Market value(EMV) = Market Value Increase/Decrease
Process Tips or Controls:
- Using the data in the response above, this is how you would calculate the Market Value Increase/Decrease
Total of BMV and All Activity =
$1,335,099.46(BMV) + $150,000.00(Contributions) – $932.92(Distributions) – $5790.95(Advisory Fees Paid) + $13,595.60(Dividends/Interest) = $1,491,971.19 (Total)
Total from above minus EMV
$1,491.971.19(Total BMV&Activity) – $1,399,894.61(EMV) = $92,076.58 (Market Value Increase/Decrease)
- Please be sure to reference the exhaustive Reporting/Scope document for detailed instructions on how to gather additional data or to see what Activity Types are available. Reporting Scope – Performance/Allocation/Activity Summary – Exhaustive