Scopo e struttura

Il DTO (Data Transfer Object) CompanyDTO è usato per rappresentare il modello dati dell'azienda, e rispecchia le caratteristiche strutturali della classe di Business Object CompanyBO


Proprietà

Questa tabella elenca l'intero set di proprietà contenute in questo tipo di dati.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")

NameKindDescription
address native Indirizzo
The address of the entity
anagraphicCompanyTypeId polymorphic Tipo azienda
The contact typology
anagraphicIndustryId polymorphic Settore
The sector of the company
billed native Classe di fatturato
The year billing of the company
boStatus polymorphic Stato anagrafica
The status of the object
categories polymorphic Categorie
The company categories
city native Città
The city of the entity
code native Codice
The custom code of the anagraphic
commercialZone polymorphic Zona
The area id of the entity
companyName native Ragione sociale
The name of the company
createdById native Creato da
The creator of the entity
createdDate native Data creazione
The creation date for the entity
customerFrom native Cliente da
The customer of the anagraphic
description native Descrizione società
A free company description
emails polymorphic Indirizzi e-mail
The normalization of the emails
employees native Dipendenti
The employees of the company
estimate native Valutazione
The cross rating of the company
externalReferences native Campi aggiuntivi
The external references linked to current object
fromLead native Da Lead
The id of the lead this company was converted from
geoLocalization native The geo localization object
id native Company Unique Id
language native Lingua
lastContact native Data ultimo contatto
The Customer of the anagraphic
lastModifiedById native Modificato da
The last modified by id
lastModifiedDate native Data modifica
The last modified date
lockReason native The object lock reason
naturalPersonId native The company's person id
naturalPersonName native Nome
The company's person name
naturalPersonSurname native Cognome
The company's person surname
nextContact native Data prossimo contatto
The Customer of the anagraphic
noContact native Non contattare
Show if you cannot contact this company
ownerId polymorphic Proprietario
The owner of the entity
phones polymorphic Numeri di telefono
The normalization of the phones
photoUrl native The photo of the contact
privacySettings polymorphic Privacy Settings
province native Provincia
The province of the entity
region native Regione
The province of the entity
salesPersons polymorphic Commerciale
The salesPersons Id
score native
source polymorphic Origine
The product interested of the lead
state native Nazione
The state of the entity
syncProperties native Sync Properties
tags polymorphic
taxIdentificationNumber native Codice fiscale
The tax identification number of the entity
vatId native Partita IVA
The vat identification number of the entity
webSite native Sito web
The WebSite of the entity
zipCode native CAP
The zip code of the entity
zoneCode native Zona
The zone's code of the entity

address

Indirizzo

The address of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameAddress
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=address eq 'my value'
Is Enum NO
Max chars length75

anagraphicCompanyTypeId

Tipo azienda

The contact typology

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameContactTypeId
Physical property typeint
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=anagraphicCompanyTypeId eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-AnagraphicCompanyTypeIdStyle

Crm-AnagraphicCompanyTypeIdStyle: AdaptiveDescription

Style nameSerialized as
AdaptiveDescription string
AdaptiveStringOnlyDescription string
Description string
FlattenedExpansion FlattenedExpansionSchema
Id int

anagraphicIndustryId

Settore

The sector of the company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCompanyTypeId
Physical property typelong
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=anagraphicIndustryId eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-AnagraphicIndustryIdStyle

Crm-AnagraphicIndustryIdStyle: AdaptiveDescription

Style nameSerialized as
AdaptiveDescription string
AdaptiveStringOnlyDescription string
Description string
FlattenedExpansion FlattenedExpansionSchema
Id int

billed

Classe di fatturato

The year billing of the company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameBilled
Physical property typedecimal
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=billed eq 123.456
Is Enum NO

boStatus

Stato anagrafica

The status of the object

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameBoStatus
Physical property typeAnagraphicStatus
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=boStatus eq 'EnumValue'
Is Enum YES

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-AnagraphicStatusEnumStyle

Crm-AnagraphicStatusEnumStyle: AdaptiveInteger

Style nameSerialized as
AdaptiveInteger int
AdaptiveString string

categories

Categorie

The company categories

