Create a holding

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

Personal access token & OAuth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

plan_uuid string Required
subAccount_uuid string Required

application/json

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.

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.

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":"c382c133-92c3-44bf-af0a-ba4552d37c1e"}'

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": "c382c133-92c3-44bf-af0a-ba4552d37c1e"
}

Response examples (200)

{
  "citi": "ACB123",
  "isin": "ACB123",
  "uuid": "a797e13d-e1fb-4d0d-be83-eb88707c5dba",
  "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": "1e149f83-a89f-46c1-a309-700e0fe832c5",
    "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": "383c8908-17b6-4fcb-9b1f-dfda208a2b3b",
    "reference": "AB123456",
    "created_at": "2025-02-20T10:13:04+00:00",
    "updated_at": "2025-02-20T10:13:04+00:00",
    "third_party": "nucleus"
  }
}