ROSE Developers - Web API Reference

Materials Management | Adjustment Reason

The adjustment reason represents reason for the adjustments.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

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:

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:

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:

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 adjustment reason key.

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:

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:

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 adjustment reason key.

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 /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:

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 adjustment reason key.

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

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

Response status codes:

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

Resource URL:

POST /materialsManagement/adjustmentReasons

POST Adjustment Reason

Inserts a new 'Adjustment Reason Account' in the 'Adjustment Reason'.

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
value (ApiAdjustmentReasonAdjustmentReasonAccountsResource) The ApiAdjustmentReasonAdjustmentReasonAccountsResource instance.
See ApiAdjustmentReasonAdjustmentReasonAccountsResource.

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:

POST /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonAccounts

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 adjustment reason key.
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 /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonKey

PUT Set Description AdjustmentReason

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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 /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/description

PUT Set GLAccount AdjustmentReasonAccount

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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:

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonAccounts/{lineId}/gLAccount

PUT Set IsActive AdjustmentReason

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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 /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 adjustment reason key.
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 /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/isInValue

PUT Set ItemAccountType AdjustmentReasonAccount

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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:

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonAccounts/{lineId}/itemAccountType

PUT Set Custom Attribute AdjustmentReason

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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:

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/{customAttributeName}

PUT Set Custom Attribute AdjustmentReasonAccount

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

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
lineId (string) The detail identifier.
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:

PUT /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonAccounts/{lineId}/{customAttributeName}

DELETE Operations

DELETE Adjustment Reason Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
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:

DELETE /materialsManagement/adjustmentReasons/{adjustmentReasonKey}/adjustmentReasonAccounts/{lineId}

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:

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 adjustment reason key.

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:

DELETE /materialsManagement/adjustmentReasons/{adjustmentReasonKey}

Resources


AdjustmentReasonAccountResource

The following elements are required:

gLAccount (string) The account of the chart of accounts that will offset the stock accounts for the item account type.
chartOfAccount (string) The chart of accounts.

The following elements are optional:

itemAccountType (string) The item account type.


AdjustmentReasonResource

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
isInValue (bool) The flag indicates if the adjustment is only in value (stock level will not be affected). Defaulted from the adjustment reason.
adjustmentType (enum AdjustmentType) The type of adjustment: incoming or outgoing stock.
See AdjustmentType.

The following elements are optional:

description (string) The description of the adjustment reason.
adjustmentReasonAccounts (List of AdjustmentReasonAccountResource) The list of accounts to be used to offset the stock accounts.
See AdjustmentReasonAccountResource.


ApiAdjustmentReasonAdjustmentReasonAccountsResource

The following elements are required:

gLAccount (string) The account of the chart of accounts that will offset the stock accounts for the item account type.
chartOfAccount (string) The chart of accounts.

The following elements are optional:

itemAccountType (string) The item account type.


ApiAdjustmentReasonResource

The following elements are required:

adjustmentReasonKey (string) The adjustment reason key.
isInValue (bool) The flag indicates if the adjustment is only in value (stock level will not be affected). Defaulted from the adjustment reason.
adjustmentType (enum AdjustmentType) The type of adjustment: incoming or outgoing stock.
See AdjustmentType.

The following elements are optional:

description (string) The description of the adjustment reason.
adjustmentReasonAccounts (List of ApiAdjustmentReasonAdjustmentReasonAccountsResource) The list of accounts to be used to offset the stock accounts.
See ApiAdjustmentReasonAdjustmentReasonAccountsResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AdjustmentType

1 Entry
2 Issue