Interface CustomsServiceInstructions

Identifies a customs service instruction document (Speditionsauftrag).

interface CustomsServiceInstructions {
    _isNew?: boolean;
    adjustmentItems?: {
        item?: LineItemModel;
        originalIdx: number;
        type?: "additionalCosts" | "freightCosts" | "discount" | "stripped" | "merged";
    }[];
    analyzerMetadata?: AnalyzerMetadataModel;
    arrivalDate?: DateTimeModel;
    carrier?: CompanyModel;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    consignee?: CompanyModel;
    customerId?: string;
    customerNumber?: Meta<string>;
    customsOffices?: CustomsOffice[];
    departureDate?: DateTimeModel;
    destinationDocks?: {
        deliveryCode?: Meta<string>;
        unloadingCode?: Meta<string>;
    };
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    extractId?: string;
    fileName?: string;
    forwardingNumber?: Meta<string>;
    freightCosts?: Money;
    generalCustomsTariffNumber?: CustomsTariffNumber;
    grossWeight?: Weight;
    id?: string;
    incoterm?: IncotermModel;
    insuranceCosts?: Money;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    itemIds?: string[];
    items?: LineItemModel[];
    loadingPlan?: {
        numberOfLoadingStops: number;
        numberOfUnloadingStops: number;
        stops: LoadingPlanStop[];
    };
    meansOfTransportation?: MeanOfTransportation[];
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    netWeight?: Weight;
    orderNumber?: Meta<string>;
    packages?: Package[];
    pageCount?: number;
    pages?: DocumentPage[];
    placeIncoterm?: AddressModel;
    placeOfUnloading?: AddressModel;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    referenceNumber?: Meta<string>;
    shipmentTrackingNumber?: Meta<string>;
    shipper?: CompanyModel;
    slvsWaiver?: Meta<boolean>;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    statisticalValue?: Money;
    subDocumentStatus?: SubDocumentStatus;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
}

Hierarchy (view full)

Properties

_isNew? adjustmentItems? analyzerMetadata? arrivalDate? carrier? caseId? classificationStatus? code? consignee? customerId? customerNumber? customsOffices? departureDate? destinationDocks? documentCode? documentReference? documentStatus? documentType? extractId? fileName? forwardingNumber? freightCosts? generalCustomsTariffNumber? grossWeight? id? incoterm? insuranceCosts? isCondensed? isPseudonymized? issueDate? itemIds? items? loadingPlan? meansOfTransportation? modifiedBy? netWeight? orderNumber? packages? pageCount? pages? placeIncoterm? placeOfUnloading? processing? projectId? queueId? receivedAt? reference? referenceNumber? shipmentTrackingNumber? shipper? slvsWaiver? sourceMaterialId? specialFileFormat? statisticalValue? subDocumentStatus? uploadedFiles? userDocumentStatus? userEdited?

Properties

Optional _isNew

_isNew?: boolean

Optional adjustmentItems

adjustmentItems?: {
    item?: LineItemModel;
    originalIdx: number;
    type?: "additionalCosts" | "freightCosts" | "discount" | "stripped" | "merged";
}[]

Type declaration

  • Optional item?: LineItemModel
  • originalIdx: number
  • Optional type?: "additionalCosts" | "freightCosts" | "discount" | "stripped" | "merged"

Optional analyzerMetadata

analyzerMetadata?: AnalyzerMetadataModel

Optional arrivalDate

arrivalDate?: DateTimeModel

Optional carrier

carrier?: CompanyModel

Optional caseId

caseId?: string

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional consignee

consignee?: CompanyModel

Optional customerId

customerId?: string

Optional customerNumber

customerNumber?: Meta<string>

Optional customsOffices

customsOffices?: CustomsOffice[]

Optional departureDate

departureDate?: DateTimeModel

Departure and arrival information

Optional destinationDocks

destinationDocks?: {
    deliveryCode?: Meta<string>;
    unloadingCode?: Meta<string>;
}

Location codes specifying the exact receiving/unloading points at the destination German: Anlieferstelle (067), Abladestelle (953)

Type declaration

  • Optional deliveryCode?: Meta<string>
  • Optional unloadingCode?: Meta<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 forwardingNumber

forwardingNumber?: Meta<string>

Optional freightCosts

freightCosts?: Money

Optional generalCustomsTariffNumber

generalCustomsTariffNumber?: CustomsTariffNumber

Optional grossWeight

grossWeight?: Weight

Optional id

id?: string

Optional incoterm

incoterm?: IncotermModel

Optional insuranceCosts

insuranceCosts?: Money

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional itemIds

itemIds?: string[]

Optional items

items?: LineItemModel[]

Optional loadingPlan

loadingPlan?: {
    numberOfLoadingStops: number;
    numberOfUnloadingStops: number;
    stops: LoadingPlanStop[];
}

Structured loading/unloading plan German: Be- und Entladeplan Used when multiple stops with full addresses are needed.

Type declaration

  • numberOfLoadingStops: number
  • numberOfUnloadingStops: number
  • stops: LoadingPlanStop[]

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 orderNumber

orderNumber?: Meta<string>

Optional packages

packages?: Package[]

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional placeOfUnloading

placeOfUnloading?: AddressModel

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 shipmentTrackingNumber

shipmentTrackingNumber?: Meta<string>

Shipment tracking number (German: Sendungs-Ladungs-Bezugsnummer)

Optional shipper

shipper?: CompanyModel

Optional slvsWaiver

slvsWaiver?: Meta<boolean>

Transport disclaimer flags German: SLVS-Verzichtskunde

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 statisticalValue

statisticalValue?: Money

Optional subDocumentStatus

subDocumentStatus?: SubDocumentStatus

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Settings

Member Visibility

Theme

On This Page

_isNewadjustmentItemsanalyzerMetadataarrivalDatecarriercaseIdclassificationStatuscodeconsigneecustomerIdcustomerNumbercustomsOfficesdepartureDatedestinationDocksdocumentCodedocumentReferencedocumentStatusdocumentTypeextractIdfileNameforwardingNumberfreightCostsgeneralCustomsTariffNumbergrossWeightidincoterminsuranceCostsisCondensedisPseudonymizedissueDateitemIdsitemsloadingPlanmeansOfTransportationmodifiedBynetWeightorderNumberpackagespageCountpagesplaceIncotermplaceOfUnloadingprocessingprojectIdqueueIdreceivedAtreferencereferenceNumbershipmentTrackingNumbershipperslvsWaiversourceMaterialIdspecialFileFormatstatisticalValuesubDocumentStatusuploadedFilesuserDocumentStatususerEdited