Get a sub account

GET /api/v1/plans/{plan_uuid}/sub-accounts/{id}

Path parameters

Responses

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

      UUID of the sub account

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was created.

    • name string

      Descriptive name of the sub account

    • policy_number string

      Provider reference of the sub account

    • latest_valuation object

      The latest valuation of the sub account

      Additional properties are allowed.

    • is_main_account boolean

      Denotes if the sub account a main account of the plan

    • active_portfolio object

      The active portfolio of the sub account

      Additional properties are allowed.

    • statistics object

      The statistics on a sub account. Only displayed when you retrieve an individual sub-account.

      Additional properties are allowed.
GET /api/v1/plans/{plan_uuid}/sub-accounts/{id} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/id \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "name": "John's ISA",
  "uuid": "3ec4e888-d965-41b2-8c9c-3c715b494b30",
  "created_at": "2024-11-20T13:24:02+00:00",
  "statistics": {
    "recent_growth": 100
  },
  "updated_at": "2024-11-20T13:24:02+00:00",
  "policy_number": "AVI-4837",
  "is_main_account": false,
  "active_portfolio": {
    "name": "Risky Portfolio",
    "uuid": "45218c20-589f-4ef5-b670-44c756a53a89",
    "created_at": "2024-11-20T13:24:02+00:00",
    "updated_at": "2024-11-20T13:24:02+00:00",
    "is_proposed": true,
    "proposed_at": "2024-11-20T00:00:00+00:00"
  },
  "latest_valuation": {
    "uuid": "02b83dc6-2273-4038-91e0-186a29e5385d",
    "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-20T13:24:02+00:00",
    "created_at": "2024-11-20T13:24:02+00:00",
    "updated_at": "2024-11-20T13:24:02+00:00",
    "sub_account": "App\\Http\\Resources\\Plans\\SubAccountResource"
  }
}