Service Directory > v32.1 > Revenue_Management > Get_Customer_Deposits
 

Operation: Get_Customer_Deposits

Public web service to retrieve Customer Deposits from Workday. Allows selection criteria of: Customer Deposit by Reference, Company, Customer, Customer Hierarchy, Customer Status, Bank Account, Payment Date Range, Deposit Reference Number, Deposit Status, Reconciliation Status and Created by Worker. Data contains: Locked in Workday, Company, Currency, Payment Deposit Date, Bank Account, Deposit Reference Number, Control Total Amount, Currency Rate Type, Currency Rate Override, Electronic File Information and references to Customer Payments in Workday.


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

Contains request reference, criteria, filter and response group for getting Customer Deposit data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Customer_Deposit_Request_References  [0..1]  Element containing Customer Deposit references   
Request_Criteria [Choice]   Customer_Deposit_Request_Criteria  [0..1]  Element containing Customer Deposit request criteria. 
Validation Description
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before.  Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before. 
 
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Deposit_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Customer_Deposits_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Customer_Deposit_Request_References  [0..1]  This element content contains the echoed Customer Deposit Request Reference Element   
Request_Criteria  Customer_Deposit_Request_Criteria  [0..1]  This element content contains the echoed Customer Deposit Request Criteria element. 
Validation Description
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before.  Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before. 
 
Response_Filter  Response_Filter  [0..1]  This element content contains the echoed Respones Filter Element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Deposit_Response_Group  [0..1]  This element content containes the echoed Customer Deposit Response Group element   
Response_Results  Response_Results  [0..1]  This element content contains the Customer Deposit REsponse Results element including total results   
Response_Data  Customer_Deposit_Response_Data  [0..1]  This element content contains the Customer Deposit Response Data element   
top
 

Customer_Deposit_Request_References

part of: Get_Customer_Deposits_Request, Get_Customer_Deposits_Response
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Deposit_Reference  Customer_DepositObject  [1..*]  Reference to an existing Customer Deposit.   
top
 

Customer_DepositObject

part of: Customer_Deposit_Request_References, Customer_Deposit
 
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
 

Customer_Deposit_Request_Criteria

part of: Get_Customer_Deposits_Request, Get_Customer_Deposits_Response
This element is the wrapper around a list of elements representing the Customer Request specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [0..*]  Reference to an existing Company which holds the asset   
Customers_Reference  CustomerObject  [0..*]  This is the customer that the invoice is for. This is the reference id value of the customer   
Customer_Hierarchy_Reference  CustomerObject  [0..*]  Reference to an existing customer that has child customers   
Customer_Status_Reference  Business_Entity_Status_ValueObject  [0..*]  Reference to an existing instance of Business Entity Status Value   
Bank_Account_Reference  Financial_AccountObject  [0..*]  Reference to the Bank Account that the Customer Deposit will be in.   
Payment_Deposit_Date_On_or_After  date  [0..1]  Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before.   
Payment_Deposit_Date_On_or_Before  date  [0..1]  Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before.   
Deposit_Reference_Number  string  [0..1]  Free form text for a Customer Deposit Reference Number   
Deposit_Status_Reference  Document_StatusObject  [0..*]  Reference to the status of the requested Customer Deposit   
Reconciliation_Status_Reference  Reconciliation_StatusObject  [0..*]  Reference to the Reconciliation Status of the Customer Deposit requested.   
Worker_Reference  WorkerObject  [0..*]  Create by Worker Reference   
Validation Description
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before.  Payment Deposit Date On or After must be earlier than Payment Deposit Date On or Before. 
top
 

OrganizationObject

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

OrganizationObjectID

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

CustomerObject

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

CustomerObjectID

part of: CustomerObject
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  [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
 

Business_Entity_Status_ValueObject

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

Business_Entity_Status_ValueObjectID

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

Financial_AccountObject

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

Document_StatusObject

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

Document_StatusObjectID

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

Reconciliation_StatusObject

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

Reconciliation_StatusObjectID

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

WorkerObject

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

Response_Filter

part of: Get_Customer_Deposits_Request, Get_Customer_Deposits_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_Deposit_Response_Group

part of: Get_Customer_Deposits_Request, Get_Customer_Deposits_Response
Customer Deposit Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Customer_Deposits_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_Deposit_Response_Data

part of: Get_Customer_Deposits_Response
Customer Deposit Response Data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Deposit  Customer_Deposit  [0..*]  Customer Deposit element wrapper.   
top
 

Customer_Deposit

part of: Customer_Deposit_Response_Data
Customer Deposit element wrapper.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Deposit_Reference  Customer_DepositObject  [0..1]  Reference to an existing Customer Deposit   
Customer_Deposit_Data  Customer_Deposit_Data  [0..*]  Customer Deposit Data 
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
 

Customer_Deposit_Data

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

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
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Business_Entity_Status_ValueReferenceEnumeration

part of: Business_Entity_Status_ValueObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Reconciliation_StatusReferenceEnumeration

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

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Customer_PaymentReferenceEnumeration

part of: Customer_PaymentObjectID
Base Type
string
top