Service Directory > v32.1 > Resource_Management > Get_Returns
 

Operation: Get_Returns

This service operation will get Returns for the specified criteria. Return data includes Return Number, Return Status, Company for Return, Supplier for Return, Return Reason, Return Date, Supplier Invoice on Return, Supplier RMA, Return Memo, Created by, Line Data, and Attachment Data. The request criteria can be a single Return based on a reference, or Returns with matching criteria of Company, Return Number, Status, Date On or After, Date On or Before, Supplier, Return Reason, Returns for Purchase Order Reference, Returns for Supplier Contract Reference, Spend Categories, Items, Supplier RMA, Created by, or Approved by.


@ - 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: Get_Returns_Request

Contains request reference, criteria, filter and response group for getting Return data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Return_Request_References  [0..1]  Element containing reference instances for a Return   
Request_Criteria [Choice]   Return_Request_Criteria  [0..1]  Utilize the following element to find Returns in the Workday system. 
Validation Description
Return Date On or After must be earlier than Return Date On or Before  Return Date On or After must be earlier than Return Date On or Before 
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Return_Response_Group  [0..1]  Element containing Return response grouping options   
top
 

Response Element: Get_Returns_Response

Element containing Return response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Return_Request_References  [0..1]  Element containing reference instances for a Return   
Request_Criteria  Return_Request_Criteria  [0..1]  Utilize the following element to find returns in the Workday system. 
Validation Description
Return Date On or After must be earlier than Return Date On or Before  Return Date On or After must be earlier than Return Date On or Before 
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Return_Response_Group  [0..1]  Element containing Return response grouping options   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Return_Response_Data  [0..1]  Element containing Return Response Data   
top
 

Return_Request_References

part of: Get_Returns_Request, Get_Returns_Response
Element containing reference instances for a Return
 
Parameter name Type/Value Cardinality Description Validations
Return_Reference  Return_to_SupplierObject  [1..*]  Reference to an existing Return   
top
 

Return_to_SupplierObject

part of: Return_Request_References, Return_to_Supplier
 
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
 

Return_Request_Criteria

part of: Get_Returns_Request, Get_Returns_Response
Utilize the following element to find returns in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [0..*]  Reference to an existing Company   
Return_Number  string (513)   [0..1]  Requisition Number   
Return_Status_Reference  Document_StatusObject  [0..*]  Reference to an existing Return Status. Examples of Document Status are Approved, Denied, Draft, In Progress   
Return_Date_On_or_After  date  [0..1]  Return Date On or After   
Return_Date_On_or_Before  date  [0..1]  Return Date On or Before   
Supplier_Reference  Resource_ProviderObject  [0..*]  Reference to an existing Supplier   
Return_Reason_Reference  Return_to_Supplier_ReasonObject  [0..*]  Reference to an existing Return Reason   
Purchase_Order_Reference [Choice]   Purchase_OrderObject  [0..1]  Reference to an existing Purchase Order   
Supplier_Contract_Reference [Choice]   Supplier_ContractObject  [0..1]  Reference to an existing Supplier Contract   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Reference to the Spend Category.   
Item_Reference  Procurement_ItemObject  [0..*]  Reference of an Item on the Return   
Supplier_RMA  string  [0..1]  Supplier RMA on the Return   
Created_by_Person_Reference  Unique_IdentifierObject  [0..*]  Reference to a Person who created the Return   
Approving_Worker_Reference  WorkerObject  [0..*]  Reference to a Worker who approved the Return   
Validation Description
Return Date On or After must be earlier than Return Date On or Before  Return Date On or After must be earlier than Return Date On or Before 
top
 

OrganizationObject

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

OrganizationObjectID

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

Document_StatusObject

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

Document_StatusObjectID

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

Resource_ProviderObject

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

Resource_ProviderObjectID

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

Purchase_OrderObject

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

Purchase_OrderObjectID

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

Supplier_ContractObject

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

Supplier_ContractObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Procurement_ItemObject

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

Procurement_ItemObjectID

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

Unique_IdentifierObject

part of: Return_Request_Criteria, Return_to_Supplier_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  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
 

WorkerObject

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

Response_Filter

part of: Get_Returns_Request, Get_Returns_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Return_Response_Group

part of: Get_Returns_Request, Get_Returns_Response
Element containing Return response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Returns_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Return_Response_Data

part of: Get_Returns_Response
Wrapper Element that includes Return Information
 
Parameter name Type/Value Cardinality Description Validations
Return  Return_to_Supplier  [0..*]  Wrapper Element that includes Return Instance and Data   
top
 

Return_to_Supplier

part of: Return_Response_Data
Wrapper Element that includes Return Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Return_Reference  Return_to_SupplierObject  [0..1]  Reference to an existing Return   
Return_Data  Return_to_Supplier_Data  [0..1]  Return Data   
top
 

Return_to_Supplier_Data

part of: Return_to_Supplier
Return Data
 
