Interface EmailDocument

Identifies an Email NOTE: if a field is added here, please update the extraction in normailization service

interface EmailDocument {
    _isNew?: boolean;
    analyzerMetadata?: AnalyzerMetadataModel;
    batchNumber?: Meta<string>;
    body?: string;
    carrier?: CompanyModel;
    caseId?: string;
    chassisNumber?: Meta<string>;
    classificationStatus?: ClassificationStatus;
    code?: string;
    consignee?: CompanyModel;
    contactPerson?: PersonModel;
    containers?: Container[];
    countryOfOrigin?: AddressModel;
    customerId?: string;
    customsOffice?: CustomsOffice;
    declarant?: CompanyModel;
    declarationType?: Meta<DeclarationType>;
    destinationCustomsOffice?: CustomsOffice;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    documents?: (DigicustDocumentModel & {
        belongsTo: string;
    })[];
    domesticFreightCosts?: Money;
    email?: Meta<string>;
    entryCustomsOffice?: CustomsOffice;
    exitCustomsOffice?: CustomsOffice;
    exportCustomsOffice?: CustomsOffice;
    extractId?: string;
    fileName?: string;
    freightCosts?: Money;
    generalGoodsDescription?: Meta<string>;
    generalTariffNumber?: CustomsTariffNumber;
    id?: string;
    incoterm?: Meta<Incoterm>;
    insuranceCosts?: Money;
    internationalFreightCosts?: Money;
    invoiceNumbers?: Meta<string>[];
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    items?: LineItemModel[];
    meanOfTransportation?: MeanOfTransportation;
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    mrnNumber?: Meta<string>;
    netWeight?: Weight;
    originalEmailSender?: Meta<string>;
    packages?: Package[];
    pageCount?: number;
    pages?: DocumentPage[];
    phoneNr?: Meta<string>;
    placeIncoterm?: AddressModel;
    placeOfLoading?: AddressModel;
    pointOfEntry?: AddressModel;
    port?: Port;
    preference?: Meta<boolean>;
    preliminaryDocuments?: PreliminaryDocument[];
    presentationDate?: DateTimeModel;
    presentationTimeEnd?: Meta<string>;
    presentationTimeStart?: Meta<string>;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    requestedReference?: Meta<string>;
    route?: Meta<string[]>;
    seals?: Seal[];
    sender?: string;
    shipments?: {
        invoiceNumbers?: Meta<string>[];
        reference?: Meta<string>;
    }[];
    shipper?: CompanyModel;
    shippingDate?: DateTimeModel;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    subDocumentStatus?: SubDocumentStatus;
    subject?: string;
    totalValue?: Money;
    transitCountries?: AddressModel[];
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

_isNew? analyzerMetadata? batchNumber? body? carrier? caseId? chassisNumber? classificationStatus? code? consignee? contactPerson? containers? countryOfOrigin? customerId? customsOffice? declarant? declarationType? destinationCustomsOffice? documentCode? documentReference? documentStatus? documentType? documents? domesticFreightCosts? email? entryCustomsOffice? exitCustomsOffice? exportCustomsOffice? extractId? fileName? freightCosts? generalGoodsDescription? generalTariffNumber? id? incoterm? insuranceCosts? internationalFreightCosts? invoiceNumbers? isCondensed? isPseudonymized? issueDate? items? meanOfTransportation? modifiedBy? mrnNumber? netWeight? originalEmailSender? packages? pageCount? pages? phoneNr? placeIncoterm? placeOfLoading? pointOfEntry? port? preference? preliminaryDocuments? presentationDate? presentationTimeEnd? presentationTimeStart? processing? projectId? queueId? receivedAt? reference? requestedReference? route? seals? sender? shipments? shipper? shippingDate? sourceMaterialId? specialFileFormat? subDocumentStatus? subject? totalValue? transitCountries? uploadedFiles? userDocumentStatus? userEdited? weight? weightUnit?

Properties

Optional _isNew

_isNew?: boolean

Optional analyzerMetadata

analyzerMetadata?: AnalyzerMetadataModel

Optional batchNumber

batchNumber?: Meta<string>

Optional body

body?: string

Optional carrier

carrier?: CompanyModel

Optional caseId

caseId?: string

Optional chassisNumber

chassisNumber?: Meta<string>

CT-1895 p2 field requested by HTS, it will be present on email or invoice

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional consignee

consignee?: CompanyModel

Optional contactPerson

contactPerson?: PersonModel

Optional containers

containers?: Container[]

Optional countryOfOrigin

countryOfOrigin?: AddressModel

Optional customerId

customerId?: string

Optional customsOffice

customsOffice?: CustomsOffice

Optional declarant

declarant?: CompanyModel

Optional declarationType

declarationType?: Meta<DeclarationType>

Optional destinationCustomsOffice

destinationCustomsOffice?: CustomsOffice

Optional documentCode

documentCode?: DocumentCode

Optional documentReference

documentReference?: Meta<string>

Optional documentStatus

documentStatus?: DocumentStatus

Optional documentType

documentType?: DigicustDocumentType

Optional documents

documents?: (DigicustDocumentModel & {
    belongsTo: string;
})[]

Optional domesticFreightCosts

domesticFreightCosts?: Money

Optional email

email?: Meta<string>

Optional entryCustomsOffice

entryCustomsOffice?: CustomsOffice

Optional exitCustomsOffice

exitCustomsOffice?: CustomsOffice

Optional exportCustomsOffice

exportCustomsOffice?: CustomsOffice

Optional extractId

extractId?: string

Optional fileName

fileName?: string

Optional freightCosts

freightCosts?: Money

Optional generalGoodsDescription

generalGoodsDescription?: Meta<string>

Optional generalTariffNumber

generalTariffNumber?: CustomsTariffNumber

Optional id

id?: string

Optional incoterm

incoterm?: Meta<Incoterm>

Optional insuranceCosts

insuranceCosts?: Money

Optional internationalFreightCosts

internationalFreightCosts?: Money

Optional invoiceNumbers

invoiceNumbers?: Meta<string>[]

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional items

items?: LineItemModel[]

Optional meanOfTransportation

meanOfTransportation?: MeanOfTransportation

Optional modifiedBy

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

Type declaration

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

Optional mrnNumber

mrnNumber?: Meta<string>

Optional netWeight

netWeight?: Weight

Optional originalEmailSender

originalEmailSender?: Meta<string>

Optional packages

packages?: Package[]

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional phoneNr

phoneNr?: Meta<string>

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional placeOfLoading

placeOfLoading?: AddressModel

Optional pointOfEntry

pointOfEntry?: AddressModel

Optional port

port?: Port

Optional preference

preference?: Meta<boolean>

Optional preliminaryDocuments

preliminaryDocuments?: PreliminaryDocument[]

Optional presentationDate

presentationDate?: DateTimeModel

Optional presentationTimeEnd

presentationTimeEnd?: Meta<string>

Optional presentationTimeStart

presentationTimeStart?: Meta<string>

Optional processing

processing?: ProcessingModel

Optional projectId

projectId?: string

Optional queueId

queueId?: string

Optional receivedAt

receivedAt?: Date

Optional reference

reference?: string

Optional requestedReference

requestedReference?: Meta<string>

Optional route

route?: Meta<string[]>

Optional seals

seals?: Seal[]

Optional sender

sender?: string

Optional shipments

shipments?: {
    invoiceNumbers?: Meta<string>[];
    reference?: Meta<string>;
}[]

Type declaration

