Sales | Quotation
Service to manage entities of type 'Quotation'.
Overview
URL | api/{tenantKey}/{orgKey}/sales/quotations |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET Quotations (odata)
- GET Quotation by identifier
- GET Quotation by key
- GET Print Quotation by identifier
- GET Print Quotation by identifier (asynchronously)
- GET Print Quotation by key
- GET Print Quotation by key (asynchronously)
- GET Original Print Quotation by identifier
- GET Original Print Quotation by identifier (asynchronously)
- GET Original Print Quotation by key
- GET Original Print Quotation by key (asynchronously)
- POST:
-
PUT:
- PUT Set Custom Attribute Quotation
- PUT Set Custom Attribute QuotationLine
- PUT Set IsActive Quotation
- PUT Set DocumentType Quotation
- PUT Set Company Quotation
- PUT Set DocumentDate Quotation
- PUT Set PostingDate Quotation
- PUT Set Note Quotation
- PUT Set BuyerCustomerPartyName Quotation
- PUT Set BuyerCustomerPartyAddress Quotation
- PUT Set BuyerCustomerPartyTaxId Quotation
- PUT Set ExchangeRate Quotation
- PUT Set ExchangeRateDate Quotation
- PUT Set Discount Quotation
- PUT Set Remarks Quotation
- PUT Set Salesperson Quotation
- PUT Set PaymentMethod Quotation
- PUT Set PaymentTerm Quotation
- PUT Set DeliveryTerm Quotation
- PUT Set Currency Quotation
- PUT Set NoteToRecipient Quotation
- PUT Set ValidUntil Quotation
- PUT Set PriceList Quotation
- PUT Set DocumentStatus Quotation
- PUT Set AccountingPartyAddress Quotation
- PUT Set AccountingPartyTaxId Quotation
- PUT Set AccountingParty Quotation
- PUT Set AccountingPartyName Quotation
- PUT Set SalesChannel Quotation
- PUT Set AltAddress Quotation
- PUT Set IsOneTimeCustomer Quotation
- PUT Set Notification Quotation
- PUT Set EmailTo Quotation
- PUT Set Store Quotation
- PUT Set IsSeriesCommunicated Quotation
- PUT Set Description QuotationLine
- PUT Set Quantity QuotationLine
- PUT Set Unit QuotationLine
- PUT Set UnitPrice QuotationLine
- PUT Set Discount1 QuotationLine
- PUT Set Discount2 QuotationLine
- PUT Set Discount3 QuotationLine
- PUT Set ItemTaxSchema QuotationLine
- PUT Set ComplementaryDescription QuotationLine
- PUT Set SalesItem QuotationLine
- PUT Set Warehouse QuotationLine
- PUT Set DocumentLineStatus QuotationLine
- PUT Set DeliveryDate QuotationLine
- PUT Set CommitmentReference QuotationLine
- PUT Set AssociatedQuotationLineId QuotationLine
- DELETE:
All Resources
This service uses the following resources:
- ApiQuotationDocumentLinesResource
- ApiQuotationResource
- MoneyResource
- QuotationResource
- StandardQuotationDocumentLinesResource
- StandardQuotationResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET Quotations (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 QuotationResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Quotation 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 QuotationResource. |
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 Quotation by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
Response:
When successful, the response body contains the entity record. See QuotationResource. |
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 Print Quotation 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 record does not exist. |
Resource URL:
GET Print Quotation by identifier (asynchronously)
Prints the specified entity record asynchronously.
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 Location header contains an URL to download the printed file. |
Response status codes:
202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Print Quotation by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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:
GET Print Quotation by key (asynchronously)
Prints the specified entity record asynchronously.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Location header contains an URL to download the printed file. |
Response status codes:
202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Original Print Quotation 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 record does not exist. |
Resource URL:
GET Original Print Quotation by identifier (asynchronously)
Prints the specified entity record asynchronously.
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 Location header contains an URL to download the printed file. |
Response status codes:
202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Original Print Quotation by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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:
GET Original Print Quotation by key (asynchronously)
Prints the specified entity record asynchronously.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Location header contains an URL to download the printed file. |
Response status codes:
202 | Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Quotations
Creates a new entity record.
The following elements are required:
quotationResource | (ApiQuotationResource) The request body should contain the entity record that should be created. See ApiQuotationResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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 ApiQuotationResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Quotation Line
Inserts a new 'Quotation Line' in the 'Quotation'.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (ApiQuotationDocumentLinesResource) The ApiQuotationDocumentLinesResource instance. See ApiQuotationDocumentLinesResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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:
POST Communicate To Tax Authority
Custom operation 'CommunicateToTaxAuthority'.
The following elements are required:
quotationId | (Guid) QuotationId. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains a string. |
Resource URL:
PUT Set AccountingParty Quotation
Updates the value of attribute 'AccountingParty' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 AccountingPartyAddress Quotation
Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 AccountingPartyName Quotation
Updates the value of attribute 'AccountingPartyName' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 AccountingPartyTaxId Quotation
Updates the value of attribute 'AccountingPartyTaxId' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 AltAddress Quotation
Updates the value of attribute 'AltAddress' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 AssociatedQuotationLineId QuotationLine
Updates the value of attribute 'AssociatedQuotationLineId' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (Guid) 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 BuyerCustomerPartyAddress Quotation
Updates the value of attribute 'BuyerCustomerPartyAddress' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 BuyerCustomerPartyName Quotation
Updates the value of attribute 'BuyerCustomerPartyName' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 BuyerCustomerPartyTaxId Quotation
Updates the value of attribute 'BuyerCustomerPartyTaxId' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 CommitmentReference QuotationLine
Updates the value of attribute 'CommitmentReference' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Company Quotation
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 ComplementaryDescription QuotationLine
Updates the value of attribute 'ComplementaryDescription' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Currency Quotation
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 DeliveryDate QuotationLine
Updates the value of attribute 'DeliveryDate' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (DateTime) 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 DeliveryTerm Quotation
Updates the value of attribute 'DeliveryTerm' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 QuotationLine
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Discount Quotation
Updates the value of attribute 'Discount' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (decimal) 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 Discount1 QuotationLine
Updates the value of attribute 'Discount1' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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 Discount2 QuotationLine
Updates the value of attribute 'Discount2' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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 Discount3 QuotationLine
Updates the value of attribute 'Discount3' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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 DocumentDate Quotation
Updates the value of attribute 'DocumentDate' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (DateTime) 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 DocumentLineStatus QuotationLine
Updates the value of attribute 'DocumentLineStatus' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (enum DocumentLineStatus) The request body should contain the new value for the attribute. See DocumentLineStatus. |
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 DocumentStatus Quotation
Updates the value of attribute 'DocumentStatus' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (enum DocumentStatus) The request body should contain the new value for the attribute. See DocumentStatus. |
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 DocumentType Quotation
Updates the value of attribute 'DocumentType' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 EmailTo Quotation
Updates the value of attribute 'EmailTo' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 ExchangeRate Quotation
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (decimal) 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 ExchangeRateDate Quotation
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (DateTime) 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 Quotation
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 IsOneTimeCustomer Quotation
Updates the value of attribute 'IsOneTimeCustomer' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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. |
Resource URL:
PUT Set IsSeriesCommunicated Quotation
Updates the value of attribute 'IsSeriesCommunicated' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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. |
Resource URL:
PUT Set ItemTaxSchema QuotationLine
Updates the value of attribute 'ItemTaxSchema' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Note Quotation
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 NoteToRecipient Quotation
Updates the value of attribute 'NoteToRecipient' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Notification Quotation
Updates the value of attribute 'Notification' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 PaymentMethod Quotation
Updates the value of attribute 'PaymentMethod' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 PaymentTerm Quotation
Updates the value of attribute 'PaymentTerm' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 PostingDate Quotation
Updates the value of attribute 'PostingDate' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (DateTime) 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 PriceList Quotation
Updates the value of attribute 'PriceList' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Quantity QuotationLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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 Remarks Quotation
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 SalesChannel Quotation
Updates the value of attribute 'SalesChannel' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 SalesItem QuotationLine
Updates the value of attribute 'SalesItem' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Salesperson Quotation
Updates the value of attribute 'Salesperson' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Store Quotation
Updates the value of attribute 'Store' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Unit QuotationLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 UnitPrice QuotationLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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 ValidUntil Quotation
Updates the value of attribute 'ValidUntil' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
companyKey | (string) The company key. |
value | (DateTime) 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 Warehouse QuotationLine
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Custom Attribute Quotation
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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 Custom Attribute QuotationLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
lineId | (string) The detail identifier. |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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:
DELETE Quotation Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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 Quotation 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 Quotation by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural 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
ApiQuotationDocumentLinesResource
The following elements are required:
description | (string) The quotation's line item description. The default is defined on the sales item. |
quantity | (decimal) The quotation's line item quantity. The default 1. |
unit | (string) The quotation's line item sales unit. The default sales unit is defined on the sales item. |
unitPrice | (MoneyResource) The quotation's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource . |
itemTaxSchema | (string) The quotation's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item. |
salesItem | (string) The sales item representing the good or service. |
documentLineStatus | (enum DocumentLineStatus) The document's line status. The default is Open.
See DocumentLineStatus. |
deliveryDate | (DateTime) The expected line item delivery date. The default is the document date. |
The following elements are optional:
discount1 | (decimal) The line item's discount 1 percentage. The default is 0. |
discount2 | (decimal) The line item's discount 2 percentage. The default is 0. |
discount3 | (decimal) The line item's discount 3 percentage. The default is 0. |
complementaryDescription | (string) The quotation's line item complementary description. The default is defined on the sales item. |
warehouse | (string) The quotation's line item warehouse. The default is defined on the materials item. |
commitmentReference | (string) Commitment Ref. |
associatedQuotationLineId | (Guid) Associated Quotation Line Id. |
ApiQuotationResource
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
company | (string) The quotation's company. The company code is the central organizational unit within the system. |
documentDate | (DateTime) The date when the document is issued. |
postingDate | (DateTime) The date when the document is created. |
buyerCustomerPartyName | (string) The customer's name. It is inferred from the customer party. |
buyerCustomerParty | (string) The customer's party that receives or consumes products (goods or services). |
exchangeRate | (decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date. |
discount | (decimal) The discount's percentage. The default is defined on the customer party. |
paymentMethod | (string) The quotation's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party. |
paymentTerm | (string) The quotation's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party. |
currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party. |
documentStatus | (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus. |
accountingParty | (string) The customer designated in the quotation as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party. |
isSeriesCommunicated | (bool) Is Series Communicated. |
ignoreAssociatedSalesItems | (bool) Ignore Associated Sales Items. |
The following elements are optional:
note | (string) The document's note. |
buyerCustomerPartyAddress | (string) The customer's address. It is inferred from the customer party. |
buyerCustomerPartyTaxId | (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party. |
exchangeRateDate | (DateTime) The exchange rate's creation date. |
remarks | (string) The quotation's remarks. |
documentLines | (List of ApiQuotationDocumentLinesResource) The quotation's lines.
See ApiQuotationDocumentLinesResource. |
salesperson | (string) The sales person associated to the quotation. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party. |
deliveryTerm | (string) The quotation's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party. |
noteToRecipient | (string) The note to the quotation's recipient. |
validUntil | (DateTime) The document's validity date. |
priceList | (string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup. |
accountingPartyAddress | (string) The accounting's customer address. It is inferred from the accounting party. |
accountingPartyTaxId | (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party. |
accountingPartyName | (string) The accounting's party name. It is inferred from the accounting party. |
salesChannel | (string) The quotation's sales channel origin. The default value is defined in the sales setup configuration settings. |
altAddress | (string) The alternative customer's address key to be used on the quotation. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values. |
isOneTimeCustomer | (bool) Defines if the customer party is a marked as an one time customer. Internally determined. |
notification | (string) The quotation's notification configuration. Inferred from the quotation type. |
emailTo | (string) The email(s) to send quotation notification. Inferred from the notification. |
store | (string) The quotaion's sales channel origin. The default value is defined in the documenttype series. |
deviceToken | (string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set). |
isExclusiveForPOSDevice | (bool) Defines if the quotation type series is defined as ExclusiveForPOSDevice. Internally determined. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
QuotationResource
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings.
(fk) Allowed value: the natural key of a record of type QuotationType. These records are accessibly through the QuotationTypes service. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
company | (string) The quotation's 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. |
documentDate | (DateTime) The date when the document is issued. |
postingDate | (DateTime) The date when the document is created. |
buyerCustomerPartyName | (string) The customer's name. It is inferred from the customer party. |
buyerCustomerParty | (string) The customer's party that receives or consumes products (goods or services).
(fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service. |
exchangeRate | (decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date. |
discount | (decimal) The discount's percentage. The default is defined on the customer party. |
grossValue | (MoneyResource) The total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource . |
allowanceChargeAmount | (MoneyResource) The total discount over goods and services. Internally calculated.
See MoneyResource . |
taxExclusiveAmount | (MoneyResource) The quotation's total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource . |
taxTotal | (MoneyResource) The total's tax value of goods and services. Internally calculated.
See MoneyResource . |
payableAmount | (MoneyResource) The quotation's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource . |
paymentMethod | (string) The quotation's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service. |
paymentTerm | (string) The quotation's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service. |
currency | (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
documentStatus | (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus. |
accountingParty | (string) The customer designated in the quotation as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
autoCreated | (bool) Indicates whether the document was created by the system. |
discountInValueAmount | (MoneyResource) Discount In Value.
See MoneyResource . |
isSeriesCommunicated | (bool) Is Series Communicated. |
isWsCommunicable | (bool) Indicates if the quotation is communicated via web service to fiscal authority. Inferred from the quotation type serie. |
isCommunicated | (bool) Is Communicated. |
ignoreAssociatedSalesItems | (bool) Ignore Associated Sales Items. |
The following elements are optional:
taxIncluded | (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the quotation series. |
note | (string) The document's note. |
buyerCustomerPartyAddress | (string) The customer's address. It is inferred from the customer party. |
buyerCustomerPartyTaxId | (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party. |
exchangeRateDate | (DateTime) The exchange rate's creation date. |
remarks | (string) The quotation's remarks. |
legalStamp | (string) In some countries, the documents issued by a company have to contain mandatory remarks, clearly visible in printing, which may vary according to the document. These texts are printed under the signature terms. Internally determined. |
isPrinted | (bool) Indicates if the quotation has been printed. Internally determined. |
documentLines | (List of QuotationLineResource) The quotation's lines.
See QuotationLineResource. |
salesperson | (string) The sales person associated to the quotation. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Salesperson. These records are accessibly through the Salespersons service. |
deliveryTerm | (string) The quotation's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service. |
noteToRecipient | (string) The note to the quotation's recipient. |
validUntil | (DateTime) The document's validity date. |
priceList | (string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
accountingPartyAddress | (string) The accounting's customer address. It is inferred from the accounting party. |
accountingPartyTaxId | (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party. |
accountingPartyName | (string) The accounting's party name. It is inferred from the accounting party. |
salesChannel | (string) The quotation's sales channel origin. The default value is defined in the sales setup configuration settings.
(fk) Allowed value: the natural key of a record of type SalesChannel. These records are accessibly through the SalesChannels service. |
altAddress | (string) The alternative customer's address key to be used on the quotation. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service. |
isOneTimeCustomer | (bool) Defines if the customer party is a marked as an one time customer. Internally determined. |
notification | (string) The quotation's notification configuration. Inferred from the quotation type.
(fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service. |
emailTo | (string) The email(s) to send quotation notification. Inferred from the notification. |
hash | (string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined. |
hashControl | (string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined. |
statusWasCompleted | (bool) Indicates whether the document status was "Completed" when edition started. Internally determined. |
printAllDiscounts | (string) Discount. |
aTCUD | (string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined. |
aTQRCode | (string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined. |
store | (string) The quotaion's sales channel origin. The default value is defined in the documenttype series.
(fk) Allowed value: the natural key of a record of type Store. These records are accessibly through the Stores service. |
printedReportName | (string) Printed Report Name. |
isReprinted | (bool) Is Reprinted. |
isSigned | (bool) Is Signed. |
fiscalDocumentType | (string) Fiscal Document Type.
(fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service. |
deviceToken | (string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set). |
isExclusiveForPOSDevice | (bool) Defines if the quotation type series is defined as ExclusiveForPOSDevice. Internally determined. |
StandardQuotationDocumentLinesResource
The following elements are required:
unit | (string) The quotation's line item sales unit. The default sales unit is defined on the sales item. |
description | (string) The quotation's line item description. The default is defined on the sales item. |
itemTaxSchema | (string) The quotation's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item. |
quantity | (decimal) The quotation's line item quantity. The default 1. |
unitPrice | (MoneyResource) The quotation's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource . |
currency | (string) The money's unit. Inferred from the quotation currency. |
lineExtensionAmount | (MoneyResource) The quotation's line payable amount. The line value including taxes and discounts. Internally calculated.
See MoneyResource . |
salesItem | (string) The sales item representing the good or service. |
deliveryDate | (DateTime) The expected line item delivery date. The default is the document date. |
The following elements are optional:
discount1 | (decimal) The line item's discount 1 percentage. The default is 0. |
discount2 | (decimal) The line item's discount 2 percentage. The default is 0. |
discount3 | (decimal) The line item's discount 3 percentage. The default is 0. |
commitmentReference | (string) Commitment Ref. |
StandardQuotationResource
The following elements are required:
documentType | (string) Defines the quotation's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default quotation type is defined in the sales setup configuration settings. |
documentDate | (DateTime) The date when the document is issued. |
seriesNumber | (int) The sequential number internally determined that uniquely identifies the document within the quotation type and serie. Part of the document natural key. |
paymentTerm | (string) The quotation's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party. |
serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the quotation type. |
payableAmount | (MoneyResource) The quotation's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource . |
company | (string) The quotation's company. The company code is the central organizational unit within the system. |
buyerCustomerParty | (string) The customer's party that receives or consumes products (goods or services). |
documentStatus | (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus. |
discount | (decimal) The discount's percentage. The default is defined on the customer party. |
discountInValueAmount | (MoneyResource) Discount In Value.
See MoneyResource . |
isSeriesCommunicated | (bool) Is Series Communicated. |
isCommunicated | (bool) Is Communicated. |
isWsCommunicable | (bool) Indicates if the quotation is communicated via web service to fiscal authority. Inferred from the quotation type serie. |
The following elements are optional:
documentLines | (List of StandardQuotationDocumentLinesResource) The quotation's lines.
See StandardQuotationDocumentLinesResource. |
note | (string) The document's note. |
hash | (string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined. |
isPrinted | (bool) Indicates if the quotation has been printed. Internally determined. |
statusWasCompleted | (bool) Indicates whether the document status was "Completed" when edition started. Internally determined. |
isOneTimeCustomer | (bool) Defines if the customer party is a marked as an one time customer. Internally determined. |
store | (string) The quotaion's sales channel origin. The default value is defined in the documenttype series. |
isReprinted | (bool) Is Reprinted. |
isSigned | (bool) Is Signed. |
printedReportName | (string) Printed Report Name. |
fiscalDocumentType | (string) Fiscal Document Type. |
isExclusiveForPOSDevice | (bool) Defines if the quotation type series is defined as ExclusiveForPOSDevice. Internally determined. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |