Interface ImportDeclaration

Identifies an Import Declaration

interface ImportDeclaration {
    _isNew?: boolean;
    adjustmentItems?: {
        item?: LineItemModel;
        originalIdx: number;
        type?: "additionalCosts" | "freightCosts" | "discount" | "stripped" | "merged";
    }[];
    analyzerMetadata?: AnalyzerMetadataModel;
    applicant?: CompanyModel;
    beforeNormalization?: {
        currency?: Meta<Currency>;
        totalGrossWeight?: Weight;
        totalNetWeight?: Weight;
        totalValue?: Money;
        weightUnit?: Meta<WeightUnit>;
    };
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    currency?: Meta<Currency>;
    customerId?: string;
    customsSealNumber?: Meta<string>;
    declarationType?: Meta<string>;
    destinationCountry?: AddressModel;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    entryCustomsOffice?: CustomsOffice;
    exportingCountry?: AddressModel;
    extractId?: string;
    fileName?: string;
    goodsLocation?: AddressModel;
    id?: string;
    importCustomsOffice?: CustomsOffice;
    incoterm?: IncotermModel;
    invoiceNumber?: Meta<string>;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    itemIds?: string[];
    items?: LineItemModel[];
    meansOfTransportation?: MeanOfTransportation[];
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    mrnNumber?: Meta<string>;
    numPackages?: Meta<number>;
    packages?: Package[];
    pageCount?: number;
    pages?: DocumentPage[];
    placeIncoterm?: AddressModel;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    recipient?: CompanyModel;
    reference?: string;
    referenceNumber?: Meta<string>;
    shipper?: CompanyModel;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    subDocumentStatus?: SubDocumentStatus;
    totalGrossWeight?: Weight;
    totalNetWeight?: Weight;
    totalValue?: Money;
    transitCountries?: AddressModel[];
    transitCountry?: AddressModel;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

_isNew? adjustmentItems? analyzerMetadata? applicant? beforeNormalization? caseId? classificationStatus? code? currency? customerId? customsSealNumber? declarationType? destinationCountry? documentCode? documentReference? documentStatus? documentType? entryCustomsOffice? exportingCountry? extractId? fileName? goodsLocation? id? importCustomsOffice? incoterm? invoiceNumber? isCondensed? isPseudonymized? issueDate? itemIds? items? meansOfTransportation? modifiedBy? mrnNumber? numPackages? packages? pageCount? pages? placeIncoterm? processing? projectId? queueId? receivedAt? recipient? reference? referenceNumber? shipper? sourceMaterialId? specialFileFormat? subDocumentStatus? totalGrossWeight? totalNetWeight? totalValue? transitCountries? transitCountry? uploadedFiles? userDocumentStatus? userEdited? weightUnit?

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 applicant

applicant?: CompanyModel

Optional beforeNormalization

beforeNormalization?: {
    currency?: Meta<Currency>;
    totalGrossWeight?: Weight;
    totalNetWeight?: Weight;
    totalValue?: Money;
    weightUnit?: Meta<WeightUnit>;
}

Type declaration

Optional caseId

caseId?: string

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional currency

currency?: Meta<Currency>

Optional customerId

customerId?: string

Optional customsSealNumber

customsSealNumber?: Meta<string>

Optional declarationType

declarationType?: Meta<string>

Optional destinationCountry

destinationCountry?: AddressModel

Optional documentCode

documentCode?: DocumentCode

Optional documentReference

documentReference?: Meta<string>

Optional documentStatus

documentStatus?: DocumentStatus

Optional documentType

documentType?: DigicustDocumentType

Optional entryCustomsOffice

entryCustomsOffice?: CustomsOffice

Optional exportingCountry

exportingCountry?: AddressModel

Optional extractId

extractId?: string

Optional fileName

fileName?: string

Optional goodsLocation

goodsLocation?: AddressModel

Optional id

id?: string

Optional importCustomsOffice

importCustomsOffice?: CustomsOffice

Optional incoterm

incoterm?: IncotermModel

Optional invoiceNumber

invoiceNumber?: Meta<string>

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional itemIds

itemIds?: string[]

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 mrnNumber

mrnNumber?: Meta<string>

Optional numPackages

numPackages?: Meta<number>

Optional packages

packages?: Package[]

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional processing

processing?: ProcessingModel

Optional projectId

projectId?: string

Optional queueId

queueId?: string

Optional receivedAt

receivedAt?: Date

Optional recipient

recipient?: CompanyModel

Optional reference

reference?: string

Optional referenceNumber

referenceNumber?: Meta<string>

Optional shipper

shipper?: CompanyModel

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 totalGrossWeight

totalGrossWeight?: Weight

Optional totalNetWeight

totalNetWeight?: Weight

Optional totalValue

totalValue?: Money

Optional transitCountries

transitCountries?: AddressModel[]

Optional transitCountry

transitCountry?: AddressModel

will be normalized into transitCountries - do not further use!

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

_isNewadjustmentItemsanalyzerMetadataapplicantbeforeNormalizationcaseIdclassificationStatuscodecurrencycustomerIdcustomsSealNumberdeclarationTypedestinationCountrydocumentCodedocumentReferencedocumentStatusdocumentTypeentryCustomsOfficeexportingCountryextractIdfileNamegoodsLocationidimportCustomsOfficeincoterminvoiceNumberisCondensedisPseudonymizedissueDateitemIdsitemsmeansOfTransportationmodifiedBymrnNumbernumPackagespackagespageCountpagesplaceIncotermprocessingprojectIdqueueIdreceivedAtrecipientreferencereferenceNumbershippersourceMaterialIdspecialFileFormatsubDocumentStatustotalGrossWeighttotalNetWeighttotalValuetransitCountriestransitCountryuploadedFilesuserDocumentStatususerEditedweightUnit