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>;
    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>;
    domesticFreightCosts?: DomesticFreightCosts;
    domesticInsuranceCosts?: DomesticFreightCosts;
    duration?: Meta<number>;
    endClient?: CompanyModel;
    exportDeclarationType?: TypeOfExportDeclarationModel;
    exporter?: CompanyModel;
    freightCosts?: Money;
    fromAddress?: AddressModel;
    guaranteeValue?: Money;
    importSalesTax?: Money;
    importer?: CompanyModel;
    incoterm?: IncotermModel;
    insuranceCosts?: Money;
    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>;
    };
    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[];
    shipper?: CompanyModel;
    statisticalValue?: Money;
    summary?: Meta<string>;
    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? consignee? constellationOfParticipants? contact? containers? contractualPartner? costIntersection? countryOfOrigin? countrySpecific? currency? customsOffices? declarant? declarantRepresentative? declarationType? departureCustomOffice? departureDate? destinationCustomOffice? domesticFreightCosts? domesticInsuranceCosts? duration? endClient? exportDeclarationType? exporter? freightCosts? fromAddress? guaranteeValue? importSalesTax? importer? incoterm? insuranceCosts? internationalFreightCosts? issueDate? items? loadType? meansOfTransportation? mrnNumber? netWeight? numberOfShipments? obligater? packages? paymentMethod? placeIncoterm? placeOfLoading? placeOfLoadingContact? pointOfEntry? pointOfExit? portOfExport? portOfImport? preliminaryDocuments? presentationDate? presentationTimeEnd? presentationTimeStart? procedure? referenceNumber? referenceNumberUCR? registrationDate? registrationNumberExternal? responsiblePerson? route? sealNumber? seals? shipper? statisticalValue? summary? 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

GRN?: Meta<string>
GRNAccessCode?: Meta<string>
LRN?: Meta<string>
additionalInformation?: Meta<string>
adjustments?: Adjustment[]

adjustments to statistical/duty/VAT value

agent?: CompanyModel
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
arrivalDate?: DateTimeModel
beneficiary?: CompanyModel
broker?: CompanyModel
buyer?: CompanyModel
buyerSellerRelation?: BuyerSellerRelationship
carrier?: CompanyModel
caseType?: Meta<CaseType>

Deprecated

case flow (import, export, ...)

consignee?: CompanyModel
constellationOfParticipants?: ConstellationOfParticipantsModel
contact?: {
    contactPerson?: PersonModel;
    email?: Meta<string>;
    phoneNr?: Meta<string>;
}

Type declaration

  • Optional contactPerson?: PersonModel
  • Optional email?: Meta<string>
  • Optional phoneNr?: Meta<string>
containers?: Container[]
contractualPartner?: CompanyModel

AWR/Außenwirtschaftsrechtlicher Ausführer

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>
domesticFreightCosts?: DomesticFreightCosts
domesticInsuranceCosts?: DomesticFreightCosts
duration?: Meta<number>
endClient?: CompanyModel
exportDeclarationType?: TypeOfExportDeclarationModel
exporter?: CompanyModel
freightCosts?: Money
fromAddress?: AddressModel
guaranteeValue?: Money
importSalesTax?: Money

EUSt

importer?: CompanyModel
incoterm?: IncotermModel
insuranceCosts?: Money
internationalFreightCosts?: Money

international freight costs

issueDate?: DateTimeModel
items?: LineItemModel[]
loadType?: Meta<LoadType>

Load Type, e.g. full container load

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>;
}

Type declaration

  • Optional contactPerson?: PersonModel
  • Optional email?: Meta<string>
  • Optional phoneNr?: Meta<string>
pointOfEntry?: AddressModel
pointOfExit?: AddressModel
portOfExport?: Port
portOfImport?: Port
preliminaryDocuments?: PreliminaryDocument[]
presentationDate?: DateTimeModel
presentationTimeEnd?: Meta<string>
presentationTimeStart?: Meta<string>
procedure?: Procedure
referenceNumber?: Meta<string>

commercial reference number, usually assigned by the trader

referenceNumberUCR?: Meta<string>
registrationDate?: DateTimeModel
registrationNumberExternal?: Meta<string>
responsiblePerson?: PersonModel
route?: Meta<string[]>
sealNumber?: Meta<string>
seals?: Seal[]
shipper?: CompanyModel
statisticalValue?: Money
summary?: Meta<string>
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>