Service Directory > v32.1 > Resource_Management > Get_Prepaid_Spend_Amortization_Schedules
 

Operation: Get_Prepaid_Spend_Amortization_Schedules

This will retrieve a set of prepaid spend amortization schedules with their installments. A criteria can be given.


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

Specify which criteria to use to find all the requested schedules.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Prepaid_Spend_Amortization_Schedule_Request_References  [0..1]  List all the references to the schedules that should be returned.   
top
 

Response Element: Get_Prepaid_Spend_Amortization_Schedules_Response

The complete response. It shows the references used in the search along with the results.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Prepaid_Spend_Amortization_Schedule_Request_References  [0..1]  List all the references to the schedules that should be returned.   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Prepaid_Spend_Amortization_Schedule_Response_Data  [0..1]  A list of all the schedules that were found.   
top
 

Prepaid_Spend_Amortization_Schedule_Request_References

part of: Get_Prepaid_Spend_Amortization_Schedules_Request, Get_Prepaid_Spend_Amortization_Schedules_Response
List all the references to the schedules that should be returned.
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Schedule_Reference  Prepaid_Spend_Amortization_ScheduleObject  [1..*]  A set of references to schedules to return.   
top
 

Prepaid_Spend_Amortization_ScheduleObject

part of: Prepaid_Spend_Amortization_Schedule_Request_References, Prepaid_Spend_Amortization_Schedule
 
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
 

Response_Results

part of: Get_Prepaid_Spend_Amortization_Schedules_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Prepaid_Spend_Amortization_Schedule_Response_Data

part of: Get_Prepaid_Spend_Amortization_Schedules_Response
A list of all the schedules that were found.
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Schedule  Prepaid_Spend_Amortization_Schedule  [0..*]  One schedule that was found along with the installments.   
top
 

Prepaid_Spend_Amortization_Schedule

part of: Prepaid_Spend_Amortization_Schedule_Response_Data
One schedule that was found along with the installments.
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Schedule_Reference  Prepaid_Spend_Amortization_ScheduleObject  [0..1]  The reference of this schedule.   
Prepaid_Spend_Amortization_Schedule  Prepaid_Spend_Amortization_Schedule_Data  [0..*]  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]   
 
top
 

Prepaid_Spend_Amortization_Schedule_Data

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

Prepaid_Spend_Amortization_ScheduleReferenceEnumeration

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