CRM in Cloud Web API documentations

Sicurezza

Questo controller è sottoposto alle regole di security del sistema.
Per maggiori dettagli, fare riferimento alla sezione Authentication

Note

Le indicazioni riportate di seguito hanno lo scopo di illustrare le funzionalità e le caratteristiche di questo Web API controller.

Aliases

Questo controller è invocabile tramite altri nomi oltre a quello di default.

Ciò significa che, facendo riferimento alla grammatica di routing ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) è possibile utilizzare un fragment differente per il componente {controller}.

Di seguito è riportata la lista di tali alias per il fragment {controller}, in ordine di preferenza d'uso.

Alias	Path
Quotes	/api/v1/Quotes
Quote	/api/v1/Quote

Authentication

Token JWT

Al fine di potere invocare le API REST, è necessario ottenere un token di autenticazione tramite l’apposito servizio /Auth/Login.
Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Bearer Authentication

La "Bearer Authentication" (tradotta "autenticazione al portatore", detta anche "autenticazione token") è uno schema di autenticazione HTTP che coinvolge un token di sicurezza denominato bearer token.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Identificazione dell’applicazione chiamante

Alcune delle funzioni delle API REST possono essere utilizzate solamente se (oltre ad una corretta autenticazione dell’utente) si esegue anche una dichiarazione dell’applicazione chiamante.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Actions & Paths

Di seguito sono elencate le azioni REST eseguibili tramite le Web API.
Le azioni sono raggruppate per "topic".
Clicca un "topic" per visualizzare le diverse azioni in esso contenute.

Ad ogni azione corrisponde un metodo interno alla classe del controller Web API, ed un set di paths di routing utilizzabili per invocarla.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Quote/CreateOrUpdate /api/v1/Quote/ /api/v1/Quote/Exists /api/v1/Quote/ /api/v1/Quote/Humanize /api/v1/Quote/GetFull /api/v1/Quote/GetNewInstance
Multiple CRUD	/api/v1/Quote/MultipleDelete /api/v1/Quote/MultipleExists /api/v1/Quote/MultipleGet
Copy	/api/v1/Quote/CreateCopy /api/v1/Quote/Copy
External References	/api/v1/Quote/SearchIdsByExternalReference /api/v1/Quote/GetByExternalReference /api/v1/Quote/DeleteByExternalReference /api/v1/Quote/MapByExternalReference /api/v1/Quote/ResetExternalReferences /api/v1/Quote/UnmapByExternalReference /api/v1/Quote/GetIdsMappedByExternalReference /api/v1/Quote/GetItemsMappedByExternalReference /api/v1/Quote/GetIdsNotMappedByExternalReference /api/v1/Quote/GetIdsByExternalReference /api/v1/Quote/GetItemsNotMappedByExternalReference
Misc	/api/v1/Quote/ConvertToOrder /api/v1/Quote/StoreDocument /api/v1/Quote/CreateRevision /api/v1/Quote/SaveFromOpportunity /api/v1/Quote/Review /api/v1/Quote/CheckVatValue /api/v1/Quote/SaveWithDocument /api/v1/Quote/RequestedByChanged /api/v1/Quote/OnAnagraphicChanged /api/v1/Quote/GetPriceListCurrency /api/v1/Quote/SendEmailWithPrintTemplate /api/v1/Quote/OnGetNewEmptyGroupRow /api/v1/Quote/OnGroupByRowType /api/v1/Quote/OnGroupByProductCategory /api/v1/Quote/OnDiscountFormulaGroupingChanged /api/v1/Quote/OnGroupTaxableAmountWithDiscountChanged /api/v1/Quote/GetInfo /api/v1/Quote/AddProductsByCode /api/v1/Quote/CloneRowsGroups /api/v1/Quote/ImportRows /api/v1/Quote/GetNewRowInstance /api/v1/Quote/ApplyCalculateTotalDocument /api/v1/Quote/ApplyCalculateTotalDocumentWithFooterTotals /api/v1/Quote/NewEmptyRow /api/v1/Quote/CatalogCodeChanged /api/v1/Quote/LinkedProducts /api/v1/Quote/PriceListChanged /api/v1/Quote/UnitPriceChanged /api/v1/Quote/QtaChanged /api/v1/Quote/UnitMeasureChanged /api/v1/Quote/TaxCodeChanged /api/v1/Quote/DiscountFormulaChanged /api/v1/Quote/CostChanged /api/v1/Quote/GainChanged /api/v1/Quote/PercentageGainChanged /api/v1/Quote/ProcessOnChangeListId /api/v1/Quote/ProcessOnChangeCurrency /api/v1/Quote/ExportRowsInExcel /api/v1/Quote/RebuildGrouping /api/v1/Quote/RecalcDocumentTotal /api/v1/Quote/Templates /api/v1/Quote/HtmlPreview /api/v1/Quote/PrintHtml /api/v1/Quote/GetDownloadUrl /api/v1/Quote/GetPostDownloadUrl /api/v1/Quote/Archive /api/v1/Quote/AsDataProduct /api/v1/Quote/GetBoDeleteModes /api/v1/Quote/FreeFields /api/v1/Quote/GetHash /api/v1/Quote/PrintableFields /api/v1/Quote/Photo /api/v1/Quote/Recent /api/v1/Quote/GetSample
OData	/api/v1/Quote/Count /api/v1/Quote/SearchIds /api/v1/Quote/Search
Preview	/api/v1/Quote/Previews /api/v1/Quote/Preview
Swagger	/api/v1/Quote/GetDataProductSchema /api/v1/Quote/GetPolymorphicSchema /api/v1/Quote/GetPolymorphicStandardSchema /api/v1/Quote/GetStandardSchema /api/v1/Quote/GetSwagger

