Service Directory > v32.1 > Resource_Management > Submit_Return
 

Operation: Submit_Return

This service operation will add Returns and submit to the Return business process. Return Data includes Return ID, Return Reason, Return Date, Supplier Invoice, Supplier RMA, Memo, Attachment Data, and Return Line. For Return Line there is a reference to a Purchase Order Item Line or a Supplier Contract Item Line (One is required, but can have both), Quantity to Return, and Memo. The Lines you are return must all be for the same Purchase Order or Supplier Contract.


@ - 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_Return_Request

Submit Return Request. Deliverable Service Lines cannot be Returned only Goods Lines.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Return_Reference  Return_to_SupplierObject  [0..1]  Reference to an existing Return.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Submit_Return_Data  Submit_Return_Data  [1..1]  Return Data 
Validation Description
The Purchase Order Lines or Supplier Contract Lines submitted to be returned must be for the same Purchase Order or Supplier Contract.  The Purchase Order Lines or Supplier Contract Lines submitted to be returned must be for the same Purchase Order or Supplier Contract. 
The Purchase Order or the Supplier Contract submitted to Return is Canceled and you cannot Return a Canceled Document.  The Purchase Order or the Supplier Contract submitted to Return is Canceled and you cannot Return a Canceled Document. 
The Purchase Order or the Supplier Contract submitted to Return is Closed and you cannot Return a Closed Document.  The Purchase Order or the Supplier Contract submitted to Return is Closed and you cannot Return a Closed Document. 
The Supplier Contract submitted to Return is Terminated and you cannot Return a Terminated Contract.  The Supplier Contract submitted to Return is Terminated and you cannot Return a Terminated Contract. 
The Supplier Invoice must be referenced by the Purchase Order or Supplier Contract submitted for the Return.  The Supplier Invoice must be referenced by the Purchase Order or Supplier Contract submitted for the Return. 
The Purchase Order or the Supplier Contract submitted to Return is Pending Close and you cannot create a Return against a document Pending Close.  The Purchase Order or the Supplier Contract submitted to Return is Pending Close and you cannot create a Return against a document Pending Close. 
Company on Return is a required field for returns for supplier contracts associated with a company hierarchy.  Company on Return is a required field for returns for supplier contracts associated with a company hierarchy. 
Company on Return does not match company hierarchy on referenced supplier contract.  Company on Return does not match company hierarchy on referenced supplier contract. 
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted.  The Web Service is set to Add Only; documents cannot be resubmitted. 
The Return is not in Draft Status so it cannot be submitted.  The Return is not in Draft Status so it cannot be submitted. 
top
 

Response Element: Submit_Return_Response

Element containing Return Reference
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Return_Reference  Return_to_SupplierObject  [0..1]  Reference to Submitted Return   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Return_to_SupplierObject

part of: Submit_Return_Request, Submit_Return_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  Return_to_SupplierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Return_to_SupplierObjectID

part of: Return_to_SupplierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Return_to_Supplier_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
 

Financials_Business_Process_Parameters

part of: Submit_Return_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
 

Submit_Return_Data

part of: Submit_Return_Request
Return Data
 
