Create a sub account

POST /api/v1/plans/{plan_uuid}/sub-accounts

Headers

Path parameters

application/json

Body Required

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.
POST /api/v1/plans/{plan_uuid}/sub-accounts 
curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"name":"Johns ISA","policy_number":"AVF-4355432","proposal_reference":"BtMWiy0JwHtogU4"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "Johns ISA",
  "policy_number": "AVF-4355432",
  "proposal_reference": "BtMWiy0JwHtogU4"
}
Response examples (200) 
{
  "name": "John's ISA",
  "uuid": "4c8cf7c0-81d0-4c9b-bddd-9bf91297c4d9",
  "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": "7dc39671-3cba-4706-a281-3ad771a8ad75",
    "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": "cfe347b9-6362-446a-ae2e-5b19a0184dc2",
    "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"
  }
}