GET: /api/v1/Quote/

Routing template:

/api/{version}/Quote/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/json;IEEE754Compatible=false
HTTP 200: Int64 as application/json;IEEE754Compatible=true
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
id	integer	YES	Path	Format: int64
template	string	NO	Query
PrintProductAttach	boolean	NO	Query
PrintAttachment	boolean	NO	Query
Preview	boolean	NO	Query
Logo	string	NO	Query

Name	Type	Required	In	Features
insertPosition	integer	NO	Query	Format: int32
overrideCurrent	boolean	NO	Query
lang	string	NO	Query

Name	Type	Required	In
exportDescription	boolean	NO	Query
exportDescriptionNewLine	boolean	NO	Query
exportExtensions	boolean	NO	Query
exportFreeFields	boolean	NO	Query

Name	Type	Required	In	Features
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
externalReference	string	NO	Query
excludeDeletedItems	boolean	NO	Query

Name	Type	Required	In	Features
serializePropertiesAsDictionary	boolean	NO	Query	Default: True
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
generateSample	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
force	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
taxableAmountWithDiscount	number	NO	Query	Format: double
extensionPartIdx	integer	NO	Query	Format: int32
decimals	integer	NO	Query	Default: 2 Format: int32

Name	Type	Required	In	Features
includeFull	boolean	NO	Query	Default: True
includeNesting	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
crossId	integer	NO	Query	Format: int64
crossType	BusinessObjectType	NO	Query
erpType	BusinessObjectType	NO	Query

Name	Type	Required	In	Features
filter	string	NO	Query
orderBy	string	NO	Query
skip	integer	NO	Query	Format: int64
top	integer	NO	Query	Format: int64
select	string	NO	Query

Name	Type	Required	In	Features
parentId	integer	NO	Query	Format: int64
parentType	BusinessObjectType	NO	Query
templateName	string	NO	Query

