Interface CompanyModel

Identifies a company

interface CompanyModel {
    EORI?: EORI;
    TIN?: Meta<string>;
    VAT?: VATNumber;
    address?: AddressModel;
    bbox?: Bbox;
    clientIdentifier?: Meta<string>;
    companyBeforeMatching?: CompanyModel;
    confidence?: number;
    contactPerson?: PersonModel;
    creationType?: MasterDataCreationType;
    customsOffices?: CustomsOffice[];
    defermentAccounts?: DefermentAccount[];
    directRepresentative?: StakeholderModel;
    display?: boolean;
    email?: Meta<string>;
    errors?: ErrorModel[];
    externalIdentifier?: Meta<string>;
    flags?: ("billable" | "using" | "archived")[];
    indirectRepresentative?: StakeholderModel;
    input?: string;
    inputTaxDeduction?: Meta<boolean>;
    intrastatVAT?: VATNumber;
    lastChangedBy?: string;
    matchingMetadata?: MatchingMetadataModel<StakeholderMatchInput, StakeholderMatchResult>;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    name?: Meta<string>;
    options?: string[];
    permitNumbers?: PermitNumber[];
    phoneNr?: Meta<string>;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    securityNumber?: Meta<string>;
    source?: string;
    stakeholderId?: string;
    subcontractor?: StakeholderModel;
    submissionDeadlineInterval?: number;
    templateValue?: string;
    userEdited?: boolean;
    value?: string;

Hierarchy (view full)

  • Meta<string>
    • CompanyModel


TIN?: Meta<string>
VAT?: VATNumber
address?: AddressModel
bbox?: Bbox

Bounding box of extracted value

clientIdentifier?: Meta<string>
companyBeforeMatching?: CompanyModel
confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

contactPerson?: PersonModel
creationType?: MasterDataCreationType
customsOffices?: CustomsOffice[]


defermentAccounts?: DefermentAccount[]


directRepresentative?: StakeholderModel

direct representative filled with name and stakeholder id

display?: boolean
email?: Meta<string>
errors?: ErrorModel[]

could be validation errors

externalIdentifier?: Meta<string>
flags?: ("billable" | "using" | "archived")[]
indirectRepresentative?: StakeholderModel

indirect representative filled with name and stakeholder id

input?: string

The input value which was initially supplied for the property

inputTaxDeduction?: Meta<boolean>
intrastatVAT?: VATNumber
lastChangedBy?: string

Encoded user (username, userId, etc.)


modifiedAt?: number

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

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

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
name?: Meta<string>
options?: string[]
permitNumbers?: PermitNumber[]
phoneNr?: Meta<string>
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

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

securityNumber?: Meta<string>
source?: string
stakeholderId?: string
subcontractor?: StakeholderModel

subcontractor filled with name and stakeholder id

submissionDeadlineInterval?: number

Gestellungsfrist (in hours)

templateValue?: string

Template value which was used to generate the value

userEdited?: boolean

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

value?: string

The current value of the property