Get the valuations formatted for a graph

GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required
  • subAccount string Required

    Optional parameter.

Query parameters

  • start_date string

    date Optional date to constrain only valuations from this date. For example: ?start_date=2022-06-12

  • end_date string

    date Optional date to constrain only valuations up until this date. For example: ?end_date=2022-06-18

  • limit integer

    Optional limit to constrain the number of unique days returned

Responses

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

      The total valuations for that day if there were any.

    • value object

      The total valuation value for that day.

      Hide value attributes Show value 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/plans/{plan_uuid}/reporting/valuations/{subAccount}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/reporting/valuations/{"value"=>"", "summary"=>"When the value is omitted"}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "value": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    }
  },
  "valued_at": "2025-06-26"
}