Service Directory > v32.1 > Revenue_Management > Get_Dunning_Level_Groups
 

Operation: Get_Dunning_Level_Groups

This web service operation returns dunning level groups.


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

Get dunning level groups request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Dunning_Level_Group_Request_References  [0..1]  Dunning level group request.   
Request_Criteria [Choice]   Dunning_Level_Group_Request_Criteria  [0..1]  Dunning level group 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  Dunning_Level_Group_Response_Group  [0..1]  Dunning level group response group.   
top
 

Response Element: Get_Dunning_Level_Groups_Response

Dunning Level Groups Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Dunning_Level_Group_Request_References  [0..1]  Dunning Level Group Request Reference   
Request_Criteria  Dunning_Level_Group_Request_Criteria  [0..1]  Dunning Level Group Request Criteria   
Response_Filter  Response_Filter  [0..1]  Dunning Level Group Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Dunning_Level_Group_Response_Group  [0..1]  Dunning Level Group Response Group   
Response_Results  Response_Results  [0..1]  Dunning Level Group Response Results   
Response_Data  Dunning_Level_Group_Response_Data  [0..1]  Dunning Level Group Response Data   
top
 

Dunning_Level_Group_Request_References

part of: Get_Dunning_Level_Groups_Request, Get_Dunning_Level_Groups_Response
Dunning level group request references
 
Parameter name Type/Value Cardinality Description Validations
Dunning_Level_Group_Reference  Dunning_Level_GroupObject  [1..*]  Dunning level group request references.   
top
 

Dunning_Level_GroupObject

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

Dunning_Level_GroupObjectID

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

Dunning_Level_Group_Request_Criteria

part of: Get_Dunning_Level_Groups_Request, Get_Dunning_Level_Groups_Response
Dunning level group request criteria
 
Parameter name Type/Value Cardinality Description Validations
Name  string  [0..1]  Reference to an existing dunning level group name that the request criteria is for.   
top
 

Response_Filter

part of: Get_Dunning_Level_Groups_Request, Get_Dunning_Level_Groups_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
 

Dunning_Level_Group_Response_Group

part of: Get_Dunning_Level_Groups_Request, Get_Dunning_Level_Groups_Response
Dunning level group response group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include reference   
top
 

Response_Results

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

Dunning_Level_Group_Response_Data

part of: Get_Dunning_Level_Groups_Response
Dunning level group response
 
Parameter name Type/Value Cardinality Description Validations
Dunning_Level_Group  Dunning_Level_Group  [0..*]  Dunning level group   
top
 

Dunning_Level_Group

part of: Dunning_Level_Group_Response_Data
Dunning Level Group
 
Parameter name Type/Value Cardinality Description Validations
Dunning_Level_Group_Reference  Dunning_Level_GroupObject  [0..1]  Dunning level group reference ID.   
Dunning_Level_Group_Data  Dunning_Level_Group_Data  [0..1]  Dunning level group data 
Validation Description
From Risk Scores and To Risk Scores can't overlap or have gaps.   
From Days and To Days can't overlap or have gaps.   
 
top
 

Dunning_Level_Group_Data

part of: Dunning_Level_Group
Element for Dunning Level Group
 
Parameter name Type/Value Cardinality Description Validations
Dunning_Level_Group_ID  string  [0..1]  The internal reference ID of the dunning level group ID   
Name  string  [1..1]  Dunning level group name 
Validation Description
Enter a Dunning Level Group name that is not already in use.   
 
By_Risk_Score  boolean  [0..1]  Returns true if dunning level is created by risk score.   
Dunning_Level_Data  Dunning_Level_Data  [0..*]  dunning levels 
Validation Description
By Risk Score can't be used with From Days and To Days. Use From Risk Score and To Risk Score.   
By Date can't be used with From Risk Score and To Risk Score. Use From Days and To Days.   
Enter a Dunning Level name that is not already in use.   
Enter a To Days value that is greater than the From Days value.   
Enter a To Risk Score value that is greater than the From Risk Score value.   
From Days and To Days can't overlap or have gaps.   
From Risk Scores and To Risk Scores can't overlap or have gaps.   
 
Validation Description
From Risk Scores and To Risk Scores can't overlap or have gaps.   
From Days and To Days can't overlap or have gaps.   
top
 

Dunning_Level_Data

part of: Dunning_Level_Group_Data
Element containing all Dunning Level Group Data
 
Parameter name Type/Value Cardinality Description Validations
Dunning_Level_Reference  Dunning_LevelObject  [0..1]  A unique internal reference ID for the dunning level instance. If a Dunning Level ID is provided, Workday uses that ID. If no ID is provided, Workday generates a new Dunning Level ID.   
Dunning_Level_ID  string  [0..1]  A unique internal reference ID for the dunning level instance. If a Dunning Level ID is provided, Workday uses that ID. If no ID is provided, Workday generates a new Dunning Level ID.   
Dunning_Level_Name  string  [0..1]  Dunning level name   
From_Days  decimal (12, 0)   [0..1]  Dunning level from days   
To_Days  decimal (12, 0)   [0..1]  Dunning level to dates   
From_Risk_Score  decimal (6, 3) >0   [0..1]  Dunning level from risk score 
Validation Description
Risk Score must be equal to, or less than 100%.   
 
To_Risk_Score  decimal (6, 3) >0   [0..1]  Dunning level to risk score 
Validation Description
Risk Score must be equal to, or less than 100%.   
 
Business_Form_Layout_Reference  Business_Form_LayoutObject  [1..1]  Dunning business form layout   
Validation Description
By Risk Score can't be used with From Days and To Days. Use From Risk Score and To Risk Score.   
By Date can't be used with From Risk Score and To Risk Score. Use From Days and To Days.   
Enter a Dunning Level name that is not already in use.   
Enter a To Days value that is greater than the From Days value.   
Enter a To Risk Score value that is greater than the From Risk Score value.   
From Days and To Days can't overlap or have gaps.   
From Risk Scores and To Risk Scores can't overlap or have gaps.   
top
 

Dunning_LevelObject

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

Dunning_LevelObjectID

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

Business_Form_LayoutObject

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

Business_Form_LayoutObjectID

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

Dunning_Level_GroupReferenceEnumeration

part of: Dunning_Level_GroupObjectID
Base Type
string
top
 

Dunning_LevelReferenceEnumeration

part of: Dunning_LevelObjectID
Base Type
string
top
 

Business_Form_LayoutReferenceEnumeration

part of: Business_Form_LayoutObjectID
Base Type
string
top