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 :Find the balance messages according to the header identifier.
Finder Variables:
- PrimaryKey :Find the balance messages according to the header identifier.
-
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: string
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: string
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:
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.
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe 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:
LinksThe 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 don't process these records. This attribute doesn't 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 LinesThe Transaction Lines resource manages details about the inventory balance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Lines
Type:
arrayTitle:
Transaction LinesThe Transaction Lines resource manages details about the inventory balance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 AliasMaximum Length:255Name of the account alias to use for the adjustment transaction. -
AgingOnsetDate: string
(date)
Title:
Aging Start DateDate when the aging period starts for the balance record in consigned inventory. -
ConsignmentAgreementNumber: string
Title:
Purchase AgreementMaximum Length:30Number that identifies the consignment agreement for the consigned quantity. -
dffForTransactionLines: array
dffForTransactionLines
-
inventoryAttributesDFF: array
inventoryAttributesDFF
-
InventoryItemId: integer
(int64)
Title:
Item IDValue that uniquely identifies the inventory item. -
itemLots: array
Lot Details for Items
Title:
Lot Details for ItemsThe Lot Details for Items resource manages details about the lot that the inventory balance references when a lot controls the item. -
ItemNumber: string
Title:
ItemMaximum Length:300Number of the item. -
itemSerials: array
Serial Details for Items
Title:
Serial Details for ItemsThe 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:
LinksThe link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
LocatorMaximum Length:255Name of the locator for the balance transaction line. -
LPNId: integer
(int64)
Value that uniquely identifies the license plate number.
-
LPNNumber: string
Maximum Length:
30License plate number associated to the item. -
OrganizationCode: string
Title:
Organization CodeMaximum Length:18Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Title:
Organization IDValue that uniquely identifies the organization. -
OrganizationName: string
Title:
Organization NameMaximum Length:240Name of the organization. -
OwningOrganizationCode: string
Title:
Owning Party SiteMaximum Length:240Site of the owning organization. -
OwningOrganizationId: integer
(int64)
Value that uniquely identifies the owning organization.
-
OwningTradingPartnerType: string
Title:
Transfer Owning Party TypeMaximum Length:30Contains 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 BUMaximum Length:240Name of the procuring business unit. Applies only for a consigned quantity. -
PrimaryUnitOfMeasure: string
Title:
New On-Hand Quantity UOMMaximum Length:25Primary unit of measure for the item in the current organization. -
PrimaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the primary unit of measure for the item in the current organization. -
PrimaryUOMQuantity: number
Title:
New On-Hand QuantityBalance quantity in the primary unit of measure for the item. -
Revision: string
Title:
RevisionMaximum Length:18Contains one of the following values. Revision: the warehouse placed the item under revision control. Empty: revisions don't control the item. -
SecondaryUnitOfMeasure: string
Title:
New Secondary On-Hand Quantity UOMMaximum Length:25Secondary unit of measure for the item in the current organization. -
SecondaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the secondary unit of measure for the item in the current organization. -
SecondaryUOMQuantity: number
Title:
New Secondary On-Hand QuantityBalance quantity in the secondary unit of measure for the item. -
Subinventory: string
Title:
SubinventoryMaximum Length:10Name of the subinventory that the balance transaction line uses to fulfill the request. -
TransactionSourceCode: string
Title:
SourceMaximum Length:30Abbreviation that identifies the source of the transaction. -
VendorName: string
Title:
SupplierMaximum Length:240Name of the supplier who supplies the consigned quantity. -
VendorNumber: string
Title:
Supplier NumberMaximum Length:30Value that uniquely identifies the supplier who supplies the consigned quantity.
Nested Schema : Lot Details for Items
Type:
arrayTitle:
Lot Details for ItemsThe 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:
arrayTitle:
Serial Details for ItemsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-dffForTransactionLines-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Title:
Interface ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
Title:
Interface ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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
dffForItemLots
-
ExpirationActionCode: string
Title:
Expiration ActionMaximum Length:32Abbreviation that identifies the action taken to expire the lot. -
ExpirationActionDate: string
(date)
Title:
Expiration Action DateDate when the lot expiration action occurred. -
ExpirationActionName: string
Title:
DescriptionMaximum Length:80Description of the action taken to expire the lot. -
GradeCode: string
Title:
GradeMaximum Length:150Abbreviation that identifies the lot grade. -
HoldDate: string
(date)
Title:
Hold Until DateDate when the hold will release for the lot. -
itemSerialsForLot: array
Serial and Lot Details for Items
Title:
Serial and Lot Details for ItemsThe 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:
LinksThe link relations associated with the resource instance. -
LotExpirationDate: string
(date)
Title:
Lot Expiration DateDate when the lot expires. -
LotNumber: string
Title:
LotMaximum Length:80Lot number of the item when the warehouse places the item under lot control. -
OriginationDate: string
(date)
Title:
Origination DateDate when the lot originated. -
OriginationType: string
Title:
Origination TypeMaximum Length:30Origination type of the lot. -
ParentLotNumber: string
Title:
Parent LotMaximum Length:80Lot number of the parent lot. -
PlaceOfOrigin: string
Maximum Length:
150Place of origin of the lot. -
PrimaryQuantity: number
Title:
New On-Hand QuantityTransaction quantity for this lot in the primary unit of measure for the item. -
PrimaryUnitOfMeasure: string
Title:
New On-Hand Quantity UOMMaximum Length:25Primary unit of measure for the item in the current organization. -
PrimaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the primary unit of measure for the item in the current organization. -
SecondaryQuantity: number
Title:
New Secondary On-Hand QuantityTransaction quantity for this lot in the secondary unit of measure for the item. -
SecondaryUnitOfMeasure: string
Title:
New Secondary On-Hand Quantity UOMMaximum Length:25Secondary unit of measure for the item in the current organization. -
SecondaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the secondary unit of measure for the item in the current organization. -
StatusCode: string
Title:
Material StatusMaximum Length:80Abbreviation that identifies the status of the material that the lot references. -
StatusId: integer
(int64)
Value that uniquely identifies the lot status.
-
StatusName: string
Title:
DescriptionMaximum Length:240Description of the lot status. -
SupplierLotNumber: string
Title:
Supplier LotMaximum Length:150Supplier lot number. -
TerritoryCode: string
Maximum Length:
3Abbreviation that identifies the territory. -
TerritoryShortName: string
Maximum Length:
80Name of the territory. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier who supplies the material.
-
VendorName: string
Title:
SupplierMaximum Length:240Name of the supplier who supplies the material.
Nested Schema : Serial and Lot Details for Items
Type:
arrayTitle:
Serial and Lot Details for ItemsThe 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:
arrayTitle:
LinksThe 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 ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TxnLotInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemLots-itemSerialsForLot-item-response
Type:
Show Source
object-
dffForItemSerialsForLot: array
dffForItemSerialsForLot
-
FromSerialNumber: string
Title:
From Serial NumberMaximum Length:80Starting 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 NumberMaximum Length:80Starting 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:
LinksThe link relations associated with the resource instance. -
OriginationDate: string
(date)
Title:
Origination DateDate when the serial originated. -
StatusCode: string
Title:
Material StatusMaximum Length:80Abbreviation that identifies the serial status. -
StatusId: integer
(int64)
Value that uniquely identifies the serial status.
-
StatusName: string
Title:
DescriptionMaximum Length:240Name of the serial status. -
TerritoryCode: string
Maximum Length:
30Value that uniquely identifies the territory. -
TerritoryShortName: string
Maximum Length:
80Name of the territory. -
ToSerialNumber: string
Title:
To Serial NumberMaximum Length:80Ending 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 NumberMaximum Length:80Ending 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 : Links
Type:
arrayTitle:
LinksThe 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 ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialTxnInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBalanceTransactions-transactionLines-itemSerials-item-response
Type:
Show Source
object-
dffForItemSerials: array
dffForItemSerials
-
FromSerialNumber: string
Title:
From Serial NumberMaximum Length:80Starting 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 NumberMaximum Length:80Starting 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:
LinksThe link relations associated with the resource instance. -
OriginationDate: string
(date)
Title:
Origination DateDate when the serial originated. -
StatusCode: string
Title:
Material StatusMaximum Length:80Abbreviation that identifies the serial status. -
StatusId: integer
(int64)
Value that uniquely identifies the serial status.
-
StatusName: string
Title:
DescriptionMaximum Length:240Name of the serial status. -
TerritoryCode: string
Maximum Length:
30Value that uniquely identifies the territory. -
TerritoryShortName: string
Maximum Length:
80Name of the territory. -
ToSerialNumber: string
Title:
To Serial NumberMaximum Length:80Ending 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 NumberMaximum Length:80Ending supplier serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialTxnInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source