Interface LineItemModel

Identifies line items (specific products) listed on a document

interface LineItemModel {
    CAS?: Meta<string>;
    VOC?: VOC;
    additionalChargesUnit?: Meta<Currency>;
    additionalInformation?: Meta<string>;
    adjustments?: Adjustment[];
    amountUnit?: Meta<number>;
    associatedRecipientIds?: string[];
    batchNumber?: Meta<string>;
    bbox?: Bbox;
    beforeNormalization?: {
        grossWeight?: Weight;
        netWeight?: Weight;
        totalGrossWeight?: Weight;
        totalNetWeight?: Weight;
        weightUnit?: Meta<WeightUnit>;
    };
    billOfLading?: Meta<string>;
    box40?: Meta<string>;
    buyerArticleNumber?: Meta<string>;
    buyerOrderNumber?: Meta<string>;
    caseId?: string;
    code?: Meta<string>;
    containers?: Container[];
    countryOfOrigin?: AddressModel;
    countrySpecific?: CountrySpecificLineItem;
    creationType?: MasterDataCreationType;
    currency?: Meta<Currency>;
    customsDuty?: CustomsDuty;
    customsProcedure?: Procedure;
    customsTariffNumber?: CustomsTariffNumber;
    customsValue?: Money;
    customsValueAdditionDeduction?: AdditionDeduction[];
    dangerousGoods?: {
        UNNumber?: Meta<string>;
    }[];
    deliveryNote?: Meta<string>;
    description?: Translatable;
    destinationCountry?: AddressModel;
    discount?: Money;
    discountText?: string;
    discountUnit?: Meta<Currency | "%">;
    documentDescription?: Translatable;
    documentId?: string;
    documentTypes?: DocumentTypeCode[];
    documents?: DigicustDocumentModel[];
    exportingCountry?: AddressModel;
    fraudDetection?: ItemFraudDetectionDetails;
    grossWeight?: Weight;
    guaranteeNumber?: Meta<string>;
    guaranteeValue?: Money;
    id?: string;
    importSalesTax?: ImportSalesTax;
    includedWithPosition?: Meta<string>;
    invoiceDate?: DateTimeModel;
    invoiceNumber?: Meta<string>;
    isCondensed?: boolean;
    itemSize?: Meta<string>;
    itemSpecialUnit?: UnitOfMeasurement;
    itemSpecialUnitMeasure?: Meta<number>;
    itemValue?: Money;
    lotNumber?: Meta<string>;
    matchingMetadata?: MatchingMetadataModel<MaterialMatchInput, MaterialMatchResult>;
    material?: Meta<string>;
    materialId?: string;
    materialMatchingType?: "tariffNumber" | "materialNumber";
    materialNumber?: Meta<string>;
    mergedItemIds?: string[];
    meursingCode?: Meta<string>;
    netWeight?: Weight;
    orderNumber?: Meta<string>;
    orderedQuantity?: Quantity;
    originalDocuments?: DigicustDocumentModel[];
    packageType?: PackageType;
    packages?: Package[];
    packingList?: Meta<string>;
    position?: Meta<string>;
    preferenceInformation?: Meta<string>;
    preferenceState?: PreferenceState;
    preliminaryDocument?: Meta<string>;
    quantity?: Quantity;
    refId?: string;
    reference?: Meta<string>;
    serialNumber?: Meta<string>;
    shipper?: CompanyModel;
    sourceDocumentIds?: string[];
    specialRemarks?: Meta<string>[];
    statisticalValue?: Money;
    totalGrossWeight?: Weight;
    totalNetWeight?: Weight;
    totalValue?: Money;
    totalValueExcludingCharges?: Money;
    transitNumber?: Meta<string>;
    typeOfBusiness?: TypeOfBusiness;
    unitOfMeasurement?: UnitOfMeasurement;
    units?: {
        number?: number;
        type?: string;
    }[];
    waybillNumber?: Meta<string>;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

CAS? VOC? additionalChargesUnit? additionalInformation? adjustments? amountUnit? associatedRecipientIds? batchNumber? bbox? beforeNormalization? billOfLading? box40? buyerArticleNumber? buyerOrderNumber? caseId? code? containers? countryOfOrigin? countrySpecific? creationType? currency? customsDuty? customsProcedure? customsTariffNumber? customsValue? customsValueAdditionDeduction? dangerousGoods? deliveryNote? description? destinationCountry? discount? discountText? discountUnit? documentDescription? documentId? documentTypes? documents? exportingCountry? fraudDetection? grossWeight? guaranteeNumber? guaranteeValue? id? importSalesTax? includedWithPosition? invoiceDate? invoiceNumber? isCondensed? itemSize? itemSpecialUnit? itemSpecialUnitMeasure? itemValue? lotNumber? matchingMetadata? material? materialId? materialMatchingType? materialNumber? mergedItemIds? meursingCode? netWeight? orderNumber? orderedQuantity? originalDocuments? packageType? packages? packingList? position? preferenceInformation? preferenceState? preliminaryDocument? quantity? refId? reference? serialNumber? shipper? sourceDocumentIds? specialRemarks? statisticalValue? totalGrossWeight? totalNetWeight? totalValue? totalValueExcludingCharges? transitNumber? typeOfBusiness? unitOfMeasurement? units? waybillNumber? weightUnit?

Properties

Optional CAS

CAS?: Meta<string>

Optional VOC

VOC?: VOC

Optional additionalChargesUnit

additionalChargesUnit?: Meta<Currency>

Optional additionalInformation

additionalInformation?: Meta<string>

Optional adjustments

adjustments?: Adjustment[]

Optional amountUnit

amountUnit?: Meta<number>

Optional associatedRecipientIds

associatedRecipientIds?: string[]

Optional batchNumber

batchNumber?: Meta<string>

Optional bbox

bbox?: Bbox

Optional beforeNormalization

beforeNormalization?: {
    grossWeight?: Weight;
    netWeight?: Weight;
    totalGrossWeight?: Weight;
    totalNetWeight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Type declaration

Optional billOfLading

billOfLading?: Meta<string>

Optional box40

box40?: Meta<string>

Optional buyerArticleNumber

buyerArticleNumber?: Meta<string>

Optional buyerOrderNumber

buyerOrderNumber?: Meta<string>

Optional caseId

caseId?: string

Optional code

code?: Meta<string>

Optional containers

containers?: Container[]

Optional countryOfOrigin

countryOfOrigin?: AddressModel

might also include the provinceCode

Optional countrySpecific

countrySpecific?: CountrySpecificLineItem

Optional creationType

creationType?: MasterDataCreationType

Optional currency

currency?: Meta<Currency>

Optional customsDuty

customsDuty?: CustomsDuty

Customs Duty

Optional customsProcedure

customsProcedure?: Procedure

Optional customsTariffNumber

customsTariffNumber?: CustomsTariffNumber

Optional customsValue

customsValue?: Money

Optional customsValueAdditionDeduction

customsValueAdditionDeduction?: AdditionDeduction[]

Optional dangerousGoods

dangerousGoods?: {
    UNNumber?: Meta<string>;
}[]

Type declaration

  • Optional UNNumber?: Meta<string>

Optional deliveryNote

deliveryNote?: Meta<string>

Optional description

description?: Translatable

Optional destinationCountry

destinationCountry?: AddressModel

Optional discount

discount?: Money

Optional discountText

discountText?: string

Optional discountUnit

discountUnit?: Meta<Currency | "%">

Optional documentDescription

documentDescription?: Translatable

Optional documentId

documentId?: string

Optional documentTypes

documentTypes?: DocumentTypeCode[]

Optional documents

documents?: DigicustDocumentModel[]

Optional exportingCountry

exportingCountry?: AddressModel

Optional fraudDetection

fraudDetection?: ItemFraudDetectionDetails

Optional grossWeight

grossWeight?: Weight

Optional guaranteeNumber

guaranteeNumber?: Meta<string>

Optional guaranteeValue

guaranteeValue?: Money

Optional id

id?: string

Optional importSalesTax

importSalesTax?: ImportSalesTax

EUSt

Optional includedWithPosition

includedWithPosition?: Meta<string>

index of the position this item is included in

Optional invoiceDate

invoiceDate?: DateTimeModel

Optional invoiceNumber

invoiceNumber?: Meta<string>

Optional isCondensed

isCondensed?: boolean

Optional itemSize

itemSize?: Meta<string>

Optional itemSpecialUnit

itemSpecialUnit?: UnitOfMeasurement

Optional itemSpecialUnitMeasure

itemSpecialUnitMeasure?: Meta<number>

Optional itemValue

itemValue?: Money

Optional lotNumber

lotNumber?: Meta<string>

Optional matchingMetadata

matchingMetadata?: MatchingMetadataModel<MaterialMatchInput, MaterialMatchResult>

Optional material

material?: Meta<string>

Textual Material Description

Optional materialId

materialId?: string

Optional materialMatchingType

materialMatchingType?: "tariffNumber" | "materialNumber"

Optional materialNumber

materialNumber?: Meta<string>

Optional mergedItemIds

mergedItemIds?: string[]

Optional meursingCode

meursingCode?: Meta<string>

Optional netWeight

netWeight?: Weight

Optional orderNumber

orderNumber?: Meta<string>

Optional orderedQuantity

orderedQuantity?: Quantity

Optional originalDocuments

originalDocuments?: DigicustDocumentModel[]

Optional packageType

packageType?: PackageType

Optional packages

packages?: Package[]

Optional packingList

packingList?: Meta<string>

Optional position

position?: Meta<string>

Optional preferenceInformation

preferenceInformation?: Meta<string>

Optional preferenceState

preferenceState?: PreferenceState

Optional preliminaryDocument

preliminaryDocument?: Meta<string>

Optional quantity

quantity?: Quantity

Optional refId

refId?: string

Optional reference

reference?: Meta<string>

Optional serialNumber

serialNumber?: Meta<string>

Optional shipper

shipper?: CompanyModel

Optional sourceDocumentIds

sourceDocumentIds?: string[]

Optional specialRemarks

specialRemarks?: Meta<string>[]

Optional statisticalValue

statisticalValue?: Money

Optional totalGrossWeight

totalGrossWeight?: Weight

Optional totalNetWeight

totalNetWeight?: Weight

Optional totalValue

totalValue?: Money

Optional totalValueExcludingCharges

totalValueExcludingCharges?: Money

Optional transitNumber

transitNumber?: Meta<string>

Optional typeOfBusiness

typeOfBusiness?: TypeOfBusiness

Optional unitOfMeasurement

unitOfMeasurement?: UnitOfMeasurement

Optional units

units?: {
    number?: number;
    type?: string;
}[]

Type declaration

  • Optional number?: number
  • Optional type?: string

Optional waybillNumber

waybillNumber?: Meta<string>

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

CASVOCadditionalChargesUnitadditionalInformationadjustmentsamountUnitassociatedRecipientIdsbatchNumberbboxbeforeNormalizationbillOfLadingbox40buyerArticleNumberbuyerOrderNumbercaseIdcodecontainerscountryOfOrigincountrySpecificcreationTypecurrencycustomsDutycustomsProcedurecustomsTariffNumbercustomsValuecustomsValueAdditionDeductiondangerousGoodsdeliveryNotedescriptiondestinationCountrydiscountdiscountTextdiscountUnitdocumentDescriptiondocumentIddocumentTypesdocumentsexportingCountryfraudDetectiongrossWeightguaranteeNumberguaranteeValueidimportSalesTaxincludedWithPositioninvoiceDateinvoiceNumberisCondenseditemSizeitemSpecialUnititemSpecialUnitMeasureitemValuelotNumbermatchingMetadatamaterialmaterialIdmaterialMatchingTypematerialNumbermergedItemIdsmeursingCodenetWeightorderNumberorderedQuantityoriginalDocumentspackageTypepackagespackingListpositionpreferenceInformationpreferenceStatepreliminaryDocumentquantityrefIdreferenceserialNumbershippersourceDocumentIdsspecialRemarksstatisticalValuetotalGrossWeighttotalNetWeighttotalValuetotalValueExcludingChargestransitNumbertypeOfBusinessunitOfMeasurementunitswaybillNumberweightUnit