Interface EmailDocument

Identifies an Email

interface EmailDocument {
    analyzerMetadata?: AnalyzerMetadataModel;
    body?: string;
    carrier?: CompanyModel;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    contactPerson?: PersonModel;
    containers?: Container[];
    countryOfOrigin?: AddressModel;
    customerId?: string;
    customsOffice?: CustomsOffice;
    declarant?: CompanyModel;
    declarationType?: Meta<DeclarationType>;
    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;
    preliminaryDocuments?: PreliminaryDocument[];
    presentationDate?: DateTimeModel;
    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;
    subDocumentStatus?: SubDocumentStatus;
    subject?: string;
    totalValue?: Money;
    transitCountries?: AddressModel[];
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

analyzerMetadata?: AnalyzerMetadataModel
body?: string
carrier?: CompanyModel
caseId?: string
classificationStatus?: ClassificationStatus
code?: string
contactPerson?: PersonModel
containers?: Container[]
countryOfOrigin?: AddressModel
customerId?: string
customsOffice?: CustomsOffice
declarant?: CompanyModel
declarationType?: Meta<DeclarationType>
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;
}

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional 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
preliminaryDocuments?: PreliminaryDocument[]
presentationDate?: DateTimeModel
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>;
}[]

Type declaration

  • Optional invoiceNumbers?: Meta<string>[]
  • Optional reference?: Meta<string>
shipper?: CompanyModel
shippingDate?: DateTimeModel
sourceMaterialId?: string
subDocumentStatus?: SubDocumentStatus
subject?: string
totalValue?: Money
transitCountries?: AddressModel[]
uploadedFiles?: UploadedFileModel[]
userDocumentStatus?: UserDocumentStatus
userEdited?: boolean
weight?: Weight
weightUnit?: Meta<WeightUnit>