Service Directory > v32.1 > Inventory > Submit_Inventory_Adjustment_for_Returns
 

Operation: Submit_Inventory_Adjustment_for_Returns

This service operation will adjust inventory quantity within an inventory location for inventory return orders and submit it to the Adjust Inventory business process.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Submit_Inventory_Adjustment_for_Returns_Request

Element containing Inventory Adjustment for Returns data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Adjustment_for_Returns_Data  Inventory_Adjustment_for_Returns_Data  [1..1]  Inventory Adjustment for Returns Data 
Validation Description
Duplicate adjustment rows found for the same return line. Please remove the duplicate(s).   
 
top
 

Response Element: Submit_Inventory_Adjustment_for_Returns_Response

Element containing Inventory Adjustment for Returns response data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Inventory_Adjustment_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to Inventory Adjustment Event   
top
 

Financials_Business_Process_Parameters

part of: Submit_Inventory_Adjustment_for_Returns_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Inventory_Adjustment_for_Returns_Data

part of: Submit_Inventory_Adjustment_for_Returns_Request
Element containing Inventory Adjustment for Returns data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Site_Reference  LocationObject  [1..1]  Reference to an existing Inventory Site. Assigns the Site for the transaction and derives the Company.   
Inventory_Return_Reference  Inventory_ReturnObject  [1..1]  Reference to an existing Inventory Return Order. The status of the return order must be Approved and the return order must be for a Transfer Stock Request whose Transfer To Site matches the adjusting Inventory Site. 
Validation Description
The number of return lines submitted for an adjustment must equal the number of open lines on the order. Either too many lines have been provided or not enough.   
 
Adjustment_for_Returns_Detail_Data  Inventory_Adjustment_for_Returns_Detail_Data  [1..*]  Encapsulating element containing Inventory Adjustment detail data. 
Validation Description
The total adjustment quantity across multiple return lines for Item [item] can’t be adjusted. The total ([qty to adjust] [base uom]) is greater than the quantity available to reserve ([adjustable qty] [base uom]). Unreserve [difference] [base uom] to allow this adjustment.   
Serial number isn't allowed for non-serial controlled item.   
 
Validation Description
Duplicate adjustment rows found for the same return line. Please remove the duplicate(s).   
top
 

LocationObject

part of: Inventory_Adjustment_for_Returns_Detail_Data, Inventory_Adjustment_for_Returns_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Inventory_ReturnObject

part of: Inventory_Adjustment_for_Returns_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Inventory_ReturnObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_ReturnObjectID

part of: Inventory_ReturnObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Return_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Inventory_Adjustment_for_Returns_Detail_Data

part of: Inventory_Adjustment_for_Returns_Data
Element containing Inventory Adjustment for Returns Detail Data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Return_Line_Reference  Inventory_Return_LineObject  [1..1]  References the return order line for which quantity is being adjusted. 
Validation Description
Return Order Line [line] does not have a status of Open.   
The referenced return order line [line] does not belong to the inventory return order.   
 
Stocking_Location_Reference  LocationObject  [1..1]  References the stocking location where quantity is being adjusted. 
Validation Description
Location [loc] is currently on hold.   
The Stocking Location must belong to the Inventory Site specified in the header.   
The Quantity to Adjust (decrease) is greater than the quantity available to be adjusted. Please correct the Quantity to Adjust so the resulting quantity on hand is greater than or equal to the quantity which is currently picked/allocated in the location.   
Invalid storage location referenced for [purchase item] [uom] [lot] in location [location]. Either a put away has not yet occurred or the entered data is invalid.   
The total Quantity to Adjust across multiple return adjustment lines from Location [location] for Item [item], Unit of Measure [uom] [lot] exceeds the quantity available in the location.   
 
Inventory_Item_Reference  Purchase_ItemObject  [0..1]  References the inventory item for which quantity is being adjusted for a return. Providing the inventory item is optional. If provided it must match the item on the return line. If not provided the item on the return line will be auto-filled. 
Validation Description
The provided inventory item [item] does not match the item on the return order line.   
 
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  References the Stocking Unit of Measure for the Adjustment for Returns. Providing the unit of measure is optional. If provided it must match the unit of measure on the return line. If not provided the unit of measure on the return line will be auto-filled. 
Validation Description
The provided unit of measure [uom] does not match the unit of measure on the return order line.   
 
Item_Lot_Reference  Item_LotObject  [0..1]  References the lot ID for the item which is being adjusted for a return. Providing the lot is optional. If provided it must match the lot on the return line. If not provided the lot on the return line will be auto-filled. 
Validation Description
The provided item lot does not match the lot on the return order line.   
A lot id can't be assigned to an item which is not lot-controlled.   
 
Quantity  decimal (26, 6)   [0..1]  References the Quantity to Adjust for the return line. Providing the quantity is optional. If provided it must be the negated quantity on the return line. If not provided the Quantity to Adjust will be auto-derived. 
Validation Description
The provided quantity [quantity] does not match the quantity on the inventory return line.   
 
Serial_Control_Reference  Item_SerialObject  [0..*]  References the Item Serials for the Inventory Item 
Validation Description
Serial Numbers do not belong to the item   
This set of serial number(s) ([itemserials]) is not located at [location] [lot] for [item]. Please check the serial number(s) on [item].   
Serial number(s) [number] currently exists on another picking list.   
One or more Serial Numbers do do not belong to the return order.   
The count of serial numbers entered does not match the quantity.   
 
Memo  string  [0..1]  Memo for the Inventory Adjustment detail line.   
Validation Description
The total adjustment quantity across multiple return lines for Item [item] can’t be adjusted. The total ([qty to adjust] [base uom]) is greater than the quantity available to reserve ([adjustable qty] [base uom]). Unreserve [difference] [base uom] to allow this adjustment.   
Serial number isn't allowed for non-serial controlled item.   
top
 

Inventory_Return_LineObject

part of: Inventory_Adjustment_for_Returns_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Inventory_Return_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Return_LineObjectID

part of: Inventory_Return_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Return_Line_Number  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Inventory_Return_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Purchase_ItemObject

part of: Inventory_Adjustment_for_Returns_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Purchase_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_ItemObjectID

part of: Purchase_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unit_of_MeasureObject

part of: Inventory_Adjustment_for_Returns_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unit_of_MeasureObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unit_of_MeasureObjectID

part of: Unit_of_MeasureObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, UN_CEFACT_Common_Code_ID, UOM_EDI_Code_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Item_LotObject

part of: Inventory_Adjustment_for_Returns_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Item_LotObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_LotObjectID

part of: Item_LotObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Item_Lot_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Item_SerialObject

part of: Inventory_Adjustment_for_Returns_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Item_SerialObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_SerialObjectID

part of: Item_SerialObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Serial_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierObject

part of: Submit_Inventory_Adjustment_for_Returns_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Inventory_ReturnReferenceEnumeration

part of: Inventory_ReturnObjectID
Base Type
string
top
 

Inventory_Return_LineReferenceEnumeration

part of: Inventory_Return_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Item_LotReferenceEnumeration

part of: Item_LotObjectID
Base Type
string
top
 

Item_SerialReferenceEnumeration

part of: Item_SerialObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top