Service Directory > v31.2 > Settlement_Services > Get_Direct_Debit_Mandates
 

Operation: Get_Direct_Debit_Mandates

This operation will retrieve Direct Debit Mandate based on the references specified. If no references are specified then no Direct Debit Mandate is returned.


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

Get Direct Debit Mandates Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Direct_Debit_Mandate_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Direct_Debit_Mandate_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Direct_Debit_Mandate_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Direct_Debit_Mandates_Response

Get Direct Debit Mandates Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Direct_Debit_Mandate_Request_References  [0..1]  Request References   
Request_Criteria  Direct_Debit_Mandate_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Direct_Debit_Mandate_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Direct_Debit_Mandate_Response_Data  [0..1]  Direct Debit Mandate Response Data   
top
 

Direct_Debit_Mandate_Request_References

part of: Get_Direct_Debit_Mandates_Request, Get_Direct_Debit_Mandates_Response
Direct Debit Mandate Request References
 
Parameter name Type/Value Cardinality Description Validations
Direct_Debit_Mandate_Reference  Direct_Debit_MandateObject  [1..*]  Direct Debit Mandate Reference which is WID or SEPA_Mandate_ID.   
top
 

Direct_Debit_MandateObject

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

Direct_Debit_MandateObjectID

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

Direct_Debit_Mandate_Request_Criteria

part of: Get_Direct_Debit_Mandates_Request, Get_Direct_Debit_Mandates_Response
Direct Debit Mandate Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Direct_Debit_Mandate_Response_Group

part of: Get_Direct_Debit_Mandates_Request, Get_Direct_Debit_Mandates_Response
Direct Debit Mandate Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Direct_Debit_Mandate_Response_Data

part of: Get_Direct_Debit_Mandates_Response
Direct Debit Mandate Response Data
 
Parameter name Type/Value Cardinality Description Validations
Direct_Debit_Mandate  Direct_Debit_Mandate  [0..*]  Direct Debit Mandate Data   
top
 

Direct_Debit_Mandate

part of: Direct_Debit_Mandate_Response_Data
Direct Debit Mandate Data
 
Parameter name Type/Value Cardinality Description Validations
Direct_Debit_Mandate_Reference  Direct_Debit_MandateObject  [0..1]  Direct Debit Mandate Reference which is WID or SEPA_Mandate_ID.   
Direct_Debit_Mandate_Data  Direct_Debit_Mandate_Data  [0..*]  Direct Debit Mandate Data 
Validation Description
When the Mandate Status is Active, Signature Date should have a value.  When the Mandate Status is Active, Signature Date should have a value. 
When the Mandate Status is Active, it is mandatory to set the IBAN for the Customer Bank Account.  When the Mandate Status is Active, it is mandatory to set the IBAN for the Customer Bank Account. 
There is no Creditor Identifier provided for the company and country specified.  There is no Creditor Identifier provided for the company and country specified. 
When the Mandate Status is Active, Signed At should have a value.  When the Mandate Status is Active, Signed At should have a value. 
The customer should have the option "Mandate Required" set as true.  The customer should have the option "Mandate Required" set as true. 
The Customer should have an Active Settlement Bank Account.  The Customer should have an Active Settlement Bank Account. 
When the Mandate Status is Active, it is mandatory to set the Bank Identification Code for the Customer Bank Account.  When the Mandate Status is Active, it is mandatory to set the Bank Identification Code for the Customer Bank Account. 
 
top
 

Direct_Debit_Mandate_Data

part of: Direct_Debit_Mandate
Direct Debit Mandate Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Optional ID. If not provided when adding, an ID will be generated.   
Mandate_Status_Reference  Document_StatusObject  [1..1]  Mandate Status Reference which are Draft, Active or Inative.   
Company_Reference  CompanyObject  [1..1]  Company Reference   
Country_Reference  CountryObject  [1..1]  Country Reference   
Creditor_Identifier_Reference  Creditor_IdentifierObject  [1..1]  Creditor Identifier Reference   
Company_Address_Reference  Address_ReferenceObject  [1..1]  Company Address Reference   
Customer_Reference  CustomerObject  [1..1]  Customer Reference   
Customer_Address_Reference  Address_ReferenceObject  [1..1]  Customer Address Reference   
Type_of_Payment_Reference  Direct_Debit_Mandate_Sequence_TypeObject  [1..1]  Type of Payment Reference   
Prenotification_Required  boolean  [0..1]  Prenotification Required   
Minimum_Days_for_Pre-notification  decimal (6, 0) >0   [0..1]  Minimum Days for Pre-notification   
Signed_at  string  [0..1]  Signed at   
Signature_Date  date  [0..1]  Signature Date   
Validation Description
When the Mandate Status is Active, Signature Date should have a value.  When the Mandate Status is Active, Signature Date should have a value. 
When the Mandate Status is Active, it is mandatory to set the IBAN for the Customer Bank Account.  When the Mandate Status is Active, it is mandatory to set the IBAN for the Customer Bank Account. 
There is no Creditor Identifier provided for the company and country specified.  There is no Creditor Identifier provided for the company and country specified. 
When the Mandate Status is Active, Signed At should have a value.  When the Mandate Status is Active, Signed At should have a value. 
The customer should have the option "Mandate Required" set as true.  The customer should have the option "Mandate Required" set as true. 
The Customer should have an Active Settlement Bank Account.  The Customer should have an Active Settlement Bank Account. 
When the Mandate Status is Active, it is mandatory to set the Bank Identification Code for the Customer Bank Account.  When the Mandate Status is Active, it is mandatory to set the Bank Identification Code for the Customer Bank Account. 
top
 

Document_StatusObject

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Creditor_IdentifierObject

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

Creditor_IdentifierObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

CustomerObject

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

CustomerObjectID

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

Direct_Debit_Mandate_Sequence_TypeObject

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

Direct_Debit_Mandate_Sequence_TypeObjectID

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

Direct_Debit_MandateReferenceEnumeration

part of: Direct_Debit_MandateObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Creditor_IdentifierReferenceEnumeration

part of: Creditor_IdentifierObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Direct_Debit_Mandate_Sequence_TypeReferenceEnumeration

part of: Direct_Debit_Mandate_Sequence_TypeObjectID
Base Type
string
top