Get all holdings

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

Path parameters

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [sub_account, portfolio].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[is_active] boolean

    Filter holdings to only active or only inactive holdings. Defaults to true.

  • filter[portfolio_uuid] string

    Filter holdings by a given portfolio_uuid. Defaults to showing holdings from the active portfolio or all holdings.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, units, unit_price, is_active]. Negative sign to denote DESC. Defaults to '-created_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}/holdings/{subAccount} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/holdings/subAccount \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "citi": "ACB123",
      "isin": "ACB123",
      "uuid": "3f9051af-d76c-4bd7-9558-7d7ceef89d32",
      "sedol": "ACB123",
      "units": 5,
      "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"
        }
      },
      "sector": "Europe",
      "fund_name": "Fund",
      "is_active": true,
      "reference": "REF123",
      "created_at": "2024-10-16T11:10:16+01:00",
      "unit_price": {
        "amount": {
          "example": "1000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£10.00",
          "description": "Money amount formatted with currency"
        }
      },
      "updated_at": "2024-10-16T11:10:16+01:00",
      "sub_account": {
        "name": "John's ISA",
        "uuid": "24729ae4-fa1b-464c-826f-d2c058e6cec6",
        "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"
      },
      "purchase_price": {
        "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"
        }
      },
      "unit_price_raw": 10
    }
  ]
}