Interface WaybillModel

Identifies a waybill document

interface WaybillModel {
    analyzerMetadata?: AnalyzerMetadataModel;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    consignee?: CompanyModel;
    containers?: Container[];
    currency?: Meta<Currency>;
    customerId?: string;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    extractId?: string;
    fileName?: string;
    goodsDescription?: Meta<string>;
    id?: string;
    incoterm?: IncotermModel;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    meansOfTransportation?: MeanOfTransportation[];
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    netWeight?: Weight;
    numPackagesShipped?: Meta<number>;
    otherPayments?: Money;
    packages?: Package[];
    pageCount?: number;
    placeIncoterm?: AddressModel;
    portOfExport?: Port;
    portOfImport?: Port;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    referenceNumber?: Meta<string>;
    rossumMetadata?: {
        annotationId?: string;
        exportOnConfirmed?: boolean;
        importStatus?: RossumImportStatus;
        queueId?: number;
    };
    shipper?: CompanyModel;
    shippingCost?: Money;
    shippingDate?: DateTimeModel;
    subDocumentStatus?: SubDocumentStatus;
    totalValue?: Money;
    totalValueExcludingCharges?: Money;
    typeOfPackage?: PackageType;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
    waybillNumber?: Meta<string>;
    waybillType?: WaybillTypeModel;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

analyzerMetadata?: AnalyzerMetadataModel
caseId?: string
classificationStatus?: ClassificationStatus
code?: string
consignee?: CompanyModel
containers?: Container[]
currency?: Meta<Currency>
customerId?: string
documentCode?: DocumentCode
documentReference?: Meta<string>
documentStatus?: DocumentStatus
documentType?: DigicustDocumentType
extractId?: string
fileName?: string
goodsDescription?: Meta<string>
id?: string
incoterm?: IncotermModel
isCondensed?: boolean
isPseudonymized?: boolean
issueDate?: DateTimeModel
meansOfTransportation?: MeanOfTransportation[]
modifiedBy?: {
    date?: Date;
    displayName?: string;
    id?: string;
}

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional id?: string
netWeight?: Weight
numPackagesShipped?: Meta<number>
otherPayments?: Money
packages?: Package[]
pageCount?: number
placeIncoterm?: AddressModel
portOfExport?: Port
portOfImport?: Port
processing?: ProcessingModel
projectId?: string
queueId?: string
receivedAt?: Date
reference?: string
referenceNumber?: Meta<string>
rossumMetadata?: {
    annotationId?: string;
    exportOnConfirmed?: boolean;
    importStatus?: RossumImportStatus;
    queueId?: number;
}

Type declaration

  • Optional annotationId?: string
  • Optional exportOnConfirmed?: boolean
  • Optional importStatus?: RossumImportStatus
  • Optional queueId?: number

Deprecated

shipper?: CompanyModel
shippingCost?: Money
shippingDate?: DateTimeModel
subDocumentStatus?: SubDocumentStatus
totalValue?: Money
totalValueExcludingCharges?: Money
typeOfPackage?: PackageType
uploadedFiles?: UploadedFileModel[]
userDocumentStatus?: UserDocumentStatus
userEdited?: boolean
waybillNumber?: Meta<string>
waybillType?: WaybillTypeModel
weight?: Weight
weightUnit?: Meta<WeightUnit>

Generated using TypeDoc