Sales | Sales Settings
Service to manage entities of type 'SalesSetup'.
Overview
URL | api/{tenantKey}/{orgKey}/salesCore/salesSetups |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive SalesSetup
- PUT Set DefaultOrderType SalesSetup
- PUT Set DefaultMemoType SalesSetup
- PUT Set Company SalesSetup
- PUT Set DefaultInvoiceType SalesSetup
- PUT Set DefaultQuotationType SalesSetup
- PUT Set DefaultDeliveryType SalesSetup
- PUT Set QuotationValidity SalesSetup
- PUT Set DefaultSalesChannel SalesSetup
- PUT Set DefaultPriceList SalesSetup
- PUT Set DefaultOneTimeCustomer SalesSetup
- DELETE:
All Resources
This service uses the following resources:
GET SalesSetups (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 SalesSetupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SalesSetup 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 SalesSetupResource. |
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 SalesSetup by key
Returns the entity record that matches the specified key.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
Response:
When successful, the response body contains the entity record. See SalesSetupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST SalesSetups
Creates a new entity record.
The following elements are required:
salesSetupResource | (ApiSalesSetupResource) The request body should contain the entity record that should be created. See ApiSalesSetupResource. |
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 ApiSalesSetupResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Company SalesSetup
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultDeliveryType SalesSetup
Updates the value of attribute 'DefaultDeliveryType' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultInvoiceType SalesSetup
Updates the value of attribute 'DefaultInvoiceType' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultMemoType SalesSetup
Updates the value of attribute 'DefaultMemoType' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultOneTimeCustomer SalesSetup
Updates the value of attribute 'DefaultOneTimeCustomer' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DefaultOrderType SalesSetup
Updates the value of attribute 'DefaultOrderType' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultPriceList SalesSetup
Updates the value of attribute 'DefaultPriceList' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultQuotationType SalesSetup
Updates the value of attribute 'DefaultQuotationType' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 DefaultSalesChannel SalesSetup
Updates the value of attribute 'DefaultSalesChannel' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive SalesSetup
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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 QuotationValidity SalesSetup
Updates the value of attribute 'QuotationValidity' in the specified entity record.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE SalesSetup 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 SalesSetup by key
Deletes the entity record that matches the specified key.
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
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
ApiSalesSetupResource
The following elements are required:
company | (string) The company's code is the central organizational unit within the system. |
The following elements are optional:
defaultOrderType | (string) Indicates the default order type when the orders are processed. |
defaultMemoType | (string) Indicates the default memo type when the memos are processed. |
defaultInvoiceType | (string) Indicates the default order type when the invoices are processed. |
defaultQuotationType | (string) Indicates the default order type when the quotations are processed. |
defaultDeliveryType | (string) Indicates the default order type when the deliveries are processed. |
quotationValidity | (int) Indicates the quotation validity. |
defaultSalesChannel | (string) Indicates the default sales channel to be used. |
defaultPriceList | (string) Indicates the default price list to be used. |
defaultOneTimeCustomer | (string) Indicates the default non-regular customer to use. |
SalesSetupResource
The following elements are required:
company | (string) The company's 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. |
The following elements are optional:
defaultOrderType | (string) Indicates the default order type when the orders are processed.
(fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service. |
defaultMemoType | (string) Indicates the default memo type when the memos are processed.
(fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service. |
defaultInvoiceType | (string) Indicates the default order type when the invoices are processed.
(fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service. |
defaultQuotationType | (string) Indicates the default order type when the quotations are processed.
(fk) Allowed value: the natural key of a record of type QuotationType. These records are accessibly through the QuotationTypes service. |
defaultDeliveryType | (string) Indicates the default order type when the deliveries are processed.
(fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service. |
quotationValidity | (int) Indicates the quotation validity. |
defaultSalesChannel | (string) Indicates the default sales channel to be used.
(fk) Allowed value: the natural key of a record of type SalesChannel. These records are accessibly through the SalesChannels service. |
defaultPriceList | (string) Indicates the default price list to be used.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
defaultOneTimeCustomer | (string) Indicates the default non-regular customer to use.
(fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service. |