Service Directory > v31.2 > Resource_Management > Get_Procurement_Mass_Close
 

Operation: Get_Procurement_Mass_Close

This service operation will get Procurement Mass Close requests for the specified criteria. Procurement Mass Close Data includes Company or Company Hierarchy, Procurement Document Type, Procurement Mass Close Request Name, header Memo, the Business Documents for the request, a line Memo and Exclude from 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: Get_Procurement_Mass_Close_Request

Element containing sub elements for the Request Reference, Request Criteria, Response Filter and the Response Group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Procurement_Mass_Close_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Procurement_Mass_Close_Request_Criteria  [0..1]  Request Criteria   
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  Procurement_Mass_Close_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Procurement_Mass_Close_Response

Element containing Procurement Mass Close response elements including received criteria, references, data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Procurement_Mass_Close_Request_References  [0..1]  Element containing reference instances for a Procurement Mass Close object   
Request_Criteria  Procurement_Mass_Close_Request_Criteria  [0..1]  This element contains criteria to find Procurement Mass Close requests.   
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  Procurement_Mass_Close_Response_Group  [0..1]  Element containing Procurement Mass Close 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  Procurement_Mass_Close_Response_Data  [0..1]  Procurement Mass Close Response Data   
top
 

Procurement_Mass_Close_Request_References

part of: Get_Procurement_Mass_Close_Request, Get_Procurement_Mass_Close_Response
Element containing reference instances for a Procurement Mass Close object
 
Parameter name Type/Value Cardinality Description Validations
Procurement_Mass_Close_Reference  Procurement_Mass_CloseObject  [1..*]  Procurement Mass Close Reference   
top
 

Procurement_Mass_CloseObject

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

Procurement_Mass_CloseObjectID

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

part of: Get_Procurement_Mass_Close_Request, Get_Procurement_Mass_Close_Response
This element contains criteria to find Procurement Mass Close requests.
 
Parameter name Type/Value Cardinality Description Validations
Company_or_Company_Hierarchy_Reference  OrganizationObject  [0..1]  Company or Company Hierarchy   
Procurement_Document_Type_Reference  Procurement_Document_TypeObject  [0..1]  Procurement Document Type   
Creation_Date_On_or_After  date  [0..1]  Creation Date On or After   
Creation_Date_On_or_Before  date  [0..1]  Creation Date On or Before   
top
 

OrganizationObject

part of: Procurement_Mass_Close_Request_Criteria, Procurement_Mass_Close_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  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
 

Procurement_Document_TypeObject

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

Procurement_Document_TypeObjectID

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

Response_Filter

part of: Get_Procurement_Mass_Close_Request, Get_Procurement_Mass_Close_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
 

Procurement_Mass_Close_Response_Group

part of: Get_Procurement_Mass_Close_Request, Get_Procurement_Mass_Close_Response
Element containing Procurement Mass Close response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Procurement_Mass_Close_Response_Data

part of: Get_Procurement_Mass_Close_Response
Procurement Mass Close Response Data
 
Parameter name Type/Value Cardinality Description Validations
Procurement_Mass_Close  Procurement_Mass_Close  [0..*]  Wrapper element for Procurement Mass Close Reference and Procurement Mass Close Data.   
top
 

Procurement_Mass_Close

part of: Procurement_Mass_Close_Response_Data
Wrapper element for Procurement Mass Close Reference and Procurement Mass Close Data.
 
Parameter name Type/Value Cardinality Description Validations
Procurement_Mass_Close_Reference  Procurement_Mass_CloseObject  [0..1]  Procurement Mass Close Reference   
Procurement_Mass_Close_Data  Procurement_Mass_Close_Data  [0..1]  Procurement Mass Close Data 
Validation Description
You must specify at least one Business Document to Close for this Procurement Mass Close request.   
 
top
 

Procurement_Mass_Close_Data

part of: Procurement_Mass_Close
Element that contains the Procurement Mass Close Data.
 
Parameter name Type/Value Cardinality Description Validations
Procurement_Mass_Close_ID  string  [0..1]  Procurement Mass Close Reference ID   
Company_or_Company_Hierarchy_Reference  OrganizationObject  [1..1]  Company or Company Hierarchy Reference   
Procurement_Document_Type_Reference  Procurement_Document_TypeObject  [1..1]  Procurement Document Type Reference   
Procurement_Mass_Close_Request_Name  string  [1..1]  Procurement Mass Close Request Name   
Memo  string  [0..1]  Memo   
Procurement_Mass_Close_Line_Data  Procurement_Year_End_Request_Line_Data  [0..*]  Procurement Mass Close Line Data   
Validation Description
You must specify at least one Business Document to Close for this Procurement Mass Close request.   
top
 

Procurement_Year_End_Request_Line_Data

part of: Procurement_Mass_Close_Data
Procurement Year End Request Line Data
 
Parameter name Type/Value Cardinality Description Validations
Business_Document_Reference  Business_DocumentObject  [1..1]  Business Document Reference 
Validation Description
The Business Document [Bus Doc] is not of type [Type].   
The Business Document [Business Doc] is not in an acceptable state for Closing.   
The Business Document [bus doc] is not for the same company or a member of the company hierarchy supplied.   
 
Memo  string  [0..1]  Line Memo   
Exclude_from_Process  boolean  [0..1]  Exclude from Process option   
top
 

Business_DocumentObject

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

Business_DocumentObjectID

part of: Business_DocumentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Advanced_Ship_Notice_ID, Advanced_Ship_Notice_Number, Award_Contract_Amendment_ID, Award_Proposal_ID, Award_Reference_ID, Change_Order_Reference_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Amendment_Reference_ID, Customer_Contract_Intercompany_ID, Customer_Contract_Reference_ID, Customer_Invoice_Adjustment_Reference_ID, Customer_Invoice_Reference_ID, Document_Number, Expense_Report_Reference_ID, Good_Delivery_ID, Goods_Delivery_Run_ID, Internal_Service_Delivery_Document_Number, Internal_Service_Delivery_ID, Inventory_Count_Sheet_Reference_ID, Inventory_Par_Count_Reference_ID, Inventory_Pick_List_Reference_ID, Inventory_Return_Reference_ID, Inventory_Ship_List_Reference_ID, Inventory_Stock_Request_Reference_ID, PO_Acknowledgement_Number, PO_Acknowledgement_Reference_ID, Procurement_Card_Transaction_Verification_ID, Purchase_Order_Reference_ID, Receipt_Number, Request_for_Quote_Award_ID, Request_for_Quote_ID, Request_for_Quote_Response_ID, Requisition_Number, Requisition_Template_ID, Return_to_Supplier_ID, Spend_Authorization_ID, Student_Sponsor_Contract_ID, Supplier_Acknowledgement_Number, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Adjustment_Reference_ID, Supplier_Invoice_Contract_ID, Supplier_Invoice_Reference_ID, Supplier_Invoice_Request_Document_Number, Supplier_Invoice_Request_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, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Procurement_Mass_CloseReferenceEnumeration

part of: Procurement_Mass_CloseObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Procurement_Document_TypeReferenceEnumeration

part of: Procurement_Document_TypeObjectID
Base Type
string
top
 

Business_DocumentReferenceEnumeration

part of: Business_DocumentObjectID
Base Type
string
top
 

Base Type
string

top