Skip to main content

Proposal

Represents a single proposal with associated calculation cycles.

creationDatedate-time

The creation date of the proposal.

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

The end date of the proposal.

Example: 1987-04-26
idint64

The identifier of the proposal.

lastModifiedDatedate-time

The last modified date of the proposal.

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

The encoded key of the proposal owner.

poolCalculationCycles object[]required

The associated pool calculation cycles.

  • Array [
  • accountNumberint64required

    The account number for the pool calculation cycle

    averageBalancenumberrequired

    The average balance of the pool calculation cycle

    cashFlowCalculationCycles object[]

    The associated cash flow calculation cycles

  • Array [
  • allocationMethodstringrequired

    The allocation method of the cash flow

    Possible values: [AVERAGE_BALANCE, NUMBER_OF_ACCOUNTS, PERCENTAGE]

    allocationPercentagenumber

    Allocation percentage

    amountnumber

    The amount of the cash flow calculation cycle

    cashFlowIdint64

    The identifier of the cash flow

    cashFlowTypestringrequired

    The type of the cash flow

    Possible values: [INCOME_CATEGORY, EXPENSE_CATEGORY]

    creationDatedate-timerequired

    The creation time of the cash flow calculation cycle

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

    The GL account encoded key

    idint64

    The identifier of the cash flow calculation cycle

    lastModifiedDatedate-timerequired

    The last modified time of the cash flow calculation cycle

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

    The percentage of the cash flow calculation cycle

    poolCalculationCycleIdint64

    The identifier of the pool calculation cycle

    proposalIdint64

    The identifier of the proposal

    sourcestring

    The source of the cash flow

    Possible values: [ISLAMIC_FINANCE, OTHERS]

  • ]
  • creationDatedate-timerequired

    The creation time of the pool calculation cycle

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

    The loss is charged to customer account when true

    daysInMonthstringrequired

    The number of days in a month to be considered in the profit calculation

    Possible values: [DAYS_ACTUAL]

    daysInYearstringrequired

    The number of days in a year to be considered in the profit calculation

    Possible values: [DAYS365]

    endDatedaterequired

    The end date of the pool calculation cycle

    Example: 1987-04-26
    idint64

    The pool calculation cycle identifier

    lastModifiedDatedate-timerequired

    The last modified time of the pool calculation cycle

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

    The pool identifier

    productCalculationCycles object[]

    The associated product calculation cycles

  • Array [
  • 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

  • ]
  • profitAmountnumberrequired

    The profit amount per pool

    profitCalculationBalanceTypestringrequired

    The aggregated balance type per account to be used in the calculation

    Possible values: [END_OF_THE_DAY_BALANCE, AVERAGE_BALANCE, MINIMUM_BALANCE]

    profitRatenumberrequired

    The profit rate per pool

    proposalIdint64

    The proposal identifier

    startDatedaterequired

    The start date of the pool calculation cycle

    Example: 1987-04-26
    statusstringrequired

    The pool calculation cycle status

    Possible values: [OPEN, CLOSE]

    totalExpensesnumberrequired

    The total expense for a profit calculation cycle

    totalIncomenumberrequired

    The total income for a profit calculation cycle

  • ]
  • proposalTypestringrequired

    The type of the proposal (DEFAULT, CUSTOM).

    Possible values: [DEFAULT, CUSTOM]

    startDatedaterequired

    The start date of the proposal.

    Example: 1987-04-26
    statusstringrequired

    The status of the proposal (PENDING, APPROVED, REJECTED, APPLIED).

    Possible values: [PENDING, APPROVED, REJECTED, APPLIED]

    Proposal
    {
    "creationDate": "2016-09-06T13:37:50+03:00",
    "endDate": "1987-04-26",
    "id": 0,
    "lastModifiedDate": "2016-09-06T13:37:50+03:00",
    "ownerEncodedKey": "string",
    "poolCalculationCycles": [
    {
    "accountNumber": 0,
    "averageBalance": 0,
    "cashFlowCalculationCycles": [
    {
    "allocationMethod": "AVERAGE_BALANCE",
    "allocationPercentage": 0,
    "amount": 0,
    "cashFlowId": 0,
    "cashFlowType": "INCOME_CATEGORY",
    "creationDate": "2016-09-06T13:37:50+03:00",
    "glAccountEncodedKey": "string",
    "id": 0,
    "lastModifiedDate": "2016-09-06T13:37:50+03:00",
    "percentage": 0,
    "poolCalculationCycleId": 0,
    "proposalId": 0,
    "source": "ISLAMIC_FINANCE"
    }
    ],
    "creationDate": "2016-09-06T13:37:50+03:00",
    "customerSharesLoss": true,
    "daysInMonth": "DAYS_ACTUAL",
    "daysInYear": "DAYS365",
    "endDate": "1987-04-26",
    "id": 0,
    "lastModifiedDate": "2016-09-06T13:37:50+03:00",
    "poolId": 0,
    "productCalculationCycles": [
    {
    "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"
    }
    ],
    "profitAmount": 0,
    "profitCalculationBalanceType": "END_OF_THE_DAY_BALANCE",
    "profitRate": 0,
    "proposalId": 0,
    "startDate": "1987-04-26",
    "status": "OPEN",
    "totalExpenses": 0,
    "totalIncome": 0
    }
    ],
    "proposalType": "DEFAULT",
    "startDate": "1987-04-26",
    "status": "PENDING"
    }