Materials Management | Item Adjustment
Service to manage entities of type 'ItemAdjustment'.
Overview
| URL | api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
- ApiItemAdjustmentDocumentLinesResource
- ApiItemAdjustmentResource
- ItemAdjustmentLineResource
- ItemAdjustmentResource
All Enumerations
This service uses the following enumerations:
GET ItemAdjustments
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See ItemAdjustmentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments
GET /materialsManagement/itemAdjustments
GET ItemAdjustments (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 ItemAdjustmentResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments?page={page}&pageSize={pageSize}
GET /materialsManagement/itemAdjustments?page={page}&pageSize={pageSize}
GET ItemAdjustment 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 ItemAdjustmentResource. |
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/itemAdjustments/{id}
GET /materialsManagement/itemAdjustments/{id}
GET ItemAdjustment by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
Response:
| When successful, the response body contains the entity record. See ItemAdjustmentResource. |
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/itemAdjustments/{companyKey}/{itemAdjustmentKey}
GET /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}
GET Print ItemAdjustment 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/itemAdjustments/{id}/print?template={template}
GET /materialsManagement/itemAdjustments/{id}/print?template={template}
GET Print ItemAdjustment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
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/itemAdjustments/{companyKey}/{itemAdjustmentKey}/print
GET /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/print
GET Original Print ItemAdjustmentOriginal 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/itemAdjustments/{id}/printOriginal?template={template}
GET /materialsManagement/itemAdjustments/{id}/printOriginal?template={template}
GET Original Print ItemAdjustment by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
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/itemAdjustments/{companyKey}/{itemAdjustmentKey}/printOriginal
GET /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/printOriginal
POST ItemAdjustments
Creates a new entity record.
The following elements are required:
| itemAdjustmentResource | (ApiItemAdjustmentResource) The request body should contain the entity record that should be created. See ApiItemAdjustmentResource. |
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 ApiItemAdjustmentResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments
POST /materialsManagement/itemAdjustments
POST Item Adjustment
Inserts a new 'Item Adjustment Line' in the 'Item Adjustment'.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company key. |
| value | (ApiItemAdjustmentDocumentLinesResource) The ApiItemAdjustmentDocumentLinesResource instance. See ApiItemAdjustmentDocumentLinesResource. |
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}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines
POST /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines
PUT Set IsActive ItemAdjustment
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/isActive
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/isActive
PUT Set MaterialsItem ItemAdjustmentLine
Updates the value of attribute 'MaterialsItem' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/materialsItem
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/materialsItem
PUT Set Note ItemAdjustment
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/note
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/note
PUT Set PostingDate ItemAdjustment
Updates the value of attribute 'PostingDate' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company key. |
| value | (DateTime) 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/itemAdjustments/{companyKey}/{itemAdjustmentKey}/postingDate
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/postingDate
PUT Set Quantity ItemAdjustmentLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (decimal) 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/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/quantity
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/quantity
PUT Set Remarks ItemAdjustment
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/remarks
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/remarks
PUT Set Unit ItemAdjustmentLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/unit
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/unit
PUT Set UnitPrice ItemAdjustmentLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (decimal) 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/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/unitPrice
PUT /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}/unitPrice
DELETE Item Adjustment Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| companyKey | (string) The company 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:
api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}
DELETE /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}/documentLines/{lineId}
DELETE ItemAdjustment 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/itemAdjustments/{id}
DELETE /materialsManagement/itemAdjustments/{id}
DELETE ItemAdjustment by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
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/itemAdjustments/{companyKey}/{itemAdjustmentKey}
DELETE /materialsManagement/itemAdjustments/{companyKey}/{itemAdjustmentKey}
Resources
ApiItemAdjustmentDocumentLinesResource
The following elements are required:
| quantity | (decimal) The quantity for the Item Adjustment Line. |
| unitPrice | (decimal) The unit price for the Item Adjustment Line. |
| unit | (string) The unit for the Item Adjustment Line. |
| materialsItem | (string) The materials item for the Item Adjustment Line. |
ApiItemAdjustmentResource
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| documentDate | (DateTime) The document date for the Item Adjustment. |
| postingDate | (DateTime) The posting date for the Item Adjustment. |
| warehouse | (string) The warehouse for the Item Adjustment. |
| company | (string) The company for the Item Adjustment. |
| adjustmentReason | (string) The adjustment reason for the Item Adjustment. |
The following elements are optional:
| documentLines | (List of ApiItemAdjustmentDocumentLinesResource) The document lines for the Item Adjustment.
See ApiItemAdjustmentDocumentLinesResource. |
| remarks | (string) The remarks for the Item Adjustment. |
| note | (string) The note for the Item Adjustment. |
ItemAdjustmentLineResource
The following elements are required:
| description | (string) The description for the Item Adjustment Line. |
| quantity | (decimal) The quantity for the Item Adjustment Line. |
| unitPrice | (decimal) The unit price for the Item Adjustment Line. |
| value | (decimal) The value for the Item Adjustment Line. |
| conversionFactor | (decimal) The conversion factor for the Item Adjustment Line. |
| unit | (string) The unit for the Item Adjustment Line. |
| currency | (string) The currency for the Item Adjustment Line. |
| unitCost | (decimal) The unit cost for the Item Adjustment Line. |
| materialsItem | (string) The materials item for the Item Adjustment Line. |
| itemType | (enum ItemType) The item's type for the Item Adjustment Line.
See ItemType. |
The following elements are optional:
| inventoryAmount | (decimal) The inventory amount for the Item Adjustment Line. |
| baseUnit | (string) The base unit for the Item Adjustment Line. |
ItemAdjustmentResource
The following elements are required:
| itemAdjustmentKey | (string) The key for the Item Adjustment. |
| documentDate | (DateTime) The document date for the Item Adjustment. |
| totalValue | (decimal) The total value for the Item Adjustment. |
| postingDate | (DateTime) The posting date for the Item Adjustment. |
| isExternallyManaged | (bool) Indicates whether the Item Adjustment is externally managed. |
| warehouse | (string) The warehouse for the Item Adjustment.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
| company | (string) The company for the Item Adjustment.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| currency | (string) The currency for the Item Adjustment.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| adjustmentReason | (string) The adjustment reason for the Item Adjustment.
(fk) Allowed value: the natural key of a record of type AdjustmentReason. These records are accessibly through the AdjustmentReasons service. |
| isInValue | (bool) Indicates whether the Item Adjustment is in value. |
The following elements are optional:
| documentLines | (List of ItemAdjustmentLineResource) The document lines for the Item Adjustment.
See ItemAdjustmentLineResource. |
| remarks | (string) The remarks for the Item Adjustment. |
| note | (string) The note for the Item Adjustment. |
| isPrinted | (bool) Indicates if the Item Adjustment has been printed. Internally determined. |
| externalId | (string) The external identification for the Item Adjustment. |
| externalVersion | (string) The external version for the Item Adjustment. |
| adjustmentType | (enum AdjustmentType) The adjustment's type for the Item Adjustment.
See AdjustmentType. |