Service Directory > v31.2 > Resource_Management > Submit_Prepaid_Spend_Amortization_Schedule
 

Operation: Submit_Prepaid_Spend_Amortization_Schedule

This creates custom schedules for prepaid spend amortizations. A reference to a supplier invoice or prepaid spend amortization schedule is required. You must create a prepaid spend amortization schedule for the supplier invoice using the Create Prepaid Spend Amortization Schedule task or the Submit Supplier Invoice web service.


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

The request for creating/updating a Prepaid Spend Amortization Schedule
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Prepaid_Spend_Amortization_Schedule_Reference [Choice]   Prepaid_Spend_Amortization_ScheduleObject  [0..1]  A reference to a Prepaid Spend Amortization Schedule. This is used to update an existing schedule. If this is entered, then the Supplier Invoice reference cannot. 
Validation Description
You can't use the Submit Prepaid Spend Amortization web service if you created the prepaid spend amortization schedule from an accounting adjustment.   
 
Supplier_Invoice_Reference [Choice]   Supplier_InvoiceObject  [0..1]  A reference to a Supplier Invoice. If this is used then the Prepaid Spend Amortization Schedule Reference cannot.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Contains data for business processing   
Prepaid_Spend_Amortization_Schedule_Data  Prepaid_Spend_Amortization_Schedule_Data  [0..1]  An element containing a set of installments. 
Validation Description
The number of installments submitted does not match the number of installments requested on the schedule.   
The total amounts of the installments must equal the amount of the invoice: [amt]   
The sum of the installment lines must equal the amount of the associated invoice line: [lines]   
 
Validation Description
Unable to proceed. A Supplier Invoice or Prepaid Spend Amortization Schedule must be referenced.   
top
 

Response Element: Submit_Prepaid_Spend_Amortization_Schedule_Response

The complete response from the get request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Prepaid_Spend_Amortization_Schedule_Reference  Prepaid_Spend_Amortization_ScheduleObject  [0..1]  The schedule returned by the search criteria.   
top
 

Prepaid_Spend_Amortization_ScheduleObject

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

Prepaid_Spend_Amortization_ScheduleObjectID

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

Supplier_InvoiceObject

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

Supplier_InvoiceObjectID

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

Financials_Business_Process_Parameters

part of: Submit_Prepaid_Spend_Amortization_Schedule_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Prepaid_Spend_Amortization_Schedule_Data

part of: Submit_Prepaid_Spend_Amortization_Schedule_Request
An element containing a set of installments.
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Schedule_ID [Choice]   string  [0..1]  The reference id of the prepaid spend amortization schedule. If this is entered, then the Supplier Invoice ID cannot.   
Supplier_Invoice_ID [Choice]   string  [0..1]  The reference id of the supplier invoice this schedule is connected to. If this is entered than the Schedule ID cannot.   
Prepaid_Spend_Amortization_Installment_Data  Prepaid_Spend_Amortization_Installment_Data  [1..*]  The set of installments that make up this schedule. 
Validation Description
Enter an installment reference ID to update existing Prepaid Spend Amortization Installments.   
Prepaid Spend Amortization Installment Reference provided doesn't belong to the Schedule.   
 
Validation Description
The number of installments submitted does not match the number of installments requested on the schedule.   
The total amounts of the installments must equal the amount of the invoice: [amt]   
The sum of the installment lines must equal the amount of the associated invoice line: [lines]   
top
 

Prepaid_Spend_Amortization_Installment_Data

part of: Prepaid_Spend_Amortization_Schedule_Data
Data representing one installment for the Prepaid Spend Amortization Schedule. An installment can be made up of many installment lines.
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Installment_Reference  Unique_IdentifierObject  [0..1]  The reference to the installment that is being updated.   
Accounting_Date  date  [1..1]  The date that accounting will use. This must match the start date.   
Prepaid_Spend_Amortization_Installment_Line_Data  Prepaid_Spend_Amortization_Installment_Line_Data  [1..*]  A set of lines that make up this installment   
Validation Description
Enter an installment reference ID to update existing Prepaid Spend Amortization Installments.   
Prepaid Spend Amortization Installment Reference provided doesn't belong to the Schedule.   
top
 

Unique_IdentifierObject

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

Prepaid_Spend_Amortization_Installment_Line_Data

part of: Prepaid_Spend_Amortization_Installment_Data
Data representing one installment line for an installment.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Line_Reference  Supplier_Invoice_Line_DistributionObject  [1..1]  The supplier invoice line this installment line references. The supplier invoice line can also be a split line. 
Validation Description
Referenced Supplier Invoice ([invoice]) does not match entered line: [invoice line].   
The selected Invoice Line is not Prepaid. Please select only prepaid lines for creating the Spend Amortization installments.   
 
Amount  decimal (26, 6)   [0..1]  The amount of the installment line.   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Accounting Worktags of the installment line. 
Validation Description
For supplier invoice lines tagged with a capital project worktag, the company of the invoice line must equal the company on the capital project.   
Transactions for contingent workers cannot have contingent worker worktags on lines. Please remove the contingent worker worktag.   
Company Selected: [comp] does not match on an Award Line in effect for Grant Worktag: [grant]   
You can't add or remove billable project worktags to installments on a prepaid spend amortization schedule.   
 
top
 

Supplier_Invoice_Line_DistributionObject

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

Supplier_Invoice_Line_DistributionObjectID

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

Prepaid_Spend_Amortization_ScheduleReferenceEnumeration

part of: Prepaid_Spend_Amortization_ScheduleObjectID
Base Type
string
top
 

Supplier_InvoiceReferenceEnumeration

part of: Supplier_InvoiceObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Supplier_Invoice_Line_DistributionReferenceEnumeration

part of: Supplier_Invoice_Line_DistributionObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top