Service Directory > v32.1 > Resource_Management > Get_Prepaid_Spend_Amortizations
 

Operation: Get_Prepaid_Spend_Amortizations

This service operation will get Prepaid Spend Amortization for the specified criteria. Prepaid Spend Amortization data includes the Accounting Date and Supplier Invoice. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Prepaid Spend Amortization data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Prepaid_Spend_Amortization_Request_Criteria  [0..1]  Get Prepaid Spend Amortization Request Critiera   
Response_Filter  Response_Filter  [0..1]  Get Prepaid Spend Amortization Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Prepaid_Spend_Amortization_Response_Group  [0..1]  Get Prepaid Spend Amortization Response Group   
top
 

Response Element: Get_Prepaid_Spend_Amortizations_Response

Element containing Prepaid Spend Amortization response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Prepaid_Spend_Amortization_Request_Criteria  [0..1]  Get Prepaid Spend Amortization Request Critiera   
Response_Filter  Response_Filter  [0..1]  Get Prepaid Spend Amortization Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Prepaid_Spend_Amortization_Response_Group  [0..1]  Element containing Prepaid Spend Amortization response grouping options   
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_Response_Data  [0..1]  Wrapper Element that includes Prepaid Spend Amortization Instance and Data   
top
 

Prepaid_Spend_Amortization_Request_Criteria

part of: Get_Prepaid_Spend_Amortizations_Request, Get_Prepaid_Spend_Amortizations_Response
Element containing Prepaid Spend Amortization request criteria
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Invoice_Reference  Supplier_InvoiceObject  [0..1]  Reference to an existing Supplier Invoice for the Prepaid Spend Amortization   
top
 

Supplier_InvoiceObject

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

Response_Filter

part of: Get_Prepaid_Spend_Amortizations_Request, Get_Prepaid_Spend_Amortizations_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Prepaid_Spend_Amortization_Response_Group

part of: Get_Prepaid_Spend_Amortizations_Request, Get_Prepaid_Spend_Amortizations_Response
Element containing Prepaid Spend Amortization response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Prepaid_Spend_Amortizations_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_Response_Data

part of: Get_Prepaid_Spend_Amortizations_Response
Wrapper Element that includes Prepaid Spend Amortization Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization  Prepaid_Spend_Amortization  [0..*]  Prepaid Spend Amortization   
top
 

Prepaid_Spend_Amortization

part of: Prepaid_Spend_Amortization_Response_Data
Wrapper Element that includes Prepaid Spend Amortization Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Prepaid_Spend_Amortization_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Prepaid Spend Amortization   
Prepaid_Spend_Amortization_Data  Prepaid_Spend_Amortization_Data  [0..*]  Element containing all Prepaid Spend Amortization data   
top
 

Unique_IdentifierObject

part of: Prepaid_Spend_Amortization
 
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_Data

part of: Prepaid_Spend_Amortization
Element containing all Prepaid Spend Amortization data
 
Parameter name Type/Value Cardinality Description Validations
Accounting_Date  date  [1..1]  Accounting Date of the Prepaid Spend Amotization   
Supplier_Invoice_Reference  Supplier_InvoiceObject  [1..1]  Reference to an existing Supplier Invoice for the Prepaid Spend Amortization 
Validation Description
To Submit Prepaid Spend Amortization, the referenced Supplier Invoice must be approved, paid, prepaid option true and a manual release type.   
 
top
 

Supplier_InvoiceReferenceEnumeration

part of: Supplier_InvoiceObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top