Get a holding

GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}

Headers

Authorization string
Content-Type string
Accept string

Path parameters

plan_uuid string Required
subAccount_uuid string Required
uuid string Required

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.
- unit_price_raw integer
  
  The raw unit price of the holding.
- purchase_price object
  
  The purchase price of the holding.
- is_active boolean
  
  Denotes if the holding is active or not.
- value object
  
  The current value of the holding.
- sub_account object
  
  The holdings sub account.

GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/holdings/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"

Response examples (200)

{
  "citi": "ACB123",
  "isin": "ACB123",
  "uuid": "9ca0847d-585d-43c1-91bc-a56508635a39",
  "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": "b5c40f84-551c-47a4-ac69-13d20600d0d4",
    "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
}