Service Directory > v31.2 > Cash_Management > Submit_Ad_Hoc_Payment_from_Template
 

Operation: Submit_Ad_Hoc_Payment_from_Template

This service operation will create an Ad Hoc Payment using an Ad Hoc Payment Template and submit to the Ad Hoc Payment business process.


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

Request for Submit Ad Hoc Payment from Template
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Ad_Hoc_Payment_Data  Ad_Hoc_Payment_from_Template_Data  [1..1]  The data used to create an Ad Hoc Payment from Template.   
top
 

Response Element: Submit_Ad_Hoc_Payment_from_Template_Response

The response for Submit Ad hoc Payment from Template
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Ad_hoc_Payment_Reference  Ad_Hoc_PaymentObject  [0..1]  Ad hoc Payment Reference   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Exceptions Response Data   
top
 

Financials_Business_Process_Parameters

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

Ad_Hoc_Payment_from_Template_Data

part of: Submit_Ad_Hoc_Payment_from_Template_Request
The data used to create an Ad Hoc Payment from Template.
 
Parameter name Type/Value Cardinality Description Validations
Ad_Hoc_Payment_Template_Reference  Ad_Hoc_Payment_TemplateObject  [1..1]  Reference to an existing Ad hoc Payment Template 
Validation Description
You must select an approved Ad Hoc Payment Template that is not in progress.  You must select an approved Ad Hoc Payment Template that is not in progress. 
You must select an active Ad Hoc Payment Template.  You must select an active Ad Hoc Payment Template. 
You cannot take this action because you do not have access to the Bank Account referenced in this Ad Hoc Payment Template.  You cannot take this action because you do not have access to the Bank Account referenced in this Ad Hoc Payment Template. 
 
Submit  boolean  [0..1]  Submit for approval   
Ad_Hoc_Payment_ID  string  [0..1]  Ad hoc Payment ID 
Validation Description
The ID is already in use by an Ad Hoc Payment.   
 
Payment_Date  date  [1..1]  Payment Date   
Amount  decimal (18, 3) >0   [1..1]  This is the amount for the Ad Hoc Payment line.   
Memo  string  [0..1]  Payment Memo   
External_Reference  string  [0..1]  External Reference   
Addenda  string  [0..1]  Addenda   
Freight_Amount  decimal (26, 6) >0   [0..1]  Freight Amount 
Validation Description
If there are Freight Charges, then there must be at least one line with a Spend Category that has Allocate Freight.   
 
Other_Charges  decimal (26, 6) >0   [0..1]  Other Charges 
Validation Description
If there are Other Charges, then there must be at least one line with a Spend Category that has Allocate Other Charges.  If there are Other Charges, then there must be at least one line with a Spend Category that has Allocate Other Charges. 
 
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.   
 
top
 

Ad_Hoc_Payment_TemplateObject

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

Ad_Hoc_Payment_TemplateObjectID

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

Ad_Hoc_PaymentObject

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

Ad_Hoc_PaymentObjectID

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

Application_Instance_Related_Exceptions_Data

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Ad_Hoc_Payment_TemplateReferenceEnumeration

part of: Ad_Hoc_Payment_TemplateObjectID
Base Type
string
top
 

Ad_Hoc_PaymentReferenceEnumeration

part of: Ad_Hoc_PaymentObjectID
Base Type
string
top