Interface MaterialModel

interface MaterialModel {
    CAS?: Workflow<string>;
    additionalInformation?: Meta<string>;
    agentId?: string;
    applicantId?: string;
    beneficiaryId?: string;
    brokerId?: string;
    buyerArticleNumber?: Workflow<string>;
    buyerId?: string;
    buyerOrderNumber?: Workflow<string>;
    carrierId?: string;
    code?: Workflow<string>;
    consigneeId?: string;
    countryOfOriginHistory?: ItemCountryOfOrigin[];
    creationType?: MasterDataCreationType;
    customProperties?: {
        [key: string]: string;
    };
    customerId?: string;
    customsLaw?: {
        customsTariffNumber?: CustomsTariffNumber & Workflow<any>;
        customsTariffNumberByCountry?: {
            [alpha2Code: string]: string;
        };
        preferences?: Workflow<TradePreference>[];
        procedure?: Workflow<string>;
        typeOfBusiness?: Workflow<TypeOfBusinessType>;
    };
    declarantId?: string;
    description?: Workflow<string>;
    destinationCountry?: AddressModel;
    dimensions?: Dimensions & Workflow<any>;
    documentDescription?: Workflow<string>;
    documentTypeCodes?: ExtendedDocumentTypeCode[];
    eanNumber?: Workflow<string>;
    exporterId?: string;
    grossWeight?: Weight & Workflow<number>;
    hasAnyUserEditedProperties?: boolean;
    id?: string;
    importerId?: string;
    itemPrice?: Money & Workflow<number>;
    matchingType?: "tariffNumber" | "materialNumber";
    materialNumber?: Workflow<string>;
    meta?: {
        userCreated?: boolean;
        userEdited?: boolean;
        version?: number;
    };
    meursing?: Meursing[];
    netWeight?: Weight & Workflow<number>;
    obligaterId?: string;
    priceHistory?: ItemPrice[];
    projectId?: string;
    recipientId?: string;
    recipients?: {
        id: string;
        name: string;
    }[];
    shipper?: string;
    shipperCountry?: AddressModel;
    shipperId?: string;
    tags?: string[];
    unitOfMeasurement?: UnitOfMeasurement;
    units?: Workflow<{
        number?: number;
        type?: string;
    }>[];
    warehouseId?: string;
}

Properties

CAS? additionalInformation? agentId? applicantId? beneficiaryId? brokerId? buyerArticleNumber? buyerId? buyerOrderNumber? carrierId? code? consigneeId? countryOfOriginHistory? creationType? customProperties? customerId? customsLaw? declarantId? description? destinationCountry? dimensions? documentDescription? documentTypeCodes? eanNumber? exporterId? grossWeight? hasAnyUserEditedProperties? id? importerId? itemPrice? matchingType? materialNumber? meta? meursing? netWeight? obligaterId? priceHistory? projectId? recipientId? recipients? shipper? shipperCountry? shipperId? tags? unitOfMeasurement? units? warehouseId?

Properties

Optional CAS

CAS?: Workflow<string>

Optional additionalInformation

additionalInformation?: Meta<string>

Optional agentId

agentId?: string

Owning agent, if any. Used for matching by tariff number.

Optional applicantId

applicantId?: string

Owning applicant, if any. Used for matching by tariff number.

Optional beneficiaryId

beneficiaryId?: string

Owning beneficiary, if any. Used for matching by tariff number.

Optional brokerId

brokerId?: string

Owning broker, if any. Used for matching by tariff number.

Optional buyerArticleNumber

buyerArticleNumber?: Workflow<string>

Optional buyerId

buyerId?: string

Owning buyer, if any. Used for matching by tariff number.

Optional buyerOrderNumber

buyerOrderNumber?: Workflow<string>

Optional carrierId

carrierId?: string

Owning carrier, if any. Used for matching by tariff number.

Optional code

code?: Workflow<string>

Optional consigneeId

consigneeId?: string

Owning consignee, if any. Used for matching by tariff number.

Optional countryOfOriginHistory

countryOfOriginHistory?: ItemCountryOfOrigin[]

Optional creationType

creationType?: MasterDataCreationType

Optional customProperties

customProperties?: {
    [key: string]: string;
}

Key/Value pairs for custom properties

Type declaration

  • [key: string]: string

Optional customerId

customerId?: string

Optional customsLaw

