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
createdById native Creato da
The creator of the entity
createdDate native Data creazione
The creation date for the entity
dateEnd native Data fine
The end date for this price
dateStart native Data inizio
The starting date for this price
discountFormula native Formula di sconto
The discount percentage fot this price
enabled native Attivo
If this list cost is enable
externalReferences native Campi aggiuntivi
The external references linked to current object
id native
lastModifiedById native Modificato da
The last modified by id
lastModifiedDate native Data modifica
The last modified date
listId native Listino
The id of the list item
notes native Note
The notes of current price list
ownerId polymorphic Proprietario
The owner of the entity
productId native Prodotto
The id of the product
qta native Quantità
The quantity for appling this price
tags polymorphic
unitPrice native Prezzo unitario
The price of the item

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

dateEnd

Data fine

The end date for this price

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 nameDateEnd
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=dateEnd eq 2019-10-06T23:59:59.999Z
Is Enum NO

dateStart

Data inizio

The starting date for this price

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 nameDateStart
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=dateStart eq 2019-10-06T23:59:59.999Z
Is Enum NO

discountFormula

Formula di sconto

The discount percentage fot this price

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 nameDiscountFormula
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=discountFormula eq 'my value'
Is Enum NO

enabled

Attivo

If this list cost is enable

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 nameEnable
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=enabled eq true
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

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.

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

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

listId

Listino

The id of the list item

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 nameListId
Physical property typelong
Is Required YES
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=listId eq 123
Is Enum NO
Foreign Key

notes

Note

The notes of current price 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.

NameValue
Physical property nameNotes
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=notes 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

productId

Prodotto

The id of the product

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 nameProductId
Physical property typelong
Is Required YES
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=productId eq 123
Is Enum NO
Foreign Key

qta

Quantità

The quantity for appling this price

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 nameQta
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=qta eq 123.456
Is Enum NO

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

unitPrice

Prezzo unitario

The price of the item

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 nameUnitPrice
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=unitPrice eq 123.456
Is Enum NO


Schema

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

FeatureValue
Complex typeCatalogProductPriceDTO
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