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