Skip to main content

Pool

An investment pool define the terms for profit pool

creationDatestring<date-time>

The creation time of the pool

Example: 2016-09-06T13:37:50+03:00
descriptionstring

The description of the pool

Possible values: <= 1024 characters

idinteger<int64>

The identifier of the pool

lastModifiedDatestring<date-time>

The last modified time of the pool

Example: 2016-09-06T13:37:50+03:00
namestringrequired

The name of the pool

Possible values: >= 3 characters and <= 64 characters

settings object[]

List of pool settings

  • Array [
    • bankPLAccountEncodedKeystring

    The bank P&L account encoded key of the pool settings

    creationDatestring<date-time>

    The creation time of the pool settings

    Example: 2016-09-06T13:37:50+03:00
    customerSharesLossbooleanrequired

    The customerSharesLoss boolean field of the pool settings, currently False is the only supported value

    daysInMonthstringrequired

    The days in month value of the pool settings

    Possible values: [DAYS_ACTUAL]

    daysInYearstringrequired

    The days in year value of the pool settings

    Possible values: [DAYS365]

    effectiveDatestring<date>required

    The effective date of the pool settings

    Example: 1987-04-26
    firstProfitPeriodStartDatestring<date>required

    The first ProfitPeriod StartDate of the pool settings

    Example: 1987-04-26
    idinteger<int64>

    The identifier of the pool settings

    initialEquivalentRatenumber

    The initial equivalent rate of the pool settings

    lastModifiedDatestring<date-time>

    The last modified time of the pool setting

    Example: 2016-09-06T13:37:50+03:00
    liabilityCheckbooleanrequired

    The pool using assets/liabilities calculation for income

    poolIdinteger<int64>

    The identifier of the investment pool

    profitCalculationBalanceTypestringrequired

    Specify which intra-day account balance to be used for profit contribution calculations

    Possible values: [END_OF_THE_DAY_BALANCE, AVERAGE_BALANCE, MINIMUM_BALANCE]

    profitDistributionFrequencyCountinteger<int32>required

    The profit Frequency count of the pool settings

    profitDistributionFrequencyUnitstringrequired

    The profit Frequency unit of the pool settings

    Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUALLY, ANNUALLY]

    profitSuspenseAccountEncodedKeystring

    The profit suspense account encoded key of the pool settings

    reserveAccountEncodedKeystring

    The reserve account encoded key of the pool settings

  • ]
    • statusstringrequired

    The status of the pool

    Possible values: [ACTIVE, INACTIVE]

    Pool
    {
      "creationDate": "2016-09-06T13:37:50+03:00",
      "description": "string",
      "id": 0,
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "name": "string",
      "settings": [
        {
          "bankPLAccountEncodedKey": "string",
          "creationDate": "2016-09-06T13:37:50+03:00",
          "customerSharesLoss": true,
          "daysInMonth": "DAYS_ACTUAL",
          "daysInYear": "DAYS365",
          "effectiveDate": "1987-04-26",
          "firstProfitPeriodStartDate": "1987-04-26",
          "id": 0,
          "initialEquivalentRate": 0,
          "lastModifiedDate": "2016-09-06T13:37:50+03:00",
          "liabilityCheck": true,
          "poolId": 0,
          "profitCalculationBalanceType": "END_OF_THE_DAY_BALANCE",
          "profitDistributionFrequencyCount": 0,
          "profitDistributionFrequencyUnit": "DAILY",
          "profitSuspenseAccountEncodedKey": "string",
          "reserveAccountEncodedKey": "string"
        }
      ],
      "status": "ACTIVE"
    }