Create a holding
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
plan_uuid
string Required -
subAccount_uuid
string Required
Body
Required
-
fund_name
string Required The name of the fund for the holding.
-
reference
string The reference of the holding/fund.
-
provider
string The provider of the holding/fund.
-
sector
string The sector of the holding/fund.
-
sedol
string The SEDOL of the holding/fund.
-
isin
string The ISIN of the holding/fund.
-
citi
string The CITI of the holding/fund.
-
units
number Required The units of the holding
-
unit_price
integer The current price of the units in pennies.
-
unit_price_raw
number The current price of the units in it's raw format with decimals.
-
purchase_price
integer The original purchase price of the holding in pennies.
-
currency
string The currency of the holding.
-
is_active
boolean Denotes if the holding is active/inactive.
-
portfolio_uuid
string Optional UUID of a portfolio to add the holding to.
POST
/api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
curl \
--request POST 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/holdings' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"fund_name":"My Fund","reference":"ABC12345","provider":"Financial Provider","sector":"Europe","sedol":"ABC12345","isin":"ABC12345","citi":"ABC12345","units":10.0,"unit_price":10000,"unit_price_raw":100.2334234,"purchase_price":5000,"currency":"GBP","is_active":true,"portfolio_uuid":"b078ed42-d8f0-447c-9ca8-7058db92d312"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"fund_name": "My Fund",
"reference": "ABC12345",
"provider": "Financial Provider",
"sector": "Europe",
"sedol": "ABC12345",
"isin": "ABC12345",
"citi": "ABC12345",
"units": 10.0,
"unit_price": 10000,
"unit_price_raw": 100.2334234,
"purchase_price": 5000,
"currency": "GBP",
"is_active": true,
"portfolio_uuid": "b078ed42-d8f0-447c-9ca8-7058db92d312"
}
Response examples (200)
{
"citi": "ACB123",
"isin": "ACB123",
"uuid": "75e27d47-adba-41f7-bb7a-d891463c7d74",
"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-04-02T13:27:57+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": "2025-04-02T13:27:57+01:00",
"sub_account": {
"name": "John's ISA",
"uuid": "41217d44-75e7-4e44-981c-fbc6c502c949",
"created_at": "2025-04-02T13:27:57+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-04-02T13:27:57+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,
"external_references": {
"uuid": "d1803286-933e-4fb2-8c3e-cf9a33e067b3",
"reference": "AB123456",
"created_at": "2025-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+01:00",
"third_party": "nucleus"
}
}