Interface AggregatedCaseDataModel

Used to store aggregated information of a case

interface AggregatedCaseDataModel {
    GRN?: Meta<string>;
    GRNAccessCode?: Meta<string>;
    LRN?: Meta<string>;
    additionalInformation?: Meta<string>;
    adjustments?: Adjustment[];
    agent?: CompanyModel;
    aggregatedDescriptions?: {
        alpha2Code: string;
        description: string;
        tariffNumber: string;
    }[];
    arrivalDate?: DateTimeModel;
    beneficiary?: CompanyModel;
    broker?: CompanyModel;
    buyer?: CompanyModel;
    buyerSellerRelation?: BuyerSellerRelationship;
    carrier?: CompanyModel;
    caseType?: Meta<CaseType>;
    chassisNumber?: Meta<string>;
    consignee?: CompanyModel;
    constellationOfParticipants?: ConstellationOfParticipantsModel;
    contact?: {
        contactPerson?: PersonModel;
        email?: Meta<string>;
        phoneNr?: Meta<string>;
    };
    containers?: Container[];
    contractualPartner?: CompanyModel;
    costIntersection?: CostIntersection;
    countryOfOrigin?: AddressModel;
    countrySpecific?: CountrySpecificAggregated;
    currency?: Meta<Currency>;
    customsOffices?: CustomsOffice[];
    declarant?: CompanyModel;
    declarantRepresentative?: CompanyModel;
    declarationType?: Meta<DeclarationType>;
    departureCustomOffice?: Meta<string>;
    departureDate?: DateTimeModel;
    destinationCustomOffice?: Meta<string>;
    destinationDocks?: {
        deliveryCode?: Meta<string>;
        unloadingCode?: Meta<string>;
    };
    domesticFreightCosts?: DomesticFreightCosts;
    domesticInsuranceCosts?: DomesticFreightCosts;
    duration?: Meta<number>;
    endClient?: CompanyModel;
    exportDeclarationType?: TypeOfExportDeclarationModel;
    exporter?: CompanyModel;
    forwardingNumber?: Meta<string>;
    freightCosts?: Money;
    fromAddress?: AddressModel;
    guaranteeValue?: Money;
    importSalesTax?: Money;
    importer?: CompanyModel;
    incoterm?: IncotermModel;
    insuranceCosts?: Money & {
        percentage?: number;
    };
    internationalFreightCosts?: Money;
    issueDate?: DateTimeModel;
    items?: LineItemModel[];
    loadType?: Meta<LoadType>;
    meansOfTransportation?: MeanOfTransportation[];
    mrnNumber?: Meta<string>;
    netWeight?: Weight;
    numberOfShipments?: Meta<number>;
    obligater?: CompanyModel;
    packages?: Package[];
    paymentMethod?: PaymentMethod;
    placeIncoterm?: AddressModel;
    placeOfLoading?: AddressModel;
    placeOfLoadingContact?: {
        contactPerson?: PersonModel;
        email?: Meta<string>;
        phoneNr?: Meta<string>;
    };
    placeOfUnloading?: AddressModel;
    pointOfEntry?: AddressModel;
    pointOfExit?: AddressModel;
    portOfExport?: Port;
    portOfImport?: Port;
    preliminaryDocuments?: PreliminaryDocument[];
    presentationDate?: DateTimeModel;
    presentationTimeEnd?: Meta<string>;
    presentationTimeStart?: Meta<string>;
    procedure?: Procedure;
    referenceNumber?: Meta<string>;
    referenceNumberUCR?: Meta<string>;
    registrationDate?: DateTimeModel;
    registrationNumberExternal?: Meta<string>;
    responsiblePerson?: PersonModel;
    route?: Meta<string[]>;
    sealNumber?: Meta<string>;
    seals?: Seal[];
    shipmentTrackingNumber?: Meta<string>;
    shipper?: CompanyModel;
    statisticalValue?: Money;
    summary?: Meta<string>;
    suppliers?: CompanyModel[];
    toAddress?: AddressModel;
    totalCustomsValue?: Money;
    totalDiscount?: Money;
    totalLicenseFee?: Money;
    totalOtherPayments?: Money;
    totalPackagingCosts?: Money;
    totalShippingCost?: Money;
    totalTax?: Money;
    totalValue?: Money;
    totalValueExcludingCharges?: Money;
    totalValueWithoutTax?: Money;
    tradePreference?: TradePreference;
    trailerLicensePlate?: Meta<string>;
    transferDate?: DateTimeModel;
    transitCountries?: AddressModel[];
    transitItems?: TransitItemModel[];
    truckLicensePlate?: Meta<string>;
    truckNationality?: Meta<string>;
    typeofBusiness?: TypeOfBusiness;
    warehouse?: CompanyModel;
    waybillNumber?: Meta<string>;
    waybillType?: WaybillTypeModel;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Properties

GRN? GRNAccessCode? LRN? additionalInformation? adjustments? agent? aggregatedDescriptions? arrivalDate? beneficiary? broker? buyer? buyerSellerRelation? carrier? caseType? chassisNumber? consignee? constellationOfParticipants? contact? containers? contractualPartner? costIntersection? countryOfOrigin? countrySpecific? currency? customsOffices? declarant? declarantRepresentative? declarationType? departureCustomOffice? departureDate? destinationCustomOffice? destinationDocks? domesticFreightCosts? domesticInsuranceCosts? duration? endClient? exportDeclarationType? exporter? forwardingNumber? freightCosts? fromAddress? guaranteeValue? importSalesTax? importer? incoterm? insuranceCosts? internationalFreightCosts? issueDate? items? loadType? meansOfTransportation? mrnNumber? netWeight? numberOfShipments? obligater? packages? paymentMethod? placeIncoterm? placeOfLoading? placeOfLoadingContact? placeOfUnloading? pointOfEntry? pointOfExit? portOfExport? portOfImport? preliminaryDocuments? presentationDate? presentationTimeEnd? presentationTimeStart? procedure? referenceNumber? referenceNumberUCR? registrationDate? registrationNumberExternal? responsiblePerson? route? sealNumber? seals? shipmentTrackingNumber? shipper? statisticalValue? summary? suppliers? toAddress? totalCustomsValue? totalDiscount? totalLicenseFee? totalOtherPayments? totalPackagingCosts? totalShippingCost? totalTax? totalValue? totalValueExcludingCharges? totalValueWithoutTax? tradePreference? trailerLicensePlate? transferDate? transitCountries? transitItems? truckLicensePlate? truckNationality? typeofBusiness? warehouse? waybillNumber? waybillType? weight? weightUnit?

Properties

Optional GRN

GRN?: Meta<string>

Optional GRNAccessCode

GRNAccessCode?: Meta<string>

Optional LRN

LRN?: Meta<string>

Optional additionalInformation

additionalInformation?: Meta<string>

Optional adjustments

adjustments?: Adjustment[]

adjustments to statistical/duty/VAT value

Optional agent

agent?: CompanyModel

Optional aggregatedDescriptions

aggregatedDescriptions?: {
    alpha2Code: string;
    description: string;
    tariffNumber: string;
}[]

Contains (experimental) aggregated descriptions by tariff number and country of origin code

Type declaration

