name | data type | constraints | description |
---|---|---|---|
appendGeneratedCode | boolean | ||
transient | boolean | ||
auditable | Auditable | ||
descriptionOrCode | string | ||
id | number | ||
notified | boolean | ||
dunningLevelInstance | DunningLevelInstance | ||
referenceCode | string | ||
referenceDescription | string | ||
parentEntity | BusinessEntity | ||
codeChanged | boolean | ||
historized | boolean | ||
actionType | ActionTypeEnum | ||
code | string | required, max size: 255, min size: 1 | |
parentEntityType | object | ||
dunningAction | DunningAction | ||
descriptionAndCode | string | ||
version | number | ||
actionStatus | DunningActionInstanceStatusEnum | ||
collectionPlan | DunningCollectionPlan | ||
auditableFields | array of AuditableFieldHistory | ||
actionMode | ActionModeEnum | ||
actionRestult | string | ||
actionOwner | DunningAgent | ||
description | string | max size: 255, min size: 0 |
Example
{ "appendGeneratedCode" : true, "transient" : true, "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "descriptionOrCode" : "...", "id" : 12345, "notified" : true, "dunningLevelInstance" : { "collectionPlanStatus" : { "dunningSettings" : { }, "version" : 12345, "historized" : true, "auditable" : { }, "colorCode" : "...", "status" : "SUCCESS", "description" : "...", "transient" : true, "notified" : true, "auditableFields" : [ { }, { } ], "id" : 12345 }, "historized" : true, "sequence" : 12345, "daysOverdue" : 12345, "actions" : [ { "appendGeneratedCode" : true, "transient" : true, "auditable" : { }, "descriptionOrCode" : "...", "id" : 12345, "notified" : true, "dunningLevelInstance" : { }, "referenceCode" : "...", "referenceDescription" : "...", "parentEntity" : { }, "codeChanged" : true, "historized" : true, "actionType" : "SEND_NOTIFICATION", "code" : "...", "parentEntityType" : { }, "dunningAction" : { }, "descriptionAndCode" : "...", "version" : 12345, "actionStatus" : "DONE", "collectionPlan" : { }, "auditableFields" : [ { }, { } ], "actionMode" : "AUTOMATIC", "actionRestult" : "...", "actionOwner" : { }, "description" : "..." }, { "appendGeneratedCode" : true, "transient" : true, "auditable" : { }, "descriptionOrCode" : "...", "id" : 12345, "notified" : true, "dunningLevelInstance" : { }, "referenceCode" : "...", "referenceDescription" : "...", "parentEntity" : { }, "codeChanged" : true, "historized" : true, "actionType" : "RETRY_PAYMENT", "code" : "...", "parentEntityType" : { }, "dunningAction" : { }, "descriptionAndCode" : "...", "version" : 12345, "actionStatus" : "DONE", "collectionPlan" : { }, "auditableFields" : [ { }, { } ], "actionMode" : "AUTOMATIC", "actionRestult" : "...", "actionOwner" : { }, "description" : "..." } ], "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "id" : 12345, "version" : 12345, "levelStatus" : "TO_BE_DONE", "notified" : true, "transient" : true, "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "OTHER", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "STATUS", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "collectionPlan" : { "historized" : true, "nextAction" : "...", "transient" : true, "startDate" : 12345, "dunningLevelInstances" : [ { }, { } ], "initialCollectionPlan" : { }, "stopReason" : { }, "pauseDuration" : 12345, "relatedPolicy" : { }, "totalDunningLevels" : 12345, "notified" : true, "status" : { }, "nextActionDate" : 12345, "daysOpen" : 12345, "pauseReason" : { }, "retryPaymentOnResumeDate" : true, "auditableFields" : [ { }, { } ], "lastActionDate" : 12345, "currentDunningLevelSequence" : 12345, "version" : 12345, "balance" : 12345.0, "closeDate" : 12345, "auditable" : { }, "pausedUntilDate" : 12345, "collectionPlanNumber" : "...", "billingAccount" : { }, "relatedInvoice" : { }, "id" : 12345, "lastAction" : "..." }, "dunningLevel" : { "daysOverdue" : 12345, "id" : 12345, "version" : 12345, "auditable" : { }, "description" : "...", "parentEntity" : { }, "transient" : true, "historized" : true, "softDecline" : true, "minBalance" : 12345.0, "dunningActions" : [ { }, { } ], "appendGeneratedCode" : true, "descriptionAndCode" : "...", "referenceDescription" : "...", "reminder" : true, "chargeType" : "PERCENTAGE", "parentEntityType" : { }, "codeChanged" : true, "minBalanceCurrency" : { }, "auditableFields" : [ { }, { } ], "chargeValue" : 12345.0, "referenceCode" : "...", "chargeCurrency" : { }, "relatedPolicies" : [ { }, { } ], "code" : "...", "notified" : true, "active" : true, "descriptionOrCode" : "...", "endOfDunningLevel" : true } }, "referenceCode" : "...", "referenceDescription" : "...", "parentEntity" : { "descriptionOrCode" : "...", "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "RENEWAL", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "RENEWAL", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "version" : 12345, "historized" : true, "appendGeneratedCode" : true, "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "parentEntity" : { }, "parentEntityType" : { }, "description" : "...", "referenceDescription" : "...", "codeChanged" : true, "referenceCode" : "...", "code" : "...", "transient" : true, "descriptionAndCode" : "...", "id" : 12345, "notified" : true }, "codeChanged" : true, "historized" : true, "actionType" : "RETRY_PAYMENT", "code" : "...", "parentEntityType" : { }, "dunningAction" : { "code" : "...", "codeChanged" : true, "actionNotificationTemplate" : { "descriptionAndCode" : "...", "historized" : true, "type" : "OTHER", "version" : 12345, "descriptionOrCode" : "...", "transient" : true, "description" : "...", "auditable" : { }, "textContent" : "...", "notified" : true, "media" : "FTP_FILE", "referenceDescription" : "...", "id" : 12345, "codeChanged" : true, "tagStartDelimiter" : "...", "auditableFields" : [ { }, { } ], "startDate" : 12345, "parentEntity" : { }, "appendGeneratedCode" : true, "code" : "...", "subject" : "...", "endDate" : 12345, "htmlContent" : "...", "parentEntityType" : { }, "tagEndDelimiter" : "...", "referenceCode" : "..." }, "actionChannel" : "CERTIFIED_LETTER", "parentEntityType" : { }, "description" : "...", "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "OTHER", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "STATUS", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "relatedLevels" : [ { "daysOverdue" : 12345, "id" : 12345, "version" : 12345, "auditable" : { }, "description" : "...", "parentEntity" : { }, "transient" : true, "historized" : true, "softDecline" : true, "minBalance" : 12345.0, "dunningActions" : [ { }, { } ], "appendGeneratedCode" : true, "descriptionAndCode" : "...", "referenceDescription" : "...", "reminder" : true, "chargeType" : "PERCENTAGE", "parentEntityType" : { }, "codeChanged" : true, "minBalanceCurrency" : { }, "auditableFields" : [ { }, { } ], "chargeValue" : 12345.0, "referenceCode" : "...", "chargeCurrency" : { }, "relatedPolicies" : [ { }, { } ], "code" : "...", "notified" : true, "active" : true, "descriptionOrCode" : "...", "endOfDunningLevel" : true }, { "daysOverdue" : 12345, "id" : 12345, "version" : 12345, "auditable" : { }, "description" : "...", "parentEntity" : { }, "transient" : true, "historized" : true, "softDecline" : true, "minBalance" : 12345.0, "dunningActions" : [ { }, { } ], "appendGeneratedCode" : true, "descriptionAndCode" : "...", "referenceDescription" : "...", "reminder" : true, "chargeType" : "FLAT_AMOUNT", "parentEntityType" : { }, "codeChanged" : true, "minBalanceCurrency" : { }, "auditableFields" : [ { }, { } ], "chargeValue" : 12345.0, "referenceCode" : "...", "chargeCurrency" : { }, "relatedPolicies" : [ { }, { } ], "code" : "...", "notified" : true, "active" : true, "descriptionOrCode" : "...", "endOfDunningLevel" : true } ], "assignedTo" : { "agentEmailItem" : "...", "dunningSettings" : { }, "agentFirstNameItem" : "...", "collectionAgency" : "...", "auditable" : { }, "transient" : true, "version" : 12345, "external" : true, "id" : 12345, "historized" : true, "auditableFields" : [ { }, { } ], "agentLastNameItem" : "...", "notified" : true }, "actionMode" : "MANUAL", "referenceDescription" : "...", "attachOverdueInvoices" : true, "actionType" : "SCRIPT", "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "version" : 12345, "historized" : true, "parentEntity" : { "descriptionOrCode" : "...", "auditableFields" : [ { }, { } ], "version" : 12345, "historized" : true, "appendGeneratedCode" : true, "auditable" : { }, "parentEntity" : { }, "parentEntityType" : { }, "description" : "...", "referenceDescription" : "...", "codeChanged" : true, "referenceCode" : "...", "code" : "...", "transient" : true, "descriptionAndCode" : "...", "id" : 12345, "notified" : true }, "scriptInstance" : { "id" : 12345, "appendGeneratedCode" : true, "parentEntityType" : { }, "referenceCode" : "...", "sourcingRoles" : [ "...", "..." ], "active" : true, "descriptionAndCode" : "...", "script" : "...", "description" : "...", "codeChanged" : true, "referenceDescription" : "...", "code" : "...", "error" : true, "sourceTypeEnum" : "JAVA_CLASS", "version" : 12345, "descriptionOrCode" : "...", "reuse" : true, "executionRoles" : [ "...", "..." ], "parentEntity" : { }, "scriptInstanceCategory" : { }, "scriptErrors" : [ { }, { } ], "notified" : true, "disabled" : true, "transient" : true, "auditableFields" : [ { }, { } ], "auditable" : { }, "historized" : true }, "appendGeneratedCode" : true, "id" : 12345, "activeAction" : true, "referenceCode" : "...", "descriptionAndCode" : "...", "transient" : true, "attachDueInvoices" : true, "descriptionOrCode" : "...", "notified" : true }, "descriptionAndCode" : "...", "version" : 12345, "actionStatus" : "TO_BE_DONE", "collectionPlan" : { "historized" : true, "nextAction" : "...", "transient" : true, "startDate" : 12345, "dunningLevelInstances" : [ { "collectionPlanStatus" : { }, "historized" : true, "sequence" : 12345, "daysOverdue" : 12345, "actions" : [ { }, { } ], "auditable" : { }, "id" : 12345, "version" : 12345, "levelStatus" : "TO_BE_DONE", "notified" : true, "transient" : true, "auditableFields" : [ { }, { } ], "collectionPlan" : { }, "dunningLevel" : { } }, { "collectionPlanStatus" : { }, "historized" : true, "sequence" : 12345, "daysOverdue" : 12345, "actions" : [ { }, { } ], "auditable" : { }, "id" : 12345, "version" : 12345, "levelStatus" : "TO_BE_DONE", "notified" : true, "transient" : true, "auditableFields" : [ { }, { } ], "collectionPlan" : { }, "dunningLevel" : { } } ], "initialCollectionPlan" : { }, "stopReason" : { "auditableFields" : [ { }, { } ], "historized" : true, "version" : 12345, "transient" : true, "auditable" : { }, "dunningSettings" : { }, "id" : 12345, "notified" : true, "description" : "...", "stopReason" : "..." }, "pauseDuration" : 12345, "relatedPolicy" : { "id" : 12345, "includePayReminder" : true, "active" : true, "policyPriority" : 12345, "historized" : true, "minBalanceTrigger" : 12345.0, "minBalanceTriggerCurrency" : { }, "dunningLevels" : [ { }, { } ], "auditable" : { }, "version" : 12345, "isDefaultPolicy" : true, "attachInvoicesToEmails" : true, "totalDunningLevels" : 12345, "transient" : true, "includeDueInvoicesInThreshold" : true, "determineLevelBy" : "DAYS_OVERDUE_OR_BALANCE_THRESHOLD", "interestForDelaySequence" : 12345, "policyDescription" : "...", "disabled" : true, "isActivePolicy" : true, "auditableFields" : [ { }, { } ], "notified" : true, "dunningPolicyRules" : [ { }, { } ], "policyName" : "..." }, "totalDunningLevels" : 12345, "notified" : true, "status" : { "dunningSettings" : { }, "version" : 12345, "historized" : true, "auditable" : { }, "colorCode" : "...", "status" : "PAUSED", "description" : "...", "transient" : true, "notified" : true, "auditableFields" : [ { }, { } ], "id" : 12345 }, "nextActionDate" : 12345, "daysOpen" : 12345, "pauseReason" : { "transient" : true, "auditable" : { }, "dunningSettings" : { }, "id" : 12345, "pauseReason" : "...", "description" : "...", "historized" : true, "version" : 12345, "auditableFields" : [ { }, { } ], "notified" : true }, "retryPaymentOnResumeDate" : true, "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "OTHER", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "STATUS", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "lastActionDate" : 12345, "currentDunningLevelSequence" : 12345, "version" : 12345, "balance" : 12345.0, "closeDate" : 12345, "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "pausedUntilDate" : 12345, "collectionPlanNumber" : "...", "billingAccount" : { "invoicePrefix" : "...", "jobTitle" : "...", "billingCycle" : { }, "paymentMethod" : { }, "vatNo" : "...", "taxCategoryResolved" : { }, "invoices" : [ { }, { } ], "minimumInvoiceSubCategory" : { }, "businessAccountModel" : { }, "parentEntity" : { }, "name" : { }, "notified" : true, "usersAccounts" : [ { }, { } ], "parentEntityType" : { }, "brAmountWithoutTax" : 12345.0, "terminationDate" : 12345, "contracts" : [ { }, { } ], "discountRate" : 12345.0, "totalInvoicingAmountWithTax" : 12345.0, "auditableFields" : [ { }, { } ], "isCompany" : true, "mailingType" : "BATCH", "totalInvoicingAmountWithoutTax" : 12345.0, "discountPlan" : { }, "appendGeneratedCode" : true, "nextInvoiceDate" : 12345, "counters" : { "property1" : { }, "property2" : { } }, "customerAccount" : { }, "referenceDescription" : "...", "referenceCode" : "...", "minimumArticle" : { }, "brAmountWithTax" : 12345.0, "taxCategory" : { }, "descriptionOrCode" : "...", "discountPlanInstances" : [ { }, { } ], "uuid" : "...", "primaryContact" : { }, "contactInformationNullSafe" : { }, "auditable" : { }, "ccedEmails" : "...", "id" : 12345, "code" : "...", "parentCFEntities" : [ { }, { } ], "tradingLanguage" : { }, "externalRef1" : "...", "parentUserAccounts" : [ { }, { } ], "minimumLabelEl" : "...", "transient" : true, "minimumAmountEl" : "...", "terminationReason" : { }, "cfValues" : { }, "seller" : { }, "providerContact" : "...", "totalInvoicingAmountTax" : 12345.0, "historized" : true, "externalRef2" : "...", "version" : 12345, "codeChanged" : true, "cfAccumulatedValues" : { }, "minRatedTransactions" : [ { }, { } ], "registrationNo" : "...", "contactInformation" : { }, "checkThreshold" : "POSITIVE_IL", "electronicBilling" : true, "address" : { }, "tradingCountry" : { }, "emailTemplate" : { }, "accountType" : "...", "description" : "...", "status" : "CANCELED", "statusDate" : 12345, "exoneratedFromtaxes" : true, "defaultLevel" : true, "billingRun" : { }, "thresholdPerEntity" : true, "legalEntityType" : { }, "descriptionAndCode" : "...", "minInvoiceLines" : [ { }, { } ], "allDiscountPlanInstances" : [ { }, { } ], "tags" : [ { }, { } ], "minimumChargeTemplate" : { }, "tradingCurrency" : { }, "subscriptionDate" : 12345, "invoicingThreshold" : 12345.0 }, "relatedInvoice" : { "newInvoicingProcess" : true, "code" : "...", "comment" : "...", "temporaryInvoiceNumber" : "...", "xmlDate" : 12345, "status" : "REJECTED", "historized" : true, "invoiceLines" : [ { }, { } ], "transient" : true, "tradingCountry" : { }, "linkedInvoices" : [ { }, { } ], "invoiceNumberOrTemporaryNumber" : "...", "id" : 12345, "hasMinimum" : true, "hasDiscounts" : true, "netToPay" : 12345.0, "quote" : { }, "adjustedInvoice" : { }, "uuid" : "...", "subscription" : { }, "productDate" : 12345, "cfValues" : { }, "paymentStatusDate" : 12345, "recordedInvoice" : { }, "hasTaxes" : true, "appliedRate" : 12345.0, "convertedAmountWithoutTax" : 12345.0, "pdfFilename" : "...", "realTimeStatus" : "ABANDONED", "amountTax" : 12345.0, "draftRatedTransactions" : [ { }, { } ], "convertedDiscountAmount" : 12345.0, "xmlFilenameOnly" : "...", "draftInvoiceLines" : [ { }, { } ], "invoiceDate" : 12345, "convertedAmountWithoutTaxBeforeDiscount" : 12345.0, "iban" : "...", "lastAppliedRateDate" : 12345, "seller" : { }, "invoiceBalance" : 12345.0, "dontSend" : true, "description" : "...", "amount" : 12345.0, "paymentMethodType" : "STRIPE", "tradingCurrency" : { }, "endDate" : 12345, "discountAmount" : 12345.0, "statusDate" : 12345, "cfAccumulatedValues" : { }, "amountWithTax" : 12345.0, "lastAppliedRate" : 12345.0, "externalRef" : "...", "discount" : 12345.0, "amountWithoutTaxBeforeDiscount" : 12345.0, "tradingLanguage" : { }, "paymentMethod" : { }, "draft" : true, "pdfFilenameOnly" : "...", "openOrderNumber" : "...", "commercialOrder" : { }, "notified" : true, "paymentPlan" : { }, "rejectReason" : "...", "useCurrentRate" : true, "pdfDate" : 12345, "prepaid" : true, "invoiceAdjustmentCurrentProviderNb" : 12345, "relatedDunningCollectionPlan" : { }, "invoiceNumber" : "...", "rawAmount" : 12345.0, "invoiceAgregates" : [ { }, { } ], "alreadySent" : true, "auditableFields" : [ { }, { } ], "alreadyAppliedMinimum" : true, "dueDate" : 12345, "billingRun" : { }, "alias" : "...", "amountWithoutTax" : 12345.0, "convertedAmountTax" : 12345.0, "alreadyAddedDiscount" : true, "dueBalance" : 12345.0, "startDate" : 12345, "xmlFilename" : "...", "convertedRawAmount" : 12345.0, "billingAccount" : { }, "cpqQuote" : { }, "reminderLevelTriggered" : true, "invoiceAdjustmentCurrentSellerNb" : 12345, "parentCFEntities" : [ { }, { } ], "previousInvoiceNumber" : "...", "discountPlan" : { }, "auditable" : { }, "order" : { }, "paymentStatus" : "PENDING_PLAN", "dunningCollectionPlanTriggered" : true, "invoiceType" : { }, "emailSentDate" : 12345, "discountRate" : 12345.0, "discountAgregates" : [ { }, { } ], "detailedInvoice" : true, "version" : 12345, "orders" : [ { }, { } ], "initialCollectionDate" : 12345, "convertedNetToPay" : 12345.0, "convertedAmountWithTax" : 12345.0 }, "id" : 12345, "lastAction" : "..." }, "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "OTHER", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "OTHER", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "actionMode" : "MANUAL", "actionRestult" : "...", "actionOwner" : { "agentEmailItem" : "...", "dunningSettings" : { "code" : "...", "auditable" : { }, "dunningCollectionPlanStatuses" : [ { }, { } ], "auditableFields" : [ { }, { } ], "version" : 12345, "transient" : true, "dunningAgents" : [ { }, { } ], "historized" : true, "descriptionOrCode" : "...", "dunningStopReasons" : [ { }, { } ], "referenceDescription" : "...", "description" : "...", "dunningMode" : "INVOICE_LEVEL", "accountingArticle" : { }, "id" : 12345, "dunningPaymentRetries" : [ { }, { } ], "maxDaysOutstanding" : 12345, "referenceCode" : "...", "applyDunningChargeFxExchangeRate" : true, "interestForDelayRate" : 12345.0, "dunningPauseReasons" : [ { }, { } ], "parentEntityType" : { }, "allowDunningCharges" : true, "maxDunningLevels" : 12345, "codeChanged" : true, "parentEntity" : { }, "allowInterestForDelay" : true, "descriptionAndCode" : "...", "notified" : true, "appendGeneratedCode" : true }, "agentFirstNameItem" : "...", "collectionAgency" : "...", "auditable" : { "lastModified" : 12345, "updated" : 12345, "updater" : "...", "created" : 12345, "creator" : "...", "lastUser" : "..." }, "transient" : true, "version" : 12345, "external" : true, "id" : 12345, "historized" : true, "auditableFields" : [ { "historized" : true, "notified" : true, "auditType" : "RENEWAL", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } }, { "historized" : true, "notified" : true, "auditType" : "RENEWAL", "historable" : true, "fieldName" : "...", "currentState" : { }, "notfiable" : true, "previousState" : { } } ], "agentLastNameItem" : "...", "notified" : true }, "description" : "..." }