Service Directory > v32.1 > Settlement_Services > Put_Direct_Debit_Mandate
 

Operation: Put_Direct_Debit_Mandate

Web service for creating a Direct Debit Mandate.


@ - 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: Put_Direct_Debit_Mandate_Request

Put Direct Debit Mandate Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
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..1]  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. 
 
Validation Description
You cannot update a Direct Debit Mandate from Active to Active.  You cannot update a Direct Debit Mandate from Active to Active. 
The Web Service is set to Add Only; but the Direct Debit Mandate already exists.  The Web Service is set to Add Only; but the Direct Debit Mandate already exists. 
You cannot edit a Direct Debit Mandate which already is Inactive.  You cannot edit a Direct Debit Mandate which already is Inactive. 
top
 

Response Element: Put_Direct_Debit_Mandate_Response

Put Direct Debit Mandate Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Direct_Debit_Mandate_Reference  Direct_Debit_MandateObject  [0..1]  Direct Debit Mandate Reference which is WID or SEPA_Mandate_ID.   
top
 

Direct_Debit_MandateObject

part of: Put_Direct_Debit_Mandate_Response, Put_Direct_Debit_Mandate_Request
 
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, Direct_Debit_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_Data

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