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")
| Name | Kind | Description |
|---|---|---|
| address | native | Indirizzo fatturazione The full address of the object |
| collectionCharges | native | Spese incasso (Iva Inclusa) The collection charges value |
| collectionChargesVat | native | IVA Spese di incasso (valore) The collection charges vat |
| collectionChargesVatCode | native | IVA Spese di incasso (tipo) The collection charges vat code |
| collectionChargesVatId | native | The collection charges vat id |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| crossId | polymorphic | Richiesto da The cross id |
| crossType | polymorphic | Only company, contact, or lead |
| currencyChange | native | Cambio The changed value of the currency |
| currencyGrandTotal | native | Totale (in valuta) The currency grand total |
| currencyPaymentDiscountTotal | native | Totale sconto pagamento The sub total |
| currencySubTotal | native | Imponibile (in valuta) The currency sub total |
| currencyTaxTotal | native | IVA Totale (in valuta) The currency tax total |
| expirationDate | native | Data presunta consegna Expiration date |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| footerDiscount | native | Sconto incondizionato The footer discount |
| grandTotal | native | Totale The grand total |
| grandTotalToPay | native | Totale da pagare (in valuta) The grand total to pay |
| grouping | native | Raggruppamenti The row of the erp object |
| id | native | |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| number | native | Numero ordine The number of the order |
| orderDate | native | Data ordine The date of the order |
| ownerId | polymorphic | Proprietario The owner of the entity |
| paymentDiscountTotal | native | Totale sconto pagamento The sub total |
| rows | native | Righe The row of the erp object |
| salesPerson | native | Commerciale The sales person id |
| ship | native | Spese spedizione (IVA Inclusa) The ship value |
| shipAddress | native | Indirizzo spedizione The ship address of the object |
| shipVat | native | IVA Spedizione (valore) The ship vat |
| shipVatCode | native | IVA Spedizione (tipo) The ship vat code |
| shipVatId | native | The ship vat id |
| stage | polymorphic | Stato ordine The stage of the order |
| subject | native | Oggetto The subject of the quote |
| subTotal | native | Imponibile The sub total |
| tags | polymorphic | |
| taxTotal | native | IVA totale The tax total |
| template | polymorphic | |
| typeOfInvoice | polymorphic | Tipologia di fattura Type of invoice |
address
Indirizzo fatturazione
The full address 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.
collectionCharges
Spese incasso (Iva Inclusa)
The collection charges value
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.
| Name | Value |
|---|---|
| Physical property name | CollectionCharges |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
collectionChargesVat
IVA Spese di incasso (valore)
The collection charges vat
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.
collectionChargesVatCode
IVA Spese di incasso (tipo)
The collection charges vat code
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.
collectionChargesVatId
The collection charges vat 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.
| Name | Value |
|---|---|
| Physical property name | CollectionChargesVatId |
| Physical property type | long |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
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.
| Name | Value |
|---|---|
| Physical property name | CreatedById |
| Physical property type | int |
| 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.
crossId
Richiesto da
The 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.
| Name | Value |
|---|---|
| Physical property name | CrossId |
| Physical property type | long |
| Is Required | YES |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=crossId 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-CrossIdStyle: ByCrossTypeName
| Style name | Serialized as |
|---|---|
| ByCrossTypeName | long |
| CrossId | int |
crossType
Only company, contact, or 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.
| Name | Value |
|---|---|
| Physical property name | CrossType |
| Physical property type | BusinessObjectType |
| Acceptable values |
|
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=crossType 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-CrossTypeStyle: Full
| Style name | Serialized as |
|---|---|
| Full | BusinessObjectType |
| None | BusinessObjectType |
currencyChange
Cambio
The changed value of the 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.
| Name | Value |
|---|---|
| Physical property name | CurrencyChange |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
currencyGrandTotal
Totale (in valuta)
The currency grand total
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.
| Name | Value |
|---|---|
| Physical property name | CurrencyGrandTotal |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
currencyPaymentDiscountTotal
Totale sconto pagamento
The sub total
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.
currencySubTotal
Imponibile (in valuta)
The currency sub total
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.
| Name | Value |
|---|---|
| Physical property name | CurrencySubTotal |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
currencyTaxTotal
IVA Totale (in valuta)
The currency tax total
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.
| Name | Value |
|---|---|
| Physical property name | CurrencyTaxTotal |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
expirationDate
Data presunta consegna
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.
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.
| Name | Value |
|---|---|
| Physical property name | ExternalReferences |
| Physical property type | array 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 |
footerDiscount
Sconto incondizionato
The footer discount
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.
| Name | Value |
|---|---|
| Physical property name | FooterDiscount |
| Physical property type | decimal |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
grandTotal
Totale
The grand total
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.
grandTotalToPay
Totale da pagare (in valuta)
The grand total to pay
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.
grouping
Raggruppamenti
The row of the erp 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.
| Name | Value |
|---|---|
| Physical property name | Grouping |
| Physical property type | array of ERPRowGroupingDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
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.
| Name | Value |
|---|---|
| Physical property name | LastModifiedById |
| Physical property type | int |
| 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.
number
Numero ordine
The number of the order
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.
orderDate
Data ordine
The date of the order
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.
| Name | Value |
|---|---|
| Physical property name | OwnerId |
| Physical property type | int |
| 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: AdaptiveExternalReference
| Style name | Serialized as |
|---|---|
| AdaptiveExternalReference | string |
| AdaptiveStringOnlyUserAccount | string |
| AdaptiveUserAccount | string |
| FlattenedExpansion | FlattenedExpansionSchema |
| Id | int |
| StrictEmail | string |
paymentDiscountTotal
Totale sconto pagamento
The sub total
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.
rows
Righe
The row of the erp 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.
| Name | Value |
|---|---|
| Physical property name | ErpRows |
| Physical property type | array of ERPRowDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
salesPerson
Commerciale
The sales 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.
| Name | Value |
|---|---|
| Physical property name | SalesPerson |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=salesPerson eq 123 |
| Is Enum | NO |
| Foreign Key |
|
ship
Spese spedizione (IVA Inclusa)
The ship value
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.
shipAddress
Indirizzo spedizione
The ship address 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.
shipVat
IVA Spedizione (valore)
The ship vat
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.
shipVatCode
IVA Spedizione (tipo)
The ship vat code
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.
shipVatId
The ship vat 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.
| Name | Value |
|---|---|
| Physical property name | ShipVatId |
| Physical property type | long |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
stage
Stato ordine
The stage of the order
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.
| Name | Value |
|---|---|
| Physical property name | Stage |
| Physical property type | OrderStage |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=stage 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-OrderStageEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
subject
Oggetto
The subject of the quote
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.
subTotal
Imponibile
The sub total
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.
| Name | Value |
|---|---|
| Physical property name | Tags |
| Physical property type | array 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: AdaptiveCsv
| Style name | Serialized as |
|---|---|
| AdaptiveCsv | string |
| AdaptiveExternalReference | string |
| AdaptiveName | string |
| AdaptiveStringOnlyName | string |
| Csv | string |
| CsvOfIds | string |
| CsvOfNames | string |
| Id | int |
taxTotal
IVA totale
The tax total
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.
| Name | Value |
|---|---|
| Physical property name | Template |
| Physical property type | PrintTemplateDTO |
| 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-TemplateStyle: Full
| Style name | Serialized as |
|---|---|
| Full | PrintTemplateDTO |
| None | PrintTemplateDTO |
typeOfInvoice
Tipologia di fattura
Type of invoice
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.
| Name | Value |
|---|---|
| Physical property name | TypeOfInvoice |
| Physical property type | InvoiceType |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=typeOfInvoice 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-InvoiceTypeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
Schema
The following table contains the main schema information about this data type.
| Feature | Value |
|---|---|
| Type | object |
| 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