Interface CaseModel

Model used for any kind of customs case.

interface CaseModel {
    aggregated?: AggregatedCaseDataModel;
    createdAt?: Date;
    createdBy?: {
        displayName?: string;
        id?: string;
    };
    customerId?: string;
    customerName?: string;
    documents?: DigicustDocumentModel[];
    environment?: Environment;
    errors?: ErrorModel[];
    executionStrategy?: ExecutionStrategy;
    extractedAt?: Date;
    finishedAt?: Date;
    flags?: {
        [key: string]: string;
    };
    id?: string;
    isPseudonymized?: boolean;
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    module?: ModuleType;
    moduleCategory?: ModuleCategory;
    moduleId?: string;
    mrnNumber?: Meta<string>;
    procedureMode?: ProcedureMode;
    processing?: ProcessingModel;
    projectId?: string;
    projectName?: string;
    reference?: string;
    startedAt?: Date;
    statistics?: {
        dailyCaseCount?: number;
    };
    status?: Meta<CaseStatus>;
    totalItemsLength?: number;
    uploadedFiles?: UploadedFileModel[];
}

Properties

aggregated? createdAt? createdBy? customerId? customerName? documents? environment? errors? executionStrategy? extractedAt? finishedAt? flags? id? isPseudonymized? modifiedBy? module? moduleCategory? moduleId? mrnNumber? procedureMode? processing? projectId? projectName? reference? startedAt? statistics? status? totalItemsLength? uploadedFiles?

Properties

Optional aggregated

aggregated?: AggregatedCaseDataModel

Aggregated case data

Optional createdAt

createdAt?: Date

Timestamp when the case was first uploaded

Optional createdBy

createdBy?: {
    displayName?: string;
    id?: string;
}

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional customerId

customerId?: string

Optional customerName

customerName?: string

Optional documents

documents?: DigicustDocumentModel[]

Customs documents (e.g. invoices, waybills, ...) Each item could only exist in condensed form

Optional environment

environment?: Environment

Optional errors

errors?: ErrorModel[]

Case level errors (property level errors are stored in property)

Optional executionStrategy

executionStrategy?: ExecutionStrategy

Information on how the case needs to be processed

Optional extractedAt

extractedAt?: Date

Timestamp when the case finished extraction in rossum/dexter

Optional finishedAt

finishedAt?: Date

Timestamp when case processing finished

Optional flags

flags?: {
    [key: string]: string;
}

custom flags

Type declaration

  • [key: string]: string

Optional id

id?: string

Optional isPseudonymized

isPseudonymized?: boolean

Optional modifiedBy

modifiedBy?: {
    date?: Date;
    displayName?: string;
    id?: string;
}

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional id?: string

Optional module

module?: ModuleType

Optional moduleCategory

moduleCategory?: ModuleCategory

Optional moduleId

moduleId?: string

Optional mrnNumber

mrnNumber?: Meta<string>

Optional procedureMode

procedureMode?: ProcedureMode

Case Type

Optional processing

processing?: ProcessingModel

Optional projectId

projectId?: string

Optional projectName

projectName?: string

Optional reference

reference?: string

Optional startedAt

startedAt?: Date

Timestamp when normalization started, case retriggered

Optional statistics

statistics?: {
    dailyCaseCount?: number;
}

Type declaration

  • Optional dailyCaseCount?: number

    gives information of this being the # case of today. Basically counts previously cases of customer and project today and adds +1

Optional status

status?: Meta<CaseStatus>

Optional totalItemsLength

totalItemsLength?: number

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Original, uploaded files

Settings

Member Visibility

Theme

On This Page

aggregatedcreatedAtcreatedBycustomerIdcustomerNamedocumentsenvironmenterrorsexecutionStrategyextractedAtfinishedAtflagsidisPseudonymizedmodifiedBymodulemoduleCategorymoduleIdmrnNumberprocedureModeprocessingprojectIdprojectNamereferencestartedAtstatisticsstatustotalItemsLengthuploadedFiles