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 value of the 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.

branch

Codice sede

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

city

Città

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

companyName

Ragione sociale

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

contactId

Referente di sede

The contact reference of 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.

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.

crossId

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

crossOtherId

Indirizzo da altra azienda

Cross Other 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.

crossOtherType

Cross Other Type

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

Usage sample: Crm-CrossTypeEnumStyle: AdaptiveInteger

crossTypeId

Cross Type 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.

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

Usage sample: Crm-CrossTypeEnumStyle: AdaptiveInteger

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

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.

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

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.

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.

legal

Sede legale

If the address is a Legal type

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

province

Provincia

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

region

Regione

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

salesPersons

Commerciale

The sale persons of the address and of the location

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

state

Nazione

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

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

zipCode

CAP

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

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