Service Directory > v32.1 > Revenue_Management > Put_Company_Creditor_Identifier
 

Operation: Put_Company_Creditor_Identifier

This is the put task to update Company Creditor Identifiers from a grid that the customer will send via Web Services.


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

Contains elements needed to process a put request for Company Creditor Identifier web services.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Indicates that all of the records in a put request for web services are to be considered as adds.   
Creditor_Identifier_Reference  Creditor_IdentifierObject  [0..1]  Reference to the Creditor Identifier class within the web services request.   
Company_Mandate_Business_Form_Layout_Reference  Business_Form_LayoutObject  [0..1]  Reference to the Business Form Layout used by the Company for Mandate.   
Company_Mandate_Pre-notification_Business_Form_Layout_Reference  Business_Form_LayoutObject  [0..1]  Reference to the Business Form Layout used by the Company for Mandate Pre-notifications.   
Company_Creditor_Identifier_WS_Detail_Data  Company_Creditor_Identifier_WS_Detail_Data  [0..*]  Contains the fields associated with a Company Creditor Identifier as used for Direct Debit Mandates. 
Validation Description
Only one creditor identifier per company and country can be marked as active.   
 
Validation Description
The Web Service is set to Add Only; but the object being updated already exists.  Validation error message for duplicate record for Creditor Identifier. 
top
 

Response Element: Put_Company_Creditor_Identifier_Response

Contains the response to a put request for Company Creditor Identifier web services.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Creditor_Identifier_Reference  Creditor_IdentifierObject  [0..1]  Contains the response to a put request for Company Creditor Identifier.   
top
 

Creditor_IdentifierObject

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

Business_Form_LayoutObject

part of: Put_Company_Creditor_Identifier_Request, Put_Company_Creditor_Identifier_Request, Company_Creditor_Identifier_WS_Detail_Data, Company_Creditor_Identifier_WS_Detail_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  Business_Form_LayoutObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_Form_LayoutObjectID

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

Company_Creditor_Identifier_WS_Detail_Data

part of: Put_Company_Creditor_Identifier_Request
Contains the fields associated with a Company Creditor Identifier as used for Direct Debit Mandates.
 
Parameter name Type/Value Cardinality Description Validations
Creditor_Identifier_Reference_ID  string  [0..1]  The internal reference ID of the Company Creditor Identifier.   
Company_Reference  CompanyObject  [1..1]  The company component of the web services request.   
Country_Reference  CountryObject  [1..1]  The country that applies to the Company Creditor Identifier.   
Mandate_Business_Form_Layout_Reference  Business_Form_LayoutObject  [0..1]  The Mandate Business Form Layout used by the Creditor Identifier.   
Mandate_Pre-notification_Business_Form_Layout_Reference  Business_Form_LayoutObject  [0..1]  The Mandate Pre-notification Business Form Layout used by the Creditor Identifier   
Creditor_Identification  string (35)   [1..1]  The user entered value for the Company Creditor Identifier.   
Active  boolean  [0..1]  Indicates that the Company Creditor Identifier is active when checked.   
Validation Description
Only one creditor identifier per company and country can be marked as active.   
top
 

CompanyObject

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

part of: Creditor_IdentifierObjectID
Base Type
string
top
 

Business_Form_LayoutReferenceEnumeration

part of: Business_Form_LayoutObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top