Parameter name Type/Value Cardinality Description Validations
Return_ID  string  [0..1]  Return ID   
Submit  boolean  [0..1]  Submit for Approval is a boolean flag indicating if the transaction is to be submitted or saved in draft mode. If this flag is set, the transaction will be submitted, otherwise the transaction is saved in draft.   
Company_Reference  CompanyObject  [0..1]  Company   
Return_Reason_Reference  Return_to_Supplier_ReasonObject  [1..1]  Return Reason   
Return_Date  date  [1..1]  Return Date   
Supplier_Invoice_Reference  Supplier_InvoiceObject  [0..1]  Reference of a Supplier Invoice to relate to the Return. If the Return Reason creates Supplier Invoice Adjustments this is the Supplier Invoice that will be used.   
Supplier_RMA  string  [0..1]  Supplier RMA   
Memo  string  [0..1]  Header Level Memo   
Item_Return_Line_Replacement_Data  Item_Return_Line_Replacement_Data  [1..*]  Item Return Line Replacement Data 
Validation Description
Purchase Order Line References must be unique. Cannot use the same Purchase Order Line on one Return.  Purchase Order Line References must be unique. Cannot use the same Purchase Order Line on one Return. 
Supplier Contract Line References must be unique. Cannot use the same Supplier Contract Line on one Return.  Supplier Contract Line References must be unique. Cannot use the same Supplier Contract Line on one Return. 
Validation Description
[Line] must have an approved Receipt in order to return it.  Purchase Order Lines or Supplier Contract Lines can only be Return if they have an Approved Receipt. 
The quantity to return for [Line] must be a whole number.  The Quantity to Return must be a whole number. 
The Quantity to Return for [Line] must be greater than zero.  The Quantity to Return must be greater than zero. 
Sum of split quantities does not equal total quantity.   
The distribution method for the provided purchase order line is 'Quantity,' but the sum of the line split quantities is 0. Modify the line splits or change the purchase order line reference.   
The distribution method for the provided purchase order line is 'Amount,' but the sum of the line split quantities is greater than 0. Modify the line splits or change the purchase order line reference.   
You can't return the goods when 1 or more associated PO lines are closed for receiving  You can't return the goods when 1 or more associated PO lines are closed for receiving 
Sum of Split Amount does not equal total amount.  Sum of Split Amount does not equal total amount. 
Enter a Quantity To Return that isn't greater than the quantity received minus the quantity already returned for the selected company.  Enter a Quantity To Return that isn't greater than the quantity received minus the quantity already returned for the selected company. 
You can't submit a return against a Consignment Purchase Order Line.   
You can't submit a return against a Consignment Supplier Contract Line.   
 
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The Purchase Order Lines or Supplier Contract Lines submitted to be returned must be for the same Purchase Order or Supplier Contract.  The Purchase Order Lines or Supplier Contract Lines submitted to be returned must be for the same Purchase Order or Supplier Contract. 
The Purchase Order or the Supplier Contract submitted to Return is Canceled and you cannot Return a Canceled Document.  The Purchase Order or the Supplier Contract submitted to Return is Canceled and you cannot Return a Canceled Document. 
The Purchase Order or the Supplier Contract submitted to Return is Closed and you cannot Return a Closed Document.  The Purchase Order or the Supplier Contract submitted to Return is Closed and you cannot Return a Closed Document. 
The Supplier Contract submitted to Return is Terminated and you cannot Return a Terminated Contract.  The Supplier Contract submitted to Return is Terminated and you cannot Return a Terminated Contract. 
The Supplier Invoice must be referenced by the Purchase Order or Supplier Contract submitted for the Return.  The Supplier Invoice must be referenced by the Purchase Order or Supplier Contract submitted for the Return. 
The Purchase Order or the Supplier Contract submitted to Return is Pending Close and you cannot create a Return against a document Pending Close.  The Purchase Order or the Supplier Contract submitted to Return is Pending Close and you cannot create a Return against a document Pending Close. 
Company on Return is a required field for returns for supplier contracts associated with a company hierarchy.  Company on Return is a required field for returns for supplier contracts associated with a company hierarchy. 
Company on Return does not match company hierarchy on referenced supplier contract.  Company on Return does not match company hierarchy on referenced supplier contract. 
top
 

CompanyObject

part of: Submit_Return_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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_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
 

Return_to_Supplier_ReasonObject

part of: Submit_Return_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  Return_to_Supplier_ReasonObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Return_to_Supplier_ReasonObjectID

part of: Return_to_Supplier_ReasonObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Return_to_Supplier_Reason_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
 

Supplier_InvoiceObject

part of: Submit_Return_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  Supplier_InvoiceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_InvoiceObjectID

part of: Supplier_InvoiceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Invoice_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
 

Item_Return_Line_Replacement_Data

part of: Submit_Return_Data
Item Return Line Replacement Data
 
Parameter name Type/Value Cardinality Description Validations
Purchase_Order_Line_Reference [Choice]   Item_Order_LineObject  [1..1]  Purchase Order Line associated with the Return Line. It must be for a goods item, or else an invalid instance error will occur.   
Supplier_Contract_Line_Reference [Choice]   Supplier_Contract_Item_LineObject  [1..1]  Supplier Contract Line associated with the Return Line. It must be for a goods item, or else an invalid instance error will occur.   
Quantity_to_Return  decimal (22, 2) >0   [1..1]  Quantity to Return   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of measure for this return line 
Validation Description
Only the unit of measure of the purchase order line is valid.  Only the unit of measure of the purchase order line is valid. 
The Unit of Measure is invalid for the catalog item. Only defined ordering units of measure for the catalog item can be used.  The Unit of Measure is invalid for the catalog item. Only defined ordering units of measure for the catalog item can be used. 
Only the unit of measure of the corresponding supplier contract line is valid.  Only the unit of measure of the corresponding supplier contract line is valid. 
Enter a valid Unit of Measure for the purchase item. This unit of measure is not defined for the supplier.  Enter a valid Unit of Measure for the purchase item. This unit of measure is not defined for the supplier. 
 
