Service Directory > v31.2 > Inventory > Get_Inventory_Transactions
 

Operation: Get_Inventory_Transactions

Get Inventory Transactions web service to allow users to fetch Inventory Transaction instance using WID and 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_Transactions_Request

Contains request reference, criteria, filter for getting Inventory Transaction data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Inventory_Transaction_Request_References  [0..1]  Inventory Transaction Request References   
Request_Criteria [Choice]   Inventory_Transaction_Request_Criteria  [0..1]  Inventory Transaction Request Criteria 
Validation Description
Company or Inventory Site is required. Please enter a value in one of these fields.   
 
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Inventory_Transaction_Response_Group  [0..1]  Inventory Transaction Response Group   
top
 

Response Element: Get_Inventory_Transactions_Response

Get Inventory Transactions Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Transaction_Request_References  [0..1]  Get Inventory Transactions Request References   
Request_Criteria  Inventory_Transaction_Request_Criteria  [0..1]  Inventory Transaction Request Criteria 
Validation Description
Company or Inventory Site is required. Please enter a value in one of these fields.   
 
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_Transaction_Response_Group  [0..1]  Inventory Transaction 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_Transaction_Response_Data  [0..1]  Inventory Transaction Response Data   
top
 

Inventory_Transaction_Request_References

part of: Get_Inventory_Transactions_Request, Get_Inventory_Transactions_Response
Get Inventory Transactions Request References
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Transaction_Reference  Unique_IdentifierObject  [1..*]  Reference to an existing Inventory Transaction   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Get_Inventory_Transactions_Request, Get_Inventory_Transactions_Response
Inventory Transaction Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Company Reference associated to Inventory Transaction   
Inventory_Site_Reference  LocationObject  [0..1]  Reference to an existing Inventory Site. Assigns the Site for the transaction and derives the Company.   
Stocking_Location_Reference  LocationObject  [0..1]  Inventory Stocking Location associated to Inventory Transaction   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Spend Categories associated to Inventory Transaction   
Inventory_Transaction_Type_Reference  Inventory_Transaction_TypeObject  [0..*]  Inventory Transaction Type associated with the Inventory Transaction   
Inventory_Item_Reference  Purchase_ItemObject  [0..1]  Inventory Items associated with the Inventory Transaction   
Transaction_Date_On_or_After  date  [0..1]  Inventory Transaction Date On or After   
Transaction_Date_On_or_Before  date  [0..1]  Inventory Transaction Date On or Before   
Issued_To_Reference  WorkerObject  [0..1]  Reference(s) to existing worker(s) that the Inventory Transaction was issued to.   
Requester_Reference  WorkerObject  [0..*]  Reference(s) to existing worker(s) that the Inventory Transaction was requested by.   
Validation Description
Company or Inventory Site is required. Please enter a value in one of these fields.   
top
 

CompanyObject

part of: Inventory_Transaction_Request_Criteria, 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  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_Transaction_Request_Criteria, Inventory_Transaction_Request_Criteria, Inventory_Transaction_Data, Inventory_Transaction_Data, 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  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
 

Spend_CategoryObject

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

Spend_CategoryObjectID

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

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

Inventory_Transaction_TypeObjectID

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

Purchase_ItemObject

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

WorkerObject

part of: Inventory_Transaction_Request_Criteria, Inventory_Transaction_Request_Criteria, Inventory_Transaction_Data, 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  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_Transactions_Request, Get_Inventory_Transactions_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_Transaction_Response_Group

part of: Get_Inventory_Transactions_Request, Get_Inventory_Transactions_Response
Inventory Transaction Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Ref   
top
 

Response_Results

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

part of: Get_Inventory_Transactions_Response
Inventory Transaction Response Data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Transaction  Inventory_Transaction  [0..*]  Inventory Transaction Payload   
top
 

Inventory_Transaction

part of: Inventory_Transaction_Response_Data
Inventory Transaction
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Transaction_Reference  Unique_IdentifierObject  [0..1]  Inventory Transaction Ref   
Inventory_Transaction_Data  Inventory_Transaction_Data  [0..*]  Inventory Transaction Data payload   
top
 

Inventory_Transaction_Data

part of: Inventory_Transaction
Inventory Transaction Data
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Transaction_Type_Reference  Inventory_Transaction_TypeObject  [0..1]  Inventory Transaction Type Reference   
Transaction_Date_Time  dateTime  [0..1]  Transaction Date Time   
Company_Reference  CompanyObject  [0..1]  Company Reference   
Inventory_Site_Reference  LocationObject  [0..1]  Inventory Site Reference   
Created_By_Reference  WorkerObject  [0..1]  Created By Reference   
Location_Reference  LocationObject  [0..1]  Location Reference   
Spend_Category_Reference  Spend_CategoryObject  [0..1]  Spend Category Reference   
To___From_Inventory_Site_Reference  LocationObject  [0..*]  To / From Inventory Site Reference   
Requester_Reference  WorkerObject  [0..1]  Requester Reference   
Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Purchase Item Reference   
Item_Lot_Reference  Item_LotObject  [0..1]  Item Lot Reference   
Serial_Number_Reference  Item_SerialObject  [0..*]  Reference of the serial numbers of the Inventory Item being issued   
Transaction_Stocking_Quantity  decimal (26, 6)   [0..1]  Transaction Stocking Quantity   
Unit_of_Measure_CF_Reference  Unique_IdentifierObject  [0..1]  Unit of Measure CF Reference   
Total_Base_Quantity_On_Hand  decimal (26, 6)   [0..1]  Total Base Quantity On Hand   
Transaction_Unit_Cost  decimal (26, 6) >0   [0..1]  Transaction Unit Cost   
Inventory_Transaction_Cost_Markup  decimal (26, 6) >0   [0..1]  Inventory Transaction Cost Markup   
Base_Unit_Cost  decimal (26, 6) >0   [0..1]  Base Unit Cost   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Transaction_Base_Currency_Conversion_Rate  decimal (18, 6) >0   [0..1]  Transaction Base Currency Conversion Rate   
Prior_Average_Cost  decimal (26, 6) >0   [0..1]  Prior Average Cost   
Average_Cost_In_Base_Currency  decimal (26, 6) >0   [0..1]  Average Cost In Base Currency   
Accounting_Date_for_Inventory_Transaction  date  [0..1]  Accounting Date for Inventory Transaction   
top
 

Item_LotObject

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

CurrencyObject

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

CurrencyObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Inventory_Transaction_TypeReferenceEnumeration

part of: Inventory_Transaction_TypeObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Item_LotReferenceEnumeration

part of: Item_LotObjectID
Base Type
string
top
 

Item_SerialReferenceEnumeration

part of: Item_SerialObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top