Parts and Inventory | Part Adjustment

Service to manage entities of type 'PartAdjustment'.

Overview

URL	api/{tenantKey}/{orgKey}/inventoryManagement/partAdjustments
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET PartAdjustments (odata)
  • GET PartAdjustment by identifier
  • GET PartAdjustment by key
• POST:
  • POST PartAdjustments
  • POST Part Adjustment Line
• PUT:
  • PUT Set Custom Attribute PartAdjustment
  • PUT Set Custom Attribute PartAdjustmentLine
  • PUT Set IsActive PartAdjustment
  • PUT Set PartAdjustmentKey PartAdjustment
  • PUT Set TotalValue PartAdjustment
  • PUT Set PostingDate PartAdjustment
  • PUT Set Remarks PartAdjustment
  • PUT Set Note PartAdjustment
  • PUT Set IsPrinted PartAdjustment
  • PUT Set ExternalId PartAdjustment
  • PUT Set ExternalVersion PartAdjustment
  • PUT Set IsExternallyManaged PartAdjustment
  • PUT Set IsInValue PartAdjustment
  • PUT Set AdjustmentType PartAdjustment
  • PUT Set Description PartAdjustmentLine
  • PUT Set Quantity PartAdjustmentLine
  • PUT Set UnitPrice PartAdjustmentLine
  • PUT Set ConversionFactor PartAdjustmentLine
  • PUT Set Unit PartAdjustmentLine
  • PUT Set Currency PartAdjustmentLine
  • PUT Set InventoryAmount PartAdjustmentLine
  • PUT Set UnitCost PartAdjustmentLine
  • PUT Set BaseUnit PartAdjustmentLine
  • PUT Set PartType PartAdjustmentLine
  • PUT Set InventoryPart PartAdjustmentLine
• DELETE:
  • DELETE Part Adjustment Line by identifier
  • DELETE PartAdjustment by identifier
  • DELETE PartAdjustment by key

All Resources

This service uses the following resources:

• ApiPartAdjustmentDocumentLinesResource
• ApiPartAdjustmentResource
• MoneyResource
• PartAdjustmentResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AdjustmentType
• PartType

GET Operations

GET PartAdjustments (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

GET PartAdjustment 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 PartAdjustmentResource.

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 PartAdjustment by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
partAdjustmentKey	(string) The adjustment unique key.

Response:

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

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 Operations

POST PartAdjustments

Creates a new entity record.

The following elements are required:

partAdjustmentResource

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

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

Response status codes:

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

Resource URL:

POST Part Adjustment Line

Inserts a new 'Part Adjustment Line' in the 'Part Adjustment'.

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
companyKey	(string) The company key.
value	(ApiPartAdjustmentDocumentLinesResource) The ApiPartAdjustmentDocumentLinesResource instance. See ApiPartAdjustmentDocumentLinesResource.

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 Operations

PUT Set AdjustmentType PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 InventoryPart PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 IsActive PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 Note PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentKey PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartType PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum PartType) The request body should contain the new value for the attribute. See PartType.

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 PostingDate PartAdjustment

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

The following elements are required:

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

PUT Set Quantity PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustmentLine

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

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment

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

The following elements are required:

companyKey	(string) The company key.
partAdjustmentKey	(string) The adjustment unique 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 Set Custom Attribute PartAdjustmentLine

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

The following elements are required:

companyKey	(string) The company key.
partAdjustmentKey	(string) The adjustment unique 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:

DELETE Operations

DELETE Part Adjustment Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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 PartAdjustment 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 PartAdjustment by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
partAdjustmentKey	(string) The adjustment unique 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:

Resources

ApiPartAdjustmentDocumentLinesResource

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 .
partType	(enum PartType) The item type for accounting purposes. See PartType.
inventoryPart	(string) Inventory Part.

The following elements are optional:

inventoryAmount	(decimal) The amount that will affect inventory.
baseUnit	(string) The base unit of the item.

ApiPartAdjustmentResource

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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) 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) Set 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 ApiPartAdjustmentDocumentLinesResource) Document Lines. See ApiPartAdjustmentDocumentLinesResource.
remarks	(string) The adjusment remarks.
note	(string) The document's note.
isPrinted	(bool) 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.

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.

PartAdjustmentResource

The following elements are required:

partAdjustmentKey	(string) The adjustment unique key.
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) 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) Set 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 PartAdjustmentLineResource) Document Lines. See PartAdjustmentLineResource.
remarks	(string) The adjusment remarks.
note	(string) The document's note.
isPrinted	(bool) 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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AdjustmentType

1	Entry
2	Issue

PartType

1	Part
2	Service