Service Directory > v25.1 > Revenue_Management > Put_Revenue_Category
 

Operation: Put_Revenue_Category

This service operation will add or update Revenue Categories. Revenue Category data includes Revenue Category ID, Name and Tax Applicability.


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

Element containing Revenue Category reference for update and all Revenue Category 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.   
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Reference to an existing Revenue Category for update only purposes   
Revenue_Category_Data  Revenue_Category_Data  [1..1]  Revenue Category Data 
Validation Description
Some of the Worktag Types of the Worktags selected are not valid for Revenue Category.   
Only one worktag of each type is allowed   
Missing Required Worktags   
An inactive Spend Category cannot map to a Revenue Category.   
An inactive Revenue Category cannot map to a Spend Category.   
Remove the spend category mapping before you inactivate the revenue category   
Spend Category is already mapped by another Revenue Category.   
Only Spend Categories with Invoice Usage can be mapped to a Revenue Category.   
 
Validation Description
The Web Service is set to Add Only; but the Revenue Category already exists.   
top
 

Response Element: Put_Revenue_Category_Response

Element containing Put Revenue Category Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Reference to an existing Revenue Category   
top
 

Revenue_CategoryObject

part of: Put_Revenue_Category_Request, Put_Revenue_Category_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  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
 

Revenue_Category_Data

part of: Put_Revenue_Category_Request
Element containing all Revenue Category data
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Category_ID  string  [0..1]  Revenue Category Reference ID. This is the Revenue Category unique identifier   
Revenue_Category_Name  string  [1..1]  Free form text field for meaningful Revenue Category Name 
Validation Description
Enter a unique Revenue Category Name. [name] is already in use.  The Revenue Category entered has already been used. 
 
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.   
Related_Worktags_Reference  Accounting_WorktagObject  [0..*]  References the related worktags for the Revenue Cateogry. These worktags get pulled in when the Revenue Category is referenced.   
Revenue_Category_Inactive  boolean  [0..1]  Attribute that determines whether the Revenue Category appears in prompts and is usable in new Customer Invoices, Contract Lines, etc.   
Maps_to_Spend_Category_Reference  Spend_CategoryObject  [0..1]  Reference to Spend Category being mapped.   
Validation Description
Some of the Worktag Types of the Worktags selected are not valid for Revenue Category.   
Only one worktag of each type is allowed   
Missing Required Worktags   
An inactive Spend Category cannot map to a Revenue Category.   
An inactive Revenue Category cannot map to a Spend Category.   
Remove the spend category mapping before you inactivate the revenue category   
Spend Category is already mapped by another Revenue Category.   
Only Spend Categories with Invoice Usage can be mapped to a Revenue Category.   
top
 

Tax_ApplicabilityObject

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

Accounting_WorktagObject

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Tax_ApplicabilityReferenceEnumeration

part of: Tax_ApplicabilityObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top