Service Directory > v31.2 > Revenue_Management > Submit_Customer_Deposit
 

Operation: Submit_Customer_Deposit

Customer Deposit Web Service. Allows a new Customer Deposit to be created, or an existing Customer Deposit to be edited. Can be used as Public Web Service or for iLoads. Contains: Locked in Workday, Company, Currency, Payment Deposit Date, Bank Account, Deposit Reference Number, Control Total Amount


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

Element containing Customer Deposit reference for update and all Customer Deposit data items.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Customer_Deposit_Reference  Customer_DepositObject  [0..1]  Reference to an existing Customer Deposit for update only purposes.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters provide the ability to auto-submit to the business process.   
Customer_Deposit_Data  Customer_Deposit_Data  [1..1]  The Data element containing all Customer Deposit attributes. 
Validation Description
The Payment Deposit Date must be greater than the Payment Date for all Payments selected.  The Payment Deposit Date must be greater than the Payment Date for all Payments selected. 
The sum of deposits selected does not equal the control total amount.  The sum of deposits selected does not equal the control total amount. 
Transaction Currency not accepted by selected Bank Account.  Transaction Currency not accepted by selected Bank Account. 
Bank Account is either not valid for Company or Currency, or is not enabled for Customer Payments.  Bank Account is either not valid for Company or Currency, or is not enabled for Customer Payments. 
Please select at least one payment to deposit.  Please select at least one payment to deposit. 
Customer Payments to be attached to this Deposit cannot already be included in another non-canceled Customer Deposit.  Customer Payments to be attached to this Deposit cannot already be included in another non-canceled Customer Deposit. 
The default worktag for unapplied and on-account payments: [partitonableByCompany] is not allowed for [company]. Ask your Finance Administrator to access the Maintain Worktag Balancing Configuration task to correct this.  The combination of cost center and company is not allowed for unapplied and on-account payments. Ask your Finance Administrator to access the Maintain Worktag Balancing Configuration task to correct this 
 
Validation Description
The Customer Deposit is canceled and cannot be resubmitted.  The Customer Deposit is canceled and cannot be resubmitted. 
The Web Service is set to Add Only; documents cannot be resubmitted.  The Web Service is set to Add Only; documents cannot be resubmitted. 
Cannot Edit Customer Deposit that is Approved, Canceled, or was created simultaneously with Customer Payment.  Cannot Edit Customer Deposit that is Approved, Canceled, or was created simultaneously with Customer Payment. 
top
 

Response Element: Submit_Customer_Deposit_Response

Element containing Customer Deposit Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Deposit_Reference  Customer_DepositObject  [0..1]  Reference to an existing Customer Deposit.   
top
 

Customer_DepositObject

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

Customer_DepositObjectID

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

part of: Submit_Customer_Deposit_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_Deposit_Data

part of: Submit_Customer_Deposit_Request
Element containing Customer Deposit reference for update and all Customer Deposit data items.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Customer Deposit ID. This is the Customer Deposit unique identifier.   
Submit  boolean  [0..1]  Submit for Approval is a boolean flag indicating if the transaction is to be submitted or saved in draft mode. If this flag is set, the transaction will be submitted, otherwise the transaction is saved in draft.   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing and canceling the Customer Payment inside the Workday Application. Customer Payment can only be updated from the web service is this is set.   
Company_Reference  CompanyObject  [1..1]  This is the company that tranasction is for. This is the reference id value of the company.   
Currency_Reference  CurrencyObject  [0..1]  This is the reference id of currency of the transaction If no currency is specified, Workday will first look to see if the payer/payee has a preferred currency and if not, currency will be populated with the company base currency. If the company base currency is not allowed currency for payer/payee then transaction will not be able to be submitted for approval.   
Payment_Deposit_Date  date  [1..1]  This is the Customer Deposit date. It must be greater than or equal to all included payment transaction dates.   
Bank_Account_Reference  Financial_AccountObject  [1..1]  Reference to an existing Bank Account   
Deposit_Reference_Number  string  [0..1]  Free form text for a Customer Deposit Reference Number   
Control_Total_Amount  decimal (26, 6)   [0..1]  Control Total Amount for the Customer Deposit. Enter this amount to ensure it matches the sum of the payment amounts deposited.   
Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [0..*]  Reference to an existing Currency Rate Type   
Currency_Rate_Override  decimal (21, 6)   [0..1]  Currency Conversion Rate Data   
Electronic_File_Information  string  [0..1]  Electronic File Information is free form text that may be entered to identify the Electronic File that initiated this web service integration.   
Customer_Payment_for_Invoices_Reference  Customer_PaymentObject  [0..*]  Reference to 1 to many Customer Payments existing in Workday, to include in this deposit. 
Validation Description
Credit Card, Direct Debit, and Direct Deposit payments cannot be included when submitting Customer Deposits.   
One or more of the Customer Payments selected to deposit is already canceled. Only non-canceled payments can be deposited.   
The Company for all Customer Payments specified must match the Company of the Customer Deposit.   
One or more of the Cash Sales selected to deposit is in progress. Only approved Cash Sales can be deposited.   
 
Total_Deposit_Amount  decimal (26, 6) >0   [0..1]  The total amount for the customer deposit. This value is read-only and will be ignored on the submit web service.   
Validation Description
The Payment Deposit Date must be greater than the Payment Date for all Payments selected.  The Payment Deposit Date must be greater than the Payment Date for all Payments selected. 
The sum of deposits selected does not equal the control total amount.  The sum of deposits selected does not equal the control total amount. 
Transaction Currency not accepted by selected Bank Account.  Transaction Currency not accepted by selected Bank Account. 
Bank Account is either not valid for Company or Currency, or is not enabled for Customer Payments.  Bank Account is either not valid for Company or Currency, or is not enabled for Customer Payments. 
Please select at least one payment to deposit.  Please select at least one payment to deposit. 
Customer Payments to be attached to this Deposit cannot already be included in another non-canceled Customer Deposit.  Customer Payments to be attached to this Deposit cannot already be included in another non-canceled Customer Deposit. 
The default worktag for unapplied and on-account payments: [partitonableByCompany] is not allowed for [company]. Ask your Finance Administrator to access the Maintain Worktag Balancing Configuration task to correct this.  The combination of cost center and company is not allowed for unapplied and on-account payments. Ask your Finance Administrator to access the Maintain Worktag Balancing Configuration task to correct this 
top
 

CompanyObject

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

CurrencyObject

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

Financial_AccountObject

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

Financial_AccountObjectID

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

Currency_Rate_TypeObject

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

Currency_Rate_TypeObjectID

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

part of: Customer_Deposit_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_DepositReferenceEnumeration

part of: Customer_DepositObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Customer_PaymentReferenceEnumeration

part of: Customer_PaymentObjectID
Base Type
string
top