Interface CustomsTariffNumber

Encapsulates typed und untyped workflow metadata for case properties

interface CustomsTariffNumber {
    additionalCodes?: Meta<string>[];
    bbox?: Bbox;
    classifier?: {
        default?: HsCodeModel;
    };
    complianceCheck?: {
        reason?: string;
        validityConfidence?: number;
    };
    confidence?: number;
    customsDescription?: string;
    display?: boolean;
    errors?: ErrorModel[];
    hsCode?: Meta<string>;
    hsCodeInvoice?: Meta<string>;
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: string[];
    reason?: string;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    suggestions?: TariffNumberSuggestion[];
    supplementaryUnits?: {
        number?: string;
        typeCode?: string;
    };
    taric?: {
        classificationType?: ClassificationTypes;
        error?: any;
        isError?: boolean;
        processedByTaric?: boolean;
        toBeProcessed?: boolean;
    };
    templateValue?: string;
    tradeZone?: {
        [key: string]: {
            code?: ClassificationCode;
            countries?: {
                [key: string]: {
                    code?: ClassificationCode;
                };
            };
        };
    };
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

  • Meta<string>
    • CustomsTariffNumber

Properties

additionalCodes? bbox? classifier? complianceCheck? confidence? customsDescription? display? errors? hsCode? hsCodeInvoice? input? lastChangedBy? modifiedAt? modifiedBy? options? reason? required? reviewNeeded? searchValue? source? suggestions? supplementaryUnits? taric? templateValue? tradeZone? userEdited? value?

Properties

Optional additionalCodes

additionalCodes?: Meta<string>[]

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional classifier

classifier?: {
    default?: HsCodeModel;
}

Type declaration

Optional complianceCheck

complianceCheck?: {
    reason?: string;
    validityConfidence?: number;
}

Checks if the tariff classification is likely to be valid

Type declaration

  • Optional reason?: string
  • Optional validityConfidence?: number

    Value between 1 (very confident) to 0 (no confidence)

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional customsDescription

customsDescription?: string

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional hsCode

hsCode?: Meta<string>

Optional hsCodeInvoice

hsCodeInvoice?: Meta<string>

Optional input

input?: string

The input value which was initially supplied for the property

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional modifiedAt

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

Optional modifiedBy

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional options

options?: string[]

Optional reason

reason?: string

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

Optional searchValue

searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

Optional source

source?: string

Optional suggestions

suggestions?: TariffNumberSuggestion[]

Optional supplementaryUnits

supplementaryUnits?: {
    number?: string;
    typeCode?: string;
}

Type declaration

  • Optional number?: string
  • Optional typeCode?: string

Optional taric

taric?: {
    classificationType?: ClassificationTypes;
    error?: any;
    isError?: boolean;
    processedByTaric?: boolean;
    toBeProcessed?: boolean;
}

Type declaration

  • Optional classificationType?: ClassificationTypes
  • Optional error?: any
  • Optional isError?: boolean
  • Optional processedByTaric?: boolean
  • Optional toBeProcessed?: boolean

Optional templateValue

templateValue?: string

Template value which was used to generate the value

Optional tradeZone

tradeZone?: {
    [key: string]: {
        code?: ClassificationCode;
        countries?: {
            [key: string]: {
                code?: ClassificationCode;
            };
        };
    };
}

Type declaration

Optional userEdited

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

Optional value

value?: string

The current value of the property

Settings

Member Visibility

Theme

On This Page

additionalCodesbboxclassifiercomplianceCheckconfidencecustomsDescriptiondisplayerrorshsCodehsCodeInvoiceinputlastChangedBymodifiedAtmodifiedByoptionsreasonrequiredreviewNeededsearchValuesourcesuggestionssupplementaryUnitstarictemplateValuetradeZoneuserEditedvalue