Purchases | Supplier Group

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

Overview

api/{tenantKey}/{orgKey}/purchasesCore/supplierGroups

URL	api/{tenantKey}/{orgKey}/purchasesCore/supplierGroups
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST SupplierGroups
- POST Supplier Group
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSupplierGroupEntityDimensionDetailsResource
ApiSupplierGroupResource
SupplierGroupDimensionResource
SupplierGroupResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET SupplierGroups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierGroups

GET /purchasesCore/supplierGroups

GET SupplierGroups (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 SupplierGroupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierGroups?page={page}&pageSize={pageSize}

GET /purchasesCore/supplierGroups?page={page}&pageSize={pageSize}

GET SupplierGroup 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 SupplierGroupResource.

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

GET /purchasesCore/supplierGroups/{id}

GET SupplierGroup by key

Returns the entity record that matches the specified key.

The following elements are required:

supplierGroupKey

(string) The key for the supplier group.

Response:

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

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}/purchasesCore/supplierGroups/{supplierGroupKey}

GET /purchasesCore/supplierGroups/{supplierGroupKey}

GET Print SupplierGroup 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}/purchasesCore/supplierGroups/{id}/print?template={template}

GET /purchasesCore/supplierGroups/{id}/print?template={template}

GET Print SupplierGroup by key

Prints the specified entity record.

The following elements are required:

supplierGroupKey

(string) The key for the supplier group.

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}/purchasesCore/supplierGroups/{supplierGroupKey}/print

GET /purchasesCore/supplierGroups/{supplierGroupKey}/print

GET Original Print SupplierGroupOriginal 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}/purchasesCore/supplierGroups/{id}/printOriginal?template={template}

GET /purchasesCore/supplierGroups/{id}/printOriginal?template={template}

GET Original Print SupplierGroup by key

Prints the specified entity record.

The following elements are required:

supplierGroupKey

(string) The key for the supplier group.

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}/purchasesCore/supplierGroups/{supplierGroupKey}/printOriginal

GET /purchasesCore/supplierGroups/{supplierGroupKey}/printOriginal

POST Operations

POST SupplierGroups

Creates a new entity record.

The following elements are required:

supplierGroupResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierGroups

POST /purchasesCore/supplierGroups

POST Supplier Group

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
value	(ApiSupplierGroupEntityDimensionDetailsResource) The ApiSupplierGroupEntityDimensionDetailsResource instance. See ApiSupplierGroupEntityDimensionDetailsResource.

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}/purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails

POST /purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails

PUT Operations

PUT Set DeliveryMode SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/deliveryMode

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/deliveryMode

PUT Set DeliveryTerm SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/deliveryTerm

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/deliveryTerm

PUT Set Description SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/description

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/description

PUT Set DimensionValue SupplierGroupDimension

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT Set IsActive SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/isActive

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/isActive

PUT Set IsDefault SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/isDefault

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/isDefault

PUT Set PartyTaxSchema SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/partyTaxSchema

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/partyTaxSchema

PUT Set PartyWithholdingTaxSchema SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/partyWithholdingTaxSchema

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/partyWithholdingTaxSchema

PUT Set PaymentMethod SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/paymentMethod

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/paymentMethod

PUT Set PaymentTerm SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/paymentTerm

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/paymentTerm

PUT Set SettlementDiscountPercent SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/settlementDiscountPercent

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/settlementDiscountPercent

PUT Set SupplierGroupKey SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/supplierGroupKey

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/supplierGroupKey

PUT Set Custom Attribute SupplierGroup

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

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/{customAttributeName}

PUT /purchasesCore/supplierGroups/{supplierGroupKey}/{customAttributeName}

DELETE Operations

DELETE Supplier Group Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
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}/purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails/{lineId}

DELETE /purchasesCore/supplierGroups/{supplierGroupKey}/entityDimensionDetails/{lineId}

DELETE SupplierGroup 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}/purchasesCore/supplierGroups/{id}

DELETE /purchasesCore/supplierGroups/{id}

DELETE SupplierGroup by key

Deletes the entity record that matches the specified key.

The following elements are required:

supplierGroupKey

(string) The key for the supplier group.

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}/purchasesCore/supplierGroups/{supplierGroupKey}

DELETE /purchasesCore/supplierGroups/{supplierGroupKey}

Resources

ApiSupplierGroupEntityDimensionDetailsResource

The following elements are required:

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

ApiSupplierGroupResource

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
settlementDiscountPercent	(decimal) The Settlement discount percentage.
isDefault	(bool) Indicates if this is the default supplier group for new suppliers.

The following elements are optional:

description	(string) The description for the supplier group.
paymentMethod	(string) The payment method for the supplier group.
paymentTerm	(string) The payment term for the supplier group.
deliveryTerm	(string) The delivery term for the supplier group.
partyTaxSchema	(string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for.
partyWithholdingTaxSchema	(string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for.
entityDimensionDetails	(List of ApiSupplierGroupEntityDimensionDetailsResource) The list of entity dimensions. See ApiSupplierGroupEntityDimensionDetailsResource.
deliveryMode	(string) The delivery mode. (ex: mail).

SupplierGroupDimensionResource

The following elements are required:

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

SupplierGroupResource

The following elements are required:

supplierGroupKey	(string) The key for the supplier group.
settlementDiscountPercent	(decimal) The Settlement discount percentage.
isDefault	(bool) Indicates if this is the default supplier group for new suppliers.

The following elements are optional:

description	(string) The description for the supplier group.
paymentMethod	(string) The payment method for the supplier group. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm	(string) The payment term for the supplier group. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
deliveryTerm	(string) The delivery term for the supplier group. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
partyTaxSchema	(string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. (fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service.
partyWithholdingTaxSchema	(string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. (fk) Allowed value: the natural key of a record of type PartyWithholdingTaxSchema. These records are accessibly through the PartyWithholdingTaxSchemas service.
entityDimensionDetails	(List of SupplierGroupDimensionResource) The list of entity dimensions. See SupplierGroupDimensionResource.
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.