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

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.

addresses

Altri indirizzi

The object that contains the list of addresses

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.

anagraphicCompanyTypeId

Tipo azienda

The contact typology

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicCompanyTypeIdStyle

Usage sample: Crm-AnagraphicCompanyTypeIdStyle: AdaptiveDescription

anagraphicIndustryId

Settore

The sector of the 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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicIndustryIdStyle

Usage sample: Crm-AnagraphicIndustryIdStyle: AdaptiveDescription

bank

Banca

The bank of the 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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-BankStyle

Usage sample: Crm-BankStyle: Full

bankCode

Codice

The bank code of the 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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-BankCodeStyle

Usage sample: Crm-BankCodeStyle: Full

bankId

Banca

The default bank of the 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.

billed

Classe di fatturato

The year billing of the 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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicStatusEnumStyle

Usage sample: Crm-AnagraphicStatusEnumStyle: AdaptiveInteger

carrierId

Vettore

The default carrier of the 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.

categories

Categorie

The company 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.

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.

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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-CommercialZoneStyle

Usage sample: Crm-CommercialZoneStyle: AdaptiveCode

companyName

Ragione sociale

The name of the 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.

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.

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.

currencyId

Valuta

The currency's 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.

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.

description

Descrizione società

A free company description

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.

discountFormula

Sconto cliente

The discount formula of the 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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-EmailStyle

Usage sample: Crm-EmailStyle: Compact

employees

Dipendenti

The employees of the 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.

estimate

Valutazione

The cross rating of the 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.

externalReference

External Reference

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-ExternalReferenceStyle

Usage sample: Crm-ExternalReferenceStyle: Full

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.

fromLead

Da Lead

The id of the lead this company was converted from

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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-GeoLocalizationStyle

Usage sample: Crm-GeoLocalizationStyle: Full

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.

hasPhotoProp

Has Photo

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-HasPhotoPropStyle

Usage sample: Crm-HasPhotoPropStyle: Full

iban

The iban of the 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.

id

Company Unique Id

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.

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.

lastActivity

Last Activity

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.

lastContact

Data ultima attività

The date of the last modified done Activity related to the current AnagraphicBO

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.

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.

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.

limbo

Indicate if Anagraphic is soft deleted

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.

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.

mailingListEmailSendAllowed

Consenso mailing list

Indicated you have the authoritazion to send a mailing list to this 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.

mailingListRights

Consensi mailing list

All rights for mailing list

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.

naturalPerson

Persona fisica

If the company is a natural person

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.

naturalPersonId

The company's person 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.

naturalPersonName

Nome

The company's person name

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.

naturalPersonSurname

Cognome

The company's person surname

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.

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.

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.

normalizeAddress

The address normalized

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AddressStyle

Usage sample: Crm-AddressStyle: Full

normalizeCity

The city normalized with fraction

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-CityStyle

Usage sample: Crm-CityStyle: Full

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-OwnerIdStyle

Usage sample: Crm-OwnerIdStyle: AdaptiveExternalReference

parentLocation

Destinazione di

The id of the main 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.

payments

Termini di pagamento

All payments for the 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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PhoneStyle

Usage sample: Crm-PhoneStyle: Compact

photo

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PhotoStyle

Usage sample: Crm-PhotoStyle: Full

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.

priceListName

Listino predefinito

The price list description

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PriceListNameStyle

Usage sample: Crm-PriceListNameStyle: Full

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-PrivacySettingsStyle

Usage sample: Crm-PrivacySettingsStyle: Compact

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.

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.

relations

Relazioni

The other anagraphic relations

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.

salesPersons

Commerciale

The salesPersons Ids

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SalesPersonsStyle

Usage sample: Crm-SalesPersonsStyle: AdaptiveCsv

salesTerms

Condizioni

The sales terms for the 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.

score

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.

sharing

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SharingStyle

Usage sample: Crm-SharingStyle: Full

shippedBy

Trasporto

The default shipped form of the 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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-ShippedByEnumStyle

Usage sample: Crm-ShippedByEnumStyle: AdaptiveInteger

skipCreateSubAddress

Skip Create Sub Address

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SkipCreateSubAddressStyle

Usage sample: Crm-SkipCreateSubAddressStyle: Full

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-AnagraphicSourceIdStyle

Usage sample: Crm-AnagraphicSourceIdStyle: AdaptiveDescription

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.

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SyncStyle

Usage sample: Crm-SyncStyle: Full

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-SyncPropertiesStyle

Usage sample: Crm-SyncPropertiesStyle: Full

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-TagsStyle

Usage sample: Crm-TagsStyle: AdaptiveCsv

taxDeducted

Ritenuta d'acconto

The default tax deducted of the 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.

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.

taxValueId

IVA predefinita

The tax code for the 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.

template

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.

Polymorphic styles for version 'v1'

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

Header parameter name: Crm-TemplateStyle

Usage sample: Crm-TemplateStyle: Full

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.

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.

workGroupId

Gruppo di lavoro

The Workgroup 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.

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.

Schema

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

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