Interface DocumentCode

Coding of documents

interface DocumentCode {
    DE_C0013?: string;
    DE_I0136?: string;
    DE_I0136_Addition?: string;
    DE_I0136_Detail?: string;
    DE_I0136_Qualifier?: string;
    DE_I0136_Reference?: string;
    DE_I0200?: string;
    DE_I0200_Bereich?: string;
    DE_I0903?: string;
    Dokumentenarten?: string;
    NC_24000?: string;
    NC_43000?: string;
    NC_44000?: string;
    NC_49000?: string;
    bbox?: Bbox;
    confidence?: number;
    derivedFrom?: DocumentCodeDerivation;
    description?: string;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: DigicustDocumentType[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    userEdited?: boolean;
    value?: DigicustDocumentType;
}

Hierarchy (view full)

Properties

DE_C0013?: string
DE_I0136?: string

Unterlagen

DE_I0136_Addition?: string
DE_I0136_Detail?: string
DE_I0136_Qualifier?: string
DE_I0136_Reference?: string
DE_I0200?: string
DE_I0200_Bereich?: string

Bescheinigungsbereich

DE_I0903?: string
Dokumentenarten?: string
NC_24000?: string
NC_43000?: string
NC_44000?: string
NC_49000?: string
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

description?: string
display?: boolean
errors?: ErrorModel[]

could be validation errors

input?: string

The input value which was initially supplied for the property

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

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

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

source?: string
templateValue?: string

Template value which was used to generate the value

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

The current value of the property