Sequence Data Type

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

Example

{
  "notified" : true,
  "version" : 12345,
  "genericEntityCodes" : [ {
    "id" : 12345,
    "transient" : true,
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "notified" : true,
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "entityClass" : "...",
    "sequence" : {
      "notified" : true,
      "version" : 12345,
      "genericEntityCodes" : [ { }, { } ],
      "currentNumber" : 12345,
      "id" : 12345,
      "transient" : true,
      "historized" : true,
      "sequenceSize" : 12345,
      "auditableFields" : [ { }, { } ],
      "parentEntity" : { },
      "referenceDescription" : "...",
      "parentEntityType" : { },
      "descriptionAndCode" : "...",
      "code" : "...",
      "auditable" : { },
      "referenceCode" : "...",
      "sequencePattern" : "...",
      "codeChanged" : true,
      "sequenceType" : "ALPHA_UP",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "description" : "..."
    },
    "formatEL" : "...",
    "historized" : true,
    "version" : 12345,
    "codeEL" : "..."
  }, {
    "id" : 12345,
    "transient" : true,
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "RENEWAL",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "notified" : true,
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "entityClass" : "...",
    "sequence" : {
      "notified" : true,
      "version" : 12345,
      "genericEntityCodes" : [ { }, { } ],
      "currentNumber" : 12345,
      "id" : 12345,
      "transient" : true,
      "historized" : true,
      "sequenceSize" : 12345,
      "auditableFields" : [ { }, { } ],
      "parentEntity" : { },
      "referenceDescription" : "...",
      "parentEntityType" : { },
      "descriptionAndCode" : "...",
      "code" : "...",
      "auditable" : { },
      "referenceCode" : "...",
      "sequencePattern" : "...",
      "codeChanged" : true,
      "sequenceType" : "UUID",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "description" : "..."
    },
    "formatEL" : "...",
    "historized" : true,
    "version" : 12345,
    "codeEL" : "..."
  } ],
  "currentNumber" : 12345,
  "id" : 12345,
  "transient" : true,
  "historized" : true,
  "sequenceSize" : 12345,
  "auditableFields" : [ {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "RENEWAL",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  }, {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "OTHER",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  } ],
  "parentEntity" : {
    "codeChanged" : true,
    "notified" : true,
    "descriptionOrCode" : "...",
    "description" : "...",
    "version" : 12345,
    "historized" : true,
    "transient" : true,
    "id" : 12345,
    "parentEntityType" : { },
    "parentEntity" : { },
    "referenceCode" : "...",
    "code" : "...",
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "descriptionAndCode" : "...",
    "appendGeneratedCode" : true,
    "referenceDescription" : "..."
  },
  "referenceDescription" : "...",
  "parentEntityType" : { },
  "descriptionAndCode" : "...",
  "code" : "...",
  "auditable" : {
    "creator" : "...",
    "updater" : "...",
    "updated" : 12345,
    "lastModified" : 12345,
    "lastUser" : "...",
    "created" : 12345
  },
  "referenceCode" : "...",
  "sequencePattern" : "...",
  "codeChanged" : true,
  "sequenceType" : "UUID",
  "appendGeneratedCode" : true,
  "descriptionOrCode" : "...",
  "description" : "..."
}