Update one or more configuration keys

PATCH/portfolio/config/settings

portfolio:write portfolio_config_settings_update

Accepts a model name to identify the settings group, plus either a single key or an array of keys to update. Each key's value is read from the request payload and persisted to the settings store.

Request body

application/json, required · PortfolioConfigSettingsRequest

modelstringRequired#
One of: CONFIG, TRANSACTION, TAX, TILED_METRICS, DATA_TABLES, SEMANTICS
keystring#
One of: reportingQuarter, asReported, showIRR, showFee, hideValuationBridge, hideDatePicker, showInvestorUnitsVPU, showCombinedView, showTotalOpenCommitment, showCapitalGains, showRealisedUnrealisedReturns, showTotalProfit, enablePortfolioDocuments, hideUnreportedTiles, enableHistoricalAssetTransfer, enableTransferInOut, enableDistributionTax, tiledMetrics, dataTables, semantics, tooltips
keysstring[]#
One of: reportingQuarter, asReported, showIRR, showFee, hideValuationBridge, hideDatePicker, showInvestorUnitsVPU, showCombinedView, showTotalOpenCommitment, showCapitalGains, showRealisedUnrealisedReturns, showTotalProfit, enablePortfolioDocuments, hideUnreportedTiles, enableHistoricalAssetTransfer, enableTransferInOut, enableDistributionTax, tiledMetrics, dataTables, semantics, tooltips
reportingQuarterstring#
Config
asReportedboolean#
showIRRboolean#
showFeeboolean#
hideValuationBridgeboolean#
hideDatePickerboolean#
showInvestorUnitsVPUboolean#
showCombinedViewboolean#
showTotalOpenCommitmentboolean#
showCapitalGainsboolean#
showRealisedUnrealisedReturnsboolean#
showTotalProfitboolean#
enablePortfolioDocumentsboolean#
hideUnreportedTilesboolean#
enableHistoricalAssetTransferboolean#
Transaction
enableTransferInOutboolean#
enableDistributionTaxboolean#
Tax
tiledMetricsobject[][][]#
dataTablesobject[][][]#
semanticsobject#
tooltipsobject#

{
  "model": "CONFIG",
  "key": "reportingQuarter",
  "keys": [
    "reportingQuarter"
  ],
  "reportingQuarter": "string",
  "asReported": true,
  "showIRR": true,
  "showFee": true,
  "hideValuationBridge": true,
  "hideDatePicker": true,
  "showInvestorUnitsVPU": true,
  "showCombinedView": true,
  "showTotalOpenCommitment": true,
  "showCapitalGains": true,
  "showRealisedUnrealisedReturns": true,
  "showTotalProfit": true,
  "enablePortfolioDocuments": true,
  "hideUnreportedTiles": true,
  "enableHistoricalAssetTransfer": true,
  "enableTransferInOut": true,
  "enableDistributionTax": true,
  "tiledMetrics": [
    [
      [
        {
          "key": "string",
          "visible": true
        }
      ]
    ]
  ],
  "dataTables": [
    [
      [
        {
          "key": "string",
          "visible": true
        }
      ]
    ]
  ],
  "semantics": {
    "capital-gains": "string",
    "total-profit": "string",
    "committed-capital": "string",
    "called-capital": "string",
    "paid-in": "string",
    "distribution": "string",
    "uncalled-capital": "string",
    "valuation": "string",
    "dpi": "string",
    "tvpi": "string",
    "rvpi": "string",
    "irr": "string",
    "multiple": "string",
    "yield-to-date": "string",
    "num-investors": "string",
    "num-investments": "string",
    "investors": "string",
    "investments": "string",
    "returned-capital": "string",
    "realised-gains": "string",
    "unrealised-gains": "string",
    "amount-invested": "string",
    "current-valuation": "string",
    "transfer-in-out": "string",
    "total-units-held": "string",
    "vpu": "string",
    "dividend": "string",
    "redemption": "string",
    "other-income": "string"
  },
  "tooltips": {
    "capital-gains": "string",
    "total-profit": "string",
    "committed-capital": "string",
    "called-capital": "string",
    "paid-in": "string",
    "distribution": "string",
    "uncalled-capital": "string",
    "valuation": "string",
    "dpi": "string",
    "tvpi": "string",
    "rvpi": "string",
    "irr": "string",
    "multiple": "string",
    "yield-to-date": "string",
    "num-investors": "string",
    "num-investments": "string",
    "investors": "string",
    "investments": "string",
    "returned-capital": "string",
    "realised-gains": "string",
    "unrealised-gains": "string",
    "amount-invested": "string",
    "current-valuation": "string",
    "transfer-in-out": "string",
    "total-units-held": "string",
    "vpu": "string",
    "dividend": "string",
    "redemption": "string",
    "other-income": "string"
  }
}

Responses

200

{}

422

Validation error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/portfolio/config/settings\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "model": "CONFIG",
  "key": "reportingQuarter",
  "keys": [
    "reportingQuarter"
  ],
  "reportingQuarter": "string",
  "asReported": true,
  "showIRR": true,
  "showFee": true,
  "hideValuationBridge": true,
  "hideDatePicker": true,
  "showInvestorUnitsVPU": true,
  "showCombinedView": true,
  "showTotalOpenCommitment": true,
  "showCapitalGains": true,
  "showRealisedUnrealisedReturns": true,
  "showTotalProfit": true,
  "enablePortfolioDocuments": true,
  "hideUnreportedTiles": true,
  "enableHistoricalAssetTransfer": true,
  "enableTransferInOut": true,
  "enableDistributionTax": true,
  "tiledMetrics": [
    [
      [
        {
          "key": "string",
          "visible": true
        }
      ]
    ]
  ],
  "dataTables": [
    [
      [
        {
          "key": "string",
          "visible": true
        }
      ]
    ]
  ],
  "semantics": {
    "capital-gains": "string",
    "total-profit": "string",
    "committed-capital": "string",
    "called-capital": "string",
    "paid-in": "string",
    "distribution": "string",
    "uncalled-capital": "string",
    "valuation": "string",
    "dpi": "string",
    "tvpi": "string",
    "rvpi": "string",
    "irr": "string",
    "multiple": "string",
    "yield-to-date": "string",
    "num-investors": "string",
    "num-investments": "string",
    "investors": "string",
    "investments": "string",
    "returned-capital": "string",
    "realised-gains": "string",
    "unrealised-gains": "string",
    "amount-invested": "string",
    "current-valuation": "string",
    "transfer-in-out": "string",
    "total-units-held": "string",
    "vpu": "string",
    "dividend": "string",
    "redemption": "string",
    "other-income": "string"
  },
  "tooltips": {
    "capital-gains": "string",
    "total-profit": "string",
    "committed-capital": "string",
    "called-capital": "string",
    "paid-in": "string",
    "distribution": "string",
    "uncalled-capital": "string",
    "valuation": "string",
    "dpi": "string",
    "tvpi": "string",
    "rvpi": "string",
    "irr": "string",
    "multiple": "string",
    "yield-to-date": "string",
    "num-investors": "string",
    "num-investments": "string",
    "investors": "string",
    "investments": "string",
    "returned-capital": "string",
    "realised-gains": "string",
    "unrealised-gains": "string",
    "amount-invested": "string",
    "current-valuation": "string",
    "transfer-in-out": "string",
    "total-units-held": "string",
    "vpu": "string",
    "dividend": "string",
    "redemption": "string",
    "other-income": "string"
  }
}'