PaymentPlanPolicy Data Type

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

Example

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