Service Directory > v31.2 > Inventory > Get_Inventory_Par_Counts
 

Operation: Get_Inventory_Par_Counts

This service operation will get Inventory Par Counts for the specified criteria.


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

Contains request reference, criteria, filter and response group for getting Inventory Par Count data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Inventory_Par_Count_Request_References  [0..1]  Element containing reference instances for inventory par count   
Request_Criteria [Choice]   Inventory_Par_Count_Request_Criteria  [0..1]  Utilize the following element to find inventory par counts in the Workday system.   
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  Inventory_Par_Count_Response_Group  [0..1]  Element containing invemntory par count response grouping options   
top
 

Response Element: Get_Inventory_Par_Counts_Response

Inventory Par Counts Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Par_Count_Request_References  [0..1]  Element containing reference instances for inventory par count   
Request_Criteria  Inventory_Par_Count_Request_Criteria  [0..1]  Utilize the following element to find inventory par counts in the Workday system.   
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_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_Group  Inventory_Par_Count_Response_Group  [0..1]  Element containing invemntory par count response grouping options   
Response_Data  Inventory_Par_Count_Response_Data  [0..1]  Inventory Par Count Response Data   
top
 

Inventory_Par_Count_Request_References

part of: Get_Inventory_Par_Counts_Request, Get_Inventory_Par_Counts_Response
Element containing reference instances for inventory par count
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Count_Reference  Inventory_Par_CountObject  [1..*]  Reference to Inventory Par Count   
top
 

Inventory_Par_CountObject

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

Inventory_Par_CountObjectID

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

Inventory_Par_Count_Request_Criteria

part of: Get_Inventory_Par_Counts_Request, Get_Inventory_Par_Counts_Response
Utilize the following element to find inventory par counts in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company or Company Hierarchy   
Par_Location_Reference  LocationObject  [1..1]  Reference to Inventory Par Location   
Par_Count_Number  string (513)   [0..1]  Inventory Par Count Doucment ID   
Par_Count_Created_On_or_After  date  [0..1]  Inventory Par Count created on or after date   
Par_Count_Created_On_or_Before  date  [0..1]  Inventory Par Count created on or before date   
Par_Count_Statuses_Reference  Document_StatusObject  [0..*]  Valid Inventory Par Count statuses   
Created_By_Worker_Reference  WorkerObject  [0..*]  Reference(s) to existing worker(s) that the Inventory Par Count was created by   
Exclude_Canceled  boolean  [0..1]  Exclude Inventory Par Counts that are Canceled   
Exclude_Ad_Hoc  boolean  [0..1]  Exclude Inventory Par Counts that are Ad Hoc   
Exclude_Kanban  boolean  [0..1]  Exclude Inventory Par Counts that are Kanban   
top
 

CompanyObject

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

LocationObject

part of: Inventory_Par_Count_Request_Criteria, Inventory_Par_Count, Inventory_Par_Count_Outbound_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
 

Document_StatusObject

part of: Inventory_Par_Count_Request_Criteria, Inventory_Par_Count_Outbound_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
 

WorkerObject

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

WorkerObjectID

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

Inventory_Par_Count_Response_Group

part of: Get_Inventory_Par_Counts_Request, Get_Inventory_Par_Counts_Response
Element containing invemntory par count response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Inventory_Par_Count_Response_Data

part of: Get_Inventory_Par_Counts_Response
Inventory Par Count Response Data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Par_Count  Inventory_Par_Count  [0..*]  Inventory Par Count Response Data   
top
 

Inventory_Par_Count

part of: Inventory_Par_Count_Response_Data
Inventory Par Count
 
Parameter name Type/Value Cardinality Description Validations
Par_Location_Reference  LocationObject  [0..1]  Par Location Reference   
Inventory_Par_Count_Data  Inventory_Par_Count_Outbound_Data  [0..*]  Inventory Par Count Data Payload   
top
 

Inventory_Par_Count_Outbound_Data

part of: Inventory_Par_Count
Element containing Outbound Inventory Par Count Data and Par Count Lines
 
