Event Name
deleteCashFlow.cashFlowDeleted
Domain
holdings
Description
an event indicating the deletion of a record from the Cashflow table.
Properties
{
"accountingAction": {
"type": "string",
"description": "Decides the accounting action to be taken"
},
"contractId": {
"type": "string",
"description": "Indicates the unique identifier of the transaction or contract which initiated the activity"
},
"sourceSystem": {
"type": "string",
"description": "Specifies an alternative short name to refer the current backend system"
},
"cashflowStaticInformation": {
"type": "array",
"description": "Contains the static information like contract currrency, product category, contract type to be recorded under cash flow.",
"items": {
"id": "urn:jsonschema:cashflowStaticInformation",
"properties": {
"iasClassification": {
"type": "string",
"description": "Identifies the classification of the financial asset/liability. Financial assets under IFRS9 can hold the business model applied for the contract. Possible values are Example include AMC ( measured at amortised cost ), FVOCI ( measured at Fair Value to Other Comprehensive Income), FVPL ( measured at Fair Value through Profit and Loss) . Financial assets under IAS39 can hold the classification of contracts with AFS(Available for Sale), HTM (Held to Maturity), LAR(Loans and Receivables), FVPL ( measured at Fair value through Profit and Loss) as possible values. Financial Liabilities under both IFRS9 and IAS39 can hold the classifications FVPL ( measured at Fair value through Profit and Loss)and AMC( measured at Amortised Cost )"
},
"iasSubType": {
"type": "string",
"description": "Identifies the accounting and posting methods applied for the contracts based on classification of assets. Examples include AMC - measured at amortised cost , FVOCI - measured at Fair value to Other Comprehensive Income, FVPL - measured at Fair value through Profit and Loss"
},
"currencyId": {
"type": "string",
"description": "Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."
},
"interestBasisId": {
"type": "string",
"description": "Interest basis identifier used in interest amount calculation. "
},
"contractRate": {
"type": "string",
"description": "Rate at which the forex contract is undertaken."
},
"accrualParam": {
"type": "string",
"description": "Indicates if the value date or maturity date or both need to be considered for commission calculation."
},
"productCategoryId": {
"type": "string",
"description": "The identifier of the product category"
},
"excludeEir": {
"type": "string",
"description": "Indicates whether the Effective Interest Rate (EIR) should be calculated for the contract cash flow or not."
},
"aprDetails": {
"type": "array",
"description": "Contains Annual Percentage Rate details of the contract like aprType, dayBasis. These values are used to calculate APR for the cash flow.",
"items": {
"id": "urn:jsonschema:aprDetails",
"properties": {
"aprType": {
"type": "string",
"description": "Indicates the type of Annual Percentage Rate calculation selected for Reporting. Available options such as Cashflow,Interest"
},
"dayBasis": {
"type": "string",
"description": "Contains the day basis on which the interest is calculated. Eg: 366/366, 360/365 (Interest days/days in the year)"
}
}
}
},
"commitmentContract": {
"type": "string",
"description": "Indicates if the nature of contract is commitment."
},
"amortisationFeeProperties": {
"type": "array",
"description": "Contains the amortisation charge properties of the contract in which charge name, charge type are defined",
"items": {
"id": "urn:jsonschema:amortisationFeeProperties",
"properties": {
"feePropertyName": {
"type": "string",
"description": "Indicates valid arrangement charge property names."
},
"feeAmortisation": {
"type": "string",
"description": "Indicates whether the Fee property amortisation has been suspended or stopped for the contract. Possible values are SUSPEND, STOP."
}
}
}
},
"reversalIndicator": {
"type": "string",
"description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
},
"accrualIds": {
"type": "array",
"description": "Identifier of the accrual record.",
"items": {
"id": "urn:jsonschema:accrualIds",
"properties": {
"accrualId": {
"type": "string",
"description": "Identifier of the accrual record."
}
}
}
},
"excludeProperties": {
"type": "array",
"description": "Indicates the list of properties excluded for Annual Percentage Rate calculation",
"items": {
"id": "urn:jsonschema:excludeProperties",
"properties": {
"excludeProperty": {
"type": "string",
"description": "Indicates the list of properties excluded for Annual Percentage Rate calculation"
}
}
}
},
"includeStartDate": {
"type": "string",
"description": "Indicates whether an accrual takes place for the start data of the contract"
},
"lastDayInclusive": {
"type": "string",
"description": "Indicates whether an accrual takes place on the final day of an accrual period"
},
"feeDetails": {
"type": "array",
"description": "Indicates the identifier for fee details in which fee name, fee amount, adjsuted fee amount are defined",
"items": {
"id": "urn:jsonschema:feeDetails",
"properties": {
"feePropertyName": {
"type": "string",
"description": "Indicates valid arrangement charge property names."
},
"feeAmortisation": {
"type": "string",
"description": "Indicates whether the Fee property amortisation has been suspended or stopped for the contract. Possible values are SUSPEND, STOP."
},
"feeAmount": {
"type": "string",
"description": "Indicates the fee amount which is applied for the payment instruction"
},
"accrualInfo": {
"type": "string",
"description": "Indicates the interest accrual calculated for the fiduciary deposit."
}
}
}
}
}
}
},
"cashflowRateInformation": {
"type": "array",
"description": "Contains the cash flow rate information like market rate identifier, market rate margin, rate fix date to be used to calculate Effective Interest Rate (EIR) and Annual Percentage Rate(APR) of the cash flow.",
"items": {
"id": "urn:jsonschema:cashflowRateInformation",
"properties": {
"marketRateId": {
"type": "string",
"description": "Indicates the market rate that has to be applied for calculating the fair value asset type of the contracts. "
},
"marketRateMargin": {
"type": "string",
"description": "Identifies the margin percentage applied on the market rate while calculating the fair value."
},
"marginOperand": {
"type": "string",
"description": "Indicates whether the margin is positive or negaitve, when margin percentage is applied on the market rate while calculating the fair value. Possible values include + or -"
},
"rateFixDate": {
"type": "string",
"description": "Indicates the date from which the new rate is applicable, in case of rate fixing contracts "
},
"outstandingAmount": {
"type": "string",
"description": "Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"
},
"migrationEffectiveInterestRate": {
"type": "string",
"description": "Indicates the Effective Interest Rate (EIR) of the contract during takeover."
},
"migrationEirNetPresentValue": {
"type": "string",
"description": "Indicates the Net Present Value of the contract during takeover.Takeover NPV is defaulted with user provided value under the Effective Interest Rate (EIR) takeover type."
},
"valueDate": {
"type": "string",
"description": "Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"
},
"companyCode": {
"type": "string",
"description": "The identifier of the underlying Entity/Company/Branch."
},
"contractTermEndDate": {
"type": "string",
"description": "Indicates the date used to withdraw from IFRS accounting prior to the actual maturity date"
},
"effectiveDate": {
"type": "string",
"description": "Contains the identifier for the transaction date. Dates are expected in ‘YYYYMMDD’ format"
},
"migrationAprDetails": {
"type": "array",
"description": "Contains the Annual Percentage Rate releated details like migration annual percentage rate, migration APR net present value, migration type provided during the contract takeover.",
"items": {
"id": "urn:jsonschema:migrationAprDetails",
"properties": {
"migrationType": {
"type": "string",
"description": "Indicates the rate type for takeover contracts. Possible values are EIR(Effective Interest Rate) or any APR(Annual Percentage Rate) types. "
},
"migrationAnnualPercentageRate": {
"type": "string",
"description": "Indicates the Annual Percentage Rate (APR) of the contract during takeover."
},
"migrationAprNetPresentValue": {
"type": "string",
"description": "Indicates the Net Present Value (NPV) of the contract during takeover.Takeover NPV is defaulted with user provided value under the corresponding takeover Annual Percentage Rate (APR) type."
}
}
}
},
"arrangementStatus": {
"type": "string",
"description": "Status of the arrangement. E.g. AUTH, CLOSE, UNAUTH etc."
},
"maturityDate": {
"type": "string",
"description": "Indicates maturity date of the contract"
},
"migrationFeeDetails": {
"type": "array",
"description": "Contains the fee details like migration fee property, migration fee amount provided during the contract takeover.",
"items": {
"id": "urn:jsonschema:migrationFeeDetails",
"properties": {
"migrationFeeProperty": {
"type": "string",
"description": "Indicates the fee or cost property from Arrangement contract taken over into IFRS9."
},
"migrationFeeAmount": {
"type": "string",
"description": "Indicates the charge amounts from Arrangement contract takenover into IFRS9."
}
}
}
}
}
}
},
"cashflowEventInformation": {
"type": "array",
"description": "Contains the event information based on the amendment made to the cash flow. Possible values are DISBURSE, REPAY, SUSPEND, RESUME, PRODUCT-CHANGE, PRINCIPAL-CHANGE, TAKEOVER-PERFORMING, TAKEOVER-SUSPEND.",
"items": {
"id": "urn:jsonschema:cashflowEventInformation",
"properties": {
"activityIds": {
"type": "array",
"description": "Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE",
"items": {
"id": "urn:jsonschema:activityIds",
"properties": {
"activityId": {
"type": "string",
"description": "Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"
}
}
}
}
}
}
},
"cashflowChargeOffInformation": {
"type": "array",
"description": "Contains the charge off information of the contract like charge off type, chager off amount, charge off operation which are used under (FASB)Financial Accounting Standard Board regulation.",
"items": {
"id": "urn:jsonschema:cashflowChargeOffInformation",
"properties": {
"chargeOffOperation": {
"type": "string",
"description": "Indicates the charge off operation performed on the contract. Possible values are CHARGE.OFF, CHARGE.OFF.INCREASE, CHARGE.OFF.DECREASE, RECOVERY, WRITE.OFF, PARTIAL.WRITE.OFF."
},
"chargeoffAmount": {
"type": "string",
"description": "Indicates the charged off amount of a loan under (FASB)Financial Accounting Standard Board regulation"
},
"cashflowIndicator": {
"type": "string",
"description": "Indicates whether the activity is cash flow type of activity or not. Possible values are YES and NO."
},
"chargeOffIndicator": {
"type": "string",
"description": "Indicates whether a loan is charged off fully or partially for FASB. Possible values include FULL,PARTIAL. Also stores value as YES, when contract is charged off, which follows IFRS alone and not (FASB) Financial Accounting Standard Board regulation"
},
"arrangementActivityId": {
"type": "string",
"description": "The unique identifier of an arrangement activity"
},
"reversalIndicator": {
"type": "string",
"description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
},
"masterArrangementId": {
"type": "string",
"description": "The unique identifier to specify an arrangement reference which is act as a Master for the arrangement being created."
}
}
}
},
"cashflowInformation": {
"type": "array",
"description": "Contains the cash flow information like cashflow date, cashflow amount, cashflow type to update the cash movements (in and out) of the contract.",
"items": {
"id": "urn:jsonschema:cashflowInformation",
"properties": {
"cashflowDate": {
"type": "string",
"description": "Indicates the cashflow dates corresponding to cashflow type and cashflow amount during the entire lifecycle of the contract "
},
"cashflowAmount": {
"type": "string",
"description": "Indicates the cashflow amount corresponding to the cashflow type and cashflow date. For example, if there is a disbursement, the cashflow is shown as negative -5000 and if there is a recovery the cashflow is shown as positive +5000"
},
"cashflowType": {
"type": "string",
"description": "Indicates the type of cashflow. Examples are principal, interest, commission, fees, charges"
},
"excludeEirs": {
"type": "array",
"description": "Indicates whether the Effective Interest Rate (EIR) should be calculated for the contract cash flow or not.",
"items": {
"id": "urn:jsonschema:excludeEirs",
"properties": {
"excludeEir": {
"type": "string",
"description": "Indicates whether the Effective Interest Rate (EIR) should be calculated for the contract cash flow or not."
}
}
}
},
"excludeApr": {
"type": "string",
"description": "Indicates whether the Annual Percentage Rate (APR) should be excluded for the particular cashflow date or not."
}
}
}
}
}