Name	Description
AccountAccessLevel	Account Access Level
ActiveModules	Active Modules
AddProductsByCodeRequest	Add Products By Code Request
AddressAccuracy	Address Accuracy
ApprovalPendingDTO	Approval Pending
ApprovalPendingStatus	Approval Pending Status
ApprovalResultDTO	Approval Result
ApprovalRuleCalcType	Approval Rule Calc Type
BoDeleteMode	Bo Delete Mode
BusinessObjectInvoker	Business Object Invoker
BusinessObjectLoadedType	Business Object Loaded Type
BusinessObjectType	Business Object Type
CatalogPriceListUsage	Catalog Price List Usage
CatalogType	Catalog Type
CloneRowsGroupsRequest	Clone Rows Groups Request
CRMTables	CRM Tables
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
ErpGroupingType	Erp Grouping Type
ERPRowDTO	ERP Row
ERPRowGroupingDTO	ERP Row Grouping
ERPRowGroupingExtensionDTO	ERP Row Grouping Extension
ERPRowType	ERP Row Type
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossTypes	File Cross Types
FilePreview	File Preview
FreeFieldsBOItemDTO	Free Fields BO Item
FreeFieldsBOItemLocalizingDTO	Free Fields BO Item Localizing
FreeFieldsBOTreeItemDTO	Free Fields BO Tree Item
FreeFieldsType	Free Fields Type
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
IBundle	Bundle
ICatalogAlternativeUnitBO	Catalog Alternative Unit BO
ICatalogBO	Catalog BO
ICatalogCodeChangeResponse	Catalog Code Change Response
ICatalogProductPriceBO	Catalog Product Price BO
ICrmBusinessObjects	Crm Business Objects
IDirection	Direction
IDocumentReference	Document Reference
IErpExportRowsExcelInfo	Erp Export Rows Excel Info
IERPRow	ERP Row
IERPRowExtension	ERP Row Extension
IERPRowGrouping	ERP Row Grouping
IERPRowGroupingExtension	ERP Row Grouping Extension
IExternalReference	External Reference
IFileCross	File Cross
IFreeFieldItemLocalizing	Free Field Item Localizing
IFreeFieldsItem	Free Fields Item
IGeo	Geo
ILocalizing	Localizing
ILocation	Location
ImportRowsRequest	Import Rows Request
object	Int 64
InvoiceType	Invoice Type
IPackageResponse	Package Response
IPrintTemplate	Print Template
IQueryFragment	Query Fragment
IQueryMutators	Query Mutators
IQueryPaging	Query Paging
ISimpleCatalogLink	Simple Catalog Link
IStorageBO	Storage BO
ITaxSummary	Tax Summary
ITotalDocumentResult	Total Document Result
ITreeItem	Tree Item
IUserConfig	User Config
LinkItem	Link Item
LiquidStruct	Liquid Struct
LocalizeType	Localize Type
LocalizingDTO	Localizing
LoggedStatus	Logged Status
LoginResult	Login Result
MapExternalReferenceRequest	Map External Reference Request
MessageCode	Message Code
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
PrintHtmlRequest	Print Html Request
PrintTemplateDTO	Print Template
QueryFragmentKind	Query Fragment Kind
QuoteDocumentTotalsRequest	Quote Document Totals Request
QuoteDTO	Quote
QuoteStage	Quote Stage
RecentRouteType	Recent Route Type
RowContentType	Row Content Type
RowTypeGiftVatMode	Row Type Gift Vat Mode
SampleGenerationStrategy	Sample Generation Strategy
StandardSchemaVersion	Standard Schema Version
StoragePermission	Storage Permission
StoreDocumentRequest	Store Document Request
StoreQuoteDocumentRequest	Store Quote Document Request
SubAccountType	Sub Account Type
Template	Template
TypeOfService	Type Of Service

APIv1italianoQuote

Quote

Sicurezza

Note

Aliases

Authentication

Token JWT

Bearer Authentication

Identificazione dell’applicazione chiamante

Actions & Paths

GET: /api/v1/Quote/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Provalo !

DELETE: /api/v1/Quote/{id}

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Provalo !

GET: /api/v1/Quote/{id}

Parameters:

Produces:

Response: 200 (Success) QuoteDTO

Samples

Provalo !

GET: /api/v1/Quote/{id}/Archive

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Provalo !

GET: /api/v1/Quote/{id}/AsDataProduct

Parameters:

Produces:

Response: 200 (Success) QuoteDTO

Samples

Provalo !

POST: /api/v1/Quote/{id}/Copy

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Provalo !

GET: /api/v1/Quote/{id}/Exists

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Provalo !

GET: /api/v1/Quote/{id}/FreeFields

Parameters:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Provalo !

GET: /api/v1/Quote/{id}/GetDownloadUrl

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Provalo !

GET: /api/v1/Quote/{id}/GetFull

Parameters:

Produces:

Response: 200 (Success) QuoteDTO

Samples

Provalo !

GET: /api/v1/Quote/{id}/GetHash

Parameters:

Produces:

Response: 200 (Success) String

Samples

Provalo !

GET: /api/v1/Quote/{id}/GetPostDownloadUrl

Parameters:

Produces:

Response: 400 (Bad Request) string

API v1 italiano Quote