Interface Adjustment

adjustments to statistical/duty/VAT value

interface Adjustment {
    amountOfMoney?: Money;
    bbox?: Bbox;
    confidence?: number;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: any[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    type?: "Addition_Insurance" | "Addition_Transport" | "Addition_Further" | "Deduction_Insurance" | "Deduction_Transport" | "Deduction_Further";
    userEdited?: boolean;
    value?: any;
    valueType?: "VAT" | "Duty" | "Statistical";
}

Hierarchy (view full)

Properties

amountOfMoney? bbox? confidence? display? errors? input? lastChangedBy? modifiedAt? modifiedBy? options? reason? required? reviewNeeded? searchValue? source? templateValue? type? userEdited? value? valueType?

Properties

Optional amountOfMoney

amountOfMoney?: Money

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

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?: any[]

Optional reason

reason?: any

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 templateValue

templateValue?: string

Template value which was used to generate the value

Optional type

type?: "Addition_Insurance" | "Addition_Transport" | "Addition_Further" | "Deduction_Insurance" | "Deduction_Transport" | "Deduction_Further"

Optional userEdited

userEdited?: boolean

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

Optional value

value?: any

The current value of the property

Optional valueType

valueType?: "VAT" | "Duty" | "Statistical"

Settings

Member Visibility

Theme

On This Page

amountOfMoneybboxconfidencedisplayerrorsinputlastChangedBymodifiedAtmodifiedByoptionsreasonrequiredreviewNeededsearchValuesourcetemplateValuetypeuserEditedvaluevalueType