Service Directory > v32.1 > Revenue_Management > Submit_Customer_Refund
 

Operation: Submit_Customer_Refund

Web service task to create and submit 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: Submit_Customer_Refund_Request

Customer Refund Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag.   
Customer_Refund_Reference  Customer_RefundObject  [0..1]  Customer Refund Reference   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Contains data for business processing   
Customer_Refund_Data  Customer_Refund_Data  [0..1]  Element contains all Customer Refund Data, if requested via Response Group 
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].   
 
Validation Description
The Web Service is set to Add Only; but the Customer Refund already exists.  Create a new Customer Refund, or change 'Add Only' to 'false' to edit the Customer Refund. 
top
 

Response Element: Submit_Customer_Refund_Response

Submit Customer Refund Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Refund_Reference  Customer_RefundObject  [0..1]  Customer Refund Reference   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Customer_RefundObject

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

Financials_Business_Process_Parameters

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

Customer_Refund_Data

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

Application_Instance_Related_Exceptions_Data

part of: Submit_Customer_Refund_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Customer_RefundReferenceEnumeration

part of: Customer_RefundObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

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