Sales | Quotation Type
Service to manage entities of type 'QuotationType'.
Overview
URL | api/{tenantKey}/{orgKey}/salesCore/quotationTypes |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive QuotationType
- PUT Set Company QuotationType
- PUT Set TypeKey QuotationType
- PUT Set Description QuotationType
- PUT Set DefaultOrderType QuotationType
- PUT Set FiscalDocumentType QuotationType
- PUT Set ContactType QuotationType
- PUT Set Notification QuotationType
- PUT Set IsDefault QuotationTypeSerie
- PUT Set TaxIncluded QuotationTypeSerie
- PUT Set NumberOfCopies QuotationTypeSerie
- PUT Set ATValidationCode QuotationTypeSerie
- PUT Set ATManualCommunication QuotationTypeSerie
- PUT Set CommunicationType QuotationTypeSerie
- PUT Set ExclusiveForPOSDevice QuotationTypeSerie
- PUT Set SalesChannel QuotationTypeSerie
- PUT Set Store QuotationTypeSerie
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET QuotationTypes (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See QuotationTypeResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET QuotationType by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See QuotationTypeResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET QuotationType by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
typeKey | (string) The quotation's type key. |
Response:
When successful, the response body contains the entity record. See QuotationTypeResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST QuotationTypes
Creates a new entity record.
The following elements are required:
quotationTypeResource | (ApiQuotationTypeResource) The request body should contain the entity record that should be created. See ApiQuotationTypeResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiQuotationTypeResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Quotation Type Serie
Inserts a new 'Quotation Type Serie' in the 'Quotation Type'.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (ApiQuotationTypeDocumentTypeSeriesResource) The ApiQuotationTypeDocumentTypeSeriesResource instance. See ApiQuotationTypeDocumentTypeSeriesResource. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ATManualCommunication QuotationTypeSerie
Updates the value of attribute 'ATManualCommunication' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ATValidationCode QuotationTypeSerie
Updates the value of attribute 'ATValidationCode' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CommunicationType QuotationTypeSerie
Updates the value of attribute 'CommunicationType' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (enum CommunicationType) The request body should contain the new value for the attribute. See CommunicationType. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Company QuotationType
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ContactType QuotationType
Updates the value of attribute 'ContactType' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DefaultOrderType QuotationType
Updates the value of attribute 'DefaultOrderType' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description QuotationType
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExclusiveForPOSDevice QuotationTypeSerie
Updates the value of attribute 'ExclusiveForPOSDevice' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FiscalDocumentType QuotationType
Updates the value of attribute 'FiscalDocumentType' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive QuotationType
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsDefault QuotationTypeSerie
Updates the value of attribute 'IsDefault' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Notification QuotationType
Updates the value of attribute 'Notification' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set NumberOfCopies QuotationTypeSerie
Updates the value of attribute 'NumberOfCopies' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SalesChannel QuotationTypeSerie
Updates the value of attribute 'SalesChannel' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Store QuotationTypeSerie
Updates the value of attribute 'Store' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxIncluded QuotationTypeSerie
Updates the value of attribute 'TaxIncluded' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TypeKey QuotationType
Updates the value of attribute 'TypeKey' in the specified entity record.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Quotation Type Serie by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
typeKey | (string) The quotation's type key. |
companyKey | (string) The company key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE QuotationType by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE QuotationType by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
typeKey | (string) The quotation's type key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiQuotationTypeDocumentTypeSeriesResource
The following elements are required:
isDefault | (bool) Indicates if this is the default serie for the document. |
taxIncluded | (bool) When checked, the document unit prices will include taxes. |
numberOfCopies | (int) The number of copies of the document to print. |
serie | (string) The range of identification values that group a set of product entities or objects. |
aTManualCommunication | (bool) Manual Communication. |
communicationType | (enum CommunicationType) Communication Type.
See CommunicationType. |
exclusiveForPOSDevice | (bool) Indicates if this series is used exclusively in POS devices. |
The following elements are optional:
aTValidationCode | (string) Validation Code. |
salesChannel | (string) Indicates the sales channel used by default for this document type series. |
store | (string) Indicates the store used by default for this document type series. Must belong to the indicated sales channel. |
ApiQuotationTypeResource
The following elements are required:
company | (string) The quotation's type company. The company code is the central organizational unit within the system. |
typeKey | (string) The quotation's type key. |
The following elements are optional:
description | (string) The quotation's type description. |
documentTypeSeries | (List of ApiQuotationTypeDocumentTypeSeriesResource) The quotation's type details.
See ApiQuotationTypeDocumentTypeSeriesResource. |
defaultOrderType | (string) Indicates the default order type when the quotations are processed. |
fiscalDocumentType | (string) The fiscal document type. |
contactType | (string) The contact type for the order type. |
notification | (string) The default notification for documents with this order type. |
QuotationTypeResource
The following elements are required:
company | (string) The quotation's type company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
typeKey | (string) The quotation's type key. |
isPortugueseCompany | (bool) Indicates if the invoice type is targeted at a company that is portuguese. |
The following elements are optional:
description | (string) The quotation's type description. |
documentTypeSeries | (List of QuotationTypeSerieResource) The quotation's type details.
See QuotationTypeSerieResource. |
defaultOrderType | (string) Indicates the default order type when the quotations are processed.
(fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service. |
fiscalDocumentType | (string) The fiscal document type.
(fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service. |
contactType | (string) The contact type for the order type.
(fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service. |
notification | (string) The default notification for documents with this order type.
(fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service. |