Service Directory > v31.2 > Resource_Management > Get_Invoice_Types
 

Operation: Get_Invoice_Types

Returns Invoice Types for the specified criteria. Invoice Type data includes Invoice Type Value, Country, Description, Usage Location, Inactive Indicator, and In Use indicator.


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

This element is the top-level request element for all Invoice Type "get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Invoice_Type_Request_References  [0..1]  This element contains the echoed Invoice Type Request Reference element.   
Request_Criteria [Choice]   Invoice_Type_Request_Criteria  [0..1]  This element contains the echoed Invoice Type Request Criteria element.   
Response_Filter  Response_Filter  [0..1]  This element content contains the echoed Response Filter element. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Invoice_Type_Response_Group  [0..1]  This element content contains the echoed Invoice Type Response Group Element.   
top
 

Response Element: Get_Invoice_Types_Response

Element containing Invoice Type 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  Invoice_Type_Request_References  [0..1]  This element contains the echoed Invoice Type Request Reference element.   
Request_Criteria  Invoice_Type_Request_Criteria  [0..1]  This element content contains the echoed Invoice Type Request Criteria element.   
Reponse_Filter  Response_Filter  [0..1]  This element content contains the echoed Response Filter element. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Invoice_Type_Response_Group  [0..1]  This element content contains the echoed Invoice Type Response Group element.   
Response_Results  Response_Results  [0..1]  This element content contains the Invoice Type Response Results element.   
Response_Data  Invoice_Type_Response_Data  [0..1]  This element content contains the Invoice Type Response Data element.   
top
 

Invoice_Type_Request_References

part of: Get_Invoice_Types_Request, Get_Invoice_Types_Response
The Invoice Type Request Reference element contains the specific instance containing the requested Invoice Type.
 
Parameter name Type/Value Cardinality Description Validations
Invoice_Type_Reference  Invoice_TypeObject  [0..*]  Business Object containing the Invoice Type   
top
 

Invoice_TypeObject

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

Invoice_TypeObjectID

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

Invoice_Type_Request_Criteria

part of: Get_Invoice_Types_Request, Get_Invoice_Types_Response
Request criteria for retrieving specific Invoice Types.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Invoice_Types_Request, Get_Invoice_Types_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
 

Invoice_Type_Response_Group

part of: Get_Invoice_Types_Request, Get_Invoice_Types_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Invoice Type response. If this element is not included, then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Invoice Type Reference data is to be included in the response.   
Include_Invoice_Type_Data  boolean  [0..1]  Flag indicating if the Invoice Type data is to be included in the response   
top
 

Response_Results

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

Invoice_Type_Response_Data

part of: Get_Invoice_Types_Response
Wrapper element containing Invoice Type response data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Invoice_Type  Invoice_Type  [0..*]  Wrapper element that includes Invoice Type instance and data.   
top
 

Invoice_Type

part of: Invoice_Type_Response_Data
Wrapper element that includes Invoice Type instance and data.
 
Parameter name Type/Value Cardinality Description Validations
Invoice_Type_Reference  Invoice_TypeObject  [0..1]  Invoice Type Reference   
Invoice_Type_Data  Invoice_Type_Data  [0..*]  Element that encapsulates all of the data related to the Invoice Type. 
Validation Description
Enter a unique Invoice Type Value. [Value] is already in use for [Country].  The combination of the Invoice Type Name and the related Country must be unique. 
The Invoice Type is currently in use, you cannot change the country.  The Invoice Type is currently in use, you cannot change the country. 
 
top
 

Invoice_Type_Data

part of: Invoice_Type
Element that encapsulates all of the data related to the Invoice Type.
 
Parameter name Type/Value Cardinality Description Validations
Invoice_Type_ID  string  [0..1]  Invoice Type ID. This is the Invoice Type unique identifier.   
Invoice_Type_Value  string  [1..1]  The name of the Invoice Type   
Country_Reference  CountryObject  [1..1]  The country for this Invoice Type. Any country is available to choose. This cannot be edited once the Invoice Type is in use.   
Invoice_Type_Description  string  [0..1]  The description of the Invoice Type. This is not required.   
Usage_Location_Reference  Unique_IdentifierObject  [0..*]  The usage location of the Invoice Type. If this is left blank, the Invoice Type will not be available anywhere. Only in the chosen usage locations will the Invoice Type be available for selection.   
Invoice_Type_Inactive  boolean  [0..1]  This boolean attribute activates or deactivates the Invoice Type. If an Invoice Type in inactive, it will no longer show up in its usage locations.   
Invoice_Type_In_Use  boolean  [0..1]  This boolean indicates whether the Invoice Type is in use within Workday. This is informational only and is not enterable.   
Validation Description
Enter a unique Invoice Type Value. [Value] is already in use for [Country].  The combination of the Invoice Type Name and the related Country must be unique. 
The Invoice Type is currently in use, you cannot change the country.  The Invoice Type is currently in use, you cannot change the country. 
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Unique_IdentifierObject

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

Invoice_TypeReferenceEnumeration

part of: Invoice_TypeObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top