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