Memo  string  [0..1]  Comment for Return Line   
Return_Line_Split_Data  Submit_Return_Line_Split_Data  [0..*]  Splits for Return Line 
Validation Description
A Return Line Split must only reference Purchase Order Line Splits of the Purchase Order Line that is related to the current Return Line.   
Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].   
 
Validation Description
[Line] must have an approved Receipt in order to return it.  Purchase Order Lines or Supplier Contract Lines can only be Return if they have an Approved Receipt. 
The quantity to return for [Line] must be a whole number.  The Quantity to Return must be a whole number. 
The Quantity to Return for [Line] must be greater than zero.  The Quantity to Return must be greater than zero. 
Sum of split quantities does not equal total quantity.   
The distribution method for the provided purchase order line is 'Quantity,' but the sum of the line split quantities is 0. Modify the line splits or change the purchase order line reference.   
The distribution method for the provided purchase order line is 'Amount,' but the sum of the line split quantities is greater than 0. Modify the line splits or change the purchase order line reference.   
You can't return the goods when 1 or more associated PO lines are closed for receiving  You can't return the goods when 1 or more associated PO lines are closed for receiving 
Sum of Split Amount does not equal total amount.  Sum of Split Amount does not equal total amount. 
Enter a Quantity To Return that isn't greater than the quantity received minus the quantity already returned for the selected company.  Enter a Quantity To Return that isn't greater than the quantity received minus the quantity already returned for the selected company. 
You can't submit a return against a Consignment Purchase Order Line.   
You can't submit a return against a Consignment Supplier Contract Line.   
top
 

Item_Order_LineObject

part of: Item_Return_Line_Replacement_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_Order_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_Order_LineObjectID

part of: Item_Order_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Line_Number, Purchase_Order_Line_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Change_Order_Reference_ID, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Supplier_Contract_Item_LineObject

part of: Item_Return_Line_Replacement_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  Supplier_Contract_Item_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Contract_Item_LineObjectID

part of: Supplier_Contract_Item_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_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, Alternate_Supplier_Contract_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID  [1..1]  The unique identifier type of a parent object   
top
 

Unit_of_MeasureObject

part of: Item_Return_Line_Replacement_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
 

Submit_Return_Line_Split_Data

part of: Item_Return_Line_Replacement_Data
One split for the corresponding return line.
 
Parameter name Type/Value Cardinality Description Validations
Quantity_for_Distribution_Line  decimal (26, 6)   [0..1]  The quantity being returned for this split.   
Currency_Amount_for_Distribution_Line  decimal (18, 3)   [1..1]  The amount being returned for this split. If quantity is entered than this value must match the unit cost * quantity.   
Memo  string  [0..1]  Memo for the split line.   
Line_Split_Allocated_From_Reference  Business_Document_Line_SplitObject  [1..1]  The purchase order line split this split refers to.   
Validation Description
A Return Line Split must only reference Purchase Order Line Splits of the Purchase Order Line that is related to the current Return Line.   
Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].   
top
 

Business_Document_Line_SplitObject

part of: Submit_Return_Line_Split_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  Business_Document_Line_SplitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_Document_Line_SplitObjectID

part of: Business_Document_Line_SplitObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Internal_Service_Delivery_Line_Split_ID, Inventory_Stock_Request_Line_Split_ID, Purchase_Order_Line_Split_ID, Request_for_Quote_Award_Line_Split_ID, Request_for_Quote_Line_Split_ID, Requisition_Line_Split_ID, Supplier_Invoice_Line_Split_ID, Supplier_Invoice_Request_Line_Split_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
 

Financials_Attachment_Data

part of: Submit_Return_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Application_Instance_Related_Exceptions_Data

part of: Submit_Return_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Return_to_SupplierReferenceEnumeration

part of: Return_to_SupplierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Return_to_Supplier_ReasonReferenceEnumeration

part of: Return_to_Supplier_ReasonObjectID
Base Type
string
top
 

Supplier_InvoiceReferenceEnumeration

part of: Supplier_InvoiceObjectID
Base Type
string
top
 

Item_Order_LineReferenceEnumeration

part of: Item_Order_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Supplier_Contract_Item_LineReferenceEnumeration

part of: Supplier_Contract_Item_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Business_Document_Line_SplitReferenceEnumeration

part of: Business_Document_Line_SplitObjectID
Base Type
string
top