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