Interface InvoiceModel

Identifies an invoice

interface InvoiceModel {
    CAS?: Meta<string>;
    _isNew?: boolean;
    adjustmentItems?: {
        item?: LineItemModel;
        originalIdx: number;
        type?: "additionalCosts" | "freightCosts" | "discount" | "stripped" | "merged";
    }[];
    analyzerMetadata?: AnalyzerMetadataModel;
    beforeNormalization?: {
        currency?: Meta<Currency>;
        netWeight?: Weight;
        totalTax?: Money;
        totalValue?: Money;
        totalValueWithoutTax?: Money;
        weight?: Weight;
        weightUnit?: Meta<WeightUnit>;
    };
    beneficiary?: CompanyModel;
    buyerOrderNumber?: Meta<string>;
    buyerReferenceId?: Meta<string>;
    caseId?: string;
    chassisNumber?: Meta<string>;
    classificationStatus?: ClassificationStatus;
    code?: string;
    consignee?: CompanyModel;
    containers?: Container[];
    countryOfOrigin?: AddressModel;
    createdAt?: Date;
    currency?: Meta<Currency>;
    customerId?: string;
    customsValue?: Money;
    deliveryNote?: Meta<string>;
    discount?: Money;
    discount2?: Money;
    discountApplied?: boolean;
    discountUnit?: Meta<Currency | "%">;
    distributions?: Distributions;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    dualUseApprovalNumber?: Meta<string>;
    dueDate?: DateTimeModel;
    extractId?: string;
    fileName?: string;
    generalGoodsDescription?: Meta<string>;
    generalHsCode?: CustomsTariffNumber;
    id?: string;
    incoterm?: IncotermModel;
    insuranceCosts?: Money;
    intendedApplication?: Meta<string>;
    intrastatInformation?: Meta<string>;
    invoiceDate?: DateTimeModel;
    invoiceNumber?: Meta<string>;
    invoiceType?: InvoiceType;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    itemIds?: string[];
    items?: LineItemModel[];
    language?: LanguageModel & Meta<DocumentLanguage>;
    licenseFee?: Money;
    meansOfTransportation?: MeanOfTransportation[];
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    netWeight?: Weight;
    numberOfShipments?: Meta<number>;
    otherPayments?: Money;
    packageDimensions?: Dimensions;
    packages?: Package[];
    packagingCosts?: Money;
    packingList?: Meta<string>;
    pageCount?: number;
    pages?: DocumentPage[];
    paymentAccountNumber?: Meta<string>;
    paymentBIC?: Meta<string>;
    paymentBankCode?: Meta<string>;
    paymentIBAN?: Meta<string>;
    placeIncoterm?: AddressModel;
    portOfExport?: Port;
    portOfImport?: Port;
    preferenceInformation?: Meta<string>;
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    recipient?: CompanyModel;
    reference?: string;
    referenceNumber?: Meta<string>;
    sellerOrderNumber?: Meta<string>;
    shipper?: CompanyModel;
    shippingCost?: Money;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    subDocumentStatus?: SubDocumentStatus;
    substanceCharacteristics?: Meta<string>;
    taxDetails?: TaxDetailsModel[];
    totalTax?: Money;
    totalValue?: Money;
    totalValueExcludingCharges?: Money;
    totalValueWithoutTax?: Money;
    tradePreference?: TradePreference;
    typeOfBusiness?: TypeOfBusiness;
    typeOfPackage?: PackageType;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
    waybillNumber?: Meta<string>;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

CAS? _isNew? adjustmentItems? analyzerMetadata? beforeNormalization? beneficiary? buyerOrderNumber? buyerReferenceId? caseId? chassisNumber? classificationStatus? code? consignee? containers? countryOfOrigin? createdAt? currency? customerId? customsValue? deliveryNote? discount? discount2? discountApplied? discountUnit? distributions? documentCode? documentReference? documentStatus? documentType? dualUseApprovalNumber? dueDate? extractId? fileName? generalGoodsDescription? generalHsCode? id? incoterm? insuranceCosts? intendedApplication? intrastatInformation? invoiceDate? invoiceNumber? invoiceType? isCondensed? isPseudonymized? issueDate? itemIds? items? language? licenseFee? meansOfTransportation? modifiedBy? netWeight? numberOfShipments? otherPayments? packageDimensions? packages? packagingCosts? packingList? pageCount? pages? paymentAccountNumber? paymentBIC? paymentBankCode? paymentIBAN? placeIncoterm? portOfExport? portOfImport? preferenceInformation? processing? projectId? queueId? receivedAt? recipient? reference? referenceNumber? sellerOrderNumber? shipper? shippingCost? sourceMaterialId? specialFileFormat? subDocumentStatus? substanceCharacteristics? taxDetails? totalTax? totalValue? totalValueExcludingCharges? totalValueWithoutTax? tradePreference? typeOfBusiness? typeOfPackage? uploadedFiles? userDocumentStatus? userEdited? waybillNumber? weight? weightUnit?

Properties

Optional CAS

CAS?: Meta<string>

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 beforeNormalization

beforeNormalization?: {
    currency?: Meta<Currency>;
    netWeight?: Weight;
    totalTax?: Money;
    totalValue?: Money;
    totalValueWithoutTax?: Money;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Type declaration

Optional beneficiary

beneficiary?: CompanyModel

Optional buyerOrderNumber

buyerOrderNumber?: Meta<string>

Optional buyerReferenceId

buyerReferenceId?: Meta<string>

Optional caseId

caseId?: string

Optional chassisNumber

chassisNumber?: Meta<string>

CT-1895 p2 field requested by HTS, it will be present on email or invoice

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional consignee

consignee?: CompanyModel

Optional containers

containers?: Container[]

Optional countryOfOrigin

countryOfOrigin?: AddressModel

Optional createdAt

createdAt?: Date

Optional currency

currency?: Meta<Currency>

Optional customerId

customerId?: string

Optional customsValue

customsValue?: Money

Optional deliveryNote

deliveryNote?: Meta<string>

Optional discount

discount?: Money

Optional discount2

discount2?: Money

Optional discountApplied

discountApplied?: boolean

Optional discountUnit

discountUnit?: Meta<Currency | "%">

Optional distributions

distributions?: Distributions

Optional documentCode

documentCode?: DocumentCode

Optional documentReference

documentReference?: Meta<string>

Optional documentStatus

documentStatus?: DocumentStatus

Optional documentType

documentType?: DigicustDocumentType

Optional dualUseApprovalNumber

dualUseApprovalNumber?: Meta<string>

Optional dueDate

dueDate?: DateTimeModel

Optional extractId

extractId?: string

Optional fileName

fileName?: string

Optional generalGoodsDescription

generalGoodsDescription?: Meta<string>

Optional generalHsCode

generalHsCode?: CustomsTariffNumber

Optional id

id?: string

Optional incoterm

incoterm?: IncotermModel

Optional insuranceCosts

insuranceCosts?: Money

Optional intendedApplication

intendedApplication?: Meta<string>

Optional intrastatInformation

intrastatInformation?: Meta<string>

Optional invoiceDate

invoiceDate?: DateTimeModel

Optional invoiceNumber

invoiceNumber?: Meta<string>

Optional invoiceType

invoiceType?: InvoiceType

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional itemIds

itemIds?: string[]

Optional items

items?: LineItemModel[]

Optional language

language?: LanguageModel & Meta<DocumentLanguage>

Optional licenseFee

licenseFee?: Money

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 numberOfShipments

numberOfShipments?: Meta<number>

Optional otherPayments

otherPayments?: Money

Optional packageDimensions

packageDimensions?: Dimensions

Optional packages

packages?: Package[]

Optional packagingCosts

packagingCosts?: Money

Optional packingList

packingList?: Meta<string>

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional paymentAccountNumber

paymentAccountNumber?: Meta<string>

Optional paymentBIC

paymentBIC?: Meta<string>

Optional paymentBankCode

paymentBankCode?: Meta<string>

Optional paymentIBAN

paymentIBAN?: Meta<string>

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional portOfExport

portOfExport?: Port

Optional portOfImport

portOfImport?: Port

Optional preferenceInformation

preferenceInformation?: Meta<string>

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 sellerOrderNumber

sellerOrderNumber?: Meta<string>

Optional shipper

shipper?: CompanyModel

Optional shippingCost

shippingCost?: Money

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 substanceCharacteristics

substanceCharacteristics?: Meta<string>

Optional taxDetails

taxDetails?: TaxDetailsModel[]

Optional totalTax

totalTax?: Money

Optional totalValue

totalValue?: Money

Optional totalValueExcludingCharges

totalValueExcludingCharges?: Money

Optional totalValueWithoutTax

totalValueWithoutTax?: Money

Optional tradePreference

tradePreference?: TradePreference

Optional typeOfBusiness

typeOfBusiness?: TypeOfBusiness

Optional typeOfPackage

typeOfPackage?: PackageType

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Optional waybillNumber

waybillNumber?: Meta<string>

Optional weight

weight?: Weight

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

CAS_isNewadjustmentItemsanalyzerMetadatabeforeNormalizationbeneficiarybuyerOrderNumberbuyerReferenceIdcaseIdchassisNumberclassificationStatuscodeconsigneecontainerscountryOfOrigincreatedAtcurrencycustomerIdcustomsValuedeliveryNotediscountdiscount2discountApplieddiscountUnitdistributionsdocumentCodedocumentReferencedocumentStatusdocumentTypedualUseApprovalNumberdueDateextractIdfileNamegeneralGoodsDescriptiongeneralHsCodeidincoterminsuranceCostsintendedApplicationintrastatInformationinvoiceDateinvoiceNumberinvoiceTypeisCondensedisPseudonymizedissueDateitemIdsitemslanguagelicenseFeemeansOfTransportationmodifiedBynetWeightnumberOfShipmentsotherPaymentspackageDimensionspackagespackagingCostspackingListpageCountpagespaymentAccountNumberpaymentBICpaymentBankCodepaymentIBANplaceIncotermportOfExportportOfImportpreferenceInformationprocessingprojectIdqueueIdreceivedAtrecipientreferencereferenceNumbersellerOrderNumbershippershippingCostsourceMaterialIdspecialFileFormatsubDocumentStatussubstanceCharacteristicstaxDetailstotalTaxtotalValuetotalValueExcludingChargestotalValueWithoutTaxtradePreferencetypeOfBusinesstypeOfPackageuploadedFilesuserDocumentStatususerEditedwaybillNumberweightweightUnit