{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$anchor": "cdm.product.common.settlement",
  "type": "object",
  "title": "Cashflow",
  "description": "Class to specify a cashflow, i.e. the outcome of either of computation (e.g. interest accrual) or an assessment of some sort (e.g. a fee). The cashflow can then be turned into a cash 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 Cashflow instantiations for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.",
  "properties": {
    "quantity": {
      "description": "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.",
      "$ref": "cdm-base-math-NonNegativeQuantity.schema.json"
    },
    "asset": {
      "description": "Represents the object that is subject to the transfer, it could be an asset or a reference.",
      "$ref": "cdm-base-staticdata-asset-common-Asset.schema.json"
    },
    "settlementDate": {
      "description": "Represents the date on which the transfer to due.",
      "$ref": "cdm-base-datetime-AdjustableOrAdjustedOrRelativeDate.schema.json"
    },
    "payerReceiver": {
      "description": "Specifies who pays / receives the cashflow, though a normalised Party1 / Party2 enumerator.",
      "$ref": "cdm-base-staticdata-party-PayerReceiver.schema.json"
    },
    "cashflowType": {
      "description": "The qualification of the type of cashflow, e.g. brokerage fee, premium, upfront fee etc. Particularly relevant when it cannot be inferred directly through lineage.",
      "$ref": "cdm-product-common-settlement-CashflowType.schema.json"
    },
    "paymentDiscounting": {
      "description": "FpML specifies the FpML PaymentDiscounting.model group for representing the discounting elements that can be associated with a payment.",
      "$ref": "cdm-product-common-settlement-PaymentDiscounting.schema.json"
    }
  },
  "required": [
    "payerReceiver",
    "cashflowType"
  ]
}