Purpose and structure

The DTO (Data Transfer Object) CompanyDTO is used to represent the company data model, and reflects the structural characteristics of the Business Object class CompanyBO

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.

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

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

categories

Categorie

The company 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/Contact/Search?$filter=categories eq 'wifi'&$select=id,name,categories
• api/latest/Contact/Search?$filter=startswith(categories,'wifi')&$select=id,name,categories
• api/latest/Contact/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.

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-CompanyCategoriesStyle

Usage sample: Crm-CompanyCategoriesStyle: AdaptiveCsv

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.

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.

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.

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

id

Company Unique Id

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

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.

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.

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.

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.

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.

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

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

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.

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.

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/Company/Search?$filter=salesPersons eq 1
• api/latest/Company/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.

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

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.

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.

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.

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

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.

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.

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.

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.

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