Service Directory > v32.1 > Resource_Management > Get_Cash_Advance_Repayments
 

Operation: Get_Cash_Advance_Repayments

Returns Cash Advance Repayments for the specified criteria.


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

This element is the top-level request element for all Cash Advance Repayment "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Cash_Advance_Repayment_Request_References  [0..1]  Cash Advance Repayment Reference element contains the specific Cash Advance Repayment requested. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the reference to the Cash Advance Repayment.   
Request_Criteria [Choice]   Cash_Advance_Repayment_Request_Criteria  [0..1]  Request criteria for retrieving specific Cash Advance Repayment objects   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Cash_Advance_Repayment_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Cash Advance Repayment response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Cash_Advance_Repayments_Response

Element containing Cash Advance Repayment response elements including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Cash_Advance_Repayment_Request_References  [0..1]  Cash Advance Repayment Reference element contains the specific Cash Advance Repayment requested. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the reference to the Cash Advance Repayment.   
Request_Criteria  Cash_Advance_Repayment_Request_Criteria  [0..1]  Request criteria for retrieving specific Cash Advance Repayment objects   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Cash_Advance_Repayment_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Cash Advance Repayment response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Cash_Advance_Repayment_Response_Data  [0..1]  Wrapper element containing Cash Advance Repayment response data for requested references or criteria and for requested response group   
top
 

Cash_Advance_Repayment_Request_References

part of: Get_Cash_Advance_Repayments_Request, Get_Cash_Advance_Repayments_Response
Cash Advance Repayment Reference element contains the specific Cash Advance Repayment requested. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the reference to the Cash Advance Repayment.
 
Parameter name Type/Value Cardinality Description Validations
Cash_Advance_Repayment_Reference  Cash_Advance_RepaymentObject  [1..*]  Business Object containing the Cash Advance Repayment   
top
 

Cash_Advance_RepaymentObject

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

Cash_Advance_RepaymentObjectID

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

Cash_Advance_Repayment_Request_Criteria

part of: Get_Cash_Advance_Repayments_Request, Get_Cash_Advance_Repayments_Response
Request criteria for retrieving specific Cash Advance Repayment objects
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Cash_Advance_Repayment_Response_Group

part of: Get_Cash_Advance_Repayments_Request, Get_Cash_Advance_Repayments_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Cash Advance Repayment response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Cash Advance Repayment Reference data is to be included in the response   
top
 

Response_Results

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

Cash_Advance_Repayment_Response_Data

part of: Get_Cash_Advance_Repayments_Response
Wrapper element containing Cash Advance Repayment response data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Cash_Advance_Repayment  Cash_Advance_Repayment  [0..*]  Cash Advance Repayment contains all of the information about a Cash Advance Repayment   
top
 

Cash_Advance_Repayment

part of: Cash_Advance_Repayment_Response_Data
Cash Advance Repayment contains all of the information about a Cash Advance Repayment
 
Parameter name Type/Value Cardinality Description Validations
Cash_Advance_Repayment_Reference  Cash_Advance_RepaymentObject  [0..1]  Reference to a specific Cash Advance Repayment   
Company_Reference  CompanyObject  [0..1]  Company for Cash Advance Repayment   
Spend_Authorization_Reference  Spend_AuthorizationObject  [0..1]  Required field representing the Spend Authorization being repaid by the Cash Advance Repayment.   
Expense_Payee_Reference  Expense_PayeeObject  [0..1]  Reference to the person who the cash advance repayment is for.   
Expense_Payee_Type_Reference  Payee_TypeObject  [0..1]  The Expense Payee Type on the Spend Authorization - Employee, Contingent Worker, or External Committee Member.   
Repayment_Date  date  [0..1]  The date the Cash Advance Repayment is being recorded   
Repayment_Amount  decimal (18, 3) >0   [0..1]  Amount being repaid with this Cash Advance Repayment   
Currency_Reference  CurrencyObject  [0..1]  Currency for the Cash Advance Repayment. Restricted to Company or Spend Authorization currency   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type for the Cash Advance Repayment   
Repayment_Reference  string  [0..1]  Reference information for the Cash Advance Repayment   
Memo  string  [0..1]  Memo for Cash Advance Repayment   
Credit_to_Expense_Advance_Account  string  [0..1]  Amount to Credit Expense Advance Account   
Balancing_Worktag_Reference  Balancing_WorktagObject  [0..1]  Reference to Balancing Worktag   
Currency_Exchange_Gain__Loss__to_Record  string  [0..1]  Currency Gain (Loss) to Record   
top
 

CompanyObject

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

Spend_AuthorizationObject

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

Spend_AuthorizationObjectID

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

Expense_PayeeObject

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

Expense_PayeeObjectID

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

Payee_TypeObject

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

Payee_TypeObjectID

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

CurrencyObject

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

Payment_TypeObject

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

Payment_TypeObjectID

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

Balancing_WorktagObject

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

Balancing_WorktagObjectID

part of: Balancing_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Fund_ID, Organization_Reference_ID, Region_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
 

Cash_Advance_RepaymentReferenceEnumeration

part of: Cash_Advance_RepaymentObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Spend_AuthorizationReferenceEnumeration

part of: Spend_AuthorizationObjectID
Base Type
string
top
 

Expense_PayeeReferenceEnumeration

part of: Expense_PayeeObjectID
Base Type
string
top
 

Payee_TypeReferenceEnumeration

part of: Payee_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Balancing_WorktagReferenceEnumeration

part of: Balancing_WorktagObjectID
Base Type
string
top