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")

NameKindDescription
createdById native Creato da
The creator of the entity
createdDate native Data creazione
The creation date for the entity
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
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
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
subTotal native Imponibile
The sub total
tags polymorphic
taxTotal native IVA totale
The tax total

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

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

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

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

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

NameValue
Physical property nameCurrencyChange
Physical property typedecimal
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à.

NameValue
Physical property nameCurrencyGrandTotal
Physical property typedecimal
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à.

NameValue
Physical property nameCurrencyPaymentDiscountTotal
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=currencyPaymentDiscountTotal eq 123.456
Is Enum NO

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

NameValue
Physical property nameCurrencySubTotal
Physical property typedecimal
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à.

NameValue
Physical property nameCurrencyTaxTotal
Physical property typedecimal
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO

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

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

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

NameValue
Physical property nameFooterDiscount
Physical property typedecimal
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à.

NameValue
Physical property nameGrandTotal
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=grandTotal eq 123.456
Is Enum NO

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

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

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

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

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

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

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

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'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-OwnerIdStyle

Crm-OwnerIdStyle: AdaptiveExternalReference

Style nameSerialized 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à.

NameValue
Physical property namePaymentDiscountTotal
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=paymentDiscountTotal eq 123.456
Is Enum NO

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

NameValue
Physical property nameErpRows
Physical property typearray of ERPRowDTO
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive NO
Is Enumerable YES
Is Searchable NO
Is Enum NO

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

NameValue
Physical property nameSubTotal
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=subTotal eq 123.456
Is Enum NO

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

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'

Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni

Crm-TagsStyle

Crm-TagsStyle: AdaptiveCsv

Style nameSerialized 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à.

NameValue
Physical property nameTaxTotal
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=taxTotal eq 123.456
Is Enum NO


Schema

La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.

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