PaymentPlanPolicy Data Type

Implemented Interfaces
Serializable
Properties
name data type description
defaultFeePerInstallmentPlan number
defaultInstallmentCount number
allowCustomInstallmentPlan boolean
defaultInterestRate number
installmentAmountRounding number
allowedCreditCategories array of CreditCategory
dunningDefaultPauseReason DunningPauseReason
theresHoldForApproval number
maxAllowedReceivableAmount number
addInstallmentFee boolean
actionOnRemainingAmount ActionOnRemainingAmountEnum
minAllowedReceivableAmount number
defaultBlockPayments boolean
maxPaymentPlanDuration number
clearingPriority ClearingPriorityEnum
minInstallmentAmount number
splitEvenly boolean
defaultStartingDateOfPlan DefaultStartingDateOfPlan
addInterestRate boolean
allowedPaymentMethods array of PaymentMethodEnum
requireInternalApproval boolean
defaultRecurrenceUnit RecurrenceUnitEnum

Example

{
  "defaultFeePerInstallmentPlan" : 12345,
  "defaultInstallmentCount" : 12345,
  "allowCustomInstallmentPlan" : true,
  "defaultInterestRate" : 12345,
  "installmentAmountRounding" : 12345,
  "allowedCreditCategories" : [ {
    "transient" : true,
    "parentEntityType" : { },
    "descriptionAndCode" : "...",
    "auditableFields" : [ {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "OTHER",
      "fieldName" : "..."
    }, {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "OTHER",
      "fieldName" : "..."
    } ],
    "notified" : true,
    "historized" : true,
    "referenceCode" : "...",
    "descriptionOrCode" : "...",
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "referenceDescription" : "...",
    "parentEntity" : {
      "auditable" : { },
      "descriptionAndCode" : "...",
      "descriptionOrCode" : "...",
      "auditableFields" : [ { }, { } ],
      "version" : 12345,
      "parentEntityType" : { },
      "historized" : true,
      "referenceDescription" : "...",
      "referenceCode" : "...",
      "id" : 12345,
      "parentEntity" : { },
      "code" : "...",
      "codeChanged" : true,
      "description" : "...",
      "transient" : true,
      "notified" : true,
      "appendGeneratedCode" : true
    },
    "code" : "...",
    "appendGeneratedCode" : true,
    "id" : 12345,
    "version" : 12345,
    "codeChanged" : true,
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "creator" : "...",
      "updater" : "..."
    },
    "provider" : {
      "language" : { },
      "invoiceConfiguration" : { },
      "displayFreeTransacInInvoice" : true,
      "id" : 12345,
      "invoiceRoundingMode" : "DOWN",
      "multicurrencyFlag" : true,
      "country" : { },
      "description" : "...",
      "entreprise" : true,
      "multicountryFlag" : true,
      "userAccount" : { },
      "email" : "...",
      "customerNoSequence" : { },
      "parentCFEntities" : [ { }, { } ],
      "active" : true,
      "paymentPlan" : true,
      "bankCoordinates" : { },
      "gdprConfiguration" : { },
      "invoiceRounding" : 12345,
      "cdrDeduplicationKeyEL" : "...",
      "paymentPlanPolicy" : { },
      "discountAccountingCode" : "...",
      "multilanguageFlag" : true,
      "paymentDeferral" : true,
      "auditable" : { },
      "currentMatchingCode" : "...",
      "cfValues" : { },
      "activateCascadingDiscounts" : true,
      "customer" : { },
      "interBankTitle" : { },
      "notified" : true,
      "disabled" : true,
      "version" : 12345,
      "transient" : true,
      "maximumDeferralPerInvoice" : 12345,
      "maximumDelay" : 12345,
      "code" : "...",
      "rounding" : 12345,
      "gdprConfigurationNullSafe" : { },
      "auditableFields" : [ { }, { } ],
      "levelDuplication" : true,
      "uuid" : "...",
      "billingAccount" : { },
      "currency" : { },
      "paymentMethods" : [ "DIRECTDEBIT", "CARD" ],
      "cfAccumulatedValues" : { },
      "roundingMode" : "UP",
      "functionalCurrencyFlag" : true,
      "invoiceConfigurationOrDefault" : { },
      "rumSequence" : { },
      "amountValidation" : true,
      "recognizeRevenue" : true,
      "automaticInvoicing" : true,
      "customerAccount" : { },
      "portalMessage" : "...",
      "currentProvider" : true,
      "historized" : true,
      "prepaidReservationExpirationDelayinMillisec" : 12345
    },
    "description" : "..."
  }, {
    "transient" : true,
    "parentEntityType" : { },
    "descriptionAndCode" : "...",
    "auditableFields" : [ {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "STATUS",
      "fieldName" : "..."
    }, {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "STATUS",
      "fieldName" : "..."
    } ],
    "notified" : true,
    "historized" : true,
    "referenceCode" : "...",
    "descriptionOrCode" : "...",
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "referenceDescription" : "...",
    "parentEntity" : {
      "auditable" : { },
      "descriptionAndCode" : "...",
      "descriptionOrCode" : "...",
      "auditableFields" : [ { }, { } ],
      "version" : 12345,
      "parentEntityType" : { },
      "historized" : true,
      "referenceDescription" : "...",
      "referenceCode" : "...",
      "id" : 12345,
      "parentEntity" : { },
      "code" : "...",
      "codeChanged" : true,
      "description" : "...",
      "transient" : true,
      "notified" : true,
      "appendGeneratedCode" : true
    },
    "code" : "...",
    "appendGeneratedCode" : true,
    "id" : 12345,
    "version" : 12345,
    "codeChanged" : true,
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "creator" : "...",
      "updater" : "..."
    },
    "provider" : {
      "language" : { },
      "invoiceConfiguration" : { },
      "displayFreeTransacInInvoice" : true,
      "id" : 12345,
      "invoiceRoundingMode" : "DOWN",
      "multicurrencyFlag" : true,
      "country" : { },
      "description" : "...",
      "entreprise" : true,
      "multicountryFlag" : true,
      "userAccount" : { },
      "email" : "...",
      "customerNoSequence" : { },
      "parentCFEntities" : [ { }, { } ],
      "active" : true,
      "paymentPlan" : true,
      "bankCoordinates" : { },
      "gdprConfiguration" : { },
      "invoiceRounding" : 12345,
      "cdrDeduplicationKeyEL" : "...",
      "paymentPlanPolicy" : { },
      "discountAccountingCode" : "...",
      "multilanguageFlag" : true,
      "paymentDeferral" : true,
      "auditable" : { },
      "currentMatchingCode" : "...",
      "cfValues" : { },
      "activateCascadingDiscounts" : true,
      "customer" : { },
      "interBankTitle" : { },
      "notified" : true,
      "disabled" : true,
      "version" : 12345,
      "transient" : true,
      "maximumDeferralPerInvoice" : 12345,
      "maximumDelay" : 12345,
      "code" : "...",
      "rounding" : 12345,
      "gdprConfigurationNullSafe" : { },
      "auditableFields" : [ { }, { } ],
      "levelDuplication" : true,
      "uuid" : "...",
      "billingAccount" : { },
      "currency" : { },
      "paymentMethods" : [ "CASH", "WIRETRANSFER" ],
      "cfAccumulatedValues" : { },
      "roundingMode" : "HALF_EVEN",
      "functionalCurrencyFlag" : true,
      "invoiceConfigurationOrDefault" : { },
      "rumSequence" : { },
      "amountValidation" : true,
      "recognizeRevenue" : true,
      "automaticInvoicing" : true,
      "customerAccount" : { },
      "portalMessage" : "...",
      "currentProvider" : true,
      "historized" : true,
      "prepaidReservationExpirationDelayinMillisec" : 12345
    },
    "description" : "..."
  } ],
  "dunningDefaultPauseReason" : {
    "version" : 12345,
    "dunningSettings" : {
      "parentEntity" : { },
      "code" : "...",
      "id" : 12345,
      "dunningPaymentRetries" : [ { }, { } ],
      "version" : 12345,
      "auditableFields" : [ { }, { } ],
      "transient" : true,
      "dunningMode" : "CUSTOMER_LEVEL",
      "dunningStopReasons" : [ { }, { } ],
      "dunningPauseReasons" : [ { }, { } ],
      "descriptionOrCode" : "...",
      "referenceCode" : "...",
      "maxDunningLevels" : 12345,
      "historized" : true,
      "allowInterestForDelay" : true,
      "dunningAgents" : [ { }, { } ],
      "codeChanged" : true,
      "interestForDelayRate" : 12345.0,
      "notified" : true,
      "descriptionAndCode" : "...",
      "description" : "...",
      "auditable" : { },
      "parentEntityType" : { },
      "appendGeneratedCode" : true,
      "maxDaysOutstanding" : 12345,
      "applyDunningChargeFxExchangeRate" : true,
      "dunningCollectionPlanStatuses" : [ { }, { } ],
      "allowDunningCharges" : true,
      "referenceDescription" : "...",
      "accountingArticle" : { }
    },
    "description" : "...",
    "auditableFields" : [ {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "OTHER",
      "fieldName" : "..."
    }, {
      "notfiable" : true,
      "previousState" : { },
      "historized" : true,
      "historable" : true,
      "currentState" : { },
      "notified" : true,
      "auditType" : "RENEWAL",
      "fieldName" : "..."
    } ],
    "notified" : true,
    "historized" : true,
    "id" : 12345,
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "creator" : "...",
      "updater" : "..."
    },
    "transient" : true,
    "pauseReason" : "..."
  },
  "theresHoldForApproval" : 12345.0,
  "maxAllowedReceivableAmount" : 12345.0,
  "addInstallmentFee" : true,
  "actionOnRemainingAmount" : "ADDITIONAL",
  "minAllowedReceivableAmount" : 12345.0,
  "defaultBlockPayments" : true,
  "maxPaymentPlanDuration" : 12345,
  "clearingPriority" : "OLDEST",
  "minInstallmentAmount" : 12345.0,
  "splitEvenly" : true,
  "defaultStartingDateOfPlan" : "LAST_DAY_OF_CURRENT_MONTH",
  "addInterestRate" : true,
  "allowedPaymentMethods" : [ "STRIPE", "WIRETRANSFER" ],
  "requireInternalApproval" : true,
  "defaultRecurrenceUnit" : "MONTH"
}