  • alpha2Code: string
  • description: string
  • tariffNumber: string

Optional arrivalDate

arrivalDate?: DateTimeModel

Optional beneficiary

beneficiary?: CompanyModel

Optional broker

broker?: CompanyModel

Optional buyer

buyer?: CompanyModel

Optional buyerSellerRelation

buyerSellerRelation?: BuyerSellerRelationship

Optional carrier

carrier?: CompanyModel

Optional caseType

caseType?: Meta<CaseType>

Deprecated

case flow (import, export, ...)

Optional chassisNumber

chassisNumber?: Meta<string>

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

Optional consignee

consignee?: CompanyModel

Optional constellationOfParticipants

constellationOfParticipants?: ConstellationOfParticipantsModel

Optional contact

contact?: {
    contactPerson?: PersonModel;
    email?: Meta<string>;
    phoneNr?: Meta<string>;
}

Type declaration

  • Optional contactPerson?: PersonModel
  • Optional email?: Meta<string>
  • Optional phoneNr?: Meta<string>

Optional containers

containers?: Container[]

Optional contractualPartner

contractualPartner?: CompanyModel

AWR/Außenwirtschaftsrechtlicher Ausführer

Optional costIntersection

costIntersection?: CostIntersection

Optional countryOfOrigin

countryOfOrigin?: AddressModel

Optional countrySpecific

countrySpecific?: CountrySpecificAggregated

Optional currency

currency?: Meta<Currency>

Optional customsOffices

customsOffices?: CustomsOffice[]

Optional declarant

declarant?: CompanyModel

Optional declarantRepresentative

declarantRepresentative?: CompanyModel

Optional declarationType

declarationType?: Meta<DeclarationType>

Optional departureCustomOffice

departureCustomOffice?: Meta<string>

Optional departureDate

departureDate?: DateTimeModel

Optional destinationCustomOffice

destinationCustomOffice?: Meta<string>

Optional destinationDocks

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

Location codes specifying the exact receiving/unloading points at the destination

Type declaration

