Interface WaybillModel

Identifies a waybill document

interface WaybillModel {
    _isNew?: boolean;
    analyzerMetadata?: AnalyzerMetadataModel;
    beforeNormalization?: {
        netWeight?: Weight;
        totalValue?: Money;
        weight?: Weight;
    };
    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;
    items?: LineItemModel[];
    meansOfTransportation?: MeanOfTransportation[];
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    netWeight?: Weight;
    numPackagesShipped?: Meta<number>;
    otherPayments?: Money;
    packageDimensions?: Dimensions;
    packages?: Package[];
    pageCount?: number;
    pages?: DocumentPage[];
    placeIncoterm?: AddressModel;
    portOfExport?: Port;
    portOfImport?: Port;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    referenceNumber?: Meta<string>;
    seal?: Seal;
    shipper?: CompanyModel;
    shippingCost?: Money;
    shippingDate?: DateTimeModel;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    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

_isNew? analyzerMetadata? beforeNormalization? caseId? classificationStatus? code? consignee? containers? currency? customerId? documentCode? documentReference? documentStatus? documentType? extractId? fileName? goodsDescription? id? incoterm? isCondensed? isPseudonymized? issueDate? items? meansOfTransportation? modifiedBy? netWeight? numPackagesShipped? otherPayments? packageDimensions? packages? pageCount? pages? placeIncoterm? portOfExport? portOfImport? processing? projectId? queueId? receivedAt? reference? referenceNumber? seal? shipper? shippingCost? shippingDate? sourceMaterialId? specialFileFormat? subDocumentStatus? totalValue? totalValueExcludingCharges? typeOfPackage? uploadedFiles? userDocumentStatus? userEdited? waybillNumber? waybillType? weight? weightUnit?

Properties

Optional _isNew

_isNew?: boolean

Optional analyzerMetadata

analyzerMetadata?: AnalyzerMetadataModel

Optional beforeNormalization

beforeNormalization?: {
    netWeight?: Weight;
    totalValue?: Money;
    weight?: Weight;
}

Type declaration

Optional caseId

caseId?: string

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional consignee

consignee?: CompanyModel

Optional containers

containers?: Container[]

Optional currency

currency?: Meta<Currency>

Optional customerId

customerId?: string

Optional documentCode

documentCode?: DocumentCode

Optional documentReference

documentReference?: Meta<string>

Optional documentStatus

documentStatus?: DocumentStatus

Optional documentType

documentType?: DigicustDocumentType

Optional extractId

extractId?: string

Optional fileName

fileName?: string

Optional goodsDescription

goodsDescription?: Meta<string>

Optional id

id?: string

Optional incoterm

incoterm?: IncotermModel

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional items

items?: LineItemModel[]

Optional meansOfTransportation

meansOfTransportation?: MeanOfTransportation[]

Optional modifiedBy

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

Type declaration

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

Optional netWeight

netWeight?: Weight

Optional numPackagesShipped

numPackagesShipped?: Meta<number>

Optional otherPayments

otherPayments?: Money

Optional packageDimensions

packageDimensions?: Dimensions

Optional packages

packages?: Package[]

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional portOfExport

portOfExport?: Port

Optional portOfImport

portOfImport?: Port

Optional processing

processing?: ProcessingModel

Optional projectId

projectId?: string

Optional queueId

queueId?: string

Optional receivedAt

receivedAt?: Date

Optional reference

reference?: string

Optional referenceNumber

referenceNumber?: Meta<string>

Optional seal

seal?: Seal

Optional shipper

shipper?: CompanyModel

Optional shippingCost

shippingCost?: Money

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 totalValue

totalValue?: Money

Optional totalValueExcludingCharges

totalValueExcludingCharges?: Money

Optional typeOfPackage

typeOfPackage?: PackageType

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Optional waybillNumber

waybillNumber?: Meta<string>

Optional waybillType

waybillType?: WaybillTypeModel

Optional weight

weight?: Weight

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

_isNewanalyzerMetadatabeforeNormalizationcaseIdclassificationStatuscodeconsigneecontainerscurrencycustomerIddocumentCodedocumentReferencedocumentStatusdocumentTypeextractIdfileNamegoodsDescriptionidincotermisCondensedisPseudonymizedissueDateitemsmeansOfTransportationmodifiedBynetWeightnumPackagesShippedotherPaymentspackageDimensionspackagespageCountpagesplaceIncotermportOfExportportOfImportprocessingprojectIdqueueIdreceivedAtreferencereferenceNumbersealshippershippingCostshippingDatesourceMaterialIdspecialFileFormatsubDocumentStatustotalValuetotalValueExcludingChargestypeOfPackageuploadedFilesuserDocumentStatususerEditedwaybillNumberwaybillTypeweightweightUnit