Get the valuations formatted for a graph

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

Path parameters

Query parameters

  • 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
    • The total valuations for that day if there were any.

    • value object

      The total valuation value for that day.

      Additional properties are allowed.

GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}
curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/reporting/valuations/subAccount \
 -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)
{
  "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": "2024-11-20"
}