GET action not supported
get
/fscmRestApi/resources/11.13.18.05/inventoryBalanceTransactions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey
Finder Variables:
- PrimaryKey
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : inventoryBalanceTransactions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-item-response
Type:
Show Source
object
-
FailedRecordsCount: integer
Number of balance transactions that failed.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnMessageCode: string
Abbreviation that identifies the error that occurred when calling the service. If the call is successful, then this attribute is empty.
-
ReturnMessageText: string
Text of the error message, if any, that occurred when calling the service. If the call is successful, then this attribute is empty.
-
ReturnStatus: string
Status of the current service call. Values include SUCCESS or FAILURE.
-
SubmitForProcessing: string
Contains one of the following values: Yes or No. If Yes, then process the inventory balance records. If No, then do not process these records. This attribute does not have a default value.
-
SuccessRecordsCount: integer
Number of balance transactions that the application successfully processed.
-
TotalRecordsCount: integer
Total number of balance records.
-
transactionLines: array
Transaction Lines
Title:
Transaction Lines
The Transaction Lines resource manages details about the inventory balance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Lines
Type:
array
Title:
Transaction Lines
The Transaction Lines resource manages details about the inventory balance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inventoryBalanceTransactions-transactionLines-item-response
Type:
Show Source
object
-
AccountAliasId: integer
(int64)
Value that uniquely identifies the account to use for the adjustment transaction.
-
AccountAliasName: string
Title:
Account Alias
Maximum Length:255
Name of the account alias to use for the adjustment transaction. -
AgingOnsetDate: string
(date)
Title:
Aging Start Date
Date when the aging period starts for the balance record in consigned inventory. -
ConsignmentAgreementNumber: string
Title:
Purchase Agreement
Maximum Length:30
Number that identifies the consignment agreement for the consigned quantity. -
dffForTransactionLines: array
Flexfields for Transaction Lines
Title:
Flexfields for Transaction Lines
The Flexfields for Transaction Lines resource manages descriptive flexfields that contain details about the transaction line. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields that contain details about the inventory attributes. This resource is associated with a feature that requires opt in. -
InventoryItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the inventory item. -
itemLots: array
Lot Details for Items
Title:
Lot Details for Items
The Lot Details for Items resource manages details about the lot that the inventory balance references when a lot controls the item. -
ItemNumber: string
Title:
Item
Maximum Length:300
Number of the item. -
itemSerials: array
Serial Details for Items
Title:
Serial Details for Items
The Serial Details for Items resource manages details about the serial that the inventory balance references when a serial controls the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
Locator
Maximum Length:255
Name of the locator for the balance transaction line. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Title:
Organization ID
Value that uniquely identifies the organization. -
OrganizationName: string
Title:
Organization Name
Maximum Length:240
Name of the organization. -
OwningOrganizationCode: string
Title:
Owning Party Site
Maximum Length:240
Site of the owning organization. -
OwningOrganizationId: integer
(int64)
Value that uniquely identifies the owning organization.
-
OwningTradingPartnerType: string
Title:
Transfer Owning Party Type
Maximum Length:30
Contains one of the following values: 1 or 2. If 1, then the balance record is a consigned quantity. If 2, then the balance record is an owned item quantity. The default value is 2. -
PrcBUName: string
Title:
Procurement BU
Maximum Length:240
Name of the procuring business unit. Applies only for a consigned quantity. -
PrimaryUnitOfMeasure: string
Title:
New On-Hand Quantity UOM
Maximum Length:25
Primary unit of measure for the item in the current organization. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure for the item in the current organization. -
PrimaryUOMQuantity: number
Title:
New On-Hand Quantity
Balance quantity in the primary unit of measure for the item. -
Revision: string
Title:
Revision
Maximum Length:18
Contains one of the following values. Revision: the warehouse placed the item under revision control. Empty: revisions do not control the item. -
SecondaryUnitOfMeasure: string
Title:
New Secondary On-Hand Quantity UOM
Maximum Length:25
Secondary unit of measure for the item in the current organization. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure for the item in the current organization. -
SecondaryUOMQuantity: number
Title:
New Secondary On-Hand Quantity
Balance quantity in the secondary unit of measure for the item. -
Subinventory: string
Title:
Subinventory
Maximum Length:10
Name of the subinventory that the balance transaction line uses to fulfill the request. -
TransactionSourceCode: string
Title:
Source
Maximum Length:30
Abbreviation that identifies the source of the transaction. -
VendorName: string
Title:
Supplier
Maximum Length:240
Name of the supplier who supplies the consigned quantity. -
VendorNumber: string
Title:
Supplier Number
Maximum Length:30
Value that uniquely identifies the supplier who supplies the consigned quantity.
Nested Schema : Flexfields for Transaction Lines
Type:
array
Title:
Flexfields for Transaction Lines
The Flexfields for Transaction Lines resource manages descriptive flexfields that contain details about the transaction line.
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type:
array
Title:
Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields that contain details about the inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Lot Details for Items
Type:
array
Title:
Lot Details for Items
The Lot Details for Items resource manages details about the lot that the inventory balance references when a lot controls the item.
Show Source
Nested Schema : Serial Details for Items
Type:
array
Title:
Serial Details for Items
The Serial Details for Items resource manages details about the serial that the inventory balance references when a serial controls the item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-dffForTransactionLines-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context name for transaction lines. -
__FLEX_Context_DisplayValue: string
Title:
Context
Descriptive flexfield context display value for transaction lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Title:
Interface ID
Value that uniquely identifies the transaction line for the inventory balance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-inventoryAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the inventory project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the inventory task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the inventory task. This attribute is associated with a feature that requires opt in. -
TransactionInterfaceId: integer
(int64)
Title:
Interface ID
Value that uniquely identifies the transaction line for the inventory balance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemLots-item-response
Type:
Show Source
object
-
Age: number
Age of the lot.
-
dffForItemLots: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages descriptive flexfields that contain details about the lot. -
ExpirationActionCode: string
Title:
Expiration Action
Maximum Length:32
Abbreviation that identifies the action taken to expire the lot. -
ExpirationActionDate: string
(date)
Title:
Expiration Action Date
Date when the lot expiration action occurred. -
ExpirationActionName: string
Title:
Description
Maximum Length:80
Description of the action taken to expire the lot. -
GradeCode: string
Title:
Grade
Maximum Length:150
Abbreviation that identifies the lot grade. -
HoldDate: string
(date)
Title:
Hold Until Date
Date when the hold will release for the lot. -
itemSerialsForLot: array
Serial and Lot Details for Items
Title:
Serial and Lot Details for Items
The Serial and Lot Details for Items resource manages details that the inventory balance references when a serial and a lot control the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotExpirationDate: string
(date)
Title:
Lot Expiration Date
Date when the lot expires. -
LotNumber: string
Title:
Lot
Maximum Length:80
Lot number of the item when the warehouse places the item under lot control. -
OriginationDate: string
(date)
Title:
Origination Date
Date when the lot originated. -
OriginationType: string
Title:
Origination Type
Maximum Length:30
Origination type of the lot. -
ParentLotNumber: string
Title:
Parent Lot
Maximum Length:80
Lot number of the parent lot. -
PlaceOfOrigin: string
Maximum Length:
150
Place of origin of the lot. -
PrimaryQuantity: number
Title:
New On-Hand Quantity
Transaction quantity for this lot in the primary unit of measure for the item. -
PrimaryUnitOfMeasure: string
Title:
New On-Hand Quantity UOM
Maximum Length:25
Primary unit of measure for the item in the current organization. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure for the item in the current organization. -
SecondaryQuantity: number
Title:
New Secondary On-Hand Quantity
Transaction quantity for this lot in the secondary unit of measure for the item. -
SecondaryUnitOfMeasure: string
Title:
New Secondary On-Hand Quantity UOM
Maximum Length:25
Secondary unit of measure for the item in the current organization. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure for the item in the current organization. -
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the status of the material that the lot references. -
StatusId: integer
(int64)
Value that uniquely identifies the lot status.
-
StatusName: string
Title:
Description
Maximum Length:240
Description of the lot status. -
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:150
Supplier lot number. -
TerritoryCode: string
Maximum Length:
3
Abbreviation that identifies the territory. -
TerritoryShortName: string
Maximum Length:
80
Name of the territory. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier who supplies the material.
-
VendorName: string
Title:
Supplier
Maximum Length:240
Name of the supplier who supplies the material.
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages descriptive flexfields that contain details about the lot.
Show Source
Nested Schema : Serial and Lot Details for Items
Type:
array
Title:
Serial and Lot Details for Items
The Serial and Lot Details for Items resource manages details that the inventory balance references when a serial and a lot control the item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemLots-dffForItemLots-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for item lots when an item is under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for item lots when an item is under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TxnLotInterfaceId: integer
(int64)
Value that uniquely identifies the lot balance record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemLots-itemSerialsForLot-item-response
Type:
Show Source
object
-
dffForItemSerialsForLot: array
Flexfields for Serials and Lots
Title:
Flexfields for Serials and Lots
The Flexfields for Serials and Lots resource manages descriptive flexfields that contain details about the item when a serial and lot control the item. -
FromSerialNumber: string
Title:
From Serial Number
Maximum Length:80
Starting serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control. -
FromVendorSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Starting supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginationDate: string
(date)
Title:
Origination Date
Date when the serial originated. -
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the serial status. -
StatusId: integer
(int64)
Value that uniquely identifies the serial status.
-
StatusName: string
Title:
Description
Maximum Length:240
Name of the serial status. -
TerritoryCode: string
Maximum Length:
30
Value that uniquely identifies the territory. -
TerritoryShortName: string
Maximum Length:
80
Name of the territory. -
ToSerialNumber: string
Title:
To Serial Number
Maximum Length:80
Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control. -
ToVendorSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Ending supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control.
Nested Schema : Flexfields for Serials and Lots
Type:
array
Title:
Flexfields for Serials and Lots
The Flexfields for Serials and Lots resource manages descriptive flexfields that contain details about the item when a serial and lot control the item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemLots-itemSerialsForLot-dffForItemSerialsForLot-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials when an item is under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials when an item is under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialTxnInterfaceId: integer
(int64)
Value that uniquely identifies the serial balance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemSerials-item-response
Type:
Show Source
object
-
dffForItemSerials: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item. -
FromSerialNumber: string
Title:
From Serial Number
Maximum Length:80
Starting serial number in a range of serial. This attribute is used when the warehouse places the item under serial control. -
FromVendorSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Starting supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginationDate: string
(date)
Title:
Origination Date
Date when the serial originated. -
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the serial status. -
StatusId: integer
(int64)
Value that uniquely identifies the serial status.
-
StatusName: string
Title:
Description
Maximum Length:240
Name of the serial status. -
TerritoryCode: string
Maximum Length:
30
Value that uniquely identifies the territory. -
TerritoryShortName: string
Maximum Length:
80
Name of the territory. -
ToSerialNumber: string
Title:
To Serial Number
Maximum Length:80
Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control. -
ToVendorSerialNumber: string
Title:
Supplier Serial Number
Maximum Length:80
Ending supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages descriptive flexfields that contain details about the item when a serial controls the item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemSerials-dffForItemSerials-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials when an item is under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials when an item is under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialTxnInterfaceId: integer
(int64)
Value that uniquely identifies the serial balance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source