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 |
|---|---|---|
| bankId | native | Banca The current bank id |
| causal | native | The current causal id |
| causalCode | native | Causali movimenti The current causal code |
| collectionCode | native | The collection code |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| currencyImport | native | Importo (in valuta) The currency value of the movement |
| description | native | Note The value of the movement |
| externalReference | native | External Reference |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| givenDate | native | Data Allibramento The movement given date |
| id | native | |
| import | native | Importo The value of the movement |
| inOut | native | In entrata If the movement is income or outcoming |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| movDate | native | Data The movement date |
| movements | native | Righe movimento The movement rows |
| ownerId | polymorphic | Proprietario The owner of the entity |
| supplier | native | Fornitore The current supplier of the movement |
| suppliers | native | |
| tags | polymorphic | |
| viewInBook | native | Registra in prima nota Register movement is book |
bankId
Banca
The current 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.
| Name | Value |
|---|---|
| Physical property name | BankId |
| 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 |
causal
The current causal 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 | Causal |
| 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 |
causalCode
Causali movimenti
The current causal 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.
| Name | Value |
|---|---|
| Physical property name | CausalCode |
| 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 |
collectionCode
The collection 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.
| Name | Value |
|---|---|
| Physical property name | CollectionCode |
| 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.
currencyImport
Importo (in valuta)
The currency value of the movement
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 | CurrencyImport |
| 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 |
description
Note
The value of the movement
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 | Description |
| 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 |
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.
| Name | Value |
|---|---|
| Physical property name | ExternalReference |
| 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 |
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 |
givenDate
Data Allibramento
The movement given 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.
| Name | Value |
|---|---|
| Physical property name | GivenDate |
| Physical property type | DateTime |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| 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.
import
Importo
The value of the movement
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 | Import |
| 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 |
inOut
In entrata
If the movement is income or outcoming
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 | InOut |
| Physical property type | bool |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| 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.
| 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.
movDate
Data
The movement 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.
| Name | Value |
|---|---|
| Physical property name | MovDate |
| Physical property type | DateTime |
| Is Required | YES |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
movements
Righe movimento
The movement rows
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 | Movements |
| Physical property type | array of PaymentMovementsBOMovementRowsDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| 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.
| 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 |
supplier
Fornitore
The current supplier of the movement
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 | Supplier |
| 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 |
suppliers
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 | Suppliers |
| 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 |
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 |
viewInBook
Registra in prima nota
Register movement is book
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 | ViewInBook |
| Physical property type | bool |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
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")