  • Optional deliveryCode?: Meta<string>
  • Optional unloadingCode?: Meta<string>

Optional domesticFreightCosts

domesticFreightCosts?: DomesticFreightCosts

Optional domesticInsuranceCosts

domesticInsuranceCosts?: DomesticFreightCosts

Optional duration

duration?: Meta<number>

Optional endClient

endClient?: CompanyModel

Optional exportDeclarationType

exportDeclarationType?: TypeOfExportDeclarationModel

Optional exporter

exporter?: CompanyModel

Optional forwardingNumber

forwardingNumber?: Meta<string>

German: Speditionsauftrag number

Optional freightCosts

freightCosts?: Money

Optional fromAddress

fromAddress?: AddressModel

Optional guaranteeValue

guaranteeValue?: Money

Optional importSalesTax

importSalesTax?: Money

EUSt

Optional importer

importer?: CompanyModel

Optional incoterm

incoterm?: IncotermModel

Optional insuranceCosts

insuranceCosts?: Money & {
    percentage?: number;
}

Type declaration

  • Optional percentage?: number

Optional internationalFreightCosts

internationalFreightCosts?: Money

international freight costs

Optional issueDate

issueDate?: DateTimeModel

Optional items

items?: LineItemModel[]

Optional loadType

loadType?: Meta<LoadType>

Load Type, e.g. full container load

Optional meansOfTransportation

meansOfTransportation?: MeanOfTransportation[]

Optional mrnNumber

mrnNumber?: Meta<string>

Optional netWeight

netWeight?: Weight

Optional numberOfShipments

numberOfShipments?: Meta<number>

Optional obligater

obligater?: CompanyModel

Optional packages

packages?: Package[]

Optional paymentMethod

paymentMethod?: PaymentMethod

Optional placeIncoterm

placeIncoterm?: AddressModel

Optional placeOfLoading

placeOfLoading?: AddressModel

Optional placeOfLoadingContact

placeOfLoadingContact?: {
    contactPerson?: PersonModel;
    email?: Meta<string>;
    phoneNr?: Meta<string>;
}

Type declaration

