Sales | Sales Parameters

The Sales Setup is used to manage default values for each company, such as the default order type or default sales channel.

Overview

api/{tenantKey}/{orgKey}/salesCore/salesSetups

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

All Operations

This service includes the following operations:

GET:
POST:
- POST SalesSetups
PUT:
DELETE:
- DELETE SalesSetup by identifier
- DELETE SalesSetup by key

All Resources

This service uses the following resources:

ApiSalesSetupResource
SalesSetupResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET SalesSetups

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups

GET /salesCore/salesSetups

GET SalesSetups (paged)

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

The following elements are optional:

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

Response:

When successful, the response body contains the list of records available. See SalesSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

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

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

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:

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

GET /salesCore/salesSetups/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}

GET /salesCore/salesSetups/{company}

GET Print SalesSetup by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

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

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

GET Print SalesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company's code is the central organizational unit within the system.

The following elements are optional:

template

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

Response:

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

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/print

GET /salesCore/salesSetups/{company}/print

GET Original Print SalesSetupOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

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

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

GET Original Print SalesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company's code is the central organizational unit within the system.

The following elements are optional:

template

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

Response:

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

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/printOriginal

GET /salesCore/salesSetups/{company}/printOriginal

POST Operations

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.

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 ApiSalesSetupResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesSetups

POST /salesCore/salesSetups

PUT Operations

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/company

PUT /salesCore/salesSetups/{company}/company

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultDeliveryType

PUT /salesCore/salesSetups/{company}/defaultDeliveryType

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultInvoiceType

PUT /salesCore/salesSetups/{company}/defaultInvoiceType

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultMemoType

PUT /salesCore/salesSetups/{company}/defaultMemoType

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultOrderType

PUT /salesCore/salesSetups/{company}/defaultOrderType

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultPriceList

PUT /salesCore/salesSetups/{company}/defaultPriceList

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultQuotationType

PUT /salesCore/salesSetups/{company}/defaultQuotationType

PUT Set DefaultReturnOrderType SalesSetup

Updates the value of attribute 'DefaultReturnOrderType' 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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultReturnOrderType

PUT /salesCore/salesSetups/{company}/defaultReturnOrderType

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/defaultSalesChannel

PUT /salesCore/salesSetups/{company}/defaultSalesChannel

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/isActive

PUT /salesCore/salesSetups/{company}/isActive

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}/quotationValidity

PUT /salesCore/salesSetups/{company}/quotationValidity

PUT Set Custom Attribute SalesSetup

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
company	(string) The company's code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{companyKey}/{company}/{customAttributeName}

PUT /salesCore/salesSetups/{companyKey}/{company}/{customAttributeName}

DELETE Operations

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:

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

DELETE /salesCore/salesSetups/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/salesSetups/{company}

DELETE /salesCore/salesSetups/{company}

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) The default order type when the orders are processed.
defaultMemoType	(string) The default memo type when the memos are processed.
defaultInvoiceType	(string) The default order type when the invoices are processed.
defaultQuotationType	(string) The default order type when the quotations are processed.
defaultDeliveryType	(string) The default order type when the deliveries are processed.
quotationValidity	(int) The quotation validity.
defaultSalesChannel	(string) The default sales channel to be used.
defaultPriceList	(string) The default price list to be used.
defaultReturnOrderType	(string) The default return order type to be used.

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) 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) 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) 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) 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) 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) The quotation validity.
defaultSalesChannel	(string) 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) 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.
defaultReturnOrderType	(string) The default return order type to be used. (fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.