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;
    supplierDeclarationIssueDate?: DateTimeModel;
    supplierDeclarationValidityFrom?: DateTimeModel;
    supplierDeclarationValidityTo?: DateTimeModel;
    templateValue?: string;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

  • Meta<string>
    • CompanyModel

Properties

EORI? TIN? VAT? address? bbox? clientIdentifier? companyBeforeMatching? confidence? contactPerson? creationType? customsOffices? defermentAccounts? directRepresentative? display? email? errors? externalIdentifier? flags? indirectRepresentative? input? inputTaxDeduction? intrastatVAT? lastChangedBy? matchingMetadata? modifiedAt? modifiedBy? name? options? permitNumbers? phoneNr? reason? required? reviewNeeded? searchValue? securityNumber? source? stakeholderId? subcontractor? submissionDeadlineInterval? supplierDeclarationIssueDate? supplierDeclarationValidityFrom? supplierDeclarationValidityTo? templateValue? userEdited? value?

Properties

Optional EORI

EORI?: EORI

Optional TIN

TIN?: Meta<string>

Optional VAT

VAT?: VATNumber

Optional address

address?: AddressModel

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional clientIdentifier

clientIdentifier?: Meta<string>

Optional companyBeforeMatching

companyBeforeMatching?: CompanyModel

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional contactPerson

contactPerson?: PersonModel

Optional creationType

creationType?: MasterDataCreationType

Optional customsOffices

customsOffices?: CustomsOffice[]

Zollstellen

Optional defermentAccounts

defermentAccounts?: DefermentAccount[]

Aufschubkonten

Optional directRepresentative

directRepresentative?: StakeholderModel

direct representative filled with name and stakeholder id

Optional display

display?: boolean

Optional email

email?: Meta<string>

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional externalIdentifier

externalIdentifier?: Meta<string>

Optional flags

flags?: ("billable" | "using" | "archived")[]

Optional indirectRepresentative

indirectRepresentative?: StakeholderModel

indirect representative filled with name and stakeholder id

Optional input

input?: string

The input value which was initially supplied for the property

Optional inputTaxDeduction

inputTaxDeduction?: Meta<boolean>

Optional intrastatVAT

intrastatVAT?: VATNumber

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional matchingMetadata

matchingMetadata?: MatchingMetadataModel<StakeholderMatchInput, StakeholderMatchResult>

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 name

name?: Meta<string>

Optional options

options?: string[]

Optional permitNumbers

permitNumbers?: PermitNumber[]

Optional phoneNr

phoneNr?: Meta<string>

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 securityNumber

securityNumber?: Meta<string>

Optional source

source?: string

Optional stakeholderId

stakeholderId?: string

Optional subcontractor

subcontractor?: StakeholderModel

subcontractor filled with name and stakeholder id

Optional submissionDeadlineInterval

submissionDeadlineInterval?: number

Gestellungsfrist (in hours)

Optional supplierDeclarationIssueDate

supplierDeclarationIssueDate?: DateTimeModel

Optional supplierDeclarationValidityFrom

supplierDeclarationValidityFrom?: DateTimeModel

Optional supplierDeclarationValidityTo

supplierDeclarationValidityTo?: DateTimeModel

Optional templateValue

templateValue?: string

Template value which was used to generate the value

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

EORITINVATaddressbboxclientIdentifiercompanyBeforeMatchingconfidencecontactPersoncreationTypecustomsOfficesdefermentAccountsdirectRepresentativedisplayemailerrorsexternalIdentifierflagsindirectRepresentativeinputinputTaxDeductionintrastatVATlastChangedBymatchingMetadatamodifiedAtmodifiedBynameoptionspermitNumbersphoneNrreasonrequiredreviewNeededsearchValuesecurityNumbersourcestakeholderIdsubcontractorsubmissionDeadlineIntervalsupplierDeclarationIssueDatesupplierDeclarationValidityFromsupplierDeclarationValidityTotemplateValueuserEditedvalue