Create a wealth summary for the client.

GET /api/v1/client/{client_uuid}/wealth

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • client_uuid string Required

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 client is linked to.

  • filter[include_inactive] boolean

    If true then the net worth will also include inactive plans.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • valued_at string

      The timestamp of when the networth was calculated

    • total object

      The total wealth of the client at the given date

      Hide total attributes Show total attributes object
      • amount object
        Hide amount attributes Show amount attributes object
        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object
        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object
        • example string
        • description string
    • abstract_types object

      The total wealth broken down in to plan abstract types

      Hide abstract_types attributes Show abstract_types attributes object
      • assets object
        Hide assets attributes Show assets attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • liabilities object
        Hide liabilities attributes Show liabilities attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • protection object
        Hide protection attributes Show protection attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
    • plan_types object

      The total wealth broken down in to plan types

      Hide plan_types attributes Show plan_types attributes object
      • annuity object
        Hide annuity attributes Show annuity attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • cash_account object
        Hide cash_account attributes Show cash_account attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • fixed_asset object
        Hide fixed_asset attributes Show fixed_asset attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • general_insurance object
        Hide general_insurance attributes Show general_insurance attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • group_protection object
        Hide group_protection attributes Show group_protection attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • investment object
        Hide investment attributes Show investment attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • loan_credit object
        Hide loan_credit attributes Show loan_credit attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • mortgage object
        Hide mortgage attributes Show mortgage attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • pension object
        Hide pension attributes Show pension attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
      • protection_policy object
        Hide protection_policy attributes Show protection_policy attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
GET /api/v1/client/{client_uuid}/wealth
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/wealth' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "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-06-25T15:10:42+01: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"
      }
    }
  }
}