Service Directory > v32.1 > Revenue_Management > Put_Deferred_Cost_Schedule
 

Operation: Put_Deferred_Cost_Schedule

This service operation will add or update Deferred Cost Schedules.


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

Element containing Deferred Cost Schedule reference for update and all Deferred Cost Schedule data items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Deferred_Cost_Schedule_Reference  Deferred_Cost_ScheduleObject  [0..1]  Deferred Cost Schedule Reference   
Deferred_Cost_Schedule_Data  Deferred_Cost_Schedule_Data  [1..1]  Element Container for Deferred Cost Schedule Data 
Validation Description
Please set the Amortization Method to Custom if you are adding or updating installments.   
Please add only valid Deferred Cost Transactions to the schedule based on the Company, Currency and Customer.   
 
Validation Description
The web service is set to add only, but the Deferred Cost Schedule already exists.   
top
 

Response Element: Put_Deferred_Cost_Schedule_Response

Element contains Put Deferred Cost Schedule Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Deferred_Cost_Schedule_Reference  Deferred_Cost_ScheduleObject  [0..1]  Reference to an existing Deferred Cost Schedule   
top
 

Deferred_Cost_ScheduleObject

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

Deferred_Cost_ScheduleObjectID

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

Deferred_Cost_Schedule_Data

part of: Put_Deferred_Cost_Schedule_Request
Element Container for Deferred Cost Schedule Data
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Cost_Schedule_Reference_ID  string  [0..1]  Deferred Cost Schedule Reference ID. This is the unique Deferred Cost Schedule identifier.   
Submit  boolean  [0..1]  Submit   
Schedule_Status_Reference  Document_StatusObject  [0..*]  Reference element representing the schedule status.   
Company_Reference  CompanyObject  [1..1]  Reference element representing the schedule company.   
Currency_Reference  CurrencyObject  [1..1]  Reference element representing the currency.   
Customer_Reference  CustomerObject  [0..1]  Reference element representing the Customer.   
Customer_Contract_Reference  Customer_ContractObject  [0..*]  Reference element representing the Deferred Cost Schedule.   
Transaction_Date_Start_Date  date  [0..1]  Transaction Start Date.   
Transaction_Date_End_Date  date  [0..1]  Transaction End Date.   
Schedule_Description  string  [0..1]  Schedule Description.   
Schedule_On_Hold  boolean  [0..1]  Schedule On Hold flag.   
Deferred_Cost_Amortization_Method_Reference  Schedule_Distribution_MethodObject  [1..1]  Reference element representing the Amortization Method.   
Frequency_Reference  Frequency_BehaviorObject  [1..1]  Reference element representing the Deferred Cost Schedule frequency.   
From_Date  date  [0..1]  From date. The system generates installments based on this value.   
To_Date  date  [0..1]  To date. The system generates installments based on this value.   
Number_of_Installments  decimal (12, 0) >0   [0..1]  Number of installments. The system generates installments based on this value.   
Lines_Reference  Deferred_Cost_AbstractObject  [0..*]  Reference element representing instances Invoice Lines linked to this schedule.   
Deferred_Cost_Installment_Data  Deferred_Cost_Installment_Data  [0..*]  Element Container for Deferred Cost Installment Data 
Validation Description
To Date must be greater than From Date.   
You may not update installments with status Canceled, Completed, or In Progress.   
There must be at least one Installment Line.   
 
Validation Description
Please set the Amortization Method to Custom if you are adding or updating installments.   
Please add only valid Deferred Cost Transactions to the schedule based on the Company, Currency and Customer.   
top
 

Document_StatusObject

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

Document_StatusObjectID

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

CompanyObject

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

CurrencyObject

part of: Deferred_Cost_Schedule_Data, Deferred_Cost_Installment_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
 

CustomerObject

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

Customer_ContractObject

part of: Deferred_Cost_Schedule_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_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
 

Schedule_Distribution_MethodObject

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

Frequency_BehaviorObject

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

Deferred_Cost_AbstractObject

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

Deferred_Cost_AbstractObjectID

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

Deferred_Cost_Installment_Data