Parameter name Type/Value Cardinality Description Validations
Par_Count_ID  string  [0..1]  Reference ID for Par Count   
Document_Number  string  [0..1]  Document Number   
Ad_Hoc_Par_Count  boolean  [0..1]  Ad Hoc Par Count   
Kanban_Par_Count  boolean  [0..1]  Kanban Par Count   
Document_Status_Reference  Document_StatusObject  [0..1]  Par Count Document Status Reference   
Count_Date  date  [0..1]  Count Date Reference   
Inventory_Par_Location_Reference  LocationObject  [0..1]  Reference for Par location   
Created_By_Reference  WorkerObject  [0..1]  Created By Reference   
Inventory_Par_Count_Line_Data  Inventory_Par_Count_Line_Outbound_Data  [0..*]  Inventory Par Count Line Data   
top
 

Inventory_Par_Count_Line_Outbound_Data

part of: Inventory_Par_Count_Outbound_Data
Element containing Inventory Par Count Line Data
 
Parameter name Type/Value Cardinality Description Validations
Par_Count_Line_Reference  Inventory_Par_Count_LineObject  [0..1]  Reference to an Inventory Par Count Line   
Par_Count_Line_Number  decimal (12, 0) >0   [0..1]  Reference to an Inventory Par Count Line number   
Item_Reference  Item_DescriptorObject  [0..1]  Reference to the Procurement Item on Inventory Par Count Line   
Line_Item_Description  string  [0..1]  Item Description   
Kanban  boolean  [0..1]  Indicates the Par Count Line is a Kanban Line.   
Par_Location_Bin_Reference  Par_Location_BinObject  [0..1]  Reference to Inventory Par Location Bin   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference to the Unit of Measure on the Inventory Par Count Line.   
Count_Quantity  decimal (22, 2) >0   [0..1]  Reference to the Count Quantity on the Inventory Par Count Line   
Request_Quantity  decimal (22, 2) >0   [0..1]  Reference to the Request Order Quantity on the Inventory Par Count Line   
Zero_On_Hand  boolean  [0..1]  Zero On Hand indicates that the actual Count Quantiy is zero when Par Count Option is set to Count Quantity   
Alternate_Item_Identifiers_Data  Alternate_Item_Identifiers_for_Inventory_Transaction_Data  [0..*]  Purchase Item Alternate Item Identifiers Data   
Item_Tag_Reference  Item_TagObject  [0..*]  Item tags for the Purchase Item.   
top
 

Inventory_Par_Count_LineObject

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

Inventory_Par_Count_LineObjectID

part of: Inventory_Par_Count_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Par_Count_Line_Number  [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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Inventory_Par_Count_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Item_DescriptorObject

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

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_Item_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
 

Par_Location_BinObject

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

Par_Location_BinObjectID

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

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Alternate_Item_Identifiers_for_Inventory_Transaction_Data

part of: Inventory_Par_Count_Line_Outbound_Data
Purchase Item Alternate Item Identifiers Data
 
Parameter name Type/Value Cardinality Description Validations
Item_Identifier_Type_Reference  Item_Identifier_TypeObject  [1..1]  Reference to existing Item Identifier Types associated with the Spend Category   
Alternate_Item_Identifier_Value  string  [0..1]  Item Identifier Type Value   
Manufacturer_Reference  ManufacturerObject  [0..1]  Reference to existing Manufacturer associated with the Item Identifier Type   
top
 

Item_Identifier_TypeObject

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

Item_Identifier_TypeObjectID

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

ManufacturerObject

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

ManufacturerObjectID

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

Item_TagObject

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

Item_TagObjectID

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

Inventory_Par_CountReferenceEnumeration

part of: Inventory_Par_CountObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Inventory_Par_Count_LineReferenceEnumeration

part of: Inventory_Par_Count_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Par_Location_BinReferenceEnumeration

part of: Par_Location_BinObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Item_Identifier_TypeReferenceEnumeration

part of: Item_Identifier_TypeObjectID
Base Type
string
top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top
 

Item_TagReferenceEnumeration

part of: Item_TagObjectID
Base Type
string
top