Parameter name Type/Value Cardinality Description Validations
Return_Number  string  [0..1]  Document Number   
Document_Status_Reference  Document_StatusObject  [0..1]  Reference to an existing Return Status. Examples of Document Status are Approved, Denied, Draft, In Progress   
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company   
Supplier_Reference  Resource_ProviderObject  [0..1]  Reference to an existing Supplier   
Return_Reason_Reference  Return_to_Supplier_ReasonObject  [0..1]  Reference to an existing Return Reason   
Return_Date  date  [0..1]  Document Date   
Supplier_Invoice_Reference  Supplier_InvoiceObject  [0..1]  Reference to an existing Supplier Invoice on the Return   
Supplier_RMA  string  [0..1]  Supplier RMA on the Return   
Memo  string  [0..1]  Document Memo   
Created_by_Person_Reference  Unique_IdentifierObject  [0..1]  Reference to the Person who Created the Return   
Return_Line_Data  Return_to_Supplier_Line_Data  [0..*]  Return to Supplier Line Data   
Attachement_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.   
 
top
 

CompanyObject

part of: Return_to_Supplier_Data, Return_to_Supplier_Line_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
 

Supplier_InvoiceObject

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

Return_to_Supplier_Line_Data

part of: Return_to_Supplier_Data
Return to Supplier Line Data
 
Parameter name Type/Value Cardinality Description Validations
Line_Company_Reference  CompanyObject  [0..1]  Line Company for the Return Line   
Item_Reference  Item_DescriptorObject  [0..1]  Item for the Return Line   
Spend_Category_Reference  Accounting_CategoryObject  [0..1]  Spend Category for the Return Line   
Packaging_String  string  [0..1]  Packaging String associated with the Item specified on the Line.   
Quantity  decimal (22, 2)   [0..1]  Quantity Returned   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure Reference   
Extended_Amount  decimal (18, 3)   [0..1]  Amount to Receive   
Memo  string  [0..1]  Line Memo   
Return_Line_Split_Data  Business_Document_Line_Split_Data  [0..*]  Encapsulating element containing Supplier Invoice Line Split data. 
Validation Description
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].   
Only one worktag for each type is allowed for each document line.   
[not allowed worktag types on Business Document Line Split for Spend Transactions]   
For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.   
For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.   
The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.   
Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.   
 
top
 

Item_DescriptorObject

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

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_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
 

Accounting_CategoryObject

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

Accounting_CategoryObjectID

part of: Accounting_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Bank_Account_ID, Customer_Category_ID, Petty_Cash_Account_ID, Receivable_Writeoff_Reason_ID, Revenue_Category_ID, Spend_Category_ID, Supplier_Category_ID, Tax_Category_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: Return_to_Supplier_Line_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
 

Business_Document_Line_Split_Data

part of: Return_to_Supplier_Line_Data
Encapsulating element containing Supplier Invoice Line Split data.
 
Parameter name Type/Value Cardinality Description Validations
Business_Document_Line_Split_Reference  Business_Document_Line_SplitObject  [0..1]  Business Document Line Split Reference. Only to be used with the Get Web Service to grab the Integration ID. 
Validation Description
The Business Document Line Split Reference field should not be entered during the Submit Web Service. It is only used as a Reference during the Get Web Service.   
 
Business_Document_Line_Split_ID  string  [0..1]  Reference ID   
Quantity  decimal (22, 2)   [0..1]  The quantity for the split line. This is optional and should be absent when splitting by amount. 
Validation Description
The quantity must be a whole number: [qty]   
 
Extended_Amount  decimal (18, 3)   [1..1]  The extended amount for the split line. This is always required and must be correct (quantity * unit cost of parent line).   
Budget_Date  date  [0..1]  Use this field to override the Budget Date on a procurement card transaction verification line split.   
Memo  string  [0..1]  Memo for the Split line. This is free form text.   
Line_Split_Allocation_Reference  Business_Document_Line_SplitObject  [0..1]  Line Split Allocated From Reference   
Worktag_Reference  Accounting_WorktagObject  [0..*]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. 
Validation Description
The following Accounting Worktag types are invalid: [invalid].   
The following Accounting Worktag types are invalid: [invalid].   
The following Accounting Worktag types are invalid: [invalid].   
The [type] is/are not available for use with the company/s: [partitionable] [company]   
[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.   
The following Accounting Worktags are required but have not been assigned: [missing].   
[missing required worktag types on Spend Transactions]   
[missing required worktag types on Spend Transactions]   
The following Accounting Worktags are required but have not been assigned: [missing].   
[missing required worktag types on Spend Transactions]   
Select a balancing worktag for Worktags of the following type: [type]   
Select a balancing worktag for Worktags of the following type: [type]   
The following Accounting Worktags are required but have not been assigned: [missing].   
Select a balancing worktag for Worktags of the following type: [type]   
Enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [comp].   
 
Validation Description
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].   
Only one worktag for each type is allowed for each document line.   
[not allowed worktag types on Business Document Line Split for Spend Transactions]   
For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.   
For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.   
The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.   
Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.   
top
 

Business_Document_Line_SplitObject

part of: Business_Document_Line_Split_Data, Business_Document_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
 

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_Type_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: Return_to_Supplier_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
 

Return_to_SupplierReferenceEnumeration

part of: Return_to_SupplierObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Return_to_Supplier_ReasonReferenceEnumeration

part of: Return_to_Supplier_ReasonObjectID
Base Type
string
top
 

Purchase_OrderReferenceEnumeration

part of: Purchase_OrderObjectID
Base Type
string
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Procurement_ItemReferenceEnumeration

part of: Procurement_ItemObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Supplier_InvoiceReferenceEnumeration

part of: Supplier_InvoiceObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Accounting_CategoryReferenceEnumeration

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

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top