Sales | Customer Group

The Customer Group represents an aggregation of suppliers that are similar in some way.

Overview

api/{tenantKey}/{orgKey}/salesCore/customerGroups

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

All Operations

This service includes the following operations:

GET:
POST:
- POST CustomerGroups
- POST Customer Group
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCustomerGroupEntityDimensionDetailsResource
ApiCustomerGroupResource
CustomerGroupDimensionResource
CustomerGroupResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET CustomerGroups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups

GET /salesCore/customerGroups

GET CustomerGroups (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 CustomerGroupResource.

Response status codes:

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

Resource URL:

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

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

GET CustomerGroup 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 CustomerGroupResource.

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/customerGroups/{id}

GET /salesCore/customerGroups/{id}

GET CustomerGroup by key

Returns the entity record that matches the specified key.

The following elements are required:

customerGroupKey

(string) The customer's group key.

Response:

When successful, the response body contains the entity record. See CustomerGroupResource.

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/customerGroups/{customerGroupKey}

GET /salesCore/customerGroups/{customerGroupKey}

GET Print CustomerGroup 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/customerGroups/{id}/print?template={template}

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

GET Print CustomerGroup by key

Prints the specified entity record.

The following elements are required:

customerGroupKey

(string) The customer's group key.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/print

GET /salesCore/customerGroups/{customerGroupKey}/print

GET Original Print CustomerGroupOriginal 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/customerGroups/{id}/printOriginal?template={template}

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

GET Original Print CustomerGroup by key

Prints the specified entity record.

The following elements are required:

customerGroupKey

(string) The customer's group key.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/printOriginal

GET /salesCore/customerGroups/{customerGroupKey}/printOriginal

POST Operations

POST CustomerGroups

Creates a new entity record.

The following elements are required:

customerGroupResource

(ApiCustomerGroupResource) The request body should contain the entity record that should be created.
See ApiCustomerGroupResource.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups

POST /salesCore/customerGroups

POST Customer Group

Inserts a new 'Customer Group Dimension' in the 'Customer Group'.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(ApiCustomerGroupEntityDimensionDetailsResource) The ApiCustomerGroupEntityDimensionDetailsResource instance. See ApiCustomerGroupEntityDimensionDetailsResource.

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:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/entityDimensionDetails

POST /salesCore/customerGroups/{customerGroupKey}/entityDimensionDetails

PUT Operations

PUT Set CustomerGroupKey CustomerGroup

Updates the value of attribute 'CustomerGroupKey' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/customerGroupKey

PUT /salesCore/customerGroups/{customerGroupKey}/customerGroupKey

PUT Set DeliveryMode CustomerGroup

Updates the value of attribute 'DeliveryMode' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/deliveryMode

PUT /salesCore/customerGroups/{customerGroupKey}/deliveryMode

PUT Set DeliveryTerm CustomerGroup

Updates the value of attribute 'DeliveryTerm' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/deliveryTerm

PUT /salesCore/customerGroups/{customerGroupKey}/deliveryTerm

PUT Set Description CustomerGroup

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/description

PUT /salesCore/customerGroups/{customerGroupKey}/description

PUT Set DimensionValue CustomerGroupDimension

Updates the value of attribute 'DimensionValue' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
lineId	(string) The detail identifier.
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/customerGroups/{customerGroupKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT /salesCore/customerGroups/{customerGroupKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT Set IsActive CustomerGroup

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/isActive

PUT /salesCore/customerGroups/{customerGroupKey}/isActive

PUT Set IsDefault CustomerGroup

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/isDefault

PUT /salesCore/customerGroups/{customerGroupKey}/isDefault

PUT Set PartyTaxSchema CustomerGroup

Updates the value of attribute 'PartyTaxSchema' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/partyTaxSchema

PUT /salesCore/customerGroups/{customerGroupKey}/partyTaxSchema

PUT Set PartyWithholdingTaxSchema CustomerGroup

Updates the value of attribute 'PartyWithholdingTaxSchema' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/partyWithholdingTaxSchema

PUT /salesCore/customerGroups/{customerGroupKey}/partyWithholdingTaxSchema

PUT Set PaymentMethod CustomerGroup

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/paymentMethod

PUT /salesCore/customerGroups/{customerGroupKey}/paymentMethod

PUT Set PaymentTerm CustomerGroup

Updates the value of attribute 'PaymentTerm' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/paymentTerm

PUT /salesCore/customerGroups/{customerGroupKey}/paymentTerm

PUT Set PriceList CustomerGroup

Updates the value of attribute 'PriceList' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/priceList

PUT /salesCore/customerGroups/{customerGroupKey}/priceList

PUT Set SettlementDiscountPercent CustomerGroup

Updates the value of attribute 'SettlementDiscountPercent' in the specified entity record.

The following elements are required:

customerGroupKey	(string) The customer's group 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:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/settlementDiscountPercent

PUT /salesCore/customerGroups/{customerGroupKey}/settlementDiscountPercent

PUT Set Custom Attribute CustomerGroup

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

The following elements are required:

customerGroupKey	(string) The customer's group 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:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/{customAttributeName}

PUT /salesCore/customerGroups/{customerGroupKey}/{customAttributeName}

DELETE Operations

DELETE Customer Group Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

customerGroupKey	(string) The customer's group key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}/entityDimensionDetails/{lineId}

DELETE /salesCore/customerGroups/{customerGroupKey}/entityDimensionDetails/{lineId}

DELETE CustomerGroup 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/customerGroups/{id}

DELETE /salesCore/customerGroups/{id}

DELETE CustomerGroup by key

Deletes the entity record that matches the specified key.

The following elements are required:

customerGroupKey

(string) The customer's group key.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerGroups/{customerGroupKey}

DELETE /salesCore/customerGroups/{customerGroupKey}

Resources

ApiCustomerGroupEntityDimensionDetailsResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

ApiCustomerGroupResource

The following elements are required:

customerGroupKey	(string) The customer's group key.
isDefault	(bool) Is Default Customer Group.

The following elements are optional:

description	(string) The customer's group description.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction.
paymentTerm	(string) Specify the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
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.
entityDimensionDetails	(List of ApiCustomerGroupEntityDimensionDetailsResource) The customer group list of dimensions. See ApiCustomerGroupEntityDimensionDetailsResource.
deliveryMode	(string) The Delivery mode. (ex: mail).

CustomerGroupDimensionResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

CustomerGroupResource

The following elements are required:

customerGroupKey	(string) The customer's group key.
isDefault	(bool) Is Default Customer Group.

The following elements are optional:

description	(string) The customer's group description.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm	(string) Specify the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party. (fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party. (fk) Allowed value: the natural key of a record of type PartyWithholdingTaxSchema. These records are accessibly through the PartyWithholdingTaxSchemas service.
deliveryTerm	(string) 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.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
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.
entityDimensionDetails	(List of CustomerGroupDimensionResource) The customer group list of dimensions. See CustomerGroupDimensionResource.
deliveryMode	(string) The Delivery mode. (ex: mail). (fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.