Materials Management | Materials Setup
The Materials Setup is used to manage default values for each company, such as the default order type.
Overview
| URL | api/{tenantKey}/{orgKey}/materialsCore/materialsSetups |
| Methods Supported | GET, PUT |
All Operations
This service includes the following operations:
- GET:
- PUT:
All Resources
This service uses the following resources:
GET MaterialsSetups
Returns the list of all the entity records available.
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 MaterialsSetups (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 MaterialsSetupResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
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 MaterialsSetup by key
Returns the entity record that matches the specified key.
The following elements are required:
| company | (string) The company for the Materials Setup. |
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 Print MaterialsSetup 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:
GET Print MaterialsSetup by key
Prints the specified entity record.
The following elements are required:
| company | (string) The company for the Materials Setup. |
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:
GET Original Print MaterialsSetupOriginal 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:
GET Original Print MaterialsSetup by key
Prints the specified entity record.
The following elements are required:
| company | (string) The company for the Materials Setup. |
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:
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 Materials Setup. |
| 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 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 Materials Setup. |
| 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 Set JournalType MaterialsSetup
Updates the value of attribute 'JournalType' in the specified entity record.
The following elements are required:
| company | (string) The company for the Materials Setup. |
| 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 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 Materials Setup. |
| 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:
Resources
MaterialsSetupResource
The following elements are required:
| company | (string) The company for the Materials Setup.
(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. |
The following elements are optional:
| journalType | (string) The journal type to be used in the item adjustment postings for account posting.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service. |
| lastInventoryCloseDate | (DateTime) The date of the last inventory close. |