Service Directory > v31.2 > Settlement_Services > Get_Stop_Items
 

Operation: Get_Stop_Items

This Web Service Task allows you to get Stop Items based on ID, or a combination of organization, stop item status, stop date, payment, payee, payment category, and the payment reference number.


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

Request Element for Get Stop Items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Stop_Item_Request_References  [0..1]  Element that shows specific Stop Items   
Request_Criteria [Choice]   Stop_Item_Request_Criteria  [0..1]  Parameters available to request a set of Stop Items   
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_Group  Stop_Item_Response_Group  [0..1]  Element containing Stop Item response grouping options   
top
 

Response Element: Get_Stop_Items_Response

This element is a container that stores all the information about your Get Stop Items Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Stop_Item_Request_References  [0..1]  Element that shows specific Stop Items   
Request_Criteria  Stop_Item_Request_Criteria  [0..1]  Parameters available to request a set of Stop Items   
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_Group  Stop_Item_Response_Group  [0..1]  Element containing Stop Item response grouping options   
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  Stop_Item_Response_Data  [0..1]  Container for Stop Item   
top
 

Stop_Item_Request_References

part of: Get_Stop_Items_Request, Get_Stop_Items_Response
Element that shows specific Stop Items
 
Parameter name Type/Value Cardinality Description Validations
Stop_Item_Reference  Stop_ItemObject  [1..*]  Get specific Stop Items. You can request by WID or Stop_Item_ID.   
top
 

Stop_ItemObject

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

Stop_ItemObjectID

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

Stop_Item_Request_Criteria

part of: Get_Stop_Items_Request, Get_Stop_Items_Response
Parameters available to request a set of Stop Items
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [1..1]  The Company or Company Hierarchy for Stop Items that you wish to query   
Stop_Item_Status_Reference  Document_StatusObject  [0..1]  Stop Item Status for Stop Item   
Stop_Date  date  [0..1]  Stop Date for Stop Item   
Payment_Reference  PaymentObject  [0..1]  Payment for Stop Item   
Payee_Reference  PayeeObject  [0..1]  Payee of Payment for Stop Item   
Payment_Category_Reference  Payment_CategoryObject  [0..1]  Payment Category of Payment for Stop Item   
Payment_Reference_Number  string  [0..1]  Payment Reference Number of Payment for Stop Item   
top
 

OrganizationObject

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

Document_StatusObject

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

PaymentObject

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

PaymentObjectID

part of: 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, Bank_Account_Transfer_Payment_ID, Customer_Refund_Reference_ID, EFT_Payment_ID, Student_Sponsor_Refund_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
 

PayeeObject

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

PayeeObjectID

part of: PayeeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Person_ID, Ad_hoc_Payee_ID, Applicant_ID, Company_Reference_ID, Contingent_Worker_ID, Corporate_Credit_Card_Account_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Employee_ID, External_Committee_Member_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investor_ID, Organization_Reference_ID, Sponsor_ID, Sponsor_Reference_ID, Student_ID, Student_Proxy_ID, Supplier_Connection_ID, Supplier_ID, Supplier_Reference_ID, Tax_Authority_ID, Tax_Authority_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
 

Payment_CategoryObject

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

Payment_CategoryObjectID

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

Stop_Item_Response_Group

part of: Get_Stop_Items_Request, Get_Stop_Items_Response
Element containing Stop Item response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Stop_Item_Response_Data

part of: Get_Stop_Items_Response
Container for Stop Item
 
Parameter name Type/Value Cardinality Description Validations
Stop_Item  Stop_Item  [0..*]  Stores information about a Stop Item   
top
 

Stop_Item

part of: Stop_Item_Response_Data
Stores information about a Stop Item
 
Parameter name Type/Value Cardinality Description Validations
Stop_Item_Reference  Stop_ItemObject  [0..1]  Reference to the Stop Item   
Stop_Item_Parameters  Stop_Item_Parameters  [1..1]  Stop Item Parameters   
Stop_Item_Data  Stop_Item_Data  [0..1]  Stop Item Data   
top
 

Stop_Item_Parameters

part of: Stop_Item
Stop Item Parameters
 
Parameter name Type/Value Cardinality Description Validations
Payment_Reference  PaymentObject  [1..1]  Payment for Stop Item 
Validation Description
This payment cannot be stopped.   
 
Stop_Date  date  [1..1]  Stop Date for Stop Item   
Stop_Item_Notes  RichText  [0..1]  Stop Item Notes for the Stop Item   
top
 

Stop_Item_Data

part of: Stop_Item
Stop Item Data
 
Parameter name Type/Value Cardinality Description Validations
Stop_Item_ID  string  [0..1]  The Reference ID of the Stop Item   
Stop_Item_Status_Reference  Document_StatusObject  [0..1]  Stop Item Status for Stop Item   
Stop_Item_Creation_Date  date  [0..1]  Creation Date of the Stop Item   
Company_Reference  CompanyObject  [0..1]  Company for the Stop Item   
Payee_Reference  PayeeObject  [0..1]  Payee of Payment for Stop Item   
Payment_Amount  decimal (18, 3)   [0..1]  Payment Amount of the Payment for the Stop Item   
Currency_Reference  CurrencyObject  [0..1]  Currency of the Payment for the Stop Item   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type of the Payment for the Stop Item   
Financial_Account_Reference  Financial_AccountObject  [0..1]  Financial Account of the Payment for the Stop Item   
Payment_Reference_Number  string  [0..1]  Payment Reference Number of Payment for Stop Item   
Resume_Date  date  [0..1]  Resume Date of the Stop Item   
top
 

CompanyObject

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

Financial_AccountObject

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

Stop_ItemReferenceEnumeration

part of: Stop_ItemObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

PaymentReferenceEnumeration

part of: PaymentObjectID
Base Type
string
top
 

PayeeReferenceEnumeration

part of: PayeeObjectID
Base Type
string
top
 

Payment_CategoryReferenceEnumeration

part of: Payment_CategoryObjectID
Base Type
string
top
 

RichText

part of: Stop_Item_Parameters
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top