customsLaw?: {
    customsTariffNumber?: CustomsTariffNumber & Workflow<any>;
    customsTariffNumberByCountry?: {
        [alpha2Code: string]: string;
    };
    preferences?: Workflow<TradePreference>[];
    procedure?: Workflow<string>;
    typeOfBusiness?: Workflow<TypeOfBusinessType>;
}

Type declaration

  • Optional customsTariffNumber?: CustomsTariffNumber & Workflow<any>

    Customs tariff number for "default" country (the one set in the project settings tariff number tree system)

  • Optional customsTariffNumberByCountry?: {
        [alpha2Code: string]: string;
    }

    Map to foreign tariff number per country, e.g. "CH" -> "12345678"

    • [alpha2Code: string]: string
  • Optional preferences?: Workflow<TradePreference>[]
  • Optional procedure?: Workflow<string>
  • Optional typeOfBusiness?: Workflow<TypeOfBusinessType>

Optional declarantId

declarantId?: string

Owning declarant, if any. Used for matching by tariff number.

Optional description

description?: Workflow<string>

Optional destinationCountry

destinationCountry?: AddressModel

Used for matching aggregated.toAddress, only for export cases

Optional dimensions

dimensions?: Dimensions & Workflow<any>

Optional documentDescription

documentDescription?: Workflow<string>

Optional documentTypeCodes

documentTypeCodes?: ExtendedDocumentTypeCode[]

Optional eanNumber

eanNumber?: Workflow<string>

Optional exporterId

exporterId?: string

Owning exporter, if any. Used for matching by tariff number.

Optional grossWeight

grossWeight?: Weight & Workflow<number>

Optional hasAnyUserEditedProperties

hasAnyUserEditedProperties?: boolean

Redundant meta property needed for search scoring

Optional id

id?: string

Optional importerId

importerId?: string

Owning exporter, if any. Used for matching by tariff number.

Optional itemPrice

itemPrice?: Money & Workflow<number>

Optional matchingType

matchingType?: "tariffNumber" | "materialNumber"

Optional materialNumber

materialNumber?: Workflow<string>

Optional meta

meta?: {
    userCreated?: boolean;
    userEdited?: boolean;
    version?: number;
}

Type declaration

  • Optional userCreated?: boolean
  • Optional userEdited?: boolean
  • Optional version?: number

Optional meursing

meursing?: Meursing[]

Optional netWeight

netWeight?: Weight & Workflow<number>

Optional obligaterId

obligaterId?: string

Owning obligater, if any. Used for matching by tariff number.

Optional priceHistory

priceHistory?: ItemPrice[]

Optional projectId

projectId?: string

Optional recipientId

recipientId?: string

Owning recipient, if any. Used for matching by tariff number.

Optional recipients

recipients?: {
    id: string;
    name: string;
}[]

Different materialNumbers might be applied for different recipients. The recipientId refers to a stakeholder.

Type declaration

  • id: string
  • name: string

Optional shipper

shipper?: string

Stakeholder reference, owning shipper entity. Each materialNumber can only be uniquely matched to the same shipper there might be more than one materialNumber for different recipients!

Optional shipperCountry

shipperCountry?: AddressModel

Used for matching item.countryOfOrigin / aggregated.fromAddress (fallback), only for import cases

Optional shipperId

shipperId?: string

Optional tags

tags?: string[]

Tags for material data

Optional unitOfMeasurement

unitOfMeasurement?: UnitOfMeasurement

Optional units

units?: Workflow<{
    number?: number;
    type?: string;
}>[]

Optional warehouseId

warehouseId?: string

Owning warehouse, if any. Used for matching by tariff number.

Settings

Member Visibility

Theme

On This Page

CASadditionalInformationagentIdapplicantIdbeneficiaryIdbrokerIdbuyerArticleNumberbuyerIdbuyerOrderNumbercarrierIdcodeconsigneeIdcountryOfOriginHistorycreationTypecustomPropertiescustomerIdcustomsLawdeclarantIddescriptiondestinationCountrydimensionsdocumentDescriptiondocumentTypeCodeseanNumberexporterIdgrossWeighthasAnyUserEditedPropertiesidimporterIditemPricematchingTypematerialNumbermetameursingnetWeightobligaterIdpriceHistoryprojectIdrecipientIdrecipientsshippershipperCountryshipperIdtagsunitOfMeasurementunitswarehouseId