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