Calculate returns for a plan within a date range

GET /api/v2/plans/{plan_uuid}/returns

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required

Query parameters

filter[date_from] string

Date to filter the start of the calculations.
filter[date_to] string

Date to filter the start of the calculations.
includePlan boolean

Include plan data with valuations and transactions.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  calculated_at string
  
  plan_started_at string
  
  time_weighted_return object
  
  Hide time_weighted_return attributes Show time_weighted_return attributes object
  
  value number
  
  status string
  
  reason string
  
  time_weighted_return.value number
  
  time_weighted_return.status string
  
  money_weighted_return object
  
  Hide money_weighted_return attributes Show money_weighted_return attributes object
  
  value number
  
  status string
  
  reason string
  
  money_weighted_return.value number
  
  money_weighted_return.status string

GET /api/v2/plans/{plan_uuid}/returns

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/returns' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "calculated_at": "2025-09-17T15:46:54+01:00",
      "plan_started_at": "2025-09-17T15:46:54+01:00",
      "time_weighted_return": {
        "value": 0.21,
        "reason": null,
        "status": "success"
      },
      "money_weighted_return": {
        "value": 0.18,
        "reason": null,
        "status": "success"
      },
      "time_weighted_return.value": 0.21,
      "money_weighted_return.value": 0.18,
      "time_weighted_return.status": "success",
      "money_weighted_return.status": "success"
    }
  ]
}