Service Directory > v31.2 > Resource_Management > Get_Location_Customer_Account_Number_Details
 

Operation: Get_Location_Customer_Account_Number_Details

This Web Service operation is to retrieve Location Customer Account Number Details by References or by Criteria. Either References or Criteria must be provided, but not both at the same time. References can be specified by one or more Reference ID or WID. Request Criteria can be Supplier, Location, Customer Account Number or Inactive flag. If no request references or request criteria is provided, then all Location Customer Account Number Details are returned by the Web Service operation. Response Data includes Supplier, Location, Customer Account Number, JIT Customer Account Number 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_Location_Customer_Account_Number_Details_Request

Element containing sub elements for Request Reference, Request Criteria, Response Filter and Response Group to retrieve Location Customer Account Number information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Location_Customer_Account_Number_Detail_Request_References  [0..1]  "References" element that allows specific object instances to be returned based on ID values.   
Request_Criteria [Choice]   Location_Customer_Account_Number_Detail_Request_Criteria  [0..1]  Element containing the filter criteria for Location Customer Account Number Details.   
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  Location_Customer_Account_Number_Detail_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the response.   
top
 

Response Element: Get_Location_Customer_Account_Number_Details_Response

Element containing Location Customer Account Number Detail response elements including request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Location_Customer_Account_Number_Detail_Request_References  [0..1]  "References" element allowing the specification of specific object instances to be returned based on ID values.   
Request_Criteria  Location_Customer_Account_Number_Detail_Request_Criteria  [0..1]  Element containing filter criteria for Location Customer Account Number Details.   
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  Location_Customer_Account_Number_Detail_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the 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  Location_Customer_Account_Number_Detail_Response_Data  [0..1]  Element containing Location Customer Account Number Details response data for requested references.   
top
 

Location_Customer_Account_Number_Detail_Request_References

part of: Get_Location_Customer_Account_Number_Details_Request, Get_Location_Customer_Account_Number_Details_Response
"References" element allowing the specification of specific object instances to be returned based on ID values.
 
Parameter name Type/Value Cardinality Description Validations
Location_Customer_Account_Number_Detail_Reference  Location_Customer_Account_Number_DetailObject  [1..*]  Reference to existing Location Customer Account Number Details.   
top
 

Location_Customer_Account_Number_DetailObject

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

Location_Customer_Account_Number_DetailObjectID

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

Location_Customer_Account_Number_Detail_Request_Criteria

part of: Get_Location_Customer_Account_Number_Details_Request, Get_Location_Customer_Account_Number_Details_Response
Element containing filter criteria for Location Customer Account Number Details.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  SupplierObject  [0..*]  Reference to existing Suppliers.   
Location_Reference  LocationObject  [0..*]  Reference to existing Locations.   
Customer_Account_Number  string (30)   [0..1]  Location Customer Account Number   
Inactive  boolean  [0..1]  Indicates whether the Location Customer Account Number is inactive or not.   
top
 

SupplierObject

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

LocationObject

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

LocationObjectID

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

Location_Customer_Account_Number_Detail_Response_Group

part of: Get_Location_Customer_Account_Number_Details_Request, Get_Location_Customer_Account_Number_Details_Response
Wrapper element around a list of elements representing the amount of data that should be included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Location_Customer_Account_Number_Detail_Response_Data

part of: Get_Location_Customer_Account_Number_Details_Response
Element containing Location Customer Account Number Details response data for requested references.
 
Parameter name Type/Value Cardinality Description Validations
Location_Customer_Account_Number_Detail  Location_Customer_Account_Number_Detail  [0..*]  Element for Location Customer Account Number Detail Reference and Location Customer Account Number Detail Data.   
top
 

Location_Customer_Account_Number_Detail

part of: Location_Customer_Account_Number_Detail_Response_Data
Element for Location Customer Account Number Detail Reference and Location Customer Account Number Detail Data.
 
Parameter name Type/Value Cardinality Description Validations
Location_Customer_Account_Number_Detail_Reference  Location_Customer_Account_Number_DetailObject  [0..1]  Reference to an existing Location Customer Account Number Detail.   
Location_Customer_Account_Number_Detail_Data  Location_Customer_Account_Number_Detail_Data  [0..*]  Element containing Location Customer Account Number Detail Data. 
Validation Description
The specified Location is inactive and hence cannot be associated with an EDI Customer Account Number.   
Either Customer Account Number or Just In Time Customer Account Number must have a value   
Company is already included in one of the selected Company Hierarchies.   
Enter one of the following: Order-From Connection, Company, Location.   
Company Hierarchy is already included in one of the hierarchies selected.   
Modify Order-From Connection, Company or Location to avoid duplicate entry   
 
top
 

Location_Customer_Account_Number_Detail_Data

part of: Location_Customer_Account_Number_Detail
Element containing Location Customer Account Number Detail Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Location Customer Account Number Detail ID.   
Supplier_Reference  SupplierObject  [1..1]  Reference to an existing Supplier.   
Order-From_Connection_Reference  Order-From_Supplier_ConnectionObject  [0..*]  Reference to Order-From Supplier Connections for the Supplier   
Company_Reference  OrganizationObject  [0..*]  Reference to the Company or Company Hierarchies   
Location_Reference  LocationObject  [0..1]  Reference to an existing Location.   
Customer_Account_Number  string (30)   [0..1]  Customer Account Number.   
Just_In_Time_Customer_Account_Number  string (30)   [0..1]  Enter the Just in Time Customer Account Number for this Supplier or Location   
Inactive  boolean  [0..1]  Inactive   
Validation Description
The specified Location is inactive and hence cannot be associated with an EDI Customer Account Number.   
Either Customer Account Number or Just In Time Customer Account Number must have a value   
Company is already included in one of the selected Company Hierarchies.   
Enter one of the following: Order-From Connection, Company, Location.   
Company Hierarchy is already included in one of the hierarchies selected.   
Modify Order-From Connection, Company or Location to avoid duplicate entry   
top
 

Order-From_Supplier_ConnectionObject

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

Order-From_Supplier_ConnectionObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Location_Customer_Account_Number_DetailReferenceEnumeration

part of: Location_Customer_Account_Number_DetailObjectID
Base Type
string
top
 

SupplierReferenceEnumeration

part of: SupplierObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Order-From_Supplier_ConnectionReferenceEnumeration

part of: Order-From_Supplier_ConnectionObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top