Service Directory > v25.1 > Revenue_Management > Put_Usage_Based_Transaction
 

Operation: Put_Usage_Based_Transaction

This service operation will add or update Usage Based Transactions. Usage Based Transaction Data includes Usage Based Transaction Reference ID, transaction date, quantity, unit of measure, location information (country/region/city/postal code), description, and contract line (or customer and sales item if contract line is not known).


@ - 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: Put_Usage_Based_Transaction_Request

Element containing Usage Based Transaction reference for update (or empty if a new Usage Based Transaction is being added).
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Usage_Based_Transaction_Reference  Usage_Based_TransactionObject  [0..1]  Reference to an existing Usage Based Transaction for update purposes only.   
Usage_Based_Transaction_Data  Usage_Based_Transaction_Data  [1..1]  Usage Based Transaction Data for the single usage based transaction being created or updated. 
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.   
 
Validation Description
The Web Service is set to Add Only, but the Usage Based Transaction already exists.  Flag as an error the condition where an already-existing usage based transaction is sent in add-only mode. 
top
 

Response Element: Put_Usage_Based_Transaction_Response

Element containing Put Usage Based Transaction Response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Usage_Based_Transaction_Reference  Usage_Based_TransactionObject  [0..1]  Reference to the Usage Based Transaction that was created or updated by this Put operation.   
top
 

Usage_Based_TransactionObject

part of: Put_Usage_Based_Transaction_Request, Put_Usage_Based_Transaction_Response
 
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_Data

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

CustomerObject

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

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
 

Usage_Based_TransactionReferenceEnumeration

part of: Usage_Based_TransactionObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

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