Service Directory > v32.1 > Resource_Management > Get_Supplier_Invoice_Line_Additional_Data
 

Operation: Get_Supplier_Invoice_Line_Additional_Data

Enable retrieval of custom objects for the Supplier Invoice Line.


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

Contains the Supplier Invoice Line additional data request data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Supplier_Invoice_Line_Request_References  [0..1]  This element contains the specific instance set containing the requested supplier invoice line. The type attribute is either Reference ID type or Workday ID and the ID is the value for the instance of the supplier invoice line.   
Request_Criteria [Choice]   Supplier_Invoice_Line_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the supplier invoice-specific criteria needed to search for instances.   
Response_Filter  Response_Filter  [0..1]  Parameters that enable you to 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  Supplier_Invoice_Line_Response_Group  [0..1]  Get Supplier Invoice Line Response Group   
top
 

Response Element: Get_Supplier_Invoice_Line_Additional_Data_Response

Element containing Supplier Invoice Line additional data 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  Supplier_Invoice_Line_Request_References  [0..1]  This element contains the specific instance set containing the requested supplier invoice line. The type attribute is either Reference ID type or Workday ID and the ID is the value for the instance of the supplier invoice line.   
Request_Criteria  Supplier_Invoice_Line_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the supplier invoice-specific criteria needed to search for instances.   
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  Supplier_Invoice_Line_Response_Group  [0..1]  Get Supplier Invoice Line Response Group   
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  Get_Supplier_Invoice_Line_Additional_Data_Response_Data  [0..1]  The element contains the Supplier Invoice Line additional data response data.   
top
 

Supplier_Invoice_Line_Request_References

part of: Get_Supplier_Invoice_Line_Additional_Data_Response, Get_Supplier_Invoice_Line_Additional_Data_Request
This element contains the specific instance set containing the requested supplier invoice line. The type attribute is either Reference ID type or Workday ID and the ID is the value for the instance of the supplier invoice line.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Line_Reference  Supplier_Invoice_LineObject  [1..*]  The Supplier Invoice Line reference   
top
 

Supplier_Invoice_LineObject

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

Supplier_Invoice_LineObjectID

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

Supplier_Invoice_Line_Request_Criteria

part of: Get_Supplier_Invoice_Line_Additional_Data_Response, Get_Supplier_Invoice_Line_Additional_Data_Request
This element is the wrapper around a list of elements representing the supplier invoice-specific criteria needed to search for instances.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Reference  Supplier_Invoice_DocumentObject  [1..*]  The Supplier Invoice reference   
top
 

Supplier_Invoice_DocumentObject

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

Supplier_Invoice_DocumentObjectID

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

Response_Filter

part of: Get_Supplier_Invoice_Line_Additional_Data_Response, Get_Supplier_Invoice_Line_Additional_Data_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
 

Supplier_Invoice_Line_Response_Group

part of: Get_Supplier_Invoice_Line_Additional_Data_Response, Get_Supplier_Invoice_Line_Additional_Data_Request
Get Supplier Invoice Line Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Get_Supplier_Invoice_Line_Additional_Data_Response_Data

part of: Get_Supplier_Invoice_Line_Additional_Data_Response
The element contains the Supplier Invoice Line additional data response data.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Line_Additional_Data  Supplier_Invoice_Line_Additional_Data  [0..*]  Wrapper element containing the Supplier Invoice Line additional data for requested references or criteria.   
top
 

Supplier_Invoice_Line_Additional_Data

part of: Get_Supplier_Invoice_Line_Additional_Data_Response_Data
Wrapper element containing the Supplier Invoice Line additional data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Line_Reference  Supplier_Invoice_LineObject  [0..1]  The Supplier Invoice Line reference   
Business_Object_Additional_Data  Non_Effective_Dated_Web_Service_Additional_Data  [0..1]  Non Effective Dated Web Service Additional Data   
top
 

Non_Effective_Dated_Web_Service_Additional_Data

part of: Supplier_Invoice_Line_Additional_Data
Non Effective Dated Web Service Additional Data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Supplier_Invoice_LineReferenceEnumeration

part of: Supplier_Invoice_LineObjectID
Base Type
string
top
 

Supplier_Invoice_DocumentReferenceEnumeration

part of: Supplier_Invoice_DocumentObjectID
Base Type
string
top