Interface InvoiceModel

Identifies an invoice

interface InvoiceModel {
    CAS?: Meta<string>;
    analyzerMetadata?: AnalyzerMetadataModel;
    beneficiary?: CompanyModel;
    buyerOrderNumber?: Meta<string>;
    buyerReferenceId?: Meta<string>;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    consignee?: CompanyModel;
    countryOfOrigin?: AddressModel;
    createdAt?: Date;
    currency?: Meta<Currency>;
    customerId?: string;
    customsValue?: Money;
    deliveryNote?: Meta<string>;
    discount?: Money;
    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;
    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>;
    rossumMetadata?: {
        annotationId?: string;
        exportOnConfirmed?: boolean;
        importStatus?: RossumImportStatus;
        queueId?: number;
    };
    sellerOrderNumber?: Meta<string>;
    shipper?: CompanyModel;
    shippingCost?: Money;
    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?: Meta<string>
analyzerMetadata?: AnalyzerMetadataModel
beneficiary?: CompanyModel
buyerOrderNumber?: Meta<string>
buyerReferenceId?: Meta<string>
caseId?: string
classificationStatus?: ClassificationStatus
code?: string
consignee?: CompanyModel
countryOfOrigin?: AddressModel
createdAt?: Date
currency?: Meta<Currency>
customerId?: string
customsValue?: Money
deliveryNote?: Meta<string>
discount?: Money
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[]
licenseFee?: Money
meansOfTransportation?: MeanOfTransportation[]
modifiedBy?: {
    date?: Date;
    displayName?: string;
    id?: string;
}

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional id?: string
netWeight?: Weight
numberOfShipments?: Meta<number>
otherPayments?: Money
packageDimensions?: Dimensions
packages?: Package[]
packagingCosts?: Money
packingList?: Meta<string>
pageCount?: number
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>
rossumMetadata?: {
    annotationId?: string;
    exportOnConfirmed?: boolean;
    importStatus?: RossumImportStatus;
    queueId?: number;
}

Type declaration

  • Optional annotationId?: string
  • Optional exportOnConfirmed?: boolean
  • Optional importStatus?: RossumImportStatus
  • Optional queueId?: number

Deprecated

sellerOrderNumber?: Meta<string>
shipper?: CompanyModel
shippingCost?: Money
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>

Generated using TypeDoc