part of: Deferred_Cost_Schedule_Data
Element Container for Deferred Cost Installment Data
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Cost_Installment_Reference_ID  string  [0..1]  Deferred Cost Installment Reference ID. This is the unique Deferred Cost Installment identifier.   
Deferred_Cost_Installment_Reference  Deferred_Cost_InstallmentObject  [0..1]  Reference to an existing Deferred Cost Installment.   
Status_Reference  Document_StatusObject  [0..*]  Reference element representing the Installment Status.   
Installment_Date  date  [1..1]  Installment Date.   
From_Date  date  [0..1]  From date. The system generates installments based on this value.   
To_Date  date  [0..1]  To date. The system generates installments based on this value.   
On_Hold  boolean  [0..1]  Installment On Hold flag   
Total_Amount  decimal (26, 6)   [0..1]  Total amount for the Installment.   
Currency_Reference  CurrencyObject  [0..1]  Reference element representing the installment currency.   
Journal_Reference  Unique_IdentifierObject  [0..1]  Reference element representing the Journal for View Accounting.   
Deferred_Cost_Installment_Line_Data  Deferred_Cost_Installment_Line_Data  [0..*]  Element Container for Deferred Cost Installment Line Data 
Validation Description
Installment Line Amount must not equal to 0.   
Invalid Deferred Cost Transaction for the Installment Line.   
 
Validation Description
To Date must be greater than From Date.   
You may not update installments with status Canceled, Completed, or In Progress.   
There must be at least one Installment Line.   
top
 

Deferred_Cost_InstallmentObject

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

Deferred_Cost_InstallmentObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Deferred_Cost_Installment_Line_Data

part of: Deferred_Cost_Installment_Data
Element Container for Deferred Cost Installment Line Data
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Cost_Installment_Line_Reference_ID  string  [0..1]  Deferred Cost Installment Line Reference ID. This is the unique Deferred Cost Installment Line identifier.   
Line_Reference  Deferred_Cost_AbstractObject  [0..1]  Reference to an existing Deferred Cost Abstract.   
Deferred_Cost_Installment_Line_Reference  Deferred_Cost_Installment_LineObject  [0..1]  Reference to an existing Deferred Cost Installment Line.   
Description  string  [0..1]  Deferred Cost Schedule Description.   
From_Date  date  [0..1]  Installment Line Start Date.   
To_Date  date  [0..1]  Installment Line End Date.   
Amount  decimal (26, 6)   [0..1]  Installment Line Amount.   
Worktag_Reference  Accounting_WorktagObject  [0..*]  Reference element representing the Worktags for Customer Installment Item. 
Validation Description
Only one worktag of each type is allowed   
[list of worktag types] not valid for this transaction.   
 
Validation Description
Installment Line Amount must not equal to 0.   
Invalid Deferred Cost Transaction for the Installment Line.   
top
 

Deferred_Cost_Installment_LineObject

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

Deferred_Cost_Installment_LineObjectID

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

Accounting_WorktagObject

part of: Deferred_Cost_Installment_Line_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, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_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_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_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, Job_Requisition_ID, Lease_Expense_Recognition_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_Income_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, Position_Time_Type_ID, Program_ID, Program_of_Study_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, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_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
 

Deferred_Cost_ScheduleReferenceEnumeration

part of: Deferred_Cost_ScheduleObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Customer_ContractReferenceEnumeration

part of: Customer_ContractObjectID
Base Type
string
top
 

Schedule_Distribution_MethodReferenceEnumeration

part of: Schedule_Distribution_MethodObjectID
Base Type
string
top
 

Frequency_BehaviorReferenceEnumeration

part of: Frequency_BehaviorObjectID
Base Type
string
top
 

Deferred_Cost_AbstractReferenceEnumeration

part of: Deferred_Cost_AbstractObjectID
Base Type
string
top
 

Deferred_Cost_InstallmentReferenceEnumeration

part of: Deferred_Cost_InstallmentObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Deferred_Cost_Installment_LineReferenceEnumeration

part of: Deferred_Cost_Installment_LineObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top