Materials Management | Item Adjustment
The item adjustment is used to manage information about an adjustment to a related warehouse such as the item and the reason why.
Overview
URL | api/{tenantKey}/{orgKey}/materialsManagement/itemAdjustments |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute ItemAdjustment
- PUT Set Custom Attribute ItemAdjustmentLine
- PUT Set IsActive ItemAdjustment
- PUT Set ItemAdjustmentKey ItemAdjustment
- PUT Set TotalValue ItemAdjustment
- PUT Set Remarks ItemAdjustment
- PUT Set Note ItemAdjustment
- PUT Set IsPrinted ItemAdjustment
- PUT Set ExternalId ItemAdjustment
- PUT Set ExternalVersion ItemAdjustment
- PUT Set IsExternallyManaged ItemAdjustment
- PUT Set IsInValue ItemAdjustment
- PUT Set AdjustmentType ItemAdjustment
- PUT Set Description ItemAdjustmentLine
- PUT Set Quantity ItemAdjustmentLine
- PUT Set UnitPrice ItemAdjustmentLine
- PUT Set ConversionFactor ItemAdjustmentLine
- PUT Set Unit ItemAdjustmentLine
- PUT Set Currency ItemAdjustmentLine
- PUT Set InventoryAmount ItemAdjustmentLine
- PUT Set UnitCost ItemAdjustmentLine
- PUT Set BaseUnit ItemAdjustmentLine
- PUT Set MaterialsItem ItemAdjustmentLine
- PUT Set ItemType ItemAdjustmentLine
- PUT Set DimensionSetJson ItemAdjustmentLine
- DELETE:
All Resources
This service uses the following resources:
- ApiItemAdjustmentDocumentLinesResource
- ApiItemAdjustmentResource
- ItemAdjustmentLineResource
- ItemAdjustmentResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
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:
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:
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:
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 adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
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:
GET Print ItemAdjustment by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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 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:
GET Original Print ItemAdjustment by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
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. |
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 ApiItemAdjustmentResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Item Adjustment
Inserts a new 'Item Adjustment Line' in the 'Item Adjustment'.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
companyKey | (string) The company key. |
value | (ApiItemAdjustmentDocumentLinesResource) The ApiItemAdjustmentDocumentLinesResource instance. See ApiItemAdjustmentDocumentLinesResource. |
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:
PUT Set AdjustmentType ItemAdjustment
Updates the value of attribute 'AdjustmentType' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
companyKey | (string) The company key. |
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:
PUT Set BaseUnit ItemAdjustmentLine
Updates the value of attribute 'BaseUnit' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set ConversionFactor ItemAdjustmentLine
Updates the value of attribute 'ConversionFactor' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Currency ItemAdjustmentLine
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Description ItemAdjustmentLine
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set DimensionSetJson ItemAdjustmentLine
Updates the value of attribute 'DimensionSetJson' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set ExternalId ItemAdjustment
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set ExternalVersion ItemAdjustment
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set InventoryAmount ItemAdjustmentLine
Updates the value of attribute 'InventoryAmount' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set IsActive ItemAdjustment
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set IsExternallyManaged ItemAdjustment
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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. |
Resource URL:
PUT Set IsInValue ItemAdjustment
Updates the value of attribute 'IsInValue' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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. |
Resource URL:
PUT Set IsPrinted ItemAdjustment
Updates the value of attribute 'IsPrinted' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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. |
Resource URL:
PUT Set ItemAdjustmentKey ItemAdjustment
Updates the value of attribute 'ItemAdjustmentKey' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set ItemType ItemAdjustmentLine
Updates the value of attribute 'ItemType' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (enum ItemType) The request body should contain the new value for the attribute. See ItemType. |
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 MaterialsItem ItemAdjustmentLine
Updates the value of attribute 'MaterialsItem' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Note ItemAdjustment
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Quantity ItemAdjustmentLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Remarks ItemAdjustment
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set TotalValue ItemAdjustment
Updates the value of attribute 'TotalValue' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Unit ItemAdjustmentLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set UnitCost ItemAdjustmentLine
Updates the value of attribute 'UnitCost' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set UnitPrice ItemAdjustmentLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
PUT Set Custom Attribute ItemAdjustment
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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 Set Custom Attribute ItemAdjustmentLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
DELETE Item Adjustment Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
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:
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 adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
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:
Resources
ApiItemAdjustmentDocumentLinesResource
The following elements are required:
description | (string) The description of the item. |
quantity | (decimal) The quantity to be adjusted. |
unitPrice | (MoneyResource) The price per unit of the item.
See MoneyResource . |
conversionFactor | (decimal) The conversion factor between the unit and the item base unit. |
unit | (string) The unit to be used in the adjustment. |
currency | (string) The money's unit used by the document. |
unitCost | (MoneyResource) The unit cost of the item.
See MoneyResource . |
materialsItem | (string) The materials item that will be adjusted. |
itemType | (enum ItemType) The item type for accounting purposes.
See ItemType. |
The following elements are optional:
inventoryAmount | (decimal) The amount that will affect inventory. |
baseUnit | (string) The base unit of the item. |
dimensionSetJson | (string) Dimension Set Json. |
ApiItemAdjustmentResource
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
documentDate | (DateTime) The date when the document is issued. |
totalValue | (MoneyResource) The total amount for the document. Internally calculated.
See MoneyResource . |
postingDate | (DateTime) The date where the document is posted. |
isExternallyManaged | (bool) The flag indicates if the item is externally managed. |
warehouse | (string) The invoice's line item warehouse. The default is defined on the materials item. |
company | (string) The company where the adjustment is posted. The company code is the central organizational unit within the system. |
adjustmentReason | (string) The reason for the adjustment. |
isInValue | (bool) The flag indicates if the adjustment is only in value (stock level will not be affected). Defaulted from the adjustment reason. |
The following elements are optional:
documentLines | (List of ApiItemAdjustmentDocumentLinesResource) The document lines.
See ApiItemAdjustmentDocumentLinesResource. |
remarks | (string) The adjusment remarks. |
note | (string) The document's note. |
isPrinted | (bool) The flag indicates if the invoice has been printed. Internally determined. |
externalId | (string) The external identifier. |
externalVersion | (string) The external version. |
adjustmentType | (enum AdjustmentType) The type of adjustment: incoming or outgoing stock. Defaulted from the adjustment reason.
See AdjustmentType. |
ItemAdjustmentLineResource
The following elements are required:
description | (string) The description of the item. |
quantity | (decimal) The quantity to be adjusted. |
unitPrice | (MoneyResource) The price per unit of the item.
See MoneyResource . |
value | (MoneyResource) The quantity multiplied by the unit price.
See MoneyResource . |
conversionFactor | (decimal) The conversion factor between the unit and the item base unit. |
unit | (string) The unit to be used in the adjustment. |
currency | (string) The money's unit used by the document. |
unitCost | (MoneyResource) The unit cost of the item.
See MoneyResource . |
materialsItem | (string) The materials item that will be adjusted. |
itemType | (enum ItemType) The item type for accounting purposes.
See ItemType. |
gLAccount | (string) The GL account that will offset the stock account. Infered from the adjusment reason based on the item type and chart of accounts. |
chartOfAccount | (string) The chart of accounts. Infered from the financial company setup. |
The following elements are optional:
inventoryAmount | (decimal) The amount that will affect inventory. |
baseUnit | (string) The base unit of the item. |
dimensionSet | (string) The dimension set. Based on the materials item dimensions. |
dimensionSetJson | (string) Dimension Set Json. |
ItemAdjustmentResource
The following elements are required:
itemAdjustmentKey | (string) The adjustment unique key. Is defined using the Warehouse key + sequential numbering. |
documentDate | (DateTime) The date when the document is issued. |
totalValue | (MoneyResource) The total amount for the document. Internally calculated.
See MoneyResource . |
postingDate | (DateTime) The date where the document is posted. |
isExternallyManaged | (bool) The flag indicates if the item is externally managed. |
warehouse | (string) The invoice's line item warehouse. The default is defined on the materials item.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
company | (string) The company where the adjustment is posted. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
currency | (string) The money's unit used by the document.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
adjustmentReason | (string) The reason for the adjustment.
(fk) Allowed value: the natural key of a record of type AdjustmentReason. These records are accessibly through the AdjustmentReasons service. |
isInValue | (bool) The flag indicates if the adjustment is only in value (stock level will not be affected). Defaulted from the adjustment reason. |
journalNumber | (int) The journal number assigned in accounting. |
The following elements are optional:
documentLines | (List of ItemAdjustmentLineResource) The document lines.
See ItemAdjustmentLineResource. |
remarks | (string) The adjusment remarks. |
note | (string) The document's note. |
isPrinted | (bool) The flag indicates if the invoice has been printed. Internally determined. |
externalId | (string) The external identifier. |
externalVersion | (string) The external version. |
adjustmentType | (enum AdjustmentType) The type of adjustment: incoming or outgoing stock. Defaulted from the adjustment reason.
See AdjustmentType. |
journalType | (string) The journal type to be used when posting in accounting. Infered from the materials configuration.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service. |
ledger | (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service. |
accountingDocument | (string) The accounting document assigned in accounting. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |