Service Directory > v32.1 > Revenue_Management > Get_Customer_Refunds
 

Operation: Get_Customer_Refunds

Get Customer Refunds


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

This element is the top-level request element for all Customer Refund "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Customer_Refund_Request_References  [0..1]  This element is the top-level request element for all Customer Refund "Get" operations   
Request_Criteria [Choice]   Customer_Refund_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Customer Refund specific criteria needed to search for instances.   
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Refund_Response_Group  [0..1]  Element content containing Customer Refund Response Group element   
top
 

Response Element: Get_Customer_Refunds_Response

Element containing Customer Refund 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  Customer_Refund_Request_References  [0..1]  This element contains the echoed Customer Refund Reference as received by the request   
Request_Criteria  Customer_Refund_Request_Criteria  [0..1]  This element content contains the element that is used as a wrapper element around a list of elements representing the Customer Refund specific criteria needed to search for instances. All of the elements are "AND" conditions.   
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Refund_Response_Group  [0..1]  Element content containing Customer Refund Response Group element   
Response_Results  Response_Results  [0..1]  Element content containing Customer Refund Response Results   
Response_Data  Customer_Refund_Response_Data  [0..1]  Element containing Customer Refund response data   
top
 

Customer_Refund_Request_References

part of: Get_Customer_Refunds_Request, Get_Customer_Refunds_Response
This contains the specific instance set containing the requested Customer Refund. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Refund_Reference  Customer_RefundObject  [1..*]  This element content contains the Customer Refund reference element used to return the Customer Refund by unique identifier   
top
 

Customer_RefundObject

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

Customer_RefundObjectID

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

part of: Get_Customer_Refunds_Request, Get_Customer_Refunds_Response
This element is the wrapper around a list of elements representing the Customer Refund specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference  EventObject  [0..1]  Event Reference.   
top
 

EventObject

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

EventObjectID

part of: EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assign_Pay_Group_Event_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Quick_Issue_Reference_ID, Receipt_Number, Reorganization_ID, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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_Customer_Refunds_Request, Get_Customer_Refunds_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
 

Customer_Refund_Response_Group

part of: Get_Customer_Refunds_Request, Get_Customer_Refunds_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Customer Refund 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 Customer Refund Reference data is to be included in the response   
Include_Customer_Refund_Data  boolean  [0..1]  Flag indicating if the Customer Refund data is to be included in the response   
Include_Customer_Invoice_Document_Data  boolean  [0..1]  Flag indicating if the Invoice Document data for the Customer Refund is to be included in the response   
Include_Customer_Invoice_Line_Data  boolean  [0..1]  Flag indicating if the Invoice Document Line data for Invoice for the Customer Refund is to be included in the response   
top
 

Response_Results

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

Customer_Refund_Response_Data

part of: Get_Customer_Refunds_Response
Wrapper element containing Customer Refund Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Customer_Refund  Customer_Refund  [0..*]  Element content containing Customer Refund element   
top
 

Customer_Refund

part of: Customer_Refund_Response_Data
Element containing Customer Refund Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Customer_Refund_Reference  Customer_RefundObject  [0..1]  Customer Refund Reference   
Customer_Refund_Data  Customer_Refund_Data  [0..*]  Customer Refund Data 
Validation Description
The Customer Refund selected is not available for editing. You may only edit customer refunds that are in 'Draft' status.   
Please select at least one item to refund.   
The following selected customer payments are currently part of another refund that is in progress or complete: [pay].   
The following selected customer invoice adjustments are currently part of another refund that is in progress or complete: [adj].   
 
top
 

Customer_Refund_Data

part of: Customer_Refund
Element contains all Customer Refund Data, if requested via Response Group
 
Parameter name Type/Value Cardinality Description Validations
Customer_Refund_Reference_ID  string  [0..1]  Customer Refund reference ID   
Submit  boolean  [0..1]  Submit flag. Leaving this blank (or setting it to false) will save the customer refund for later.   
Company_Reference  CompanyObject  [1..1]  Company Reference   
Customer_Reference  Billable_EntityObject  [1..1]  Customer Reference   
Currency_Reference  CurrencyObject  [1..1]  Currency for Company   
Customer_Refund_Date  date  [1..1]  Date of Customer Refund   
Total_Refund_Amount  decimal (18, 3)   [0..1]  The total amount included in this Refund. This field is read-only, and will be ignored if populated on Submit Customer Refund.   
Memo  string  [0..1]  Memo   
Payee_Reference  Billable_EntityObject  [0..1]  A reference to a Customer the refund should be paid to. If not provided, will be defaulted to the same customer as the Customer Reference field.   
Payment_Type_Reference  Payment_TypeObject  [1..1]  Payment Type Reference   
Credit_Card_Profile_Reference  Customer_Credit_Card_Profile_AbstractObject  [0..1]  Credit Card Profile Reference 
Validation Description
A credit card profile is required for payments of type 'Credit Card.'  A credit card profile is required for payments of type 'Credit Card.' 
You must select 'Credit Card' as the payment type if you want to specify a credit card profile.  You must select 'Credit Card' as the payment type if you want to specify a credit card profile. 
 
On_Account_Payments  Customer_Unapplied_Payment_Refund_Subedit_Data  [0..*]  On Account Payments   
Invoice_Adjustments  Customer_Invoice_Adjustment_Refund_Subedit_Data  [0..*]  Invoice Adjustments   
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The Customer Refund selected is not available for editing. You may only edit customer refunds that are in 'Draft' status.   
Please select at least one item to refund.   
The following selected customer payments are currently part of another refund that is in progress or complete: [pay].   
The following selected customer invoice adjustments are currently part of another refund that is in progress or complete: [adj].   
top
 

CompanyObject

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

Billable_EntityObject

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

Billable_EntityObjectID

part of: Billable_EntityObject
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, Sponsor_ID, Sponsor_Reference_ID, Student_Financial_Account_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: Customer_Refund_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
 

Payment_TypeObject

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

Customer_Credit_Card_Profile_AbstractObject

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

Customer_Credit_Card_Profile_AbstractObjectID

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

part of: Customer_Refund_Data
Element containing unapplied payment reference for customer refund.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Payment_Reference  Customer_PaymentObject  [0..1]  Customer Payment Reference 
Validation Description
The provided Customer Payment is not valid for the provided Customer Refund.   
 
top
 

Customer_PaymentObject

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

Customer_PaymentObjectID

part of: Customer_PaymentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cash_Sale_ID, Customer_Payment_for_Invoices_Reference_ID, Student_Application_Fee_Payment_ID, Student_Disbursement_Payment_ID, Student_Historical_Payment_ID, Student_Payment_ID, Student_Sponsor_Payment_ID, Student_Waiver_Payment_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_Invoice_Adjustment_Refund_Subedit_Data

part of: Customer_Refund_Data
Element containing customer invoice adjustment reference for customer refund.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Invoice_Adjustment_Reference  Customer_Invoice_AdjustmentObject  [0..1]  Customer Invoice Adjustment Reference 
Validation Description
The provided Customer Invoice Adjustment is not valid for the provided Customer Refund.   
 
top
 

Customer_Invoice_AdjustmentObject

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

Customer_Invoice_AdjustmentObjectID

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

part of: Customer_Refund_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Customer_RefundReferenceEnumeration

part of: Customer_RefundObjectID
Base Type
string
top
 

EventReferenceEnumeration

part of: EventObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Customer_Credit_Card_Profile_AbstractReferenceEnumeration

part of: Customer_Credit_Card_Profile_AbstractObjectID
Base Type
string
top
 

Customer_PaymentReferenceEnumeration

part of: Customer_PaymentObjectID
Base Type
string
top
 

Customer_Invoice_AdjustmentReferenceEnumeration

part of: Customer_Invoice_AdjustmentObjectID
Base Type
string
top