Sequence Data Type

Subtypes
InvoiceSequence
Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
referenceCode string  
parentEntityType object  
appendGeneratedCode boolean  
sequenceSize number  
currentNumber number  
codeChanged boolean  
sequencePattern string  
version number  
descriptionOrCode string  
code string required, max size: 255, min size: 1
transient boolean  
notified boolean  
historized boolean  
referenceDescription string  
parentEntity BusinessEntity  
genericEntityCodes array of CustomGenericEntityCode  
auditable Auditable  
description string max size: 255, min size: 0
auditableFields array of AuditableFieldHistory  
sequenceType SequenceTypeEnum  
descriptionAndCode string  
id number  

Example

{
  "referenceCode" : "...",
  "parentEntityType" : { },
  "appendGeneratedCode" : true,
  "sequenceSize" : 12345,
  "currentNumber" : 12345,
  "codeChanged" : true,
  "sequencePattern" : "...",
  "version" : 12345,
  "descriptionOrCode" : "...",
  "code" : "...",
  "transient" : true,
  "notified" : true,
  "historized" : true,
  "referenceDescription" : "...",
  "parentEntity" : {
    "code" : "...",
    "appendGeneratedCode" : true,
    "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" : { }
    } ],
    "notified" : true,
    "parentEntity" : { },
    "referenceDescription" : "...",
    "id" : 12345,
    "auditable" : {
      "created" : 12345,
      "creator" : "...",
      "lastModified" : 12345,
      "updater" : "...",
      "updated" : 12345,
      "lastUser" : "..."
    },
    "codeChanged" : true,
    "transient" : true,
    "referenceCode" : "...",
    "descriptionOrCode" : "...",
    "historized" : true,
    "version" : 12345,
    "parentEntityType" : { },
    "description" : "...",
    "descriptionAndCode" : "..."
  },
  "genericEntityCodes" : [ {
    "auditable" : {
      "created" : 12345,
      "creator" : "...",
      "lastModified" : 12345,
      "updater" : "...",
      "updated" : 12345,
      "lastUser" : "..."
    },
    "auditableFields" : [ {
      "fieldName" : "...",
      "historable" : true,
      "historized" : true,
      "auditType" : "STATUS",
      "notfiable" : true,
      "currentState" : { },
      "notified" : true,
      "previousState" : { }
    }, {
      "fieldName" : "...",
      "historable" : true,
      "historized" : true,
      "auditType" : "RENEWAL",
      "notfiable" : true,
      "currentState" : { },
      "notified" : true,
      "previousState" : { }
    } ],
    "notified" : true,
    "codeEL" : "...",
    "historized" : true,
    "id" : 12345,
    "formatEL" : "...",
    "transient" : true,
    "version" : 12345,
    "sequence" : {
      "referenceCode" : "...",
      "parentEntityType" : { },
      "appendGeneratedCode" : true,
      "sequenceSize" : 12345,
      "currentNumber" : 12345,
      "codeChanged" : true,
      "sequencePattern" : "...",
      "version" : 12345,
      "descriptionOrCode" : "...",
      "code" : "...",
      "transient" : true,
      "notified" : true,
      "historized" : true,
      "referenceDescription" : "...",
      "parentEntity" : { },
      "genericEntityCodes" : [ { }, { } ],
      "auditable" : { },
      "description" : "...",
      "auditableFields" : [ { }, { } ],
      "sequenceType" : "REGEXP",
      "descriptionAndCode" : "...",
      "id" : 12345
    },
    "entityClass" : "..."
  }, {
    "auditable" : {
      "created" : 12345,
      "creator" : "...",
      "lastModified" : 12345,
      "updater" : "...",
      "updated" : 12345,
      "lastUser" : "..."
    },
    "auditableFields" : [ {
      "fieldName" : "...",
      "historable" : true,
      "historized" : true,
      "auditType" : "STATUS",
      "notfiable" : true,
      "currentState" : { },
      "notified" : true,
      "previousState" : { }
    }, {
      "fieldName" : "...",
      "historable" : true,
      "historized" : true,
      "auditType" : "STATUS",
      "notfiable" : true,
      "currentState" : { },
      "notified" : true,
      "previousState" : { }
    } ],
    "notified" : true,
    "codeEL" : "...",
    "historized" : true,
    "id" : 12345,
    "formatEL" : "...",
    "transient" : true,
    "version" : 12345,
    "sequence" : {
      "referenceCode" : "...",
      "parentEntityType" : { },
      "appendGeneratedCode" : true,
      "sequenceSize" : 12345,
      "currentNumber" : 12345,
      "codeChanged" : true,
      "sequencePattern" : "...",
      "version" : 12345,
      "descriptionOrCode" : "...",
      "code" : "...",
      "transient" : true,
      "notified" : true,
      "historized" : true,
      "referenceDescription" : "...",
      "parentEntity" : { },
      "genericEntityCodes" : [ { }, { } ],
      "auditable" : { },
      "description" : "...",
      "auditableFields" : [ { }, { } ],
      "sequenceType" : "RUM",
      "descriptionAndCode" : "...",
      "id" : 12345
    },
    "entityClass" : "..."
  } ],
  "auditable" : {
    "created" : 12345,
    "creator" : "...",
    "lastModified" : 12345,
    "updater" : "...",
    "updated" : 12345,
    "lastUser" : "..."
  },
  "description" : "...",
  "auditableFields" : [ {
    "fieldName" : "...",
    "historable" : true,
    "historized" : true,
    "auditType" : "STATUS",
    "notfiable" : true,
    "currentState" : { },
    "notified" : true,
    "previousState" : { }
  }, {
    "fieldName" : "...",
    "historable" : true,
    "historized" : true,
    "auditType" : "RENEWAL",
    "notfiable" : true,
    "currentState" : { },
    "notified" : true,
    "previousState" : { }
  } ],
  "sequenceType" : "CUSTOMER_NO",
  "descriptionAndCode" : "...",
  "id" : 12345
}