Service Directory > v31.2 > Cash_Management > Get_Petty_Cash_Accounts
 

Operation: Get_Petty_Cash_Accounts

This service operation will get Get Petty Cash Accounts for the specified criteria. Petty Cash Account data includes Petty Cash Account ID, Account Name, Financial Party, Payment Type, Used by Cash flag, Used by Customer Payments flag, Used by Expense Payments flag, Used by Payroll flag, Used by Supplier Payments flag, and Used by Inter Company Payments flag. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Petty Cash Account data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Petty_Cash_Account_Request_References  [0..1]  Get Petty Cash Accounts Request References   
Request_Criteria [Choice]   Petty_Cash_Account_Request_Criteria  [0..1]  Get Petty Cash Accounts Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Petty Cash Accounts Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Petty_Cash_Account_Response_Group  [0..1]  Get Petty Cash Accounts Response Group   
top
 

Response Element: Get_Petty_Cash_Accounts_Response

Element containing Petty Cash Account response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Petty_Cash_Account_Request_References  [0..1]  Request References   
Request_Criteria  Petty_Cash_Account_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Petty_Cash_Account_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Petty_Cash_Account_Response_Data  [0..1]  Response Data   
top
 

Petty_Cash_Account_Request_References

part of: Get_Petty_Cash_Accounts_Request, Get_Petty_Cash_Accounts_Response
Element containing reference instances for a Petty Cash Account
 
Parameter name Type/Value Cardinality Description Validations
Petty_Cash_Account_Reference  Petty_Cash_AccountObject  [1..*]  Petty Cash Account Reference   
top
 

Petty_Cash_AccountObject

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

Petty_Cash_AccountObjectID

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

Petty_Cash_Account_Request_Criteria

part of: Get_Petty_Cash_Accounts_Request, Get_Petty_Cash_Accounts_Response
Element containing Petty Cash request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Petty_Cash_Account_Response_Group

part of: Get_Petty_Cash_Accounts_Request, Get_Petty_Cash_Accounts_Response
Element containing Petty Cash Account response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Petty_Cash_Account_Response_Data

part of: Get_Petty_Cash_Accounts_Response
Wrapper Element that includes Petty Cash Account Reference Instance
 
Parameter name Type/Value Cardinality Description Validations
Petty_Cash_Account  Petty_Cash_Account  [0..*]  Petty Cash Account   
top
 

Petty_Cash_Account

part of: Petty_Cash_Account_Response_Data
Element containing Petty Cash Account reference and data
 
Parameter name Type/Value Cardinality Description Validations
Petty_Cash_Account_Reference  Petty_Cash_AccountObject  [0..1]  Reference to an existing Petty Cash Account   
Petty_Cash_Account_Data  Petty_Cash_Account_Data  [0..*]  Petty Cash Account Data 
Validation Description
Duplicate Petty Cash Account - A petty cash account with this name and for the same company already exists.  Duplicate Petty Cash Account - A petty cash account with this name and for the same company already exists. 
Financial Party must be a Company or a Company Hierarchy where all of the Companies have the same default currency.  Financial Party must be a Company or a Company Hierarchy where all of the Companies have the same default currency. 
If currencies are limited for Bank Account, Account currency must be included in limit group.  If currencies are limited for Bank Account, Account currency must be included in limit group. 
 
top
 

Petty_Cash_Account_Data

part of: Petty_Cash_Account
Wrapper Element that includes Petty Cash Account Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Petty_Cash_Account_ID  string  [0..1]  Petty Cash Account ID. This is the Petty Cash Account unique identifier   
Account_Name  string  [1..1]  Petty Cash Account Name   
Financial_Party_Reference  Financial_PartyObject  [1..1]  Reference to an existing Organization   
Default_Currency_Reference  CurrencyObject  [0..1]  Currency Reference 
Validation Description
Currency is required for Petty Cash Account.  Currency is required for Petty Cash Account. 
 
Accepted_Currencies_Reference  CurrencyObject  [0..*]  Accepted Currencies Reference. When no accepted currencies are passed in the web service, the bank account will accept all currencies.   
Payment_Type_Reference  Payment_TypeObject  [1..*]  This is the payment type for the transaction and needs to be the reference id value of the payment type. Payment Type establishes methods of making payments, such as cash, check, or electronic transfer. Workday supplies the payment methods. Usually there is a one-to-one relationship between payment type (which you define) and Workday's provided payment methods. If no payment type is specified, Workday will populate this with the customer's default payment type if one is defined. Typically this is only populated when it is an electronic payment type whose collection would be initiated by Workday.   
Used_by_Cash  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Cash payments   
Used_by_Customer_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Customer payments   
Used_by_Expense_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Expense payments   
Used_by_Payroll  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Payroll payments   
Used_by_Supplier_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Supplier payments   
Used_by_Intercompany_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Intercompany payments   
Used_by_Ad_hoc_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Ad Hoc payments   
Used_by_Bank_Account_Transfers_for_Settlement  boolean  [0..1]  Indicates that the account can be used for Bank Account Transfer for Settlement   
Used_by_Off-Cycle_Payroll  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Off-Cycle Payroll payments   
Used_by_Prenote_Payments  boolean  [0..1]  Boolean flag indicating if the Petty Cash Account is usable for Prenote payments   
Allow_Additional_usage  boolean  [0..1]  Boolean indicating if the bank account can be used for additional usages   
Bank_Account_Security_Segment_Reference  Bank_Account_Security_SegmentObject  [0..*]  This is the bank account security segment for the bank account. If segmented security is set up for bank accounts, these segments indicate the security for the bank account.   
Validation Description
Duplicate Petty Cash Account - A petty cash account with this name and for the same company already exists.  Duplicate Petty Cash Account - A petty cash account with this name and for the same company already exists. 
Financial Party must be a Company or a Company Hierarchy where all of the Companies have the same default currency.  Financial Party must be a Company or a Company Hierarchy where all of the Companies have the same default currency. 
If currencies are limited for Bank Account, Account currency must be included in limit group.  If currencies are limited for Bank Account, Account currency must be included in limit group. 
top
 

Financial_PartyObject

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

Financial_PartyObjectID

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

CurrencyObject

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

Bank_Account_Security_SegmentObject

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

Bank_Account_Security_SegmentObjectID

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

Petty_Cash_AccountReferenceEnumeration

part of: Petty_Cash_AccountObjectID
Base Type
string
top
 

Financial_PartyReferenceEnumeration

part of: Financial_PartyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Bank_Account_Security_SegmentReferenceEnumeration

part of: Bank_Account_Security_SegmentObjectID
Base Type
string
top