Proprietà
Questa tabella elenca l'intero set di proprietà contenute in questo tipo di dati.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")
Name | Kind | Description |
---|---|---|
address | native | Indirizzo fatturazione The full address of the object |
convertedOrderId | native | Converted Order Id |
createdById | native | Creato da The creator of the entity |
createdDate | native | Data creazione The creation date for the entity |
crossId | native | Richiesto da The cross id |
crossName | native | Cross Name |
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 validità The expiration date of the quote |
externalReferences | native | Campi aggiuntivi The external references linked to current object |
footerDiscount | native | Sconto incondizionato The footer discount |
grandTotal | native | Totale The grand total |
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 |
number | native | Numero preventivo The number of the quote |
opportunityId | native | Opportunità The opportunity |
ownerId | polymorphic | Proprietario The owner of the entity |
paymentDiscountTotal | native | Totale sconto pagamento The sub total |
paymentId | native | Termine di pagamento The id of payment terms |
paymentMode | native | Modalità di pagamento The id of payment mode |
quoteDate | native | Data The date of the quote |
rows | native | Righe The row of the erp object |
salesPerson | native | Commerciale The sales person id |
shipAddress | native | Indirizzo spedizione The ship address of the object |
stage | polymorphic | Stato preventivo The stage of the quote |
subject | native | Oggetto preventivo The subject of the quote |
subTotal | native | Imponibile The sub total |
tags | polymorphic | |
taxTotal | native | IVA totale The tax total |
address
Indirizzo fatturazione
The full address of the object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
convertedOrderId
Converted Order Id
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | ConvertedOrderId |
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
crossId
Richiesto da
The cross id
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | CrossId |
Physical property type | long |
Is Required | YES |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=crossId eq 123 |
Is Enum | NO |
Foreign Key |
|
crossName
Cross Name
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | CrossName |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
crossType
Only company, contact, or lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | CrossType |
Physical property type | BusinessObjectType |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | YES |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-BusinessObjectTypeEnumStyle
Crm-BusinessObjectTypeEnumStyle: AdaptiveInteger
Style name | Serialized as |
---|---|
AdaptiveInteger | int |
AdaptiveString | string |
currencyChange
Cambio
The changed value of the currency
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
currencySubTotal
Imponibile (in valuta)
The currency sub total
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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 validità
The expiration date of the quote
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
externalReferences
Campi aggiuntivi
The external references linked to current object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
id
Questa proprietà contiene la chiave primaria dell'oggetto all'interno del sistema. Può essere utilizzato per identificare universalmente il record contenente tutti i dati dell'oggetto
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
lastModifiedById
Modificato da
The last modified by id
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
listId
Listino
The id of the list item
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | ListId |
Physical property type | long |
Is Required | NO |
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 |
|
number
Numero preventivo
The number of the quote
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
opportunityId
Opportunità
The opportunity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | OpportunityId |
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 |
Foreign Key |
|
ownerId
Proprietario
The owner of the entity
Questa proprietà polimorfica è una foreign key, e rappresenta il legame con l'utente che fa da "owner" a questo oggetto.
Sono disponibili svariati stili di serializzazione (vedi la sezione a seguire)
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
paymentId
Termine di pagamento
The id of payment terms
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | PaymentId |
Physical property type | long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=paymentId eq 123 |
Is Enum | NO |
Foreign Key |
|
paymentMode
Modalità di pagamento
The id of payment mode
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | PaymentMode |
Physical property type | long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=paymentMode eq 123 |
Is Enum | NO |
Foreign Key |
|
quoteDate
Data
The date of the quote
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
rows
Righe
The row of the erp object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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 |
|
shipAddress
Indirizzo spedizione
The ship address of the object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
stage
Stato preventivo
The stage of the quote
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Stage |
Physical property type | QuoteStage |
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-QuoteStageEnumStyle: AdaptiveInteger
Style name | Serialized as |
---|---|
AdaptiveInteger | int |
AdaptiveString | string |
subject
Oggetto preventivo
The subject of the quote
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
subTotal
Imponibile
The sub total
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
tags
Questa proprietà polimorfica è un array di tags (etichette testuali) associati all'oggetto corrente.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"
Ricerche OData
E' possibile utilizzare questa proprietà come condizione di filtro in una espressione OData tramite l'operatore eq e le funzioni startswith, endswith
Esempi:
'eq' -> GET: /api/{version}/Company/Search?$filter=tags eq 'categoria'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(tags,'ro')
Esempio complesso -> 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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Schema
La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.
Feature | Value |
---|---|
Complex type | QuoteDTO |
Required: |
Schema polimorfico
Lo schema polimorfico descrive come l'oggetto viene serializzato e deserializzato dalla pipeline Web API.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")
Free Fields
Questo Business Object è customizzabile, ed è quindi possibile definire un set di campi custom.
Tali campi custom sono detti Free Field.
I Free Field sono campi custom definibili dall'utente, e possono contenere dati di svariata natura.
Ogni Free Field ha un tipo dati specifico (selezionato in fase di configurazione), e sulla base di tale tipo, i dati del campo seguono determinate regole di validazione.
Per maggiori informazioni circa i Free Field, fare riferimento all'apposita sezione
Free Field e polimorfismo
Come per molti altri campi, anche i Free Field godono delle proprietà di polimorfismo, ed è quindi possibile selezionare molteplici stili di serializzazione/deserializzazione.
Per maggiori dettagli, fare riferimento all'apposito paragrafo descrittivo sulla serializzazione dei Free Field
Free Field e OData
I Free Field sono utilizzabili nelle ricerche OData come selettori di campo (criterio $select).
Al fine di poterli discriminare dagli altri campi standard del Business Object, è necessario specificare il prefisso "FF_"
Esempio:
GET: /api/{version}/{controller}/Search?$select=id,FF_MyCustomFreeField1,FF_AnotherFreeField