Jasmin Developers - Web API Reference

Materials Management | Stock Settings

Service to manage entities of type 'Stock Settings'.

Overview


URL api/{tenantKey}/{orgKey}/materialsCore/materialsSetups
Methods Supported GET, PUT

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET MaterialsSetups (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 MaterialsSetupResource.

Response status codes:

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

Resource URL:

GET /materialsCore/materialsSetups/odata

GET MaterialsSetup 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 MaterialsSetupResource.

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

GET MaterialsSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company (string) The company for the Stock Setttings.

Response:

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

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 /materialsCore/materialsSetups/{company}

PUT Operations

PUT Set Company MaterialsSetup

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

The following elements are required:

company (string) The company for the Stock Setttings.
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 /materialsCore/materialsSetups/{company}/company

PUT Set DefaultWarehouse MaterialsSetup

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

The following elements are required:

company (string) The company for the Stock Setttings.
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 /materialsCore/materialsSetups/{company}/defaultWarehouse

PUT Set InventoryManagementForNewItems MaterialsSetup

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

The following elements are required:

company (string) The company for the Stock Setttings.
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:

PUT /materialsCore/materialsSetups/{company}/inventoryManagementForNewItems

PUT Set IsActive MaterialsSetup

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

The following elements are required:

company (string) The company for the Stock Setttings.
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 /materialsCore/materialsSetups/{company}/isActive

PUT Set NegativeStock MaterialsSetup

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

The following elements are required:

company (string) The company for the Stock Setttings.
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:

PUT /materialsCore/materialsSetups/{company}/negativeStock

Resources


MaterialsSetupResource

The following elements are required:

company (string) The company for the Stock Setttings.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
negativeStock (bool) Indicates whether the warehouse can accept negative stock values.
inventoryManagementForNewItems (bool) Indicates whether it's suggested inventory management for new Items.

The following elements are optional:

lastInventoryCloseDate (DateTime) Last Inventory Close Date.
defaultWarehouse (string) The default warehouse for the Materials Setup.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.