Sequence Data Type

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

Example

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