Service Directory > v32.1 > Resource_Management > Get_Remit_To_Supplier_Connections
 

Operation: Get_Remit_To_Supplier_Connections

This service operation will get Supplier Connections for the specified Supplier criteria, The request criteria can be for a single supplier based on Reference, or all supplier connections can be retrieved if no criteria is specified. Supplier Connection data includes owning Supplier, Supplier Connection ID, Supplier Connection Name, Remit To Supplier Reference, Default Payment Type, Accepted Payment Type, Settlement Bank Account Reference, Remit To Address Reference, Remit To Email, Payee Alternate Name Reference, Payment Memo, Default flag and inactive flag.


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

This element is the top-level request element for Get Supplier Connections operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Supplier_Request_References  [0..1]  Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria [Choice]   Supplier_Request_Criteria  [0..1]  Element used to Request certain Suppliers 
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any 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_Group  Supplier_Connection_Response_Group  [0..1]  Wrapper element representing the amount of data that should be included in the Supplier Connection response   
top
 

Response Element: Get_Remit_To_Supplier_Connections_Response

Top-level response element for all "Get" Supplier Connections operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Request_References  [0..1]  Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria  Supplier_Request_Criteria  [0..1]  Element used to Request certain Suppliers 
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any 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_Group  Supplier_Connection_Response_Group  [0..1]  Wrapper element representing the amount of data that should be included in the Supplier Connection response   
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  Supplier_Connection_Response_Data  [0..1]  Wrapper Element that contains Supplier Connection   
top
 

Supplier_Request_References

part of: Get_Remit_To_Supplier_Connections_Request, Get_Remit_To_Supplier_Connections_Response
Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  SupplierObject  [1..*]  Supplier Reference   
top
 

SupplierObject

part of: Supplier_Request_References, Supplier_Request_Criteria, Supplier_Connection, Supplier_Connection_Line
 
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  SupplierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SupplierObjectID

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

Supplier_Request_Criteria

part of: Get_Remit_To_Supplier_Connections_Request, Get_Remit_To_Supplier_Connections_Response
Element used to Request certain Suppliers
 
Parameter name Type/Value Cardinality Description Validations
Updated_From_Date  dateTime  [0..1]  Supplier Change From Date   
Updated_To_Date  dateTime  [0..1]  Supplier Change To Date   
Supplier_Status_Reference  Business_Entity_Status_ValueObject  [0..*]  Supplier Status   
Supplier_Category_Reference  Supplier_CategoryObject  [0..*]  Supplier Category   
Supplier_Group_Reference  Supplier_GroupObject  [0..*]  Supplier Group   
Customer_Account_Number  string  [0..1]  Account Number   
DUNS_Number  string (9)   [0..1]  DUNS Number   
Parent_Supplier_Reference  SupplierObject  [0..*]  Parent Supplier   
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any Data.   
top
 

Business_Entity_Status_ValueObject

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

Business_Entity_Status_ValueObjectID

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

Supplier_CategoryObject

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

Supplier_CategoryObjectID

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

Supplier_GroupObject

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

Supplier_GroupObjectID

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

Supplier_Connection_Response_Group

part of: Get_Remit_To_Supplier_Connections_Request, Get_Remit_To_Supplier_Connections_Response
Wrapper element representing the amount of data that should be included in the Supplier Connection response
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Supplier Connection reference is to be included in the response.   
top
 

Response_Results

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

Supplier_Connection_Response_Data

part of: Get_Remit_To_Supplier_Connections_Response
Wrapper Element that contains Supplier Connection
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Connection  Supplier_Connection  [0..*]  The Element contains the owning Supplier Reference and Supplier Connection Data   
top
 

Supplier_Connection

part of: Supplier_Connection_Response_Data
The Element contains the owning Supplier Reference and Supplier Connection Data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  SupplierObject  [0..1]  The Supplier Reference which owns Supplier Connections in Supplier Connection Data   
Supplier_Connection_Data  Supplier_Connection_Data  [0..1]  This element contains all Supplier Connections for the supplier 
Validation Description
Enter one default Remit-To Connection only   
Multiple default Supplier Connection selected   
 
top
 

Supplier_Connection_Data

part of: Supplier_Connection
This element contains all Supplier Connections for the supplier
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference_ID  string  [0..1]  Supplier Reference ID   
Supplier_ID  string  [0..1]  Supplier ID   
Supplier_Connection_Line  Supplier_Connection_Line  [0..*]  The Element contains individual Supplier Connection attributes 
Validation Description
Supplier Connection must be owned by the host Supplier   
Settlement Bank Account must be valid for Remit To Supplier   
All Payee Alternate Names must be valid for Remit To Supplier   
Remit To Address must be valid for Remit to Supplier   
Remit To Email must be valid for Remit To Supplier   
Default Payment Type must be valid for Remit To Supplier.   
Enter a unique Supplier Connection Name   
Supplier Connection Name already exists for Supplier   
Default Payment Type must be an Accepted Payment Type   
Accepted Payment Type must be an accepted payment type for the Remit to Supplier.   
The accepted payment type(s) require a settlement bank account.   
The accepted payment type(s) require a remit-to address.   
Address with this reference ID cannot be found: [addrID]   
 
