GET Household/{householdId}/Performance/Summary

Gets the household summary.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
householdId

The household identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns household performance summary information in a PerformanceSummaryModel object.

Type: PerformanceSummaryModel
NameDescriptionTypeAdditional information
AsOfDate

The date that the values were calculated as of

date

None.

InceptionToDateGrossPerformance

Gross rate of return percentage since inception

decimal number

None.

InceptionToDateNetPerformance

Net rate of return percentage since inception

decimal number

None.

MonthToDateGrossPerformance

Gross rate of return percentage for the current Month

decimal number

None.

MonthToDateNetPerformance

Net rate of return percentage for the current Month

decimal number

None.

OneYearGrossPerformance

Gross rate of return percentage for the last 365 days

decimal number

None.

OneYearNetPerformance

Net rate of return percentage for the last 365 days

decimal number

None.

PreviousFiveYearGrossPerformance

Gross rate of return percentage for the previous five (5) years

decimal number

None.

PreviousFiveYearNetPerformance

Net rate of return percentage for the previous five (5) years

decimal number

None.

PreviousThreeYearGrossPerformance

Gross rate of return percentage for the previous three (3) years

decimal number

None.

PreviousThreeYearNetPerformance

Net rate of return percentage for the previous three (3) years

decimal number

None.

PreviousYearGrossPerformance

Gross rate of return percentage for the previous year

decimal number

None.

PreviousYearNetPerformance

Net rate of return percentage for the previous year

decimal number

None.

QuarterToDateGrossPerformance

Gross rate of return percentage for the current quarter

decimal number

None.

QuarterToDateNetPerformance

Net rate of return percentage for the current quarter

decimal number

None.

YearToDateGrossPerformance

Gross rate of return percentage for the current year

decimal number

None.

YearToDateNetPerformance

Net rate of return percentage for the current year

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "AsOfDate": "2019-01-18T00:00:00-05:00",
  "InceptionToDateGrossPerformance": 9.6,
  "InceptionToDateNetPerformance": 11.2,
  "MonthToDateGrossPerformance": 1.0,
  "MonthToDateNetPerformance": 1.1,
  "OneYearGrossPerformance": 7.0,
  "OneYearNetPerformance": 5.0,
  "PreviousFiveYearGrossPerformance": 6.7,
  "PreviousFiveYearNetPerformance": 6.934,
  "PreviousThreeYearGrossPerformance": 4.5,
  "PreviousThreeYearNetPerformance": 4.45,
  "PreviousYearGrossPerformance": 3.4,
  "PreviousYearNetPerformance": 3.6,
  "QuarterToDateGrossPerformance": 12.0,
  "QuarterToDateNetPerformance": 10.0,
  "YearToDateGrossPerformance": 13.0,
  "YearToDateNetPerformance": 9.0
}

application/xml, text/xml

Sample:
<PerformanceSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <AsOfDate>2019-01-18T00:00:00-05:00</AsOfDate>
  <InceptionToDateGrossPerformance>9.6</InceptionToDateGrossPerformance>
  <InceptionToDateNetPerformance>11.2</InceptionToDateNetPerformance>
  <MonthToDateGrossPerformance>1</MonthToDateGrossPerformance>
  <MonthToDateNetPerformance>1.1</MonthToDateNetPerformance>
  <OneYearGrossPerformance>7</OneYearGrossPerformance>
  <OneYearNetPerformance>5</OneYearNetPerformance>
  <PreviousFiveYearGrossPerformance>6.7</PreviousFiveYearGrossPerformance>
  <PreviousFiveYearNetPerformance>6.934</PreviousFiveYearNetPerformance>
  <PreviousThreeYearGrossPerformance>4.5</PreviousThreeYearGrossPerformance>
  <PreviousThreeYearNetPerformance>4.45</PreviousThreeYearNetPerformance>
  <PreviousYearGrossPerformance>3.4</PreviousYearGrossPerformance>
  <PreviousYearNetPerformance>3.6</PreviousYearNetPerformance>
  <QuarterToDateGrossPerformance>12</QuarterToDateGrossPerformance>
  <QuarterToDateNetPerformance>10</QuarterToDateNetPerformance>
  <YearToDateGrossPerformance>13</YearToDateGrossPerformance>
  <YearToDateNetPerformance>9</YearToDateNetPerformance>
</PerformanceSummaryModel>