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")

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicCompanyTypeIdStyle

Usage sample: Crm-AnagraphicCompanyTypeIdStyle: AdaptiveDescription

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicIndustryIdStyle

Usage sample: Crm-AnagraphicIndustryIdStyle: AdaptiveDescription

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicStatusEnumStyle

Usage sample: Crm-AnagraphicStatusEnumStyle: AdaptiveInteger

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-CompanyCategoriesStyle

Usage sample: Crm-CompanyCategoriesStyle: AdaptiveCsv

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-CommercialZoneStyle

Usage sample: Crm-CommercialZoneStyle: AdaptiveCode

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à.

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à.

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à.

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-EmailStyle

Usage sample: Crm-EmailStyle: Compact

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à.

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à.

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-GeoLocalizationStyle

Usage sample: Crm-GeoLocalizationStyle: Full

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à.

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à.

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à.

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à.

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à.

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à.

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à.

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à.

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à.

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-OwnerIdStyle

Usage sample: Crm-OwnerIdStyle: AdaptiveExternalReference

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PhoneStyle

Usage sample: Crm-PhoneStyle: Compact

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PrivacySettingsStyle

Usage sample: Crm-PrivacySettingsStyle: Compact

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SalesPersonsStyle

Usage sample: Crm-SalesPersonsStyle: AdaptiveCsv

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicSourceIdStyle

Usage sample: Crm-AnagraphicSourceIdStyle: AdaptiveDescription

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à.

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à.

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à.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-TagsStyle

Usage sample: Crm-TagsStyle: AdaptiveCsv

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à.

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à.

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à.

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à.

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à.

Schema

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

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