Service Directory > v31.2 > Revenue_Management > Get_Usage_Billing_Rates
 

Operation: Get_Usage_Billing_Rates

This service operation will get Usage Billing Rates.


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

Contains Get Usage Billing Rates Request Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Usage_Billing_Rate_Request_References  [0..1]  Usage Billing Rate Request References Element.   
Request_Criteria [Choice]   Usage_Billing_Rate_Request_Criteria  [0..1]  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  Usage_Billing_Rate_Response_Group  [0..1]  Response Group.   
top
 

Response Element: Get_Usage_Billing_Rates_Response

Get Usage Billing Rates Response Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Usage_Billing_Rate_Request_References  [0..1]  Usage Billing Rate Request References Element.   
Request_Criteria  Usage_Billing_Rate_Request_Criteria  [0..1]  Usage Billing Rate Request Criteria Element.   
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  Usage_Billing_Rate_Response_Group  [0..1]  Usage Billing Rate Response Group Element.   
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  Usage_Billing_Rate_Response_Data  [0..1]  Usage Billing Rate Response Data.   
top
 

Usage_Billing_Rate_Request_References

part of: Get_Usage_Billing_Rates_Request, Get_Usage_Billing_Rates_Response
Usage Billing Rate Request References Element.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate_Reference  Usage_Billing_RateObject  [1..*]  Usage Billing Rate Request References.   
top
 

Usage_Billing_RateObject

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

Usage_Billing_RateObjectID

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

Usage_Billing_Rate_Request_Criteria

part of: Get_Usage_Billing_Rates_Request, Get_Usage_Billing_Rates_Response
Usage Billing Rate Request Criteria Element.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Usage_Billing_Rates_Request, Get_Usage_Billing_Rates_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
 

Usage_Billing_Rate_Response_Group

part of: Get_Usage_Billing_Rates_Request, Get_Usage_Billing_Rates_Response
Usage Billing Rate Response Group Element.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference.   
top
 

Response_Results

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

Usage_Billing_Rate_Response_Data

part of: Get_Usage_Billing_Rates_Response
Usage Billing Rate Response Data Element.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate  Usage_Billing_Rate  [0..*]  Usage Billing Rate details.   
top
 

Usage_Billing_Rate

part of: Usage_Billing_Rate_Response_Data
Usage Billing Rate details.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate_Reference  Usage_Billing_RateObject  [0..1]  Usage Billing Rate Reference.   
Usage_Billing_Rate_Data  Usage_Billing_Rate_Data  [0..1]  Contains Usage Billing Rate Data.   
top
 

Usage_Billing_Rate_Data

part of: Usage_Billing_Rate
Contains data for Get/Put of Usage Billing Rate data.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate_ID  string  [0..1]  Usage Billing Rate ID.   
Usage_Billing_Rate_Name  string  [1..1]  Usage Billing Rate Name.   
Usage_Billing_Rate_Description  string  [0..1]  Usage Billing Rate Description.   
Customer_Contract_Line_Reference  Customer_Contract_LineObject  [0..*]  Customer Contract Line Reference. 
Validation Description
The Line Type for this customer contract line must be Usage Based to add a Usage Billing Rate.   
Submit a contract line to associate with this Recurring Fixed Term contract line.   
 
Minimum_Commitment_Contract_Line_Reference  Customer_Contract_LineObject  [0..1]  Minimum Commitment Contract Line Reference 
Validation Description
You cannot associate contract lines from other contracts, or contract lines that are not Recurring Fixed Term, to this usage rate sheet.  You cannot associate contract lines from other contracts, or contract lines that are not Recurring Fixed Term, to this usage rate sheet. 
 
Usage_Billing_Rate_Rule_Type_Group_Data  Usage_Billing_Rate_Rule_Type_Group_Data  [0..*]  Contains Usage Billing Rate Rule Type Groups.   
top
 

Customer_Contract_LineObject

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

Customer_Contract_LineObjectID

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

Usage_Billing_Rate_Rule_Type_Group_Data

part of: Usage_Billing_Rate_Data
Contains Usage Billing Rate Rule Type Groups.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate_Rule_Data  Usage_Billing_Rate_Rule_Data  [0..*]  Contains Usage Billing Rate Rules. 
Validation Description
The rule must have one tier that starts from 0.   
Change one tier in the rule to be marked as the Max Tier.   
 
top
 

Usage_Billing_Rate_Rule_Data

part of: Usage_Billing_Rate_Rule_Type_Group_Data
Contains Usage Billing Rate Rules.
 
Parameter name Type/Value Cardinality Description Validations
Billing_Rate_Rule_Reference  Billing_Rate_RuleObject  [0..1]  Billing Rate Rule Reference.   
Billing_Rate_Rule_Pricing_Option_Reference  Billing_Rate_Rule_Pricing_OptionObject  [1..1]  Billing Rate Rule Pricing Option Reference   
Billing_Rate_Rule_Reset_Option_Reference  Billing_Rate_Rule_Reset_OptionObject  [1..1]  Billing Rate Rule Reset Option Reference   
Reset_Frequency_Reference  Frequency_BehaviorObject  [0..1]  Reset Frequency Reference. 
Validation Description
If you select reset by transaction, you can't enter frequency and start date.   
Enter a Reset Frequency if you enter a Start Date for Reset.   
 
Start_Date_for_Reset  date  [0..1]  Start Date for Reset. 
Validation Description
If you select reset by transaction, you can't enter frequency and start date.   
Enter a Start Date for Reset if you enter a Reset Frequency.   
 
Minimum_Count [Choice]   decimal (14, 2) >0   [0..1]  Minimum Count.   
Minimum_Amount [Choice]   decimal (26, 6) >0   [0..1]  Minimum Amount.   
Notes  RichText  [0..1]  Billing Rate Rule Notes.   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..*]  Unit of Measure Reference.   
Usage_Billing_Rate_Rule_Break_Data  Usage_Billing_Rate_Rule_Break_Data  [0..*]  Contains Usage Billing Rate Rule Breaks. 
Validation Description
All rule breaks must have contiguous ranges. There is a gap before the tier beginning with From value [From].   
All rule breaks must have contiguous ranges. There is a gap after the tier ending with To value [To]. The break step between each tier must be [break].   
You can only use the From value, [From], on one tier.   
You can only use the To value, [To], on 1 tier.   
To value, [To], overlaps with the values on another tier.   
From value, [From], overlaps with the values on another tier.   
The From value can't be greater than the To value. Change either value so From is not greater than To.   
 
Validation Description
The rule must have one tier that starts from 0.   
Change one tier in the rule to be marked as the Max Tier.   
top
 

Billing_Rate_RuleObject

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

Billing_Rate_RuleObjectID

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

Billing_Rate_Rule_Pricing_OptionObject

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

Billing_Rate_Rule_Pricing_OptionObjectID

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

Billing_Rate_Rule_Reset_OptionObject

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

Billing_Rate_Rule_Reset_OptionObjectID

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

Frequency_BehaviorObject

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

Frequency_BehaviorObjectID

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

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Usage_Billing_Rate_Rule_Break_Data

part of: Usage_Billing_Rate_Rule_Data
Contains Usage Billing Rate Rule Breaks.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Billing_Rate_Rule_Break_Reference  Billing_Rate_Rule_BreakObject  [0..1]  Usage Billing Rate Rule Break Reference.   
Begin_Break_Range_Units  decimal (14, 2) >0   [0..1]  Begin Break Range Units.   
End_Break_Range_Units  decimal (14, 2) >0   [0..1]  End Break Range Units.   
Rate_Amount  decimal (21, 6) >0   [0..1]  Rate Amount.   
Max_Tier  boolean  [0..1]  Max Break Tier Boolean.   
Validation Description
All rule breaks must have contiguous ranges. There is a gap before the tier beginning with From value [From].   
All rule breaks must have contiguous ranges. There is a gap after the tier ending with To value [To]. The break step between each tier must be [break].   
You can only use the From value, [From], on one tier.   
You can only use the To value, [To], on 1 tier.   
To value, [To], overlaps with the values on another tier.   
From value, [From], overlaps with the values on another tier.   
The From value can't be greater than the To value. Change either value so From is not greater than To.   
top
 

Billing_Rate_Rule_BreakObject

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

Billing_Rate_Rule_BreakObjectID

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

Usage_Billing_RateReferenceEnumeration

part of: Usage_Billing_RateObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

Billing_Rate_RuleReferenceEnumeration

part of: Billing_Rate_RuleObjectID
Base Type
string
top
 

Billing_Rate_Rule_Pricing_OptionReferenceEnumeration

part of: Billing_Rate_Rule_Pricing_OptionObjectID
Base Type
string
top
 

Billing_Rate_Rule_Reset_OptionReferenceEnumeration

part of: Billing_Rate_Rule_Reset_OptionObjectID
Base Type
string
top
 

Frequency_BehaviorReferenceEnumeration

part of: Frequency_BehaviorObjectID
Base Type
string
top
 

RichText

part of: Usage_Billing_Rate_Rule_Data
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Billing_Rate_Rule_BreakReferenceEnumeration

part of: Billing_Rate_Rule_BreakObjectID
Base Type
string
top