Service Directory > v31.2 > Inventory > Get_Inventory_Count_Sheets
 

Operation: Get_Inventory_Count_Sheets

Returns Inventory Count Sheets matching the request 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_Count_Sheets_Request

Inventory Cont Sheet request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Inventory_Count_Sheet_Request_References  [0..1]  Count Sheet reference   
Request_Criteria [Choice]   Inventory_Count_Sheet_Request_Criteria  [0..1]  Count Sheet search criteria   
Response_Filter  Response_Filter  [0..1]  response filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Inventory_Count_Sheet_Response_Group  [0..1]  response group   
top
 

Response Element: Get_Inventory_Count_Sheets_Response

count sheet response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Count_Sheet_Request_References  [0..1]  Inventory Count Sheet Request Reference   
Request_Criteria  Inventory_Count_Sheet_Request_Criteria  [0..1]  Inventory Count Sheet 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  Inventory_Count_Sheet_Response_Group  [0..1]  response group   
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  Inventory_Count_Sheet_Response_Data  [0..1]  Inventory Count Sheet response   
top
 

Inventory_Count_Sheet_Request_References

part of: Get_Inventory_Count_Sheets_Request, Get_Inventory_Count_Sheets_Response
Inventory Count Sheet Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Count_Sheet_Reference  Inventory_Count_SheetObject  [1..*]  Inventory Count Sheet Reference   
top
 

Inventory_Count_SheetObject

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

Inventory_Count_SheetObjectID

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

part of: Get_Inventory_Count_Sheets_Request, Get_Inventory_Count_Sheets_Response
Inventory Count Sheet search criteria
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Sites_Reference  LocationObject  [1..*]  Inventory Sites to find count sheets. This field is required.   
Count_Sheet_Number  string  [0..1]  Count sheet document number.   
Count_Sheet_Created_On_or_After  date  [0..1]  Count sheet created on or after date.   
Count_Sheet_Created_On_or_Before  date  [0..1]  Count sheet created on or before date.   
Count_Sheet_Statuses_Reference  Document_StatusObject  [0..*]  Count sheet statuses to include.   
Assigned_To_Workers_Reference  WorkerObject  [0..*]  Count sheet assigned to person.   
Exclude_Cancelled  boolean  [0..1]  Whether or not to exclude cancelled count sheets.   
Exclude_Closed  boolean  [0..1]  Whether or not to exclude closed count sheets.   
top
 

LocationObject

part of: Inventory_Count_Sheet_Request_Criteria, Inventory_Count_Sheet_Data, Inventory_Count_Sheet_Line_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_Count_Sheet_Request_Criteria, Inventory_Count_Sheet_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_Count_Sheet_Request_Criteria, Inventory_Count_Sheet_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_Count_Sheets_Request, Get_Inventory_Count_Sheets_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_Count_Sheet_Response_Group

part of: Get_Inventory_Count_Sheets_Request, Get_Inventory_Count_Sheets_Response
response group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  whether or not to include reference   
top
 

Response_Results

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

part of: Get_Inventory_Count_Sheets_Response
Inventory Count Sheet response
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Count_Sheet  Inventory_Count_Sheet  [0..*]  Inventory Count Sheet information   
top
 

Inventory_Count_Sheet

part of: Inventory_Count_Sheet_Response_Data
Inventory Count Sheet information
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Count_Sheet_Reference  Inventory_Count_SheetObject  [0..1]  Inventory Count Sheet Reference   
Inventory_Count_Sheet_Data  Inventory_Count_Sheet_Data  [0..*]  Inventory Count Sheet Data   
top
 

Inventory_Count_Sheet_Data

part of: Inventory_Count_Sheet
Element Containing Count Inventory Data
 
Parameter name Type/Value Cardinality Description Validations
Count_Sheet  string  [0..1]  Count Sheet Number   
Status_Reference  Document_StatusObject  [0..1]  Status of the count sheet   
Created_On  date  [0..1]  Count Sheet created on date/time   
Inventory_Site_Reference  LocationObject  [0..1]  Inventory site   
Assigned_To_Reference  WorkerObject  [0..1]  The person the count sheet is assigned to   
Adjustment_Reason_Reference  Inventory_Adjustment_ReasonObject  [0..1]  Adjustment reason   
Memo  string  [0..1]  memo   
Inventory_Count_Sheet_Line_Data  Inventory_Count_Sheet_Line_Data  [0..*]  Count sheet line specific data   
top
 

Inventory_Adjustment_ReasonObject

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

Inventory_Adjustment_ReasonObjectID

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

part of: Inventory_Count_Sheet_Data
Information about Inventory Item/Location
 
Parameter name Type/Value Cardinality Description Validations
Line_Number  decimal (6, 0) >0   [0..1]  Line Number for Count Sheet Line   
Stocking_Location_Reference  LocationObject  [0..1]  Stocking Location   
Item_Reference  Purchase_ItemObject  [0..1]  Item   
Description  string  [0..1]  Item Description   
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.   
Inventory_Count_Sheet_Line_Detail_Data  Inventory_Count_Sheet_Line_Detail_Data  [0..*]  Line Unit of Measure specific details   
top
 

Purchase_ItemObject

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

Purchase_ItemObjectID

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

Alternate_Item_Identifiers_for_Inventory_Transaction_Data

part of: Inventory_Count_Sheet_Line_Data, Inventory_Count_Sheet_Line_Detail_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_Count_Sheet_Line_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_Count_Sheet_Line_Detail_Data

part of: Inventory_Count_Sheet_Line_Data
Detailed Information about Item/Location/Unit of Measure combination
 
Parameter name Type/Value Cardinality Description Validations
Line_Number  decimal (6, 0) >0   [0..1]  Line Number for Count Sheet Line Detail   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure   
Item_Lot_Reference  Item_LotObject  [0..1]  Reference to the Item Lot ID   
Quantity_On_Hand  decimal (26, 6)   [0..1]  Quantity on Hand for the Item/Location/ Unit of Measure   
Quantity_On_Hand_As_Of  dateTime  [0..1]  Unit of Measure As of timestamp   
Quantity_Counted  decimal (26, 6) >0   [0..1]  Quantity Counted   
Zero_On_Hand  boolean  [0..1]  If the item has zero balance   
Memo  string  [0..1]  memo   
Serial_Number_Reference  Item_SerialObject  [0..*]  Serial numbers of count sheet line detail.   
Alternate_Item_Identifiers_Data  Alternate_Item_Identifiers_for_Inventory_Transaction_Data  [0..*]  Purchase Item Alternate Item Identifiers Data   
top
 

Unit_of_MeasureObject

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

Item_LotObject

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

Item_LotObjectID

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

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

Item_SerialObjectID

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

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

part of: Inventory_Adjustment_ReasonObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

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

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Item_LotReferenceEnumeration

part of: Item_LotObjectID
Base Type
string
top
 

Item_SerialReferenceEnumeration

part of: Item_SerialObjectID
Base Type
string
top