Service Directory > v31.2 > Financial_Management > Get_Suspense_Account_Rules
 

Operation: Get_Suspense_Account_Rules

This service operation will get Suspense Account Rules for the specified criteria. The request criteria can be for a single Suspense Account Rule based on Reference, or all Suspense Account Rules 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_Suspense_Account_Rules_Request

Contains request reference, criteria, filter for getting Suspense Account Rule data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Suspense_Account_Rule_Request_References  [0..1]  Contains request reference, criteria, filter and response results for getting Suspense Account Rule data   
Request_Criteria [Choice]   Suspense_Account_Rule_Request_Criteria  [0..1]  Contains request criteria for getting Suspense Account Rule data   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Suspense_Account_Rules_Response

Contains request reference, criteria, filter and response results for getting Suspense Account Rule data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Suspense_Account_Rule_Request_References  [0..1]  Contains request reference, criteria, filter and response results for getting Suspense Account Rule data   
Request_Criteria  Suspense_Account_Rule_Request_Criteria  [0..1]  Contains request criteria for getting Suspense Account Rule data   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Suspense_Account_Rule_Response_Data  [0..1]  Wrapper Element that includes Suspense Account Rule Instance and Data   
top
 

Suspense_Account_Rule_Request_References

part of: Get_Suspense_Account_Rules_Request, Get_Suspense_Account_Rules_Response
Contains request reference, criteria, filter and response results for getting Suspense Account Rule data
 
Parameter name Type/Value Cardinality Description Validations
Suspense_Account_Rule_Reference  Suspense_Account_RuleObject  [1..*]  Reference to an existing Suspense Account Rule   
top
 

Suspense_Account_RuleObject

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

Suspense_Account_RuleObjectID

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

Suspense_Account_Rule_Request_Criteria

part of: Get_Suspense_Account_Rules_Request, Get_Suspense_Account_Rules_Response
Contains request criteria for getting Suspense Account Rule data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Response_Results

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

Suspense_Account_Rule_Response_Data

part of: Get_Suspense_Account_Rules_Response
Wrapper Element that includes Suspense Account Rule Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Suspense_Account_Rule  Suspense_Account_Rule  [0..*]  Wrapper Element that includes Suspense Account Rule Instance and Data   
top
 

Suspense_Account_Rule

part of: Suspense_Account_Rule_Response_Data
Wrapper Element that includes Suspense Account Rule Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Suspense_Account_Rule_Reference  Suspense_Account_RuleObject  [0..1]  Reference to an existing Suspense Account Rule   
Suspense_Account_Rule_Data  Suspense_Account_Rule_Data  [0..*]  Element containing all Suspense Account Rule data 
Validation Description
Select a Ledger Account that is in the Account Set.   
Select a Ledger Account that isn't retired   
You must set up required worktag types for the accounting journal if you want to use Required Worktags in the suspense account rule.   
You may only specify Required Worktag types for Required Worktags. You must select 1 worktag for each of these types of Required Worktags: [wts]   
Worktag balancing for the transaction is in use. You must set up the suspense account rule using Balancing Worktag type [bwt].   
You must set up worktag balancing if you want to use Balancing Worktag in the suspense account rule.   
You must set up optional worktag balancing if you want to use Optional Balancing Worktags in the suspense account rule.   
You can only select these optional balancing worktag types for the suspense account rule: "[types]"   
You can only use 1 worktag of each type per suspense account rule.   
You can only use 1 worktag of each type per suspense account rule.   
 
top
 

Suspense_Account_Rule_Data

part of: Suspense_Account_Rule
Element containing all Suspense Account Rule data
 
Parameter name Type/Value Cardinality Description Validations
Suspense_Account_Rule_ID  string  [0..1]  Suspense Account Rule Reference ID. This is the Suspense Account Rule unique identifier   
Suspense_Account_Rule_Name  string  [1..1]  Suspense Account Rule Name 
Validation Description
Enter a unique Suspense Account Rule Name. "[name]" is already in use.   
 
Account_Set_Reference  Account_SetObject  [1..1]  Reference to an existing Account Set 
Validation Description
The account set is already in use. Edit the suspense account rule if you want to change this account set: [account_set]   
 
Ledger_Account_Reference  Ledger_AccountObject  [0..1]  Reference to an existing Actuals Ledger   
Required_Worktags_Reference  Audited_Accounting_WorktagObject  [0..*]  References to Required Accounting Worktags   
Balancing_Worktag_Reference  Balancing_WorktagObject  [0..1]  Reference to Balancing Worktag   
Optional_Balancing_Worktags_Reference  Audited_Accounting_WorktagObject  [0..*]  Reference to Existing Optional Balancing Worktag.   
Validation Description
Select a Ledger Account that is in the Account Set.   
Select a Ledger Account that isn't retired   
You must set up required worktag types for the accounting journal if you want to use Required Worktags in the suspense account rule.   
You may only specify Required Worktag types for Required Worktags. You must select 1 worktag for each of these types of Required Worktags: [wts]   
Worktag balancing for the transaction is in use. You must set up the suspense account rule using Balancing Worktag type [bwt].   
You must set up worktag balancing if you want to use Balancing Worktag in the suspense account rule.   
You must set up optional worktag balancing if you want to use Optional Balancing Worktags in the suspense account rule.   
You can only select these optional balancing worktag types for the suspense account rule: "[types]"   
You can only use 1 worktag of each type per suspense account rule.   
You can only use 1 worktag of each type per suspense account rule.   
top
 

Account_SetObject

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

Account_SetObjectID

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

Ledger_AccountObject

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

Ledger_AccountObjectID

part of: Ledger_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Audited_Accounting_WorktagObject

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

Audited_Accounting_WorktagObjectID

part of: Audited_Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Donor_ID, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_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
 

Balancing_WorktagObject

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

Balancing_WorktagObjectID

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

Suspense_Account_RuleReferenceEnumeration

part of: Suspense_Account_RuleObjectID
Base Type
string
top
 

Account_SetReferenceEnumeration

part of: Account_SetObjectID
Base Type
string
top
 

Ledger_AccountReferenceEnumeration

part of: Ledger_AccountObjectID
Base Type
string
top
 

Base Type
string

top
 

Audited_Accounting_WorktagReferenceEnumeration

part of: Audited_Accounting_WorktagObjectID
Base Type
string
top
 

Balancing_WorktagReferenceEnumeration

part of: Balancing_WorktagObjectID
Base Type
string
top