Service Directory > v31.2 > Settlement_Services > Submit_Settlement_Run
 

Operation: Submit_Settlement_Run

Web service for creating a settlement run.


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

Root element for the Request on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Settlement_Run_Data  Settlement_Run_Data  [0..1]  Element used for creating a settlement run. 
Validation Description
Cannot select more than one Currency as Multi-Currency Settlement Run has not been enabled.   
Cannot select All Currencies as Multi-Currency Settlement Run has not been enabled.   
No exchange rate exists to convert from the Search Currency ([restricted_currencies]) to the selected Display Currency ([display_currency]).   
This company does not have an ID generator for Settlement Runs setup. The Settlement Administrator must setup a Settlement Run ID generator in order to create Settlement Runs.   
This company or tenant does not have an ID generator for Outsourced Payment Group setup. The Settlement Administrator must setup a Outsourced Payment Group ID generator in order to create Settlement Runs.   
An ID generator for EFT IDs has not been setup. The Settlement Administrator must setup a Payment External EFT ID generator in order to create Settlement Runs.   
Cannot create settlement run as Display Currency is invalid.   
It is not possible to "Include payments on behalf of other companies" for a Company Hierarchy.   
It is not possible to "Include payments on behalf of other companies" for the selected Company.   
Settlement Run Filters for Intercompany Items cannot be used when the Settlement Run Organization is a company hierarchy.   
User is not allowed to use one or more of the selected filters.   
Define bank routing rules with a default bank account using the Create Bank Routing Rules for the companies in this settlement run.   
Define bank routing rules with a default bank account using the Create Bank Routing Rules for the companies in this settlement run.   
 
top
 

Response Element: Submit_Settlement_Run_Response

Root element for the Response on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Settlement_Run_Reference  Unique_IdentifierObject  [0..1]  The settlement run created by web service.   
top
 

Settlement_Run_Data

part of: Submit_Settlement_Run_Request
Element containing date necessary for settlement run creation.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [1..1]  Organization that the settlement run is created for. Can include hierarchies.   
Currency_Reference [Choice]   CurrencyObject  [1..*]  Currency(s) used in the settlement run. Determines which transactions of a currency type are added to the settlement run from filters.   
All_Currencies_Reference [Choice]   boolean  [1..1]  Use all currencies available in Workday for creating the settlement run. Workday adds transactions of all currencies available from filters.   
Display_Currency_Reference  CurrencyObject  [1..1]  Display Currency used in the settlement run.   
Settlement_Run_Name  string  [0..1]  Name of settlement run.   
Payment_Date  date  [1..1]  Payment Date for the settlement run.   
Auto_Select_Filters_Reference  Settlement_Run_FilterObject  [1..*]  Custom or System Select Filters for this settlement run   
Include_Payments_on_Behalf_of_Other_Companies  boolean  [0..1]  Flag to include transactions for other companies in the settlement run.   
Exclude_Negative_Payments  boolean  [0..1]  Flag to include negative transactions in the settlement run. Workday leaves the settlement run in draft state before processing.   
Dynamic_Supplier_Payment_Date_Reference  Dynamic_Supplier_Payment_DateObject  [0..1]  Dynamic Supplier Payment Date determines payment date for Supplier Payment for Invoices.   
Validation Description
Cannot select more than one Currency as Multi-Currency Settlement Run has not been enabled.   
Cannot select All Currencies as Multi-Currency Settlement Run has not been enabled.   
No exchange rate exists to convert from the Search Currency ([restricted_currencies]) to the selected Display Currency ([display_currency]).   
This company does not have an ID generator for Settlement Runs setup. The Settlement Administrator must setup a Settlement Run ID generator in order to create Settlement Runs.   
This company or tenant does not have an ID generator for Outsourced Payment Group setup. The Settlement Administrator must setup a Outsourced Payment Group ID generator in order to create Settlement Runs.   
An ID generator for EFT IDs has not been setup. The Settlement Administrator must setup a Payment External EFT ID generator in order to create Settlement Runs.   
Cannot create settlement run as Display Currency is invalid.   
It is not possible to "Include payments on behalf of other companies" for a Company Hierarchy.   
It is not possible to "Include payments on behalf of other companies" for the selected Company.   
Settlement Run Filters for Intercompany Items cannot be used when the Settlement Run Organization is a company hierarchy.   
User is not allowed to use one or more of the selected filters.   
Define bank routing rules with a default bank account using the Create Bank Routing Rules for the companies in this settlement run.   
Define bank routing rules with a default bank account using the Create Bank Routing Rules for the companies in this settlement run.   
top
 

OrganizationObject

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

CurrencyObject

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

Settlement_Run_FilterObject

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

Settlement_Run_FilterObjectID

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

Dynamic_Supplier_Payment_DateObject

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

Dynamic_Supplier_Payment_DateObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Settlement_Run_FilterReferenceEnumeration

part of: Settlement_Run_FilterObjectID
Base Type
string
top
 

Dynamic_Supplier_Payment_DateReferenceEnumeration

part of: Dynamic_Supplier_Payment_DateObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top