Materials Management | Adjustment Reason

Service to manage entities of type 'AdjustmentReason'.

Overview

api/{tenantKey}/{orgKey}/materialsManagement/adjustmentReasons

URL	api/{tenantKey}/{orgKey}/materialsManagement/adjustmentReasons
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST AdjustmentReasons
PUT:
DELETE:
- DELETE AdjustmentReason by identifier
- DELETE AdjustmentReason by key

All Resources

This service uses the following resources:

AdjustmentReasonResource
ApiAdjustmentReasonResource

All Enumerations

This service uses the following enumerations:

AdjustmentType

GET Operations

GET AdjustmentReasons

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/materialsManagement/adjustmentReasons

GET /materialsManagement/adjustmentReasons

GET AdjustmentReasons (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 AdjustmentReasonResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/materialsManagement/adjustmentReasons?page={page}&pageSize={pageSize}

GET /materialsManagement/adjustmentReasons?page={page}&pageSize={pageSize}

GET AdjustmentReason 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 AdjustmentReasonResource.

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

GET /materialsManagement/adjustmentReasons/{id}

GET AdjustmentReason by key

Returns the entity record that matches the specified key.

The following elements are required:

adjustmentReasonKey

(string) The key for the Adjustment Reason.

Response:

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

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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}

GET /materialsManagement/adjustmentReasons/{adjustmentReasonKey}

GET Print AdjustmentReason 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}/materialsManagement/adjustmentReasons/{id}/print?template={template}

GET /materialsManagement/adjustmentReasons/{id}/print?template={template}

GET Print AdjustmentReason by key

Prints the specified entity record.

The following elements are required:

adjustmentReasonKey

(string) The key for the Adjustment Reason.

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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/print

GET /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/print

GET Original Print AdjustmentReasonOriginal 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}/materialsManagement/adjustmentReasons/{id}/printOriginal?template={template}

GET /materialsManagement/adjustmentReasons/{id}/printOriginal?template={template}

GET Original Print AdjustmentReason by key

Prints the specified entity record.

The following elements are required:

adjustmentReasonKey

(string) The key for the Adjustment Reason.

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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/printOriginal

GET /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/printOriginal

POST Operations

POST AdjustmentReasons

Creates a new entity record.

The following elements are required:

adjustmentReasonResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/materialsManagement/adjustmentReasons

POST /materialsManagement/adjustmentReasons

PUT Operations

PUT Set AdjustmentReasonKey AdjustmentReason

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

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonKey

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonKey

PUT Set AdjustmentType AdjustmentReason

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

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
value	(enum AdjustmentType) The request body should contain the new value for the attribute. See AdjustmentType.

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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentType

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentType

PUT Set Description AdjustmentReason

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

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/description

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/description

PUT Set IsActive AdjustmentReason

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

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/isActive

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/isActive

PUT Set IsInValue AdjustmentReason

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

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}/isInValue

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/isInValue

DELETE Operations

DELETE AdjustmentReason 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}/materialsManagement/adjustmentReasons/{id}

DELETE /materialsManagement/adjustmentReasons/{id}

DELETE AdjustmentReason by key

Deletes the entity record that matches the specified key.

The following elements are required:

adjustmentReasonKey

(string) The key for the Adjustment Reason.

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}/materialsManagement/adjustmentReasons/{adjustmentReasonKey}

DELETE /materialsManagement/adjustmentReasons/{adjustmentReasonKey}

Resources

AdjustmentReasonResource

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
isInValue	(bool) Indicates whether the Adjustment Reason is in value.
adjustmentType	(enum AdjustmentType) The adjustment's type for the Adjustment Reason. See AdjustmentType.

The following elements are optional:

description

(string) The description for the Adjustment Reason.

ApiAdjustmentReasonResource

The following elements are required:

adjustmentReasonKey	(string) The key for the Adjustment Reason.
isInValue	(bool) Indicates whether the Adjustment Reason is in value.
adjustmentType	(enum AdjustmentType) The adjustment's type for the Adjustment Reason. See AdjustmentType.

The following elements are optional:

description

(string) The description for the Adjustment Reason.

Enumerations

AdjustmentType

1	Entry
2	Issue