Skip to main content

Product calculation cycle

Profit calculation cycle for a product

accountNumberint64required

The account number for the product calculation cycle

aggregatedAccountBalancesPaymentnumberrequired

The aggregated account balances payment

aggregatedAccountBalancesProfitnumberrequired

The aggregated account balances profit

averageBalancenumberrequired

The average balance of the product calculation cycle

balanceEligibility objectrequired

The balance eligibility criteria

minimumEligiblenumber

The minimum eligible balance to be included in the profit computation flow

typestring

The balance eligibility type

Possible values: [END_OF_THE_DAY_BALANCE, AVERAGE_BALANCE, MINIMUM_BALANCE]

creationDatedate-timerequired

The creation time of the product calculation cycle

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

The end date for the product calculation cycle

Example: 1987-04-26
idint64

The identifier of the product calculation cycle

lastModifiedDatedate-timerequired

The last modified time of the product calculation cycle

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

The identifier of the pool calculation cycle

productEncodedKeystringrequired

The associated product encoded key

profit objectrequired

The profit calculation configuration

cappedRatePercentagenumber

Upper threshold limit on the calculated customer profit rate

fixedRatePercentagenumber

A fixed percentage used to calculate the final profit amount

fixedRateRulestring

The type of fixed rate

Possible values: [ALWAYS_USE_FIXED_RATE, TREAT_AS_MIN, USE_CALCULATED_RATE]

tiers object[]

List of customer share tiers associated with product settings

  • Array [
    • creationDatedate-time

    The creation time of the customer share tier

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

    The starting value for the customer share tier

    idint64

    The identifier of the customer share tier

    lastModifiedDatedate-time

    The last modified time of the customer share tier

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

    The percentage of the customer share tier

    productSettingsIdint64

    The identifier of the associated product settings

  • ]
    • profitRatenumberrequired

    The profit rate for the product calculation

    startDatedaterequired

    The start date for the product calculation cycle

    Example: 1987-04-26
    statusstringrequired

    The status of the product calculation cycle

    Possible values: [ACTIVE, INACTIVE]

    totalAccruedProfitAmountnumberrequired

    The total accrued profit amount

    totalBankShareAmountPaymentnumberrequired

    The total bank share amount payment

    totalBankShareAmountProfitnumberrequired

    The total bank share amount profit

    totalFinalShareAmountnumberrequired

    The total final share amount

    totalMudaribShareAmountPaymentnumberrequired

    The total mudarib share amount payment

    totalMudaribShareAmountProfitnumberrequired

    The total mudarib share amount profit

    withholdingTaxEnabledbooleanrequired

    Indicates whether withholding tax is enabled in the associated IPS product

    withholdingTaxSourceKeystring

    The key reference for the withholding tax source based on the the associated IPS product settings

    Product calculation cycle
    {
      "accountNumber": 0,
      "aggregatedAccountBalancesPayment": 0,
      "aggregatedAccountBalancesProfit": 0,
      "averageBalance": 0,
      "balanceEligibility": {
        "minimumEligible": 0,
        "type": "END_OF_THE_DAY_BALANCE"
      },
      "creationDate": "2016-09-06T13:37:50+03:00",
      "endDate": "1987-04-26",
      "id": 0,
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "poolCalculationCycleId": 0,
      "productEncodedKey": "string",
      "profit": {
        "cappedRatePercentage": 0,
        "fixedRatePercentage": 0,
        "fixedRateRule": "ALWAYS_USE_FIXED_RATE",
        "tiers": [
          {
            "creationDate": "2016-09-06T13:37:50+03:00",
            "fromValue": 0,
            "id": 0,
            "lastModifiedDate": "2016-09-06T13:37:50+03:00",
            "percentage": 0,
            "productSettingsId": 0
          }
        ]
      },
      "profitRate": 0,
      "startDate": "1987-04-26",
      "status": "ACTIVE",
      "totalAccruedProfitAmount": 0,
      "totalBankShareAmountPayment": 0,
      "totalBankShareAmountProfit": 0,
      "totalFinalShareAmount": 0,
      "totalMudaribShareAmountPayment": 0,
      "totalMudaribShareAmountProfit": 0,
      "withholdingTaxEnabled": true,
      "withholdingTaxSourceKey": "string"
    }