Sales | Quotation Type

Service to manage entities of type 'QuotationType'.

Overview

api/{tenantKey}/{orgKey}/salesCore/quotationTypes

URL	api/{tenantKey}/{orgKey}/salesCore/quotationTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST QuotationTypes
- POST Quotation Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiQuotationTypeDocumentTypeSeriesResource
ApiQuotationTypeResource
QuotationTypeResource
QuotationTypeSerieResource

All Enumerations

This service uses the following enumerations:

ATCommunicationStatus

GET Operations

GET QuotationTypes

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes

GET /salesCore/quotationTypes

GET QuotationTypes (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes?page={page}&pageSize={pageSize}

GET /salesCore/quotationTypes?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{id}

GET /salesCore/quotationTypes/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}

GET /salesCore/quotationTypes/{companyKey}/{typeKey}

GET Print QuotationType by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{id}/print?template={template}

GET /salesCore/quotationTypes/{id}/print?template={template}

GET Print QuotationType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The quotation's type key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/print

GET /salesCore/quotationTypes/{companyKey}/{typeKey}/print

GET Original Print QuotationTypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{id}/printOriginal?template={template}

GET /salesCore/quotationTypes/{id}/printOriginal?template={template}

GET Original Print QuotationType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The quotation's type key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/printOriginal

GET /salesCore/quotationTypes/{companyKey}/{typeKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes

POST /salesCore/quotationTypes

POST Quotation Type

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries

PUT Operations

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/company

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/company

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/contactType

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/contactType

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/defaultOrderType

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/defaultOrderType

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/description

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/description

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/fiscalDocumentType

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/isActive

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/isActive

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/notification

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/notification

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/typeKey

PUT /salesCore/quotationTypes/{companyKey}/{typeKey}/typeKey

DELETE Operations

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /salesCore/quotationTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{id}

DELETE /salesCore/quotationTypes/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/quotationTypes/{companyKey}/{typeKey}

DELETE /salesCore/quotationTypes/{companyKey}/{typeKey}

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.

The following elements are optional:

aTValidationCode

(string) Validation Code.

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.

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.

QuotationTypeSerieResource

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.

The following elements are optional:

currentNumber	(int) The current document number.
currentDate	(DateTime) The current date for the order type serie.
aTValidationCode	(string) Validation Code.
aTCommunicationStatus	(enum ATCommunicationStatus) Communication Status. See ATCommunicationStatus.
aTCommunicationDate	(DateTime) Communication Date.

Enumerations

ATCommunicationStatus

1	Active
2	Finished
3	Annulled
4	NotCommunicated