  • Optional contactPerson?: PersonModel
  • Optional email?: Meta<string>
  • Optional phoneNr?: Meta<string>

Optional placeOfUnloading

placeOfUnloading?: AddressModel

Optional pointOfEntry

pointOfEntry?: AddressModel

Optional pointOfExit

pointOfExit?: AddressModel

Optional portOfExport

portOfExport?: Port

Optional portOfImport

portOfImport?: Port

Optional preliminaryDocuments

preliminaryDocuments?: PreliminaryDocument[]

Optional presentationDate

presentationDate?: DateTimeModel

Optional presentationTimeEnd

presentationTimeEnd?: Meta<string>

Optional presentationTimeStart

presentationTimeStart?: Meta<string>

Optional procedure

procedure?: Procedure

Optional referenceNumber

referenceNumber?: Meta<string>

commercial reference number, usually assigned by the trader

Optional referenceNumberUCR

referenceNumberUCR?: Meta<string>

Optional registrationDate

registrationDate?: DateTimeModel

Optional registrationNumberExternal

registrationNumberExternal?: Meta<string>

Optional responsiblePerson

responsiblePerson?: PersonModel

Optional route

route?: Meta<string[]>

Optional sealNumber

sealNumber?: Meta<string>

Optional seals

seals?: Seal[]

Optional shipmentTrackingNumber

shipmentTrackingNumber?: Meta<string>

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

Optional shipper

shipper?: CompanyModel

Optional statisticalValue

statisticalValue?: Money

Optional summary

summary?: Meta<string>

Optional suppliers

suppliers?: CompanyModel[]

Optional toAddress

toAddress?: AddressModel

Optional totalCustomsValue

totalCustomsValue?: Money

Optional totalDiscount

totalDiscount?: Money

Optional totalLicenseFee

totalLicenseFee?: Money

Optional totalOtherPayments

totalOtherPayments?: Money

Optional totalPackagingCosts

totalPackagingCosts?: Money

Optional totalShippingCost

totalShippingCost?: Money

Optional totalTax

totalTax?: Money

Optional totalValue

totalValue?: Money

Optional totalValueExcludingCharges

totalValueExcludingCharges?: Money

Optional totalValueWithoutTax

totalValueWithoutTax?: Money

Optional tradePreference

tradePreference?: TradePreference

Optional trailerLicensePlate

trailerLicensePlate?: Meta<string>

Optional transferDate

transferDate?: DateTimeModel

Optional transitCountries

transitCountries?: AddressModel[]

Optional transitItems

transitItems?: TransitItemModel[]

Optional truckLicensePlate

truckLicensePlate?: Meta<string>

Optional truckNationality

truckNationality?: Meta<string>

Optional typeofBusiness

typeofBusiness?: TypeOfBusiness

Optional warehouse

warehouse?: CompanyModel

Optional waybillNumber

waybillNumber?: Meta<string>

Optional waybillType

waybillType?: WaybillTypeModel

Optional weight

weight?: Weight

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

GRNGRNAccessCodeLRNadditionalInformationadjustmentsagentaggregatedDescriptionsarrivalDatebeneficiarybrokerbuyerbuyerSellerRelationcarriercaseTypechassisNumberconsigneeconstellationOfParticipantscontactcontainerscontractualPartnercostIntersectioncountryOfOrigincountrySpecificcurrencycustomsOfficesdeclarantdeclarantRepresentativedeclarationTypedepartureCustomOfficedepartureDatedestinationCustomOfficedestinationDocksdomesticFreightCostsdomesticInsuranceCostsdurationendClientexportDeclarationTypeexporterforwardingNumberfreightCostsfromAddressguaranteeValueimportSalesTaximporterincoterminsuranceCostsinternationalFreightCostsissueDateitemsloadTypemeansOfTransportationmrnNumbernetWeightnumberOfShipmentsobligaterpackagespaymentMethodplaceIncotermplaceOfLoadingplaceOfLoadingContactplaceOfUnloadingpointOfEntrypointOfExitportOfExportportOfImportpreliminaryDocumentspresentationDatepresentationTimeEndpresentationTimeStartprocedurereferenceNumberreferenceNumberUCRregistrationDateregistrationNumberExternalresponsiblePersonroutesealNumbersealsshipmentTrackingNumbershipperstatisticalValuesummarysupplierstoAddresstotalCustomsValuetotalDiscounttotalLicenseFeetotalOtherPaymentstotalPackagingCoststotalShippingCosttotalTaxtotalValuetotalValueExcludingChargestotalValueWithoutTaxtradePreferencetrailerLicensePlatetransferDatetransitCountriestransitItemstruckLicensePlatetruckNationalitytypeofBusinesswarehousewaybillNumberwaybillTypeweightweightUnit