Properties

This table lists the whole set of properties contained into this data type.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")

NameKindDescription
address native Indirizzo
The address of the entity
associatedCompany native Azienda associata
A company linked to this lead
associatedContact native Contatto associato
A contact linked to this lead
birthDay native Data di nascita
The lead's birthday
birthPlace native Luogo di nascita
The lead's birthplace
boStatus polymorphic Stato anagrafica
The status of the object
businessRole native Ruolo aziendale
The business role
businessRoles polymorphic Ruoli aziendali
The business roles of the lead
categories polymorphic Categorie
The contact 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 Azienda
The company name of the lead
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
emails polymorphic Indirizzi e-mail
The normalization of the emails
estimatedCloseDate native Data chiusura
The estimated closed date for the lead in small datetime (min 01/01/1910)
expirationDate native Data scadenza fase
The status expiration date
externalReferences native Campi aggiuntivi
The external references linked to current object
geoLocalization polymorphic The geo localization object
groups native Gruppi
The groups of the object
id native The unique id
industry polymorphic Settore
The lead's industry
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
leadCurrency native Valuta
The lead's currency
lockReason native The object lock reason
name native Nome
The name of the lead
nextContact native Data prossimo contatto
The Customer of the anagraphic
noContact native Non contattare
Show if you cannot contact this company
note native The lead's notes
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
potentialRevenue native Reddito previsto
The potential revenue for the lead
priority polymorphic Priorità
The priority of the lead
privacySettings polymorphic Privacy Settings
productInterest polymorphic Interesse
The lead's product interest
province native Provincia
The province of the entity
rating polymorphic Valutazione
The cross rating of the lead
region native Regione
The province of the entity
salesPersons polymorphic Commerciale
The salesPersons Id
source polymorphic Origine
The product interested of the lead
state native Nazione
The state of the entity
status polymorphic Stato
The cross status of the lead
surname native Cognome
The surname of the lead
sync native Sync Mobile
Indicated if you can synchronize this with outlook
syncProperties native Sync Properties
tags polymorphic
taxIdentificationNumber native Codice fiscale
The tax identification number of the entity
title native Titolo
The title of the lead
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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

associatedCompany

Azienda associata

A company linked to this lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameAssociatedCompany
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=associatedCompany eq 123
Is Enum NO
Foreign Key

associatedContact

Contatto associato

A contact linked to this lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameAssociatedContact
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=associatedContact eq 123
Is Enum NO
Foreign Key

birthDay

Data di nascita

The lead's birthday

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameBirthDay
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=birthDay eq 2019-10-06T23:59:59.999Z
Is Enum NO

birthPlace

Luogo di nascita

The lead's birthplace

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameBirthPlace
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=birthPlace eq 'my value'
Is Enum NO
Max chars length100

boStatus

Stato anagrafica

The status of the object

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-AnagraphicStatusEnumStyle

Crm-AnagraphicStatusEnumStyle: AdaptiveInteger

Style nameSerialized as
AdaptiveInteger int
AdaptiveString string

businessRole

Ruolo aziendale

The business role

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameBusinessRole
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=businessRole eq 'my value'
Is Enum NO
Max chars length50

businessRoles

Ruoli aziendali

The business roles of the lead

OData support

This property is searchable using OData.

$filter

The values must have a string representations (the name of the business role).

The supported operators/functions are:

  • eq
  • startswith
  • endswith
$select

The property can be specified into the $select parameter

$orderby

The property cannot be specified into the $orderby parameter

OData examples
  • api/latest/Lead/Search?$filter=businessRoles eq 'wifi'&$select=id,name,businessRoles
  • api/latest/Lead/Search?$filter=startswith(businessRoles,'wifi')&$select=id,name,businessRoles
  • api/latest/Lead/Search?$filter=endswith(businessRoles,'wifi')&$select=id,name,businessRoles

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameBusinessRoles
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
Max value50

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-BusinessRolesStyle

Crm-BusinessRolesStyle: AdaptiveCsv

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

categories

Categorie

The contact categories

OData support

This property is searchable using OData.

$filter

The values must have a string representations (the description of the category).

The supported operators/functions are:

  • eq
  • startswith
  • endswith
$select

The property can be specified into the $select parameter

$orderby

The property cannot be specified into the $orderby parameter

OData examples
  • api/latest/Lead/Search?$filter=categories eq 'wifi'&$select=id,name,categories
  • api/latest/Lead/Search?$filter=startswith(categories,'wifi')&$select=id,name,categories
  • api/latest/Lead/Search?$filter=endswith(categories,'wifi')&$select=id,name,categories

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-LeadCategoriesStyle

Crm-LeadCategoriesStyle: 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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-CommercialZoneStyle

Crm-CommercialZoneStyle: AdaptiveCode

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

companyName

Azienda

The company name of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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 length100

createdById

Creato da

The creator of the entity

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

emails

Indirizzi e-mail

The normalization of the emails

This is a polymorphic property and contains an array of emails.
For more details about the serialization/deserialization styles, please refere to the following section "Polymorphic styles"

OData searches

You can use this property as a filter condition in an OData expression.

Examples:

  • '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')

  • Complex example -> 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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-EmailStyle

Crm-EmailStyle: Compact

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

estimatedCloseDate

Data chiusura

The estimated closed date for the lead in small datetime (min 01/01/1910)

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameEstimatedCloseDate
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=estimatedCloseDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

