PaymentPlanPolicy Data Type

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

Example

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