Service Directory > v32.1 > Revenue_Management > Get_Electronic_Invoicing_Acknowledgements
 

Operation: Get_Electronic_Invoicing_Acknowledgements

This service operation will get Electronic Invoicing Acknowledgements for the specified criteria. Electronic Invoicing Acknowledgement data includes Electronic Invoicing Acknowledgment ID, Customer Invoice Document, Date, Status, and Message.


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

This element is the top-level request element for all Electronic Invoicing Acknowledgement "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Electronic_Invoicing_Acknowledgement_Request_References  [0..1]  An element containing the specific instance set that should be returned in the Get.   
Request_Criteria [Choice]   Electronic_Invoicing_Acknowledgement_Request_Criteria  [0..1]  An element containing wrapper element that has a list of specific criteria to search for instances of the Electronic Invoicing Acknowledgement.   
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  Electronic_Invoicing_Acknowledgement_Response_Group  [0..1]  Element content containing Electronic Invoicing Acknowledgement Response Group element   
top
 

Response Element: Get_Electronic_Invoicing_Acknowledgements_Response

An element containing Electronic Invoicing Acknowledgement response elements including echoed request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Electronic_Invoicing_Acknowledgement_Request_References  [0..1]  An element containing the specific instance set that should be returned in the Get.   
Request_Criteria  Electronic_Invoicing_Acknowledgement_Request_Criteria  [0..1]  This is a wrapper element around a list of elements representing the Electronic Invoicing Acknowledgement Request specific criteria needed to search for instances. All of the elements are "AND" conditions.   
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  Electronic_Invoicing_Acknowledgement_Response_Group  [0..1]  A wrapper around a list of elements representing the amount of data that should be included in the Electronic Invoicing Acknowledgement response. If this element is not included, then ALL response groups are included in the data returned.   
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  Electronic_Invoicing_Acknowledgement_Response_Data  [0..1]  A wrapper element containing Electronic Invoicing Acknowledgement response data for requested references, criteria, and response group.   
top
 

Electronic_Invoicing_Acknowledgement_Request_References

part of: Get_Electronic_Invoicing_Acknowledgements_Response, Get_Electronic_Invoicing_Acknowledgements_Request
An element containing the specific instance set that should be returned in the Get.
 
Parameter name Type/Value Cardinality Description Validations
Electronic_Invoicing_Acknowledgement_Reference  Electronic_Invoicing_AcknowledgementObject  [1..*]  An instance set that contains the Electronic Invoicing Acknowledgement object.   
top
 

Electronic_Invoicing_AcknowledgementObject

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

Electronic_Invoicing_AcknowledgementObjectID

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

Electronic_Invoicing_Acknowledgement_Request_Criteria

part of: Get_Electronic_Invoicing_Acknowledgements_Response, Get_Electronic_Invoicing_Acknowledgements_Request
This is a wrapper element around a list of elements representing the Electronic Invoicing Acknowledgement Request specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Invoice_Reference  Customer_Invoice_DocumentObject  [0..*]  Reference to Customer Invoice or Adjustment for Electronic Invoicing Acknowledgement   
Electronic_Invoicing_Acknowledgement_Date_On_or_After  date  [0..1]  Electronic Invoicing Acknowledgement Date On or After   
Electronic_Invoicing_Acknowledgement_Date_On_or_Before  date  [0..1]  Electronic Invoicing Acknowledgement Date On or Before   
Status  string  [0..1]  Electronic Invoicing Acknowledgement Status   
top
 

Customer_Invoice_DocumentObject

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

Customer_Invoice_DocumentObjectID

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

Response_Filter

part of: Get_Electronic_Invoicing_Acknowledgements_Response, Get_Electronic_Invoicing_Acknowledgements_Request
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
 

Electronic_Invoicing_Acknowledgement_Response_Group

part of: Get_Electronic_Invoicing_Acknowledgements_Response, Get_Electronic_Invoicing_Acknowledgements_Request
A wrapper around a list of elements representing the amount of data that should be included in the Electronic Invoicing Acknowledgement response. If this element is not included, then ALL response groups are included in the data returned.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  A flag indicating if the Electronic Invoicing Acknowledgement Reference data is to be included in the response.   
top
 

Response_Results

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

Electronic_Invoicing_Acknowledgement_Response_Data

part of: Get_Electronic_Invoicing_Acknowledgements_Response
A wrapper element containing Electronic Invoicing Acknowledgement response data for requested references, criteria, and response group.
 
Parameter name Type/Value Cardinality Description Validations
Electronic_Invoicing_Acknowledgement  Electronic_Invoicing_Acknowledgement  [0..*]  An element content containing Electronic Invoicing Acknowledgement elements   
top
 

Electronic_Invoicing_Acknowledgement

part of: Electronic_Invoicing_Acknowledgement_Response_Data
A Wrapper element that includes Electronic Invoicing Acknowledgement instance and data.
 
Parameter name Type/Value Cardinality Description Validations
Electronic_Invoicing_Acknowledgement_Reference  Electronic_Invoicing_AcknowledgementObject  [0..1]  Reference to an existing Electronic Invoicing Acknowledgement Instance   
Electronic_Invoicing_Acknowledgement_Data  Electronic_Invoicing_Acknowledgement_WWS_Data  [0..*]  An element containing Electronic Invoicing Acknowledgement response data. 
Validation Description
Enter a customer invoice reference.   
Enter a processed date.   
 
top
 

Electronic_Invoicing_Acknowledgement_WWS_Data

part of: Electronic_Invoicing_Acknowledgement
This Element that contains Electronic Invoicing Acknowledgement data.
 
Parameter name Type/Value Cardinality Description Validations
Electronic_Invoicing_Acknowledgement_ID  string  [0..1]  A unique identifier for an Electronic Invoicing Acknowledgement instance.   
Customer_Invoice_Reference  Customer_Invoice_DocumentObject  [0..1]  A reference to an existing customer invoice.   
Processed_Date  dateTime  [0..1]  The date and time when the electronic customer invoice was processed by the third party provider.   
Status  string  [0..1]  The status of an electronic invoice from the third party provider.   
Message  string  [0..1]  A message or any other data regarding the electronic invoice from the third party provider.   
Validation Description
Enter a customer invoice reference.   
Enter a processed date.   
top
 

Electronic_Invoicing_AcknowledgementReferenceEnumeration

part of: Electronic_Invoicing_AcknowledgementObjectID
Base Type
string
top
 

Customer_Invoice_DocumentReferenceEnumeration

part of: Customer_Invoice_DocumentObjectID
Base Type
string
top