| name | data type | constraints | description |
|---|---|---|---|
| code | string | required, max size: 255, min size: 1 | |
| descriptionAndCode | string | ||
| descriptionOrCode | string | ||
| failStatus | InvoiceValidationStatusEnum | ||
| historized | boolean | ||
| notified | boolean | ||
| validationScript | ScriptInstance | ||
| referenceCode | string | ||
| id | number | ||
| type | ValidationRuleTypeEnum | ||
| auditableFields | array of AuditableFieldHistory | ||
| validationEL | string | ||
| validTo | number | ||
| referenceDescription | string | ||
| appendGeneratedCode | boolean | ||
| transient | boolean | ||
| validFrom | number | ||
| auditable | Auditable | ||
| parentEntityType | object | ||
| description | string | max size: 255, min size: 0 | |
| parentEntity | BusinessEntity | ||
| invoiceType | InvoiceType | ||
| priority | number | ||
| codeChanged | boolean | ||
| toReorder | boolean | ||
| version | number | ||
| ruleValues | map of string |
Example
{
"code" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"failStatus" : "VALID",
"historized" : true,
"notified" : true,
"validationScript" : {
"referenceCode" : "...",
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"parentEntityType" : { },
"active" : true,
"scriptParameters" : [ {
"id" : 12345,
"allowedValues" : "...",
"valuesSeparator" : "...",
"scriptInstance" : { },
"code" : "...",
"defaultValue" : "...",
"collection" : true,
"className" : "...",
"version" : 12345,
"transient" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"mandatory" : true
}, {
"id" : 12345,
"allowedValues" : "...",
"valuesSeparator" : "...",
"scriptInstance" : { },
"code" : "...",
"defaultValue" : "...",
"collection" : true,
"className" : "...",
"version" : 12345,
"transient" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"mandatory" : true
} ],
"reuse" : true,
"version" : 12345,
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"descriptionOrCode" : "...",
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : { },
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"scriptErrors" : [ {
"sourceFile" : "...",
"lineNumber" : 12345,
"message" : "...",
"columnNumber" : 12345
}, {
"sourceFile" : "...",
"lineNumber" : 12345,
"message" : "...",
"columnNumber" : 12345
} ],
"notified" : true,
"historized" : true,
"descriptionAndCode" : "...",
"sourceTypeEnum" : "JAVA_CLASS",
"id" : 12345,
"referenceDescription" : "...",
"sourcingRoles" : [ "...", "..." ],
"script" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true,
"code" : "...",
"scriptInstanceCategory" : {
"historized" : true,
"auditable" : { },
"parentEntity" : { },
"transient" : true,
"version" : 12345,
"auditableFields" : [ { }, { } ],
"parentEntityType" : { },
"notified" : true,
"referenceDescription" : "...",
"id" : 12345,
"descriptionAndCode" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"descriptionOrCode" : "...",
"appendGeneratedCode" : true
},
"appendGeneratedCode" : true,
"description" : "...",
"codeChanged" : true,
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"error" : true
},
"referenceCode" : "...",
"id" : 12345,
"type" : "SCRIPT",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"validationEL" : "...",
"validTo" : 12345,
"referenceDescription" : "...",
"appendGeneratedCode" : true,
"transient" : true,
"validFrom" : 12345,
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"parentEntityType" : { },
"description" : "...",
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"referenceDescription" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"invoiceType" : {
"occTemplateNegativeCodeEl" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "RENEWAL",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"version" : 12345,
"customInvoiceXmlScriptInstance" : {
"referenceCode" : "...",
"auditable" : { },
"parentEntityType" : { },
"active" : true,
"scriptParameters" : [ { }, { } ],
"reuse" : true,
"version" : 12345,
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"descriptionOrCode" : "...",
"parentEntity" : { },
"scriptErrors" : [ { }, { } ],
"notified" : true,
"historized" : true,
"descriptionAndCode" : "...",
"sourceTypeEnum" : "JAVA_CLASS",
"id" : 12345,
"referenceDescription" : "...",
"sourcingRoles" : [ "...", "..." ],
"script" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true,
"code" : "...",
"scriptInstanceCategory" : { },
"appendGeneratedCode" : true,
"description" : "...",
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"error" : true
},
"occTemplateCodeEl" : "...",
"invoiceValidationScript" : {
"referenceCode" : "...",
"auditable" : { },
"parentEntityType" : { },
"active" : true,
"scriptParameters" : [ { }, { } ],
"reuse" : true,
"version" : 12345,
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"descriptionOrCode" : "...",
"parentEntity" : { },
"scriptErrors" : [ { }, { } ],
"notified" : true,
"historized" : true,
"descriptionAndCode" : "...",
"sourceTypeEnum" : "JAVA",
"id" : 12345,
"referenceDescription" : "...",
"sourcingRoles" : [ "...", "..." ],
"script" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true,
"code" : "...",
"scriptInstanceCategory" : { },
"appendGeneratedCode" : true,
"description" : "...",
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"error" : true
},
"mailingType" : "AUTO",
"uuid" : "...",
"emailTemplate" : {
"referenceDescription" : "...",
"code" : "...",
"tagStartDelimiter" : "...",
"subject" : "...",
"description" : "...",
"referenceCode" : "...",
"translatedSubject" : {
"property1" : "...",
"property2" : "..."
},
"type" : "INVOICE",
"id" : 12345,
"parentEntityType" : { },
"translatedHtmlContent" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true,
"notified" : true,
"codeChanged" : true,
"version" : 12345,
"tagEndDelimiter" : "...",
"descriptionOrCode" : "...",
"htmlContent" : "...",
"startDate" : 12345,
"textContent" : "...",
"translatedTextContent" : {
"property1" : "...",
"property2" : "..."
},
"auditable" : { },
"media" : "CFT_FILE",
"endDate" : 12345,
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"appendGeneratedCode" : true,
"historized" : true,
"descriptionAndCode" : "..."
},
"id" : 12345,
"prefixEL" : "...",
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : { },
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"occTemplate" : {
"parentEntity" : { },
"appendGeneratedCode" : true,
"historized" : true,
"id" : 12345,
"accountCodeClientSide" : "...",
"referenceCode" : "...",
"auditableFields" : [ { }, { } ],
"descriptionOrCode" : "...",
"accountingScheme" : { },
"parentEntityType" : { },
"codeChanged" : true,
"code" : "...",
"transient" : true,
"contraAccountingCode2" : { },
"contraAccountingCode" : { },
"descriptionAndCode" : "...",
"auditable" : { },
"description" : "...",
"manualCreationEnabled" : true,
"referenceDescription" : "...",
"version" : 12345,
"notified" : true,
"journal" : { },
"occCategory" : "CREDIT",
"accountingCode" : { }
},
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"descriptionAndCode" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"code" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"taxScript" : {
"referenceCode" : "...",
"auditable" : { },
"parentEntityType" : { },
"active" : true,
"scriptParameters" : [ { }, { } ],
"reuse" : true,
"version" : 12345,
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"descriptionOrCode" : "...",
"parentEntity" : { },
"scriptErrors" : [ { }, { } ],
"notified" : true,
"historized" : true,
"descriptionAndCode" : "...",
"sourceTypeEnum" : "JAVA_CLASS",
"id" : 12345,
"referenceDescription" : "...",
"sourcingRoles" : [ "...", "..." ],
"script" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true,
"code" : "...",
"scriptInstanceCategory" : { },
"appendGeneratedCode" : true,
"description" : "...",
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"error" : true
},
"xmlFilenameEL" : "...",
"parentEntityType" : { },
"sellerSequence" : [ {
"invoiceType" : { },
"prefixEL" : "...",
"transient" : true,
"id" : { },
"invoiceSequence" : { },
"seller" : { }
}, {
"invoiceType" : { },
"prefixEL" : "...",
"transient" : true,
"id" : { },
"invoiceSequence" : { },
"seller" : { }
} ],
"notified" : true,
"billingTemplateNameEL" : "...",
"invoiceValidationRules" : [ {
"code" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"failStatus" : "REJECTED",
"historized" : true,
"notified" : true,
"validationScript" : { },
"referenceCode" : "...",
"id" : 12345,
"type" : "SCRIPT",
"auditableFields" : [ { }, { } ],
"validationEL" : "...",
"validTo" : 12345,
"referenceDescription" : "...",
"appendGeneratedCode" : true,
"transient" : true,
"validFrom" : 12345,
"auditable" : { },
"parentEntityType" : { },
"description" : "...",
"parentEntity" : { },
"invoiceType" : { },
"priority" : 12345,
"codeChanged" : true,
"toReorder" : true,
"version" : 12345,
"ruleValues" : {
"property1" : "...",
"property2" : "..."
}
}, {
"code" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"failStatus" : "SUSPECT",
"historized" : true,
"notified" : true,
"validationScript" : { },
"referenceCode" : "...",
"id" : 12345,
"type" : "EXPRESSION_LANGUAGE",
"auditableFields" : [ { }, { } ],
"validationEL" : "...",
"validTo" : 12345,
"referenceDescription" : "...",
"appendGeneratedCode" : true,
"transient" : true,
"validFrom" : 12345,
"auditable" : { },
"parentEntityType" : { },
"description" : "...",
"parentEntity" : { },
"invoiceType" : { },
"priority" : 12345,
"codeChanged" : true,
"toReorder" : true,
"version" : 12345,
"ruleValues" : {
"property1" : "...",
"property2" : "..."
}
} ],
"pdfFilenameEL" : "...",
"descriptionOrCode" : "...",
"appendGeneratedCode" : true,
"historized" : true,
"invoiceAccountable" : true,
"matchingAuto" : true,
"parentCFEntities" : [ {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"cfAccumulatedValues" : { },
"CFValuesCopy" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesNullSafe" : { },
"dirtyCF" : true,
"uuid" : "...",
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
}
}, {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"cfAccumulatedValues" : { },
"CFValuesCopy" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesNullSafe" : { },
"dirtyCF" : true,
"uuid" : "...",
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
}
} ],
"appliesTo" : [ { }, { } ],
"excludeFromAgedTrialBalance" : true,
"useSelfSequence" : true,
"referenceCode" : "...",
"transient" : true,
"referenceDescription" : "...",
"invoiceSequence" : {
"invoiceTypes" : [ { }, { } ],
"historized" : true,
"previousInvoiceNb" : 12345,
"codeChanged" : true,
"appendGeneratedCode" : true,
"version" : 12345,
"descriptionAndCode" : "...",
"code" : "...",
"sequencePattern" : "...",
"referenceCode" : "...",
"sequenceSize" : 12345,
"description" : "...",
"referenceDescription" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"genericEntityCodes" : [ { }, { } ],
"auditable" : { },
"transient" : true,
"parentEntityType" : { },
"sequenceType" : "NUMERIC",
"currentNumber" : 12345,
"parentEntity" : { },
"invoiceTypeSellerSequences" : [ { }, { } ],
"notified" : true
},
"codeChanged" : true,
"description" : "...",
"occTemplateNegative" : {
"parentEntity" : { },
"appendGeneratedCode" : true,
"historized" : true,
"id" : 12345,
"accountCodeClientSide" : "...",
"referenceCode" : "...",
"auditableFields" : [ { }, { } ],
"descriptionOrCode" : "...",
"accountingScheme" : { },
"parentEntityType" : { },
"codeChanged" : true,
"code" : "...",
"transient" : true,
"contraAccountingCode2" : { },
"contraAccountingCode" : { },
"descriptionAndCode" : "...",
"auditable" : { },
"description" : "...",
"manualCreationEnabled" : true,
"referenceDescription" : "...",
"version" : 12345,
"notified" : true,
"journal" : { },
"occCategory" : "DEBIT",
"accountingCode" : { }
}
},
"priority" : 12345,
"codeChanged" : true,
"toReorder" : true,
"version" : 12345,
"ruleValues" : {
"property1" : "...",
"property2" : "..."
}
}