Service Directory > v31.2 > Settlement_Services > Submit_Stop_Items
 

Operation: Submit_Stop_Items

This Web Service Task allows you to add a new Stop Item to a payment.


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

Stop Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Financials_Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Stop_Item  Stop_Item  [1..1]  Stores information about a Stop Item   
top
 

Response Element: Submit_Stop_Items_Response

Container for the Stop Item resulting from Submit Stop Items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Stop_Item_Reference  Stop_ItemObject  [0..1]  Reference to the Stop Item   
top
 

Financials_Business_Process_Parameters

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

Stop_Item

part of: Submit_Stop_Items_Request
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_ItemObject

part of: Stop_Item, Submit_Stop_Items_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  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_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
 

PaymentObject

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

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
 

Document_StatusObject

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

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
 

PayeeObject

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

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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Stop_ItemReferenceEnumeration

part of: Stop_ItemObjectID
Base Type
string
top
 

PaymentReferenceEnumeration

part of: PaymentObjectID
Base Type
string
top
 

RichText

part of: Stop_Item_Parameters
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

PayeeReferenceEnumeration

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