Service Directory > v32.1 > Resource_Management > Get_Supplier_Invoice_Histories
 

Operation: Get_Supplier_Invoice_Histories

This web service operation will retrieve instances of Supplier Invoice Histories. This contains data for Reference ID, Company, Currency, Supplier, Total Invoice Amount, document Reference Number, Invoice Date, External PO Number, Document Number, and Source Integration System name. On the web service request, you can specify a specific reference to a Supplier Invoice History to return, or find them by supplying search criteria of Company, Supplier, Supplier Reference Number, Invoice Date, Invoice Amount, Currency, External PO Number, Invoice Number, or Source Integration System.


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

This element is the top-level request element for all "Get" Supplier Invoice HIstory operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Supplier_Invoice_History_Request_References  [0..1]  Wrapper element for references to specific Supplier Invoice Histories that will be returned in the "Get" operation.   
Request_Criteria [Choice]   Supplier_Invoice_History_Request_Criteria  [0..1]  The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Supplier Invoice History instances. 
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
 
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_History_Response_Group  [0..1]  The Response Group is a wrapper element around a list of elements representing the amount of data that should be included in the response.   
top
 

Response Element: Get_Supplier_Invoice_Histories_Response

This element is the top-level response element for all "Get" Supplier Invoice History operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Invoice_History_Request_References  [0..1]  Wrapper element for references to specific Supplier Invoice Histories that will be returned in the "Get" operation.   
Request_Criteria  Supplier_Invoice_History_Request_Criteria  [0..1]  The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Supplier Invoice History instances. 
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
 
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_History_Response_Group  [0..1]  The Response Group is a wrapper element around a list of elements representing the amount of data that should be included in the response.   
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  Supplier_Invoice_History_Response_Data  [0..1]  Wrapper for all the Supplier Invoice Histories being returned in the "Get" operation response.   
top
 

Supplier_Invoice_History_Request_References

part of: Get_Supplier_Invoice_Histories_Request, Get_Supplier_Invoice_Histories_Response
Wrapper element for references to specific Supplier Invoice Histories that will be returned in the "Get" operation.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_History_Reference  Supplier_Invoice_HistoryObject  [1..*]  References to specific Supplier Invoice History objects to be returned by the "Get" operation.   
top
 

Supplier_Invoice_HistoryObject

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

Supplier_Invoice_HistoryObjectID

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

part of: Get_Supplier_Invoice_Histories_Request, Get_Supplier_Invoice_Histories_Response
The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Supplier Invoice History instances.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [0..*]  References to one or more Companies to use as search criteria to find Supplier Invoice Histories.   
Supplier_Reference  Resource_ProviderObject  [0..*]  References to one or more Suppliers to use as search criteria to find Supplier Invoice Histories.   
Supplier_Reference_Number  string  [0..1]  Text value for Supplier Reference Number to use as search criteria to find Supplier Invoice Histories.   
Invoice_Date  date  [0..1]  Date value to use to search for Supplier Invoice Histories with an Invoice Date matching this date.   
Total_Invoice_Amount  decimal (26, 6)   [0..1]  Currency amount for the Total Invoice Amount to use as search criteria to find Supplier Invoice Histories.   
Currency_Reference  CurrencyObject  [0..1]  Reference to a Currency to use as search criteria to find Supplier Invoice Histories.   
External_PO_Number  string  [0..1]  Text value for an External PO Number to use as search criteria to find Supplier Invoice Histories.   
Invoice_Number  string  [0..1]  Text value for an Invoice Number to use as search criteria to find Supplier Invoice Histories.   
Source_Integration_System  string  [0..1]  Text value for a Source Integration System to use as search criteria to find Supplier Invoice Histories.   
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.  Supplier reference is for a supplier that can be used as a basic worktag only. 
top
 

OrganizationObject

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

Resource_ProviderObject

part of: Supplier_Invoice_History_Request_Criteria, Supplier_Invoice_History_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
 

CurrencyObject

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

CurrencyObjectID

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

Supplier_Invoice_History_Response_Group

part of: Get_Supplier_Invoice_Histories_Request, Get_Supplier_Invoice_Histories_Response
The Response Group is a wrapper element around a list of elements representing the amount of data that should be included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Supplier Invoice History Reference data is to be included in the response.   
top
 

Response_Results

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

Supplier_Invoice_History_Response_Data

part of: Get_Supplier_Invoice_Histories_Response
Wrapper for all the Supplier Invoice Histories being returned in the "Get" operation response.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_History  Supplier_Invoice_History  [0..*]  Wrapper for a single Supplier Invoice History object and its data being returned by the "Get" operation.   
top
 

Supplier_Invoice_History

part of: Supplier_Invoice_History_Response_Data
Wrapper for a single Supplier Invoice History object and its data being returned by the "Get" operation.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_History_Reference  Supplier_Invoice_HistoryObject  [0..1]  Reference to a Supplier Invoice History object being returned by the "Get" operation.   
Supplier_Invoice_History_Data  Supplier_Invoice_History_Data  [0..1]  Wrapper element containing all the data fields for the Supplier Invoice History object. 
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.   
 
top
 

Supplier_Invoice_History_Data

part of: Supplier_Invoice_History
Wrapper element containing all the data fields for the Supplier Invoice History object.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_History_ID  string  [0..1]  Supplier Invoice History ID. This is the Supplier Invoice History unique identifier   
Company_Reference  CompanyObject  [1..1]  This is the company that tranasction is for. This is the reference id value of the company.   
Supplier_Reference  Resource_ProviderObject  [1..1]  Reference to the Supplier the Invoice History is for.   
Suppliers_Invoice_Number  string  [0..1]  Text value for Supplier Reference Number.   
Total_Invoice_Amount  decimal (26, 6)   [0..1]  Currency amount for the Total Invoice Amount. This amount corresponds with the Currency in Supplier Invoice History Currency Reference.   
Currency_Reference  CurrencyObject  [0..1]  Reference to the Currency used in this Supplier Invoice History. 
Validation Description
Supplier Invoice History Currency Reference is required if Supplier Invoice History Total Invoice Amount is specified.  Supplier Invoice History Currency Reference is required if Supplier Invoice History Total Invoice Amount is specified. 
 
Invoice_Date  date  [0..1]  Date value for the Supplier Invoice History date. Format is MM/DD/YYYY.   
External_PO_Number  string  [0..1]  Text value for an External Purchase Order Number recorded on the Supplier Invoice History.   
Invoice_Number  string  [0..1]  Text value for the Document Number of the Supplier Invoice History.   
Source_Integration_System  string  [0..1]  Text value of the Source Integration System of the Supplier Invoice History.   
Validation Description
Supplier reference is for a supplier that can be used as a basic worktag only.   
top
 

CompanyObject

part of: Supplier_Invoice_History_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_Invoice_HistoryReferenceEnumeration

part of: Supplier_Invoice_HistoryObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top