AssetFlow
Type CDM 7.2.0Specifies an asset flow, i.e. the outcome of either of computation (e.g. interest accrual) or an assessment of some sort. The asset flow can then be turned into an asset transfer artefact to be used as the input to a payment system or the outcome of it. The associated globalKey denotes the ability to associate a hash value to the AssetFlow instantiations for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.
Attributes
2 declared on AssetFlow, 4 inherited. Cardinality in amber is required.
| Name | Type | Card. | Description | From |
|---|---|---|---|---|
| quantity | NonNegativeQuantity | 1..1 | Represents the amount of the asset to be transferred. The cashflow amount is always a positive number, as the cashflow direction is implied by the payer/receiver attribute. | AssetFlowBase |
| asset | Asset | 1..1 | Represents the object that is subject to the transfer, it could be an asset or a reference. | AssetFlowBase |
| settlementDate | AdjustableOrAdjustedOrRelativeDate | 1..1 | Represents the date on which the transfer to due. | AssetFlowBase |
| paymentDiscounting | PaymentDiscounting | 0..1 | FpML specifies the FpML PaymentDiscounting.model group for representing the discounting elements that can be associated with a payment. | AssetFlowBase |
| payerReceiver | PayerReceiver | 1..1 | Specifies who pays / receives the asset flow, through a normalised Party1 / Party2 enumerator. | — |
| assetFlowType | ScheduledTransferEnum | 0..1 | Type of asset flow corresponding to a scheduled event. | — |
Functions
Model functions that produce or consume this type. These are the CDM's own behaviour — the logic a correct implementation has to match.
| Function | Role | Description |
|---|---|---|
| Create_AssetFlowFromSettlementPayout | returns | Generates two opposite cashflows that correspond to a settlement payout. One leg is the asset leg, that settles the asset according to the quantity, direction and date defined in the settlement payout. The other is the price leg, that settles the price as a currency amount going in the opposite direction. The function's applicability is limited on purpose to a single asset with a single price and quantity specified. |
Open AssetFlow in the Model Browser
Walk the tree and the reference graph interactively, and switch releases to see how the type has changed. Free, no signup.