Get Wealth summary of all accounts of a circle
Wealth Aggregate net worth output for all clients of a circle
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
date string
Get the clients net worth at a particular date in history. Get current net worth when not provided.
-
filter[include_other_plans] boolean
If true then the net worth will also include other plans the circle clients are linked to.
-
filter[include_inactive] boolean
If true then the net worth will also include inactive plans.
GET
/api/v1/circles/{circle_uuid}/wealth
curl \
-X GET https://api.plannrcrm.com/api/v1/circles/circle_uuid/wealth \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"total": {
"amount": {
"example": "100000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£1,000,000.00",
"description": "Money amount formatted with currency"
}
},
"valued_at": "2025-01-29T10:30:12+00:00",
"plan_types": {
"annuity": {
"amount": {
"example": "9172106",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£91,721.06",
"description": "Money amount formatted with currency"
}
},
"pension": {
"amount": {
"example": "6850594",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£68,505.94",
"description": "Money amount formatted with currency"
}
},
"mortgage": {
"amount": {
"example": "3630342",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£36,303.42",
"description": "Money amount formatted with currency"
}
},
"investment": {
"amount": {
"example": "3848845",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£38,488.45",
"description": "Money amount formatted with currency"
}
},
"fixed_asset": {
"amount": {
"example": "8394776",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£83,947.76",
"description": "Money amount formatted with currency"
}
},
"loan_credit": {
"amount": {
"example": "7564545",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£75,645.45",
"description": "Money amount formatted with currency"
}
},
"cash_account": {
"amount": {
"example": "9452110",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£94,521.10",
"description": "Money amount formatted with currency"
}
},
"group_protection": {
"amount": {
"example": "9767027",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£97,670.27",
"description": "Money amount formatted with currency"
}
},
"general_insurance": {
"amount": {
"example": "3091804",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£30,918.04",
"description": "Money amount formatted with currency"
}
},
"protection_policy": {
"amount": {
"example": "8796070",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£87,960.70",
"description": "Money amount formatted with currency"
}
}
},
"abstract_types": {
"assets": {
"amount": {
"example": "59500000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£595,000.00",
"description": "Money amount formatted with currency"
}
},
"protection": {
"amount": {
"example": "8000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£80,000.00",
"description": "Money amount formatted with currency"
}
},
"liabilities": {
"amount": {
"example": "32500000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£325,000.00",
"description": "Money amount formatted with currency"
}
}
}
}
]
}