Validation Description
Enter one default Remit-To Connection only   
Multiple default Supplier Connection selected   
top
 

Supplier_Connection_Line

part of: Supplier_Connection_Data
The Element contains individual Supplier Connection attributes
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Connection_Reference  Remit-To_Supplier_ConnectionObject  [0..1]  Supplier Connection Reference   
Supplier_Connection_ID  string  [0..1]  Supplier Connection ID   
Supplier_Connection_Name  string  [1..1]  Supplier Connection Name   
Remit_To_Supplier_Reference  SupplierObject  [1..1]  Remit To Supplier Reference for the Supplier Connection   
Default_Payment_Type_Reference  Payment_TypeObject  [1..1]  Default Payment Type   
Accepted_Payment_Type_Reference  Payment_TypeObject  [1..*]  Accepted Payment Types   
Settlement_Bank_Account_Reference  Settlement_Bank_AccountObject  [0..1]  Settlement Bank Account for this Supplier Connection   
Remit_To_Address_Reference [Choice]   Unique_IdentifierObject  [0..1]  Remit To address Reference for the Supplier Connection   
Remit_To_Address_ID [Choice]   string  [0..1]  Remit to Address Reference ID for Supplier Connection   
Remit_To_Email_Address  string  [0..1]  Remit To Email for the Supplier Connection   
Payee_Alternate_Name_Reference [Choice]   Unique_IdentifierObject  [0..*]  Payee Alternate Name Reference for the Supplier Connection 
Validation Description
You can't select more than 1 alternate name with a usage type of Alternate Supplier Connections or Remit to Payee for supplier connections.   
 
Payee_Alternate_Name [Choice]   Remit-To_Supplier_Connection_Payee_Alternate_Name  [0..*]  Payee Alternate Name used by Supplier Connection 
Validation Description
Alternate Name [altname] must be valid for Remit to Supplier   
 
Payment_Memo  string  [0..1]  Payment Memo for the Supplier Connection   
Is_Default  boolean  [0..1]  Flag to indicate if the Supplier Connection is the Default one   
Is_Inactive  boolean  [0..1]  Flag to indicate if the Supplier Connection is inactive   
Validation Description
Supplier Connection must be owned by the host Supplier   
Settlement Bank Account must be valid for Remit To Supplier   
All Payee Alternate Names must be valid for Remit To Supplier   
Remit To Address must be valid for Remit to Supplier   
Remit To Email must be valid for Remit To Supplier   
Default Payment Type must be valid for Remit To Supplier.   
Enter a unique Supplier Connection Name   
Supplier Connection Name already exists for Supplier   
Default Payment Type must be an Accepted Payment Type   
Accepted Payment Type must be an accepted payment type for the Remit to Supplier.   
The accepted payment type(s) require a settlement bank account.   
The accepted payment type(s) require a remit-to address.   
Address with this reference ID cannot be found: [addrID]   
top
 

Remit-To_Supplier_ConnectionObject

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

Remit-To_Supplier_ConnectionObjectID

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

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

Settlement_Bank_AccountObject

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

Settlement_Bank_AccountObjectID

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

Unique_IdentifierObject

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

Remit-To_Supplier_Connection_Payee_Alternate_Name

part of: Supplier_Connection_Line
Payee Alternate Name used by Supplier Connection
 
Parameter name Type/Value Cardinality Description Validations
Payee_Alternate_Name  string  [1..1]  Payee Alternate Name   
Alternate_Name_Usage_Reference  Alternate_Name_UsageObject  [0..*]  Payee Alternate Name Usage Reference   
Validation Description
Alternate Name [altname] must be valid for Remit to Supplier   
top
 

Alternate_Name_UsageObject

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

Alternate_Name_UsageObjectID

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

SupplierReferenceEnumeration

part of: SupplierObjectID
Base Type
string
top
 

Business_Entity_Status_ValueReferenceEnumeration

part of: Business_Entity_Status_ValueObjectID
Base Type
string
top
 

Supplier_CategoryReferenceEnumeration

part of: Supplier_CategoryObjectID
Base Type
string
top
 

Supplier_GroupReferenceEnumeration

part of: Supplier_GroupObjectID
Base Type
string
top
 

Remit-To_Supplier_ConnectionReferenceEnumeration

part of: Remit-To_Supplier_ConnectionObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Settlement_Bank_AccountReferenceEnumeration

part of: Settlement_Bank_AccountObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Alternate_Name_UsageReferenceEnumeration

part of: Alternate_Name_UsageObjectID
Base Type
string
top