Purchases | Supplier Set

The Supplier Set represents a company container where supplier are grouped. A supplier can belong to a company or to several.

Overview

api/{tenantKey}/{orgKey}/purchasesCore/supplierSets

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

All Operations

This service includes the following operations:

GET:
POST:
- POST SupplierSets
- POST Supplier Set
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSupplierSetResource
ApiSupplierSetSupplierSetCompaniesResource
SupplierSetCompanyResource
SupplierSetResource

GET Operations

GET SupplierSets

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierSets

GET /purchasesCore/supplierSets

GET SupplierSets (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 SupplierSetResource.

Response status codes:

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

Resource URL:

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

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

GET SupplierSet 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 SupplierSetResource.

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

GET /purchasesCore/supplierSets/{id}

GET SupplierSet by key

Returns the entity record that matches the specified key.

The following elements are required:

supplierSetKey

(string) The key for suplier set.

Response:

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

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/supplierSets/{supplierSetKey}

GET /purchasesCore/supplierSets/{supplierSetKey}

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

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

GET Print SupplierSet by key

Prints the specified entity record.

The following elements are required:

supplierSetKey

(string) The key for suplier set.

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/supplierSets/{supplierSetKey}/print

GET /purchasesCore/supplierSets/{supplierSetKey}/print

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

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

GET Original Print SupplierSet by key

Prints the specified entity record.

The following elements are required:

supplierSetKey

(string) The key for suplier set.

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/supplierSets/{supplierSetKey}/printOriginal

GET /purchasesCore/supplierSets/{supplierSetKey}/printOriginal

POST Operations

POST SupplierSets

Creates a new entity record.

The following elements are required:

supplierSetResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierSets

POST /purchasesCore/supplierSets

POST Supplier Set

Inserts a new 'Supplier Set Company' in the 'Supplier Set'.

The following elements are required:

supplierSetKey	(string) The key for suplier set.
value	(ApiSupplierSetSupplierSetCompaniesResource) The ApiSupplierSetSupplierSetCompaniesResource instance. See ApiSupplierSetSupplierSetCompaniesResource.

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/supplierSets/{supplierSetKey}/supplierSetCompanies

POST /purchasesCore/supplierSets/{supplierSetKey}/supplierSetCompanies

PUT Operations

PUT Set Company SupplierSetCompany

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

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/supplierSetCompanies/{lineId}/company

PUT /purchasesCore/supplierSets/{supplierSetKey}/supplierSetCompanies/{lineId}/company

PUT Set Description SupplierSet

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

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/description

PUT /purchasesCore/supplierSets/{supplierSetKey}/description

PUT Set IsActive SupplierSet

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

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/isActive

PUT /purchasesCore/supplierSets/{supplierSetKey}/isActive

PUT Set IsDefault SupplierSet

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

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/isDefault

PUT /purchasesCore/supplierSets/{supplierSetKey}/isDefault

PUT Set SupplierSetKey SupplierSet

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

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/supplierSetKey

PUT /purchasesCore/supplierSets/{supplierSetKey}/supplierSetKey

DELETE Operations

DELETE Supplier Set Company by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

supplierSetKey	(string) The key for suplier set.
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/supplierSets/{supplierSetKey}/supplierSetCompanies/{lineId}

DELETE /purchasesCore/supplierSets/{supplierSetKey}/supplierSetCompanies/{lineId}

DELETE SupplierSet 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/supplierSets/{id}

DELETE /purchasesCore/supplierSets/{id}

DELETE SupplierSet by key

Deletes the entity record that matches the specified key.

The following elements are required:

supplierSetKey

(string) The key for suplier set.

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/supplierSets/{supplierSetKey}

DELETE /purchasesCore/supplierSets/{supplierSetKey}

Resources

ApiSupplierSetResource

The following elements are required:

supplierSetKey	(string) The key for suplier set.
isDefault	(bool) Indicates if this is the default supplier set for new suppliers.

The following elements are optional:

description	(string) The description of suplier set.
supplierSetCompanies	(List of ApiSupplierSetSupplierSetCompaniesResource) The list of companies of suplier set. See ApiSupplierSetSupplierSetCompaniesResource.

ApiSupplierSetSupplierSetCompaniesResource

The following elements are required:

company

(string) The company.

SupplierSetCompanyResource

The following elements are required:

company

(string) The company.

SupplierSetResource

The following elements are required:

supplierSetKey	(string) The key for suplier set.
isDefault	(bool) Indicates if this is the default supplier set for new suppliers.

The following elements are optional:

description	(string) The description of suplier set.
supplierSetCompanies	(List of SupplierSetCompanyResource) The list of companies of suplier set. See SupplierSetCompanyResource.