Service Directory > v31.2 > Revenue_Management > Get_Company_Creditor_Identifiers
 

Operation: Get_Company_Creditor_Identifiers

This service operation will get Company Creditor Identifiers for Direct Debit mandates. Creditor Identifier data Active Indicator, Country, and the text Identifier itself.


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

Highest level element for the Company Creditor Identifier get request for web services.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Creditor_Identifier_Request_References  [0..1]  Get Request for Company Creditor Identifiers web services.   
Request_Criteria  Company_Creditor_Identifier_Request_Criteria  [0..*]  Element containing the Company Creditor Identifier search criteria.   
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  Company_Creditor_Identifier_Response_Group  [0..1]  Company Creditor Identifier response group element.   
top
 

Response Element: Get_Company_Creditor_Identifiers_Response

Contains all of the subelements needed for a get response for Company Creditor Identifier queries via Web Services.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Creditor_Identifier_Request_References  [0..1]  Get Request for Company Creditor Identifiers web services.   
Request_Criteria  Company_Creditor_Identifier_Request_Criteria  [0..*]  Company Creditor Identifier request criteria specifies the criteria for the request.   
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  Company_Creditor_Identifier_Response_Group  [0..1]  Element containing Company Creditor Identifier response elements including original get request data and its result.   
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  Company_Creditor_Identifier_Response_Data  [0..1]  Contains the get response data for a Company Creditor Identifier web services Request.   
top
 

Company_Creditor_Identifier_Request_References

part of: Get_Company_Creditor_Identifiers_Request, Get_Company_Creditor_Identifiers_Response
Get Request for Company Creditor Identifiers web services.
 
Parameter name Type/Value Cardinality Description Validations
Company_Creditor_Identifier_Reference  Creditor_IdentifierObject  [0..*]  Reference for Creditor Identifier.   
top
 

Creditor_IdentifierObject

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

Company_Creditor_Identifier_Request_Criteria

part of: Get_Company_Creditor_Identifiers_Request, Get_Company_Creditor_Identifiers_Response
Element containing the Company Creditor Identifier search criteria.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..*]  Reference to an existing Company that the request criteria is for.   
top
 

CompanyObject

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

Response_Filter

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

Company_Creditor_Identifier_Response_Group

part of: Get_Company_Creditor_Identifiers_Request, Get_Company_Creditor_Identifiers_Response
Company Creditor Identifier response group element.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Company_Creditor_Identifier_Response_Data

part of: Get_Company_Creditor_Identifiers_Response
Contains the get response data for a Company Creditor Identifier web services Request.
 
Parameter name Type/Value Cardinality Description Validations
Company_Creditor_Identifier  Company_Creditor_Identifier  [0..*]  Contains the company and subelement for additional fields as relates to a Company Creditor Identifier as used for Direct Debit Mandates web services.   
top
 

Company_Creditor_Identifier

part of: Company_Creditor_Identifier_Response_Data
Contains the company and subelement for additional fields as relates to a Company Creditor Identifier as used for Direct Debit Mandates web services.
 
Parameter name Type/Value Cardinality Description Validations
Creditor_Identifier_Reference  Creditor_IdentifierObject  [0..1]  Creditor Identifier reference.   
Company_Creditor_Identifier_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.   
 
top
 

Company_Creditor_Identifier_WS_Detail_Data

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

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
 

Business_Form_LayoutObject

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

Creditor_IdentifierReferenceEnumeration

part of: Creditor_IdentifierObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Business_Form_LayoutReferenceEnumeration

part of: Business_Form_LayoutObjectID
Base Type
string
top