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

activityId

If the document is completed

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.

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.

appearance

Aspetto esteriore

The description text of the appearance (if not exists, create this)

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.

bank

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

bankCode

Banca di appoggio

The name of the bank

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

Usage sample: Crm-BankCodeStyle: Full

boStatus

Bo Status

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

Usage sample: Crm-ErpDocumentStatusEnumStyle: AdaptiveInteger

carrier

Vettore

The carrier

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.

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.

completed

Completato

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

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.

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.

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

Usage sample: Crm-CrossTypeStyle: Full

currency

Valuta

The type of 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.

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.

currencyCollectionCharges

Spese incasso (in valuta)

The currency ship

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.

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.

currencyGrandTotalToPay

Totale da pagare (in valuta)

The currency 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.

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.

currencyShip

Spese spedizione (in valuta)

The currency ship

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.

currencySimbol

The simbol 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.

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.

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.

customDocumentTypeCode

The type code of document

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.

customDocumentTypeId

Tipo documento

The type code of document

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.

description

Note

The description 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.

documentDate

Data documento

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.

documentTotals

Totali

The list of tax summary 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.

erpRowType

The type of the rows (all must be same)

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

Usage sample: Crm-ERPRowTypeEnumStyle: AdaptiveInteger

expirationDate

Data validità

The expiration date 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.

externalPdfDocument

External Pdf Document

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.

externalPdfDocumentBase64

The external PDF document

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.

externalReference

External Reference

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

Usage sample: Crm-ExternalReferenceStyle: Full

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.

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.

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.

groups

Gruppi

The groups 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.

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.

managerId

Area manager (responsabile agenti)

The manager id 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.

movementsGenerationLogId

The foreign key referencing the eventual movement generation log 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.

number

Numero documento

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.

ourRef

Nostro riferimento

Our reference

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

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.

paymentMovements

Pagamenti

The payment movements 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.

porto

The porto

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.

reference

Persona di riferimento

The reference of document

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.

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.

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.

shipDate

Data presunta consegna

The shipping 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.

shipId

The ship id 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.

shippedBy

Trasporto a cura di

Shipped by

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.

signaler

Segnalatore

The signaler 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.

splitPayment

Split payments (pubblica amministrazione)

Split payment

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.

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.

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

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.

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

Usage sample: Crm-TemplateStyle: Full

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.

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

Usage sample: Crm-InvoiceTypeEnumStyle: AdaptiveInteger

yourRef

Vostro riferimento

Your reference

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