expirationDate

Data scadenza fase

The status expiration date

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

externalReferences

Campi aggiuntivi

The external references linked to current object

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

geoLocalization

The geo localization object

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-GeoLocalizationStyle

Crm-GeoLocalizationStyle: Full

Style nameSerialized as
Full GeoDTO
GeoJSON GeoJsonItem

groups

Gruppi

The groups of the object

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

id

The unique id

The Id of the lead is a Int64 integer.

This property contains the primary key of the object inside the system. It can be used to universally identify the record containing all the object's data

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

industry

Settore

The lead's industry

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameIndustry
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=industry eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-AnagraphicIndustryIdStyle

Crm-AnagraphicIndustryIdStyle: AdaptiveDescription

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

language

Lingua

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

leadCurrency

Valuta

The lead's currency

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameLeadCurrency
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=leadCurrency eq 123
Is Enum NO
Foreign Key

lockReason

The object lock reason

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

name

Nome

The name of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameName
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=name eq 'my value'
Is Enum NO
Max chars length25

nextContact

Data prossimo contatto

The Customer of the anagraphic

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

note

The lead's notes

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameNote
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=note eq 'my value'
Is Enum NO

ownerId

Proprietario

The owner of the entity

This polymorphic property is a foreign key, and refers to the account ID of the owner of this object.
Multiple serialization styles are available (see the section below).

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

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

This is a polymorphic property and contains an array of phones.
For more details about the serialization/deserialization styles, please refere to the following section "Polymorphic styles"

OData searches

You can use this property as a filter condition in an OData expression.

Examples:

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

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

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

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

potentialRevenue

Reddito previsto

The potential revenue for the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property namePotentialRevenue
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=potentialRevenue eq 123.456
Is Enum NO

priority

Priorità

The priority of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property namePriority
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=priority eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-LeadPriorityIdStyle

Crm-LeadPriorityIdStyle: AdaptiveDescription

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

privacySettings

Privacy Settings

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-PrivacySettingsStyle

Crm-PrivacySettingsStyle: Compact

Style nameSerialized as
Compact CompactItem
Full PrivacyManagementDTO

productInterest

Interesse

The lead's product interest

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameProductInterest
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=productInterest eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-LeadProductInterestIdStyle

Crm-LeadProductInterestIdStyle: AdaptiveDescription

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

province

Provincia

The province of the entity

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

rating

Valutazione

The cross rating of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameRating
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=rating eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-LeadRatingIdStyle

Crm-LeadRatingIdStyle: AdaptiveDescription

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

region

Regione

The province of the entity

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

OData support

This property is searchable using OData.

$filter

The values must have an integer representations (the ID of the account of the salesperson).

$select

The property can be specified into the $select parameter

$orderby

The property cannot be specified into the $orderby parameter

OData examples
  • api/latest/Lead/Search?$filter=salesPersons eq 1
  • api/latest/Lead/Search?$filter=salesPersons gt 0

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-SalesPersonsStyle

Crm-SalesPersonsStyle: AdaptiveCsv

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

source

Origine

The product interested of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

status

Stato

The cross status of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameStatus
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=status eq 123
Is Enum NO
Foreign Key

Polymorphic styles for version 'v1'

For more details about using the polymorphic properties, please refer to the general guide on the options

Crm-LeadStatusIdStyle

Crm-LeadStatusIdStyle: AdaptiveDescription

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

surname

Cognome

The surname of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameSurname
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=surname eq 'my value'
Is Enum NO
Max chars length25

sync

Sync Mobile

Indicated if you can synchronize this with outlook

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameSync
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=sync eq true
Is Enum NO

syncProperties

Sync Properties

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

This polymorphic property is an array of tags (textual labels) associated to the object.
For details on using the different serialization/deserialization styles, refer to the section below "Polymorphic styles"

OData searches

You can use this property as a filter condition in an OData expression via the eq operator and the startswith, endswith functions.

Examples:

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

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

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

  • Complex example -> 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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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'

For more details about using the polymorphic properties, please refer to the general guide on the options

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

title

Titolo

The title of the lead

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

NameValue
Physical property nameTitle
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=title eq 'my value'
Is Enum NO
Max chars length20

vatId

Partita IVA

The vat identification number of the entity

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options

Features

This table contains all the information about to this property features.

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

The following table contains the main schema information about this data type.

FeatureValue
Complex typeLeadDTO
Required:

Polymorphic Schema

The polymorphic schema describe how the object is serialized and deserialized by the Web API pipeline.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")


Free Fields

This Business Object is customizable, and it is therefore possible to define a set of custom fields.
These custom fields are called Free Fields.

Free Fields are user-definable custom fields, and can contain data of various kinds.

Each Free Field has a specific data type (selected during configuration), and on the basis of this type, the field data follow certain validation rules.

For more details about Free Fields, refer to the appropriate section

Free Field and polymorphism

As with many other fields, Free Fields also implement polymorphic serialization capabilities, and it is therefore possible to select multiple serialization/deserialization styles.
For more details, refer to the specific descriptive paragraph on the serialization of the Free Fields

Free Field and OData

Free Fields can be used in OData searches as field selectors ($select criterion).
In order to be able to discriminate them from the other standard fields of the Business Object, it is necessary to specify the prefix "FF_"

Example:

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