  • Optional invoiceNumbers?: Meta<string>[]
  • Optional reference?: Meta<string>

Optional shipper

shipper?: CompanyModel

Optional shippingDate

shippingDate?: DateTimeModel

Optional sourceMaterialId

sourceMaterialId?: string

Optional specialFileFormat

specialFileFormat?: "xlsx" | "xml" | "csv"

Special file format that requires different processing than normal OCR. Examples: 'xlsx', 'xml', 'csv' for structured data files.

Optional subDocumentStatus

subDocumentStatus?: SubDocumentStatus

Optional subject

subject?: string

Optional totalValue

totalValue?: Money

Optional transitCountries

transitCountries?: AddressModel[]

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Optional weight

weight?: Weight

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

_isNewanalyzerMetadatabatchNumberbodycarriercaseIdchassisNumberclassificationStatuscodeconsigneecontactPersoncontainerscountryOfOrigincustomerIdcustomsOfficedeclarantdeclarationTypedestinationCustomsOfficedocumentCodedocumentReferencedocumentStatusdocumentTypedocumentsdomesticFreightCostsemailentryCustomsOfficeexitCustomsOfficeexportCustomsOfficeextractIdfileNamefreightCostsgeneralGoodsDescriptiongeneralTariffNumberidincoterminsuranceCostsinternationalFreightCostsinvoiceNumbersisCondensedisPseudonymizedissueDateitemsmeanOfTransportationmodifiedBymrnNumbernetWeightoriginalEmailSenderpackagespageCountpagesphoneNrplaceIncotermplaceOfLoadingpointOfEntryportpreferencepreliminaryDocumentspresentationDatepresentationTimeEndpresentationTimeStartprocessingprojectIdqueueIdreceivedAtreferencerequestedReferenceroutesealssendershipmentsshippershippingDatesourceMaterialIdspecialFileFormatsubDocumentStatussubjecttotalValuetransitCountriesuploadedFilesuserDocumentStatususerEditedweightweightUnit