Service Directory > v32.1 > Inventory > Get_Inventory_Balance
 

Operation: Get_Inventory_Balance

Retrieve the result of Inventory Balances via Web Service operations


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

Get Inventory Balance Request WWS Data Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Company_Reference  CompanyObject  [0..1]  Company parameter for search criteria   
Inventory_Site_Reference  LocationObject  [0..1]  Inventory site parameter for search criteria   
Inventory_Items_Reference  Purchase_ItemObject  [0..*]  Inventory Items parameter for search criteria   
Location_or_Location_Hierarchy_Reference  Asset_Location_or_Location_HierarchyObject  [0..*]  Location or Location Hierarchy parameter for search criteria   
Show_Inventory_Zero_Balance  boolean  [0..1]  boolean flag of showing inventory zero   
Validation Description
Company or Inventory Site is required. Please enter a value in one of these fields.  Company or Inventory Site is required. Please enter a value in one of these fields. 
top
 

Response Element: Get_Inventory_Balance_WWS_Main_Response

Get Inventory Balance Main Response view
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Company_for_Inventory_Reference  CompanyObject  [0..1]  Company parameter for search criteria   
Inventory_Site_Reference  LocationObject  [0..1]  Inventory site parameter for search criteria   
Inventory_Items_Reference  Purchase_ItemObject  [0..*]  Inventory Items parameter for search criteria   
Location_or_Location_Hierarchy_Reference  Asset_Location_or_Location_HierarchyObject  [0..*]  Location or Location Hierarchy parameter for search criteria   
Show_Inventory_Zero_Balance  boolean  [0..1]  boolean flag of showing inventory zero   
Get_Inventory_Balance_Detail_Response_Element  Get_Inventory_Balance_Detail_Response  [0..*]  Get Inventory Balance Detail response element   
top
 

CompanyObject

part of: Get_Inventory_Balance_WWS_Request, Get_Inventory_Balance_WWS_Main_Response
 
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: Get_Inventory_Balance_WWS_Request, Get_Inventory_Balance_WWS_Main_Response, Get_Inventory_Balance_Detail_Site_Response, Get_Inventory_Balance_Detail_Sub_Response
 
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
 

Purchase_ItemObject

part of: Get_Inventory_Balance_WWS_Request, Get_Inventory_Balance_WWS_Main_Response, Get_Inventory_Balance_Detail_Response
 
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
 

Asset_Location_or_Location_HierarchyObject

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

Asset_Location_or_Location_HierarchyObjectID

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

Get_Inventory_Balance_Detail_Response

part of: Get_Inventory_Balance_WWS_Main_Response
Get Inventory Balance WWS Main Response Element
 
Parameter name Type/Value Cardinality Description Validations
Item_in_Inventory_Location_Reference  Purchase_ItemObject  [0..1]  Reference of the Location of the Inventory Item being issued   
QOH_with_UOM  string  [0..1]  QOH with UOM numeric attribute   
Get_Inventory_Balance_Detail_Site_Response_Element  Get_Inventory_Balance_Detail_Site_Response  [0..*]  Get Inventory Balance Detail Site Response Element   
top
 

Get_Inventory_Balance_Detail_Site_Response

part of: Get_Inventory_Balance_Detail_Response
Get Inventory Balance Detail response element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Balance_Detail__Inventory_Site_Reference  LocationObject  [0..1]  Inventory Site Reference   
Average_Cost_In_Base_Currency  decimal (26, 6) >0   [0..1]  Average Cost In Base Currency   
Inventory_Balance_Detail_Site_Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Get_Inventory_Balance_Detail_Site_Response_Element  Get_Inventory_Balance_Detail_Sub_Response  [0..*]  Get Inventory Balance Detail Sub Response Element   
top
 

CurrencyObject

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

Get_Inventory_Balance_Detail_Sub_Response

part of: Get_Inventory_Balance_Detail_Site_Response
Get Inventory Balance Detail Site Response Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Balance_Sub_Inventory_Location_Reference  LocationObject  [0..1]  Inventory Location Reference   
Location_Quantity_with_UOM  string  [0..1]  Location Quantity on Hand with Unit of Measure as text attribute   
Get_Inventory_Balance_Location_Quantity_Detail_View_Element  Get_Inventory_Balance_Location_Quantity_Detail_View  [0..*]  Get Inventory Balance Location Quantity Detail View Element   
top
 

Get_Inventory_Balance_Location_Quantity_Detail_View

part of: Get_Inventory_Balance_Detail_Sub_Response
Get Inventory Balance Detail Sub Response Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Location_Quantity_Reference  Unique_IdentifierObject  [0..1]  Reference to Inventory Location Quantity   
Item_Lot_Reference  Item_LotObject  [0..1]  Reference to the Item Lot ID   
Quantity_On_Hand  decimal (26, 6)   [0..1]  Quantity On Hand of Inventory Summary   
Total_Allocated_Pick_Quantity  decimal (26, 6) >0   [0..1]  Total quantity picked   
Quantity_Available  decimal (26, 6)   [0..1]  Quantity Available To Issue   
Location_Quantity_Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Location Quantity Unit of Measure Reference   
Base_Quantity_On_Hand  decimal (26, 6)   [0..1]  Base Quantity On Hand   
Base_Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Base Unit of Measure Reference   
top
 

Unique_IdentifierObject

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

Item_LotObject

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

Unit_of_MeasureObject

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

Asset_Location_or_Location_HierarchyReferenceEnumeration

part of: Asset_Location_or_Location_HierarchyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Item_LotReferenceEnumeration

part of: Item_LotObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top