Get all valuations

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

Path parameters

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [valued_at]. Negative sign to denote DESC. Defaults to 'valued_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/plans/{plan_uuid}/valuations/{subAccount} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/valuations/subAccount \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "uuid": "5d12ebb1-8f5b-49c8-b709-9fdae7224890",
      "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-10-16T11:10:16+01:00",
      "created_at": "2024-10-16T11:10:16+01:00",
      "updated_at": "2024-10-16T11:10:16+01:00",
      "sub_account": {
        "name": "John's ISA",
        "uuid": "2e314f40-ed9d-4909-9c75-cf8c1a5f0da0",
        "created_at": "2024-10-16T11:10:16+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2024-10-16T11:10:16+01:00",
        "policy_number": "AVI-4837",
        "is_main_account": false,
        "active_portfolio": "App\\Http\\Resources\\Plans\\PortfolioResource",
        "latest_valuation": "App\\Http\\Resources\\Plans\\ValuationResource"
      }
    }
  ]
}