Supporto OData

Questa proprietà è ricercabile tramite OData.

$filter

I valori devono avere una rappresentazione in formato stringa (la descrizione della categoria).

Gli operatori/funzioni supportati sono:

  • eq
  • startswith
  • endswith
$select

La proprietà può essere specificata nel parametro $select

$orderby

La proprietà non può essere specificata nel parametro $orderby

Esempi OData
  • api/latest/Company/Search?$filter=categories eq 'wifi'&$select=id,companyName,categories
  • api/latest/Company/Search?$filter=startswith(categories,'wifi')&$select=id,companyName,categories
  • api/latest/Company/Search?$filter=endswith(categories,'wifi')&$select=id,companyName,categories

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCategories
Physical property typearray of long
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-CompanyCategoriesStyle

Crm-CompanyCategoriesStyle: AdaptiveCsv

Style nameSerialized as
AdaptiveCsv string
AdaptiveExternalReference string
AdaptiveName string
AdaptiveStringOnlyName string
CsvOfIds string
CsvOfNames string
Id long

city

Città

The city of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCity
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=city eq 'my value'
Is Enum NO
Max chars length50

code

Codice

The custom code of the anagraphic

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCode
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=code eq 'my value'
Is Enum NO
Max chars length25

commercialZone

Zona

The area id of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCommercialZone
Physical property typeint
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=commercialZone eq 123
Is Enum NO
Max value100
Foreign Key

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-CommercialZoneStyle

Crm-CommercialZoneStyle: AdaptiveCode

Style nameSerialized as
AdaptiveCode string
AdaptiveDescription string
AdaptiveExternalReference string
AdaptiveStringOnlyCode string
AdaptiveStringOnlyDescription string
Id int

companyName

Ragione sociale

The name of the company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCompanyName
Physical property typestring
Is Required YES
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=companyName eq 'my value'
Is Enum NO
Max chars length50

createdById

Creato da

The creator of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCreatedById
Physical property typeint
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=createdById eq 123
Is Enum NO
Foreign Key

createdDate

Data creazione

The creation date for the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCreatedDate
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=createdDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

customerFrom

Cliente da

The customer of the anagraphic

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameCustomerFrom
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=customerFrom eq 2019-10-06T23:59:59.999Z
Is Enum NO

description

Descrizione società

A free company description

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameDescription
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=description eq 'my value'
Is Enum NO

emails

Indirizzi e-mail

The normalization of the emails

Questa è una proprietà polimorfica, e contiene un array di indirizzi emails.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"

Ricerche OData

E' possibile utilizzare questa proprietà sia come filtro (criterio $filter), sia come selettore di campo (criterio $select) in una espressione OData
Di seguito alcuni esempi:

  • 'eq' -> GET: /api/{version}/Company/Search?$filter=emails eq 'my@email.com'

  • 'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(emails,'te')

  • 'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(emails,'ro')

  • Esempio complesso -> GET: /api/{version}/Company/Search?$filter=startswith(emails,'te') or endswith(emails,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,emails

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNormalizeEMail
Physical property typearray of NormalizeEMailDTO
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-EmailStyle

Crm-EmailStyle: Compact

Style nameSerialized as
Compact CompactItem
Csv string
FlattenedExpansion FlattenedExpansionSchema
Full EMailNormalizedDTO
Tiny TinyItem
ValueOnly string

employees

Dipendenti

The employees of the company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameEmployees
Physical property typeint
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=employees eq 123
Is Enum NO

estimate

Valutazione

The cross rating of the company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameEstimate
Physical property typeint
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=estimate eq 123
Is Enum NO
Foreign Key

externalReferences

Campi aggiuntivi

The external references linked to current object

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameExternalReferences
Physical property typearray of ExternalReferencesDTO
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive NO
Is Enumerable YES
Is Searchable NO
Is Enum NO
Max value-1

fromLead

Da Lead

The id of the lead this company was converted from

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameFromLead
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=fromLead eq 123
Is Enum NO

geoLocalization

The geo localization object

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameGeoLocalization
Physical property typeGeoDTO
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable NO
Is Enum NO

id

Company Unique Id

L'ID dell'azienda è un intero a 64 bits.

Questa proprietà contiene la chiave primaria dell'oggetto all'interno del sistema. Può essere utilizzato per identificare universalmente il record contenente tutti i dati dell'oggetto

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameId
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=id eq 123
Is Enum NO

language

Lingua

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameLanguage
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=language eq 'my value'
Is Enum NO
Max chars length50

lastContact

Data ultimo contatto

The Customer of the anagraphic

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameLastContact
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=lastContact eq 2019-10-06T23:59:59.999Z
Is Enum NO

lastModifiedById

Modificato da

The last modified by id

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameLastModifiedById
Physical property typeint
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=lastModifiedById eq 123
Is Enum NO
Foreign Key

lastModifiedDate

Data modifica

The last modified date

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameLastModifiedDate
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=lastModifiedDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

lockReason

The object lock reason

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameLockReason
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO
Max chars length1000

naturalPersonId

The company's person id

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNaturalPersonId
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO

naturalPersonName

Nome

The company's person name

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNaturalPersonName
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=naturalPersonName eq 'my value'
Is Enum NO

naturalPersonSurname

Cognome

The company's person surname

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNaturalPersonSurname
Physical property typestring
Is Required YES
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=naturalPersonSurname eq 'my value'
Is Enum NO

nextContact

Data prossimo contatto

The Customer of the anagraphic

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNextContact
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=nextContact eq 2019-10-06T23:59:59.999Z
Is Enum NO

noContact

Non contattare

Show if you cannot contact this company

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNoContact
Physical property typebool
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=noContact eq true
Is Enum NO

ownerId

Proprietario

The owner of the entity

Questa proprietà polimorfica è una foreign key, e rappresenta il legame con l'utente che fa da "owner" a questo oggetto.
Sono disponibili svariati stili di serializzazione (vedi la sezione a seguire)

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameOwnerId
Physical property typeint
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=ownerId eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-OwnerIdStyle

Crm-OwnerIdStyle: AdaptiveExternalReference

Style nameSerialized as
AdaptiveExternalReference string
AdaptiveStringOnlyUserAccount string
AdaptiveUserAccount string
FlattenedExpansion FlattenedExpansionSchema
Id int
StrictEmail string

phones

Numeri di telefono

The normalization of the phones

Questa è una proprietà polimorfica, e contiene un array di numeri telefonici.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"

Ricerche OData

E' possibile utilizzare questa proprietà sia come filtro (criterio $filter), sia come selettore di campo (criterio $select) in una espressione OData
Di seguito alcuni esempi:

  • 'eq' -> GET: /api/{version}/Company/Search?$filter=phones eq 'my@phone.com'

  • 'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(phones,'te')

  • 'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(phones,'ro')

  • Esempio complesso -> GET: /api/{version}/Company/Search?$filter=startswith(phones,'te') or endswith(phones,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,phones

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameNormalizePhone
Physical property typearray of NormalizePhoneDTO
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-PhoneStyle

Crm-PhoneStyle: Compact

Style nameSerialized as
Compact CompactItem
Csv string
FlattenedExpansion FlattenedExpansionSchema
Full PhoneNormalizedDTO
Tiny TinyItem
ValueOnly string

photoUrl

The photo of the contact

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property namePhotoUrl
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO

privacySettings

Privacy Settings

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property namePrivacySettings
Physical property typearray of PrivacyManagementDTO
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-PrivacySettingsStyle

Crm-PrivacySettingsStyle: Compact

Style nameSerialized as
Compact CompactItem
Full PrivacyManagementDTO

province

Provincia

The province of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameProvince
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=province eq 'my value'
Is Enum NO
Max chars length50

region

Regione

The province of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameRegion
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=region eq 'my value'
Is Enum NO
Max chars length50

salesPersons

Commerciale

The salesPersons Id

Supporto OData

Questa proprietà è ricercabile tramite OData.

$filter

I valori devono avere rappresentazioni di un numero intero (l'ID dell'account del venditore).

$select

La proprietà può essere specificata nel parametro $select

$orderby

La proprietà non può essere specificata nel parametro $orderby

Esempi OData
  • api/latest/Company/Search?$filter=salesPersons eq 1
  • api/latest/Company/Search?$filter=salesPersons gt 0

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameSalesPersons
Physical property typearray of int
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-SalesPersonsStyle

Crm-SalesPersonsStyle: AdaptiveCsv

Style nameSerialized as
AdaptiveCsv string
AdaptiveExternalReference string
AdaptiveStringOnlyUserAccount string
AdaptiveUserAccount string
Csv string
CsvOfIds string
CsvOfNames string
Id int

score

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameScore
Physical property typebyte
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=score eq 123
Is Enum NO

source

Origine

The product interested of the lead

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameSource
Physical property typelong
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=source eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-AnagraphicSourceIdStyle

Crm-AnagraphicSourceIdStyle: AdaptiveDescription

Style nameSerialized as
AdaptiveDescription string
AdaptiveStringOnlyDescription string
Description string
FlattenedExpansion FlattenedExpansionSchema
Id long

state

Nazione

The state of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameState
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=state eq 'my value'
Is Enum NO
Max chars length25

syncProperties

Sync Properties

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameSyncProperties
Physical property typeSyncPropertyFlag
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum YES

tags

Questa proprietà polimorfica è un array di tags (etichette testuali) associati all'oggetto corrente.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"

Ricerche OData

E' possibile utilizzare questa proprietà come condizione di filtro in una espressione OData tramite l'operatore eq e le funzioni startswith, endswith
Esempi:

  • 'eq' -> GET: /api/{version}/Company/Search?$filter=tags eq 'categoria'

  • 'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te')

  • 'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(tags,'ro')

  • Esempio complesso -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te') or endswith(tags,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,tags

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameTags
Physical property typearray of long
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable YES
Is Searchable NO
Is Enum NO

Polymorphic styles for version 'v1'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-TagsStyle

Crm-TagsStyle: AdaptiveCsv

Style nameSerialized as
AdaptiveCsv string
AdaptiveExternalReference string
AdaptiveName string
AdaptiveStringOnlyName string
Csv string
CsvOfIds string
CsvOfNames string
Id int

taxIdentificationNumber

Codice fiscale

The tax identification number of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameTaxIdentificationNumber
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=taxIdentificationNumber eq 'my value'
Is Enum NO
Max chars length20

vatId

Partita IVA

The vat identification number of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameVatId
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=vatId eq 'my value'
Is Enum NO
Max chars length50

webSite

Sito web

The WebSite of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameWebSite
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=webSite eq 'my value'
Is Enum NO
Max chars length100

zipCode

CAP

The zip code of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameZipCode
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=zipCode eq 'my value'
Is Enum NO
Max chars length20

zoneCode

Zona

The zone's code of the entity

Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni

Features

Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.

NameValue
Physical property nameZoneCode
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO
Max chars length100


Schema

La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.

FeatureValue
Typeobject
Required:

Schema polimorfico

Lo schema polimorfico descrive come l'oggetto viene serializzato e deserializzato dalla pipeline Web API.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")


Free Fields

Questo Business Object è customizzabile, ed è quindi possibile definire un set di campi custom.
Tali campi custom sono detti Free Field.

I Free Field sono campi custom definibili dall'utente, e possono contenere dati di svariata natura.

Ogni Free Field ha un tipo dati specifico (selezionato in fase di configurazione), e sulla base di tale tipo, i dati del campo seguono determinate regole di validazione.

Per maggiori informazioni circa i Free Field, fare riferimento all'apposita sezione

Free Field e polimorfismo

Come per molti altri campi, anche i Free Field godono delle proprietà di polimorfismo, ed è quindi possibile selezionare molteplici stili di serializzazione/deserializzazione.
Per maggiori dettagli, fare riferimento all'apposito paragrafo descrittivo sulla serializzazione dei Free Field

Free Field e OData

I Free Field sono utilizzabili nelle ricerche OData come selettori di campo (criterio $select).
Al fine di poterli discriminare dagli altri campi standard del Business Object, è necessario specificare il prefisso "FF_"

Esempio:

GET: /api/{version}/{controller}/Search?$select=id,FF_MyCustomFreeField1,FF_AnotherFreeField