Get a holding

GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
Personal access token & OAuth2

Path parameters

Responses

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

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was created.

    • fund_name string

      The name of the fund.

    • reference string

      The reference of the holding.

    • sector string

      The sector of the holding.

    • sedol string

      The SEDOL of the holding.

    • isin string

      The ISIN of the holding.

    • citi string

      The CITI of the holding.

    • units integer

      Holding units as a decimal.

    • unit_price object

      The unit price of the holding.

      Additional properties are allowed.

    • unit_price_raw integer

      The raw unit price of the holding.

    • purchase_price object

      The purchase price of the holding.

      Additional properties are allowed.

    • is_active boolean

      Denotes if the holding is active or not.

    • value object

      The current value of the holding.

      Additional properties are allowed.

    • sub_account object

      The holdings sub account.

      Additional properties are allowed.

    • external_references object

      The external references of the holding.

      Additional properties are allowed.
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid} 
curl \
 --request GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/holdings/uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "citi": "ACB123",
  "isin": "ACB123",
  "uuid": "11b3a744-e3c6-4d05-a094-d85926f2f516",
  "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": "2025-02-20T10:13:04+00: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": "2025-02-20T10:13:04+00:00",
  "sub_account": {
    "name": "John's ISA",
    "uuid": "8ea720e3-1aa3-4b1f-b988-e81ca65bf203",
    "created_at": "2025-02-20T10:13:04+00:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-02-20T10:13:04+00: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,
  "external_references": {
    "uuid": "2370e3de-7985-4e16-98c3-718026772922",
    "reference": "AB123456",
    "created_at": "2025-02-20T10:13:04+00:00",
    "updated_at": "2025-02-20T10:13:04+00:00",
    "third_party": "nucleus"
  }
}