Service Directory > v25.1 > Revenue_Management > Put_Sales_Item
 

Operation: Put_Sales_Item

This service operation will add or update Sales Items. Sales items are goods and services which a company sells. Sales Item data includes Sales Item ID, Item Name, Revenue Category, Item Description, Item Identifier, Unit of Measure, Unit Price, Currency, Tax Applicability, Sales Item Group.


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

Element containing Sales Item reference for update and all Sales Item data items
 
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.   
Sales_Item_Reference  Sales_ItemObject  [0..1]  Reference to an existing Sales Item for update only purposes   
Sales_Item_Data  Sales_Item_Data  [1..1]  Sales Item Data 
Validation Description
If the Item Unit Price, VSOE Price, Esitmated Selling Price, or Third Party Evidence is specified, then the Currency must also be specified.   
Revenue Category is required field except for Sales Item that is a basic worktag only.   
Only the Sales Item Name, Inactive, and Basic Worktag Only attributes can be entered for a Sales Item that is a basic worktag only.   
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated.  Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated. 
Some of the Worktag Types of the Worktags selected are not valid for Sales Item.   
Only one worktag of each type is allowed   
Cannot use inactive Revenue Category   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
An inactive purchase item cannot map to a sales item.   
Purchase Item is already mapped by another Sales Item.   
An inactive sales item cannot map to a purchase item.   
Remove the Purchase item mapping before you inactivate the item   
 
Validation Description
The Web Service is set to Add Only; but the Sales Item already exists.   
top
 

Response Element: Put_Sales_Item_Response

Element containing Put Sales Item Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Sales_Item_Reference  Sales_ItemObject  [0..1]  This is the reference id value of the sales item. If a value is provided for sales item, revenue category will default so it is recommended to provide a value for either sales item or revenue category but not both.   
top
 

Sales_ItemObject

part of: Put_Sales_Item_Request, Put_Sales_Item_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  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
 

Sales_Item_Data

part of: Put_Sales_Item_Request
Element containing all Sales Item data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_ID  string  [0..1]  Sales Item ID. This is the Sales Item unique identifier   
Item_Name  string  [1..1]  Free form text for a meaningful Sales Item Name 
Validation Description
Sales item name is already used.   
 
Inactive  boolean  [0..1]  Boolean to indicate a Sales Item that is Inactive.   
Worktag_Only  boolean  [0..1]  Boolean to indicate if the sales item is only used as a worktag value. If set to true, the sales item will not be available as a selection in sales item fields on financial transactions like Customer Invoices.   
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Reference to an existing Spend Category. A Spend Category is a classification of items and services that drive the accounting. All sales items are associated with a Revenue Category and expense items are associated with a Spend Category.   
Item_Description  string  [0..1]  Free form text providing a detailed Item Description   
Item_Identifier  string  [0..1]  Free form text for an Item Identifier. This is not a Workday Reference ID   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference to an existing Unit of Measure   
Unit_of_Measure_2_Reference  Unit_of_MeasureObject  [0..1]  Reference to an existing Unit of Measure. This reference is for the secondary Unit of Measure for the item, usually a measure of time, such as hours or months. 
Validation Description
Unit of Measure 2 can only be provided if the first Unit of Measure is provided.  Unit of Measure 2 can only be provided if the first Unit of Measure is provided. 
 
Enable_Bulk_Quantity_Pricing  boolean  [0..1]  Enable Bulk Pricing Flag.Possible Values Y/N.   
Item_Unit_Price  decimal (26, 6)   [0..1]  Item Unit Price 
Validation Description
When Contract Line Type is Variable and there is a Unit Price, Unit of Measure is not expected to be blank.  When Contract Line Type is Variable and there is a Unit Price, Unit of Measure is not expected to be blank. 
Unit Price must be greater than or equal to zero.   
 
Currency_Reference  CurrencyObject  [0..1]  Reference to the currency of the company. If entered, this field is not processed on inbound Workday Web Services requests.   
UOM_Priced_at_Quantities_of  decimal (18, 0) >0   [0..1]  Bulk Quantity Divisor for Quantity   
Tax_Applicability_Reference  Tax_ApplicabilityObject  [0..1]  This is the reference id value of the tax applicability. If this is blank and there invoice line has a sales item, Workday will default tax applicability from the sales item. If the invoice line has a tax code then tax applicability is required.   
Sales_Item_Group_Reference  Sales_Item_GroupObject  [0..*]  Reference to an existing Sales Item Group   
Project_Template_Reference  Project_TemplateObject  [0..1]  Reference to an existing Project Template.   
Deferred_Revenue  boolean  [0..1]  Indicates if the Sales Item can be deferred for revenue recognition.   
Revenue_Recognition_Method_Reference  Schedule_Distribution_MethodObject  [0..1]  Returns the Revenue Recognition Method related to the Sales Item.   
VSOE_Price  decimal (26, 6) >0   [0..1]  The amount for VSOE Price for the Sales Item.   
Third_Party_Evidence  decimal (26, 6) >0   [0..1]  The amount for Third Party Evidence for the Sales Item.   
Estimated_Selling_Price  decimal (26, 6) >0   [0..1]  The amount for Esitmated Selling Price for the Sales Item.   
Price_Type_Reference  Contract_Line_TypeObject  [0..1]  References the amount type of the Sales Item. Indicates if it is a Fixed Amount, Recurring, or Activity-Based.   
Related_Worktags_Reference  Accounting_WorktagObject  [0..*]  References the related worktags for the Sales Item. These worktags get pulled in when the Sales Item is referenced.   
Maps_to_Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Reference to Purchase Item being mapped.   
Validation Description
If the Item Unit Price, VSOE Price, Esitmated Selling Price, or Third Party Evidence is specified, then the Currency must also be specified.   
Revenue Category is required field except for Sales Item that is a basic worktag only.   
Only the Sales Item Name, Inactive, and Basic Worktag Only attributes can be entered for a Sales Item that is a basic worktag only.   
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated.  Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated. 
Some of the Worktag Types of the Worktags selected are not valid for Sales Item.   
Only one worktag of each type is allowed   
Cannot use inactive Revenue Category   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
An inactive purchase item cannot map to a sales item.   
Purchase Item is already mapped by another Sales Item.   
An inactive sales item cannot map to a purchase item.   
Remove the Purchase item mapping before you inactivate the item   
top
 

Revenue_CategoryObject

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

Revenue_CategoryObjectID

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

CurrencyObject

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

Tax_ApplicabilityObject

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

Tax_ApplicabilityObjectID

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

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

Sales_Item_GroupObjectID

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

Project_TemplateObject

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

Project_TemplateObjectID

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

Schedule_Distribution_MethodObject

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

Schedule_Distribution_MethodObjectID

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

Contract_Line_TypeObject

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

Contract_Line_TypeObjectID

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Unit_ID, Catalog_Item_ID, Company_Reference_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Expense_Item_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Program_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Assignment_Line_Item_ID, Student_Charge_Item_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Supplier_Category_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Third_Party_ID, Withholding_Order_Case_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_Type_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
 

Purchase_ItemObject

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

Purchase_ItemObjectID

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

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Tax_ApplicabilityReferenceEnumeration

part of: Tax_ApplicabilityObjectID
Base Type
string
top
 

Sales_Item_GroupReferenceEnumeration

part of: Sales_Item_GroupObjectID
Base Type
string
top
 

Project_TemplateReferenceEnumeration

part of: Project_TemplateObjectID
Base Type
string
top
 

Schedule_Distribution_MethodReferenceEnumeration

part of: Schedule_Distribution_MethodObjectID
Base Type
string
top
 

Contract_Line_TypeReferenceEnumeration

part of: Contract_Line_TypeObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top