Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Query-String
    Assets Number Body Retail client's assets held
    BenchmarkDebtFactor Number Body The maximum value of the debtfactor for a given risk rating, so if your the factor is higher then the benchmark then lossability is set to low and then risk level becomes low as well
    BenchmarkIncomeAfterExpenses Number Body Retail client's benchmark income of a retail household after taxes and fixed costs has been deducted
    ClientKey ClientKey Route
    DebtFactor Number Body Retail client's ratio of debt of a retail household compared to the assets owned by the household
    Equity Number Body Corporate client's liquid cash
    ExpectedEconomicChanges Boolean Body Whether any major economic changes are expected
    Expenses Number Body Retail client's fixed costs
    FreeLiquidity Number Body Corporate client's FreeLiquidity for InvestmentHorizon
    Horizon Integer Body Horizon
    IlliquidAssets Number Body Amount of assets that are difficult to convert into cash in market
    Income Number Body Retail client's income after taxes
    IncomeAfterExpenses Number Body Retail client's income after taxes and fixed costs has been deducted
    InitialDeposit Number Body InitialDeposit
    InvestmentCurrency String Body InvestmentCurrency
    Liabilities Number Body Corporate client's liabilities
    LiquidAssets Number Body Amount of assets that can be easily converted to cash or other assets into the market
    NetIncome Number Body Corporate client's net income
    PensionAfterTaxes Number Body Retail client's pension after taxes has been deducted
    Purpose String Body Purpose
    RequiredLiquidity Number Body Corporate client's LiquidityRequired for InvestmentHorizon
    Tags String [] Body Tags
  • Response Parameters

    View Response Codes

    There are no response parameters

  • Request Example

    Request URL
    PUT /partnerintegration/v1/financialdata/{ClientKey}?AccountKey={AccountKey}
    Request Body
      "Assets": 10,
      "BenchmarkDebtFactor": 10,
      "BenchmarkIncomeAfterExpenses": 10,
      "DebtFactor": 10,
      "Equity": 10,
      "ExpectedEconomicChanges": true,
      "Expenses": 10,
      "FreeLiquidity": 10,
      "Horizon": 99,
      "IlliquidAssets": 10,
      "Income": 10,
      "IncomeAfterExpenses": 10,
      "InitialDeposit": 10,
      "InvestmentCurrency": "stringValue",
      "Liabilities": 10,
      "LiquidAssets": 10,
      "NetIncome": 10,
      "PensionAfterTaxes": 10,
      "Purpose": "stringValue",
      "RequiredLiquidity": 10,
      "Tags": [