Service Directory > v25.1 > Revenue_Management > Get_Usage_Based_Transactions
 

Operation: Get_Usage_Based_Transactions

This service operation will get Usage Based Transactions based on request criteria (all transactions is not an option). Usage Based Transaction Data includes Usage Based Transaction Reference ID, transaction date, quantity, unit of measure, location data (country, country region, city, postal code), description, calculated transaction rate, and amount to bill.


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

This element is the top-level request element for the Usage Based Transaction "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Usage_Based_Transaction_Request_References  [0..1]  This element content contains the Usage Based Transaction reference element used to return Usage Based Transaction by reference id.   
Request_Criteria [Choice]   Usage_Based_Transaction_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Usage Based Transaction. 
Validation Description
You can specify Customer Contracts or Customers but not both.   
 
Response_Filter  Response_Filter  [0..1]  Element content containing Usage Based Transaction Response Filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Usage_Based_Transaction_Response_Group  [0..1]  Element content containing Usage Based Transaction Response Group element   
top
 

Response Element: Get_Usage_Based_Transactions_Response

Element containing Usage Based Transaction response elements including echoed request data and request result
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Usage_Based_Transaction_Request_References  [0..1]  Usage Based Transaction Reference element contains the set of requested Usage Based Transactions for which to return data.   
Request_Criteria  Usage_Based_Transaction_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Usage Based Transaction-specific criteria. 
Validation Description
You can specify Customer Contracts or Customers but not both.   
 
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_Based_Transaction_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Usage Based Transaction 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  Usage_Based_Transaction_Response_Data  [0..1]  Wrapper element containing Usage Based Transaction Response Data for requested references or criteria   
top
 

Usage_Based_Transaction_Request_References

part of: Get_Usage_Based_Transactions_Request, Get_Usage_Based_Transactions_Response
Usage Based Transaction Reference element contains the set of requested Usage Based Transactions for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Based_Transaction_Reference  Usage_Based_TransactionObject  [0..*]  Reference Usage Based Transaction for which data will be returned   
top
 

Usage_Based_TransactionObject

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

Usage_Based_TransactionObjectID

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

part of: Get_Usage_Based_Transactions_Request, Get_Usage_Based_Transactions_Response
This element is the wrapper around a list of elements representing the Usage Based Transaction-specific criteria.
 
Parameter name Type/Value Cardinality Description Validations
Contracts_Reference  Customer_ContractObject  [0..*]  Contracts used as criteria for selecting Usage Based Transactions.   
Customers_Reference  CustomerObject  [0..*]  Customers used as criteria for selecting Usage Based Transactions.   
Start_Transaction_Date  date  [0..1]  The start date used as criteria for selecting Usage Based Transactions.   
End_Transaction_Date  date  [0..1]  The end date used as criteria for selecting Usage Based Transactions.   
Validation Description
You can specify Customer Contracts or Customers but not both.   
top
 

Customer_ContractObject

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

Customer_ContractObjectID

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

CustomerObject

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

CustomerObjectID

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

part of: Get_Usage_Based_Transactions_Request, Get_Usage_Based_Transactions_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Usage Based Transaction response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Usage Based Transaction Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Usage_Based_Transactions_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_Based_Transaction_Response_Data

part of: Get_Usage_Based_Transactions_Response
Wrapper element containing Usage Based Transaction Response Data for requested references or criteria
 
Parameter name Type/Value Cardinality Description Validations
Usage_Based_Transaction  Usage_Based_Transaction  [0..*]  The response for a request for Usage Based Transaction data.   
top
 

Usage_Based_Transaction

part of: Usage_Based_Transaction_Response_Data
Wrapper Element containing a Usage Based Transaction Reference and all data for the single Usage Based Transaction.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Based_Transaction_Reference  Usage_Based_TransactionObject  [0..1]  The Usage Based Transaction for which data is returned.   
Usage_Based_Transaction_Data  Usage_Based_Transaction_Data  [0..*]  Contains all References and Attributes to represent a complete Usage Based Transaction. 
Validation Description
You can’t update a transaction that has already been submitted.   
The Contract Line Reference must be active, usage based, and valid for the Transaction Date.   
 
Amount_To_Bill  decimal (26, 6)   [0..1]  The Amount to Bill for the Usage Based Transaction.   
Currency_Reference  CurrencyObject  [0..1]  The Currency for the Usage Based Transaction.   
top
 

Usage_Based_Transaction_Data

part of: Usage_Based_Transaction
Contains all References and Attributes to represent a complete Usage Based Transaction.
 
Parameter name Type/Value Cardinality Description Validations
Usage_Based_Transaction_ID  string  [0..1]  Usage Based Transaction Reference ID. This is the Usage Based Transaction Unique Identifier.   
Transaction_Date  date  [0..1]  The Usage Based Transaction transaction date.   
Company_Reference  CompanyObject  [1..1]  The Company Reference for the Usage Based Transaction. 
Validation Description
Company must match the Company on the Contract Line.   
 
Contract_Line_Reference  Customer_Contract_LineObject  [0..1]  The Contract Line Reference for the Usage Based Transaction. This links the transaction to the rules that determine the price for the transaction.   
Customer_Reference  CustomerObject  [0..1]  The Customer Reference for the Usage Based Transaction. This should be used (with the Sales Item Reference) in cases where the Contract Line Reference is unknown at the time the request is submitted. The Contract Line Reference will be derived from the Customer and Sales Item References if a unique match is found.   
Sales_Item_Reference  Sales_ItemObject  [0..1]  The Sales Item Reference for the Usage Based Transaction. This should be used (with the Customer Reference) in cases where the Contract Line Reference is unknown at the time the request is submitted. The Contract Line Reference will be derived from the Customer and Sales Item References if a unique match is found.   
Description  string  [0..1]  The Description for the Usage Based Transaction.   
Quantity  decimal (22, 2)   [0..1]  The Quantity for the Usage Based Transaction.   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  The Unit of Measure for the Usage Based Transaction.   
Country_Reference  CountryObject  [0..1]  The Country in which the Usage Based Transaction occurred. This is used with the other address components to determine taxation, if applicable.   
Country_Region_Reference  Country_RegionObject  [0..1]  The Country Region in which the Usage Based Transaction occurred. This is used with the other address components to determine taxation, if applicable.   
City  string  [0..1]  The City in which the Usage Based Transaction occurred. This is used with the other address components to determine taxation, if applicable.   
Postal_Code  string  [0..1]  The Postal Code in which the Usage Based Transaction occurred. This is used with the other address components to determine taxation, if applicable.   
Validation Description
You can’t update a transaction that has already been submitted.   
The Contract Line Reference must be active, usage based, and valid for the Transaction Date.   
top
 

CompanyObject

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

Customer_Contract_LineObject

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

Sales_ItemObject

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

Sales_ItemObjectID

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

CountryObject

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

Country_RegionObject

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

Country_RegionObjectID

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

Usage_Based_TransactionReferenceEnumeration

part of: Usage_Based_TransactionObjectID
Base Type
string
top
 

Customer_ContractReferenceEnumeration

part of: Customer_ContractObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top