Get all advices
get
/fscmRestApi/resources/11.13.18.05/inventoryConsumptionAdvices
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 inventory consumption advices.
Finder Variables:- ConsumptionHeaderId; integer; Value that uniquely identifies the inventory consumption advice.
- Revision; integer; Value that identifies the revision of the consumption advice.
- PrimaryKey: Find inventory consumption advices.
-
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
You can use these queryable attributes to filter this collection resource using the q query parameter:- BusinessUnitId; integer; Value that uniquely identifies the business unit.
- BusinessUnitName; string; Abbreviation that identifies the business unit.
- ConsumptionAdvice; string; Value that identifies the consumption advice document.
- ConsumptionHeaderId; integer; Value that uniquely identifies the consumption advice.
- CreationDate; string; Date when the consumption advice was created.
- DisplayUnprintedConsumptionAdvices; string; Value that identifies the revision header records to display.
- EndCycleDate; string; Date when periodic cycle for the consumption advice ended.
- InventoryOrganizationId; integer; Value that uniquely identifies the inventory organization.
- LastRevisedDate; string; Date when most recent revision is applied to the consumption advice header.
- LegalEntityId; integer; Value that uniquely identifies the sold-to legal entity.
- LegalEntityName; string; Value that specifies the name of the legal entity.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationName; string; Name of the organization.
- POHeaderId; integer; Value that uniquely identifies the purchase order header .
- PurchaseAgreement; string; Value that specifies the purchase agreement associated with the consumption advice.
- Revision; integer; Value that represents the revision of the consumption advice document.
- StartCycleDate; string; Date when the periodic cycle for the consumption advice started.
- Supplier; string; Abbreviation that identifies the supplier.
- SupplierId; integer; Value that uniquely identifies the supplier.
- VendorSiteCode; string; Abbreviation that identifies the vendor site.
- VendorSiteId; integer; Value that uniquely identifies the vendor site.
-
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:
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 : inventoryConsumptionAdvices
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 : inventoryConsumptionAdvices-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Abbreviation that identifies the business unit. -
ConsumptionAdvice: string
Title:
Consumption Advice
Maximum Length:20
Value that identifies the consumption advice document. -
consumptionAdviceLines: array
Consumption Advice Lines
Title:
Consumption Advice Lines
The Consumption Advice Lines resource gets the line level details like item, organization, and purchase order details for a consumption advice. -
ConsumptionHeaderId: integer
(int64)
Value that uniquely identifies the consumption advice.
-
CreationDate: string
(date)
Title:
Creation Date
Date when the consumption advice was created. -
DisplayUnprintedConsumptionAdvices: string
Read Only:
true
Value that identifies the revision header records to display. -
EndCycleDate: string
(date)
Title:
End Date
Date when periodic cycle for the consumption advice ended. -
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
LastRevisedDate: string
(date)
Read Only:
true
Date when most recent revision is applied to the consumption advice header. -
LegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity.
-
LegalEntityName: string
Title:
Legal Entity Name
Read Only:true
Maximum Length:240
Value that specifies the name of the legal entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header . -
PurchaseAgreement: string
Title:
Order
Read Only:true
Maximum Length:30
Value that specifies the purchase agreement associated with the consumption advice. -
Revision: integer
(int64)
Title:
Revision
Read Only:true
Value that represents the revision of the consumption advice document. -
StartCycleDate: string
(date)
Title:
Start Date
Date when the periodic cycle for the consumption advice started. -
Supplier: string
Title:
Name
Read Only:true
Maximum Length:360
Abbreviation that identifies the supplier. -
SupplierId: integer
Read Only:
true
Value that uniquely identifies the supplier. -
VendorSiteCode: string
Title:
Site
Read Only:true
Maximum Length:240
Abbreviation that identifies the vendor site. -
VendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the vendor site.
Nested Schema : Consumption Advice Lines
Type:
array
Title:
Consumption Advice Lines
The Consumption Advice Lines resource gets the line level details like item, organization, and purchase order details for a consumption advice.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-item-response
Type:
Show Source
object
-
ConsumedQuantity: number
Title:
Consumed Quantity
Quantity of the item consumed. -
ConsumedQuantityUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the user chooses for the consuming quantity. -
ConsumedQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure that the user chooses for the consuming quantity. -
ConsumptionAdviceLine: number
Title:
Consumption Advice Line
Value that uniquely identifies the consumption advice line. -
consumptionAdviceLots: array
Consumption Advice Lots
Title:
Consumption Advice Lots
The Consumption Advice Lots resource gets the lot-level details like lot number and transaction quantity for items in the consumption advice line. -
consumptionAdviceSerials: array
Consumption Advice Serials
Title:
Consumption Advice Serials
The Consumption Advice Serials resource gets the serial numbers for items in the consumption advice line. -
consumptionAdviceTransactions: array
Consumption Advice Transactions
Title:
Consumption Advice Transactions
The Consumption Advice Transactions resource gets the transaction details like transaction quantity and transaction type at the line level. -
ConsumptionHeaderId: integer
(int64)
Value that uniquely identifies the consumption header.
-
ConsumptionLineId: integer
(int64)
Value that uniquely identifies the consumption line.
-
CurrencyCode: string
Maximum Length:
10
Abbreviation that identifies the currency. -
ExtendedPrice: number
Read Only:
true
Revised price of the item. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization. -
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line.
-
POLineNumber: number
Title:
Line
Read Only:true
Number that identifies the purchase order line. -
PONumber: string
Title:
Order
Read Only:true
Maximum Length:30
Value that uniquely identifies the purchase order. -
POScheduleId: integer
(int64)
Value that uniquely identifies the purchase order schedule .
-
POScheduleNumber: number
Title:
Schedule
Read Only:true
Number that identifies the purchase order schedule . -
PurchaseAgreementLine: number
Title:
Line
Read Only:true
Value that specifies the purchase agreement line. -
PurchaseAgreementLineId: integer
(int64)
Value that uniquely identifies the purchase agreement line.
-
ReceiptLineNumber: integer
(int64)
Read Only:
true
Number that identifies the receipt line. -
RevisionNumber: integer
(int64)
Title:
Revision
Read Only:true
Revision number corresponding to each change in the item price. -
SecondaryConsumedQuantity: number
Title:
Secondary Consumed Quantity
Quantity consumed expressed in secondary unit of measure of the item. -
SecondaryQuantityUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the secondary unit of measure of the item. -
SecondaryQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line. -
ShipmentReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment receipt . -
TransactionDate: string
(date)
Date when the transaction was performed.
-
TransactionTypeId: integer
(int64)
Value that uniquely identifies the transaction type.
-
TransactionTypeName: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the type of transaction. -
UnitPrice: number
Read Only:
true
Unit price of the item.
Nested Schema : Consumption Advice Lots
Type:
array
Title:
Consumption Advice Lots
The Consumption Advice Lots resource gets the lot-level details like lot number and transaction quantity for items in the consumption advice line.
Show Source
Nested Schema : Consumption Advice Serials
Type:
array
Title:
Consumption Advice Serials
The Consumption Advice Serials resource gets the serial numbers for items in the consumption advice line.
Show Source
Nested Schema : Consumption Advice Transactions
Type:
array
Title:
Consumption Advice Transactions
The Consumption Advice Transactions resource gets the transaction details like transaction quantity and transaction type at the line level.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceLots-item-response
Type:
Show Source
object
-
consumptionAdviceLotsAndSerials: array
Consumption Advice Lots And Serials
Title:
Consumption Advice Lots And Serials
The Consumption Advice Lots And Serials resource gets the lot-serial details for items in the consumption advice line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
TransactionQuantity: number
Title:
Transaction Quantity
Quantity of lot that is consumed.
Nested Schema : Consumption Advice Lots And Serials
Type:
array
Title:
Consumption Advice Lots And Serials
The Consumption Advice Lots And Serials resource gets the lot-serial details for items in the consumption advice line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceLots-consumptionAdviceLotsAndSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number of the item when a serial in a lot controls the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number of the item in a transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceTransactions-item-response
Type:
Show Source
object
-
Account: string
Account number for the inventory transaction.
-
AlmInterfaceStatus: string
Read Only:
true
Maximum Length:30
Status of the asset lifecycle management interface. -
AssemblySerialNumber: string
Read Only:
true
Maximum Length:80
Serial number that identifies the assembly. -
AssessableValue: number
Read Only:
true
Price that the tax authority uses to calculate tax for the item. -
AssetTrackingStatus: string
Read Only:
true
Tracking status of the asset. -
AssociatedOwnershipChangeTransaction: integer
(int64)
Read Only:
true
Value that indicates the change in ownership in a transfer transaction for a transfer consignment. -
Carrier: string
Read Only:
true
Name of the party that transports the shipment. -
Category: string
Abbreviation that identifies the category.
-
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the fiscal classification for the item. It determines the tax for the item. -
ConsErrorActionCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the action when an error occurs on the consumption advice. -
ConsErrorTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of error for the consumption advice. -
ConsumptionAdvice: string
Read Only:
true
Value that identifies the header of the consumption advice. -
ConsumptionAdviceError: string
Description of the error in the consumption advice.
-
ConsumptionAdviceErrorAction: string
Read Only:
true
Name of the action that must be performed to resolve the consumption advice error. -
ConsumptionAdviceLine: string
Read Only:
true
Value that identifies the line for the consumption advice. -
ConsumptionLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line for the consumption advice. -
Costed: string
Contains True or False. True: the application costs the transactions. False: the application does not cost the transactions.
-
CountryOfOrigin: string
Read Only:
true
Maximum Length:255
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
CountryOfOriginCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the transaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the transaction. -
Currency: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the currency. -
DefaultTaxationCountry: string
Read Only:
true
Maximum Length:2
Abbreviation that identifies the default country for taxation. It determines the tax for the item. -
DepartmentCode: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the department. -
DepartmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the department. -
DistributionAccountId: integer
(int64)
Read Only:
true
Value that uniquely identifies the distribution account. -
DocumentFiscalClassification: string
Classification of the fiscal document. It determines the tax for the item.
-
DocumentSubType: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the classification of the fiscal document. It determines the tax for the item. -
ElectronicSignature: integer
(int64)
Title:
Electronic Signature
Read Only:true
Value that identifies the electronic signature. -
ErrorExplanation: string
Read Only:
true
Maximum Length:240
Message text of the error that occurred during an inventory transaction. -
ExemptReasonCode: string
Read Only:
true
Maximum Length:30
Name of the tax exemption reason. -
ExternalSystemPackingUnit: string
Title:
External Packing Unit
Read Only:true
Maximum Length:150
Packing unit in an external application that resides outside of Oracle Fusion application. -
ExternalSystemTransactionReference: string
Title:
External System Transaction Reference
Read Only:true
Maximum Length:300
Value that refers to the corresponding transaction in external applications. -
FinalDischargeLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location of the final discharge. It determines the tax for the item. -
FirstPartyTaxRegistrationNumber: string
Number that identifies the tax registration for first party of the transaction. It determines the tax for the item.
-
FirstPtyRegId: integer
(int64)
Read Only:
true
Value that uniquely identifies the tax registration for first party of the transaction. It determines the tax for the item. -
FreightCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the freight for a shipment that is in transit. -
IntendedUse: string
Value that identifies the classification for the intended use. It determines the tax for the item.
-
IntendedUseClassifId: integer
(int64)
Read Only:
true
Value that uniquely identifies the classification for the intended use. It determines the tax for the item. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
Item: string
Read Only:
true
Maximum Length:300
Number that identifies the inventory item. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadRequestId: integer
(int64)
Title:
Load Request ID
Read Only:true
Value that uniquely identifies the Load Interface File for Import scheduled process that uploaded the transaction. -
Location: string
Read Only:
true
Physical location of the warehouse. -
LocationOfFinalDischarge: string
Location of the final discharge. It determines the tax for the item.
-
LocationType: string
Read Only:
true
Maximum Length:30
Type of ship-to location. -
Locator: string
Description of the stock locators.
-
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the stock locator. -
Lot: string
Read Only:
true
Value that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. -
LotTransactionGroupName: string
Read Only:
true
Maximum Length:30
Name of the group of lot split, merge, and translate transactions data. This value is defined by the user. -
ManualReceiptExpense: string
Title:
Receipt Required at Expense Destination
Read Only:true
Maximum Length:1
Expense for the manual receipt. -
MovementRequestLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the movement request line. -
NumberOfContainers: integer
(int64)
Title:
Number of Packing Units
Read Only:true
Number of packing units. -
OperationNumber: string
Number that identifies the operation.
-
OperationSequenceNumber: integer
(int64)
Read Only:
true
Sequence number of the operation in the routing request. -
OperationSequenceNumberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the operation sequence number. -
OperationTransaction: integer
(int64)
Read Only:
true
Value that identifies the operation transaction. -
Organization: string
Abbreviation that identifies the organization.
-
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
OrganizationName: string
Name of the organization.
-
OwningOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization of the party who owns the transaction. -
OwningParty: string
Name of the party who owns the transaction.
-
OwningPartyLocation: string
Name of the location of the party who owns the transaction.
-
OwningPartyLocationId: integer
Value that uniquely identifies the location of the party who owns the transaction.
-
OwningPartyOrgName: string
Name of the organization party who owns the transaction.
-
OwningPartySite: string
Read Only:
true
Name of the site of the party who owns the transaction. -
OwningPartyType: string
Read Only:
true
Type of party who owns the transaction. -
OwningTpType: integer
(int64)
Read Only:
true
Type of trading partner for the party who owns the transaction. -
PackingUnit: string
Title:
Packing Unit
Read Only:true
Maximum Length:30
Details of the packing unit. -
ParentTransaction: integer
(int64)
Title:
Parent Transaction
Read Only:true
Value that identifies the parent transaction. -
PickSlip: integer
(int64)
Title:
Pick Slip
Read Only:true
Pick slip number for the transaction line. -
PrimaryUOMCode: string
Abbreviation that identifies the primary unit of measure for the item.
-
ProductCategory: string
Name of the product category of the transaction line. It determines the tax for the item.
-
ProductCategoryCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the item category on the transaction line. It determines the tax for the item. -
ProductFiscalClassification: string
Abbreviation that identifies the fiscal classification for the inventory item. It determines the tax for the item.
-
ProductType: string
Type of inventory item. Values include GOODS or SERVICES. It determines the tax for the item.
-
ProductTypeCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the item type of the inventory item. Value includes GOODS or SERVICES. It determines the tax for the item. -
ProjectId: number
Read Only:
true
Value that uniquely identifies the project. -
ProjectNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the project. -
PurchaseOrder: string
Read Only:
true
Purchase order number that the transaction references. -
PurchaseOrderHeaderId: string
Read Only:
true
Value that uniquely identifies the purchase order header. -
PurchaseOrderLine: string
Read Only:
true
Number that identifies the purchase order line. -
PurchaseOrderLineId: string
Read Only:
true
Value that uniquely identifies the purchase order line. -
Quantity: number
Title:
Quantity
Read Only:true
Transaction quantity in the primary unit of measure. -
RcvShipmentHeaderId: integer
Value that uniquely identifies the receiving shipment header.
-
RcvShipmentLineId: string
Value that uniquely identifies the receiving shipment line.
-
Reason: string
Describes the rationale for the transaction.
-
ReasonId: integer
(int64)
Read Only:
true
Value that identifies the reason for the transaction. -
Receipt: string
Number that identifies the receipt.
-
ReceiptLine: string
Read Only:
true
Maximum Length:255
Default Value:if (ReceivingTransaction!=null && RcvShipmentLineId!=null){ return ReceivingShipmentReceiptLinePVOVA?.first()?.getAttribute("LineNum"); }
Number that identifies the receipt line. -
ReceiptRequiredAtExpenseDestination: string
Read Only:
true
Contains True or False. True: the expense destination requires a receipt. False: receipt is not required. -
ReceivingTransaction: integer
(int64)
Title:
Receiving Transaction
Read Only:true
Cross-reference for the receiving transaction. -
Reference: string
Title:
Reference
Read Only:true
Maximum Length:240
Reference to the transaction. -
RequesterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the person who requested the material issued or received. -
RequesterName: string
Name of the person who requested the material issued or received.
-
Revision: string
Read Only:
true
Maximum Length:18
Revision of the inventory item. -
SecondaryQuantity: number
Title:
Secondary Quantity
Read Only:true
Transaction quantity in the secondary unit of measure. -
SecondaryUOM: string
Read Only:
true
Name of the secondary unit of measure for the transaction. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure for the item. -
SerialNumber: string
Read Only:
true
Serial number that tracks items that are in inventory. -
ShipFromLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-from location. It determines the tax for the item. -
ShipFromSite: string
Read Only:
true
Name of the ship-from location. It determines the tax for the item. -
Shipment: string
Title:
Shipment
Read Only:true
Maximum Length:30
Value that identifies the shipment that is in transit. -
ShipToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to location. -
Source: string
Read Only:
true
Maximum Length:30
Line for the transaction in the source application. -
SourceLine: integer
(int64)
Title:
Source Line
Read Only:true
Value that uniquely identifies the line for the transaction in the source application. -
SourceLotFlag: boolean
Read Only:
true
Maximum Length:3
Contains one of the following values: true or false. If true, then the data belongs to the source lot of lot split, merge, and translate transaction types. If false, then the data belongs to the resultant lot of split, merge, and translate transaction types. This attribute does not have a default value. -
SourceReference: string
Reference to the transaction in the source application.
-
StructureInstanceNumber: integer
Name of the secondary inventory.
-
SubinventoryCode: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the subinventory. -
SubinventoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the subinventory. -
SupplierLot: string
Number that identifies the supplier lot.
-
TaskId: number
Read Only:
true
Value that uniquely identifies the task. -
TaskNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the task. -
TaxationCountry: string
Read Only:
true
Country for the default taxation. It determines the tax for the item. -
TaxClassification: string
Read Only:
true
Maximum Length:50
Classification of the tax. It determines the tax for the item. -
TaxClassificationCode: string
Abbreviation that identifies the tax classification. It determines the tax for the item.
-
TaxExemptionCertificateNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the tax exemption certificate. -
TaxExemptReasonCode: string
Abbreviation that identifies the reason for the tax exemption.
-
TaxInvoiceDate: string
(date)
Read Only:
true
Date and time of generation of the fiscal document. It determines the tax for the item. -
TaxInvoiceNumber: string
Read Only:
true
Maximum Length:150
Number of the fiscal document. It determines the tax for the item. -
ThirdPartyTaxRegistrationNumber: string
Number that identifies the tax registration for third party of the transaction. It determines the tax for the item.
-
ThirdPtyRegId: integer
(int64)
Read Only:
true
Value that uniquely identifies the tax registration for third party of the transaction. It determines the tax for the item. -
TransactionAction: string
Name of the transaction action.
-
TransactionActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction action. -
TransactionBusinessCategory: string
Name of the transaction business category. It determines the tax for the item.
-
TransactionDate: string
(date-time)
Title:
Transaction Date
Read Only:true
Date when the transaction occurred. -
TransactionId: integer
(int64)
Title:
Transaction
Read Only:true
Value that uniquely identifies the transaction. -
TransactionQuantity: number
Title:
Transaction Quantity
Read Only:true
Transacted quantity of the item. -
TransactionSet: integer
(int64)
Title:
Transaction Set
Read Only:true
Value that identifies the transaction group. -
TransactionSourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source of the transaction. -
TransactionSourceName: string
Read Only:
true
Maximum Length:120
Name of the source of the transaction. -
TransactionSourceType: string
Type of the transaction source.
-
TransactionSourceTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the type of transaction source. -
TransactionType: string
Type of the transaction.
-
TransactionTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the type of transaction. -
TransactionUOM: string
Unit of measure for the transaction.
-
TransactionUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the transaction. -
TransferBusinessUnit: string
Read Only:
true
Name of the transfer business unit. -
TransferLocator: string
Read Only:
true
Name of the destination locator for a transfer transaction. -
TransferLocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the destination locator for a transfer transaction. -
TransferOrganization: string
Name of the transfer organization.
-
TransferOrganizationCode: string
Abbreviation that uniquely identifies the destination organization for transfer.
-
TransferOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the destination organization for transfer transactions. -
TransferOrgLocation: string
Read Only:
true
Physical location of the transfer organization. -
TransferOrgLocationId: number
Value that uniquely identifies the location of the transfer organization.
-
TransferOwningParty: string
Read Only:
true
Name of the party who owns the transfer. -
TransferOwningPartySite: string
Read Only:
true
Name of the site of the party who owns the transfer. -
TransferOwningPartyType: string
Read Only:
true
Type of the party who owns the transfer. -
TransferOwningTpType: integer
(int64)
Read Only:
true
Type of trading partner for the transfer. -
TransferProjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer project. This attribute is associated with a feature that requires opt in. -
TransferProjectNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the transfer project. This attribute is associated with a feature that requires opt in. -
TransferSubinventory: string
Name of the destination subinventory for a transfer transaction.
-
TransferSubinventoryCode: string
Read Only:
true
Maximum Length:10
Abbreviation that uniquely identifies the destination subinventory for a transfer transaction. -
TransferTaskId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer task. This attribute is associated with a feature that requires opt in. -
TransferTaskNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the transfer task. This attribute is associated with a feature that requires opt in. -
TransferTransaction: integer
(int64)
Title:
Transfer Transaction
Read Only:true
Value that identifies the transaction of the opposing transfer transaction. -
TrxBusinessCategory: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the transaction business category. It determines the tax for the item. -
UOMName: string
Read Only:
true
Name of the unit of measure for the transaction. -
UserDefinedFiscalClassification: string
Name of the fiscal classification. It determines the tax for the item.
-
UserDefinedFiscClass: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the fiscal classification that the user defines. It determines the tax for the item. -
Waybill: string
Title:
Waybill
Read Only:true
Maximum Length:20
Nonnegotiable document that describes the contract for transporting cargo. -
WIPSupplyType: string
Type of supply for work that the application is processing.
-
WIPSupplyTypeCode: number
Read Only:
true
Abbreviation that identifies the type of supply for work that the application is processing. -
WorkCenter: string
Name of the work center.
-
XfrOwningOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization who owns the transfer.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all advices.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryConsumptionAdvices"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ConsumptionHeaderId": 300100046952934, "ConsumptionAdvice": "300100046952934", "CreationDate": "2014-08-07", "StartCycleDate": "2014-08-06", "EndCycleDate": "2014-08-06", "BusinessUnitName": "Vision Corporation", "BusinessUnitId": 204, "InventoryOrganizationId": null, "OrganizationCode": null, "OrganizationName": null, "LegalEntityId": 204, "LegalEntityName": "Vision Corporation", "PurchaseAgreement": "1002031", "POHeaderId": 300100043350370, "Revision": 1, "VendorSiteCode": "CISuppA00Site01", "VendorSiteId": 300100039215262, "LastRevisedDate": "2014-08-07", "SupplierId": 300100039215133, "Supplier": "CI_SuppA00", "DisplayUnprintedConsumptionAdvices": null, "consumptionAdviceLines": [ { "ConsumptionLineId": 300100046952939, "ConsumptionAdviceLine": 5, "ConsumptionHeaderId": 300100046952934, "PurchaseAgreementLine": 4, "PurchaseAgreementLineId": 300100043350396, "ConsumedQuantity": 1965, "ConsumedQuantityUOMCode": "Ea", "ConsumedQuantityUnitOfMeasure": "Each", "InventoryItemId": 928, "ItemNumber": "CM23594", "ItemDescription": "Plastic Clam Shell - Bottom", "InventoryOrganizationId": 204, "OrganizationName": "Vision Corporation", "OrganizationCode": "V1", "POHeaderId": 300100043350634, "PONumber": "1002832", "POLineId": 300100043350736, "POLineNumber": 4, "POScheduleId": 300100043350737, "POScheduleNumber": 1, "SecondaryConsumedQuantity": null, "SecondaryQuantityUOMCode": null, "SecondaryQuantityUnitOfMeasure": null, "TransactionDate": "2014-08-06", "TransactionTypeId": null, "TransactionTypeName": null, "ShipmentReceiptNumber": "9115", "ShipmentHeaderId": 2802398, "ReceiptLineNumber": 4, "ShipmentLineId": 2887254, "CurrencyCode": "USD", "UnitPrice": 33.22, "ExtendedPrice": 65277.3, "RevisionNumber": 1, "consumptionAdviceLots": [], "consumptionAdviceSerials": [], "consumptionAdviceTransactions": [ { "TransactionId": 22206247, "Item": "CM23594", "ItemDescription": "Plastic Clam Shell - Bottom", "InventoryItemId": 928, "Revision": null, "SubinventoryCode": "ABCSUB01", "SubinventoryId": 100000015305185, "LocatorId": null, "Locator": null, "TransactionQuantity": -2000, "TransactionUOMCode": "Ea", "TransactionUOM": "Each", "TransactionDate": "2014-08-06T01:29:10+00:00", "TransactionTypeId": 74, "TransactionType": "Transfer to Owned", "TransactionSourceTypeId": 1, "TransactionSourceType": "Purchase Order", "SourceReference": null, "Account": null, "Reason": null, "Reference": null, "ErrorExplanation": null, "TransferOrganization": "Vision Corporation", "TransferOrganizationCode": "V1", "TransferOrganizationId": 204, "TransferOrgLocation": null, "TransferOrgLocationId": 204, "TransferSubinventory": "ABCSUB01", "TransferSubinventoryCode": "ABCSUB01", "TransferLocator": null, "TransferLocatorId": null, "TransferBusinessUnit": "Vision Corporation", "Quantity": -2000, "UOMName": "Each", "PrimaryUOMCode": "Ea", "SecondaryQuantity": null, "SecondaryUOM": null, "SecondaryUOMCode": null, "Source": null, "SourceLine": null, "TransactionAction": "Ownership transfer", "TransactionActionId": 6, "TransactionSet": 300100043532851, "TransferTransaction": 22206246, "ReceivingTransaction": null, "Costed": "Interfaced to costing", "AssetTrackingStatus": null, "AlmInterfaceStatus": null, "PickSlip": null, "PackingUnit": null, "ReceiptRequiredAtExpenseDestination": null, "ManualReceiptExpense": null, "Location": null, "ShipToLocationId": null, "LocationType": null, "Shipment": null, "Waybill": null, "Carrier": null, "FreightCode": null, "NumberOfContainers": null, "OwningPartyType": "Supplier site", "OwningTpType": 1, "TransferOwningTpType": 2, "OwningParty": "CI_SuppA00", "OwningPartySite": "CISuppA00Site01", "TransferOwningPartyType": "Inventory organization", "TransferOwningParty": "V1", "TransferOwningPartySite": null, "ConsumptionAdvice": "300100046952934", "ConsumptionAdviceLine": "5", "ConsumptionLineId": 300100046952939, "PurchaseOrder": null, "PurchaseOrderHeaderId": null, "PurchaseOrderLineId": null, "PurchaseOrderLine": null, "ParentTransaction": null, "Receipt": null, "RcvShipmentHeaderId": null, "ReceiptLine": null, "RcvShipmentLineId": null, "ConsumptionAdviceError": null, "ConsumptionAdviceErrorAction": null, "AssociatedOwnershipChangeTransaction": null, "TaxationCountry": null, "DefaultTaxationCountry": "US", "TransactionBusinessCategory": null, "TrxBusinessCategory": null, "DocumentFiscalClassification": null, "DocumentSubType": null, "UserDefinedFiscalClassification": null, "UserDefinedFiscClass": "TPD_D", "ProductFiscalClassification": null, "CategoryId": null, "IntendedUse": null, "IntendedUseClassifId": null, "LocationOfFinalDischarge": null, "ProductCategory": null, "ProductCategoryCode": null, "TaxClassificationCode": null, "TaxClassification": null, "ProductType": null, "ProductTypeCode": null, "FirstPartyTaxRegistrationNumber": "4567890", "FirstPtyRegId": 35647, "ThirdPartyTaxRegistrationNumber": null, "ThirdPtyRegId": null, "ShipFromSite": null, "ShipFromLocationId": null, "TaxInvoiceNumber": null, "TaxInvoiceDate": null, "AssessableValue": 33220000, "Currency": "USD", "TaxExemptionCertificateNumber": null, "TaxExemptReasonCode": null, "ExemptReasonCode": null, "OperationNumber": null, "OperationSequenceNumber": null, "OperationSequenceNumberId": null, "OperationTransaction": null, "WIPSupplyType": null, "WIPSupplyTypeCode": null, "WorkCenter": null, "DepartmentCode": null, "DepartmentId": null, "AssemblySerialNumber": null, "ElectronicSignature": null, "Organization": "V1", "OrganizationName": "Vision Corporation", "OrganizationId": 204, "OwningPartyOrgName": "Vision Corporation", "OwningPartyLocation": null, "OwningPartyLocationId": 204, "TransactionSourceName": null, "TransactionSourceId": 2802398, "ReasonId": null, "ConsErrorTypeCode": null, "ConsErrorActionCode": null, "OwningOrganizationId": 300100039215262, "XfrOwningOrganizationId": 204, "StructureInstanceNumber": 101, "Category": null, "Lot": null, "SerialNumber": null, "SupplierLot": null, "ExternalSystemPackingUnit": null, "DistributionAccountId": null, "FinalDischargeLocationId": null }, { "TransactionId": 22206267, "Item": "CM23594", "ItemDescription": "Plastic Clam Shell - Bottom", "InventoryItemId": 928, "Revision": null, "SubinventoryCode": "ABCSUB01", "SubinventoryId": 100000015305185, "LocatorId": null, "Locator": null, "TransactionQuantity": 35, "TransactionUOMCode": "Ea", "TransactionUOM": "Each", "TransactionDate": "2014-08-06T01:31:05+00:00", "TransactionTypeId": 75, "TransactionType": "Transfer to Consigned", "TransactionSourceTypeId": 13, "TransactionSourceType": "Inventory", "SourceReference": null, "Account": null, "Reason": null, "Reference": null, "ErrorExplanation": null, "TransferOrganization": "Vision Corporation", "TransferOrganizationCode": "V1", "TransferOrganizationId": 204, "TransferOrgLocation": null, "TransferOrgLocationId": 204, "TransferSubinventory": "ABCSUB01", "TransferSubinventoryCode": "ABCSUB01", "TransferLocator": null, "TransferLocatorId": null, "TransferBusinessUnit": "Vision Corporation", "Quantity": 35, "UOMName": "Each", "PrimaryUOMCode": "Ea", "SecondaryQuantity": null, "SecondaryUOM": null, "SecondaryUOMCode": null, "Source": null, "SourceLine": null, "TransactionAction": "Ownership transfer", "TransactionActionId": 6, "TransactionSet": 300100043532858, "TransferTransaction": 22206266, "ReceivingTransaction": null, "Costed": "Interfaced to costing", "AssetTrackingStatus": null, "AlmInterfaceStatus": null, "PickSlip": null, "PackingUnit": null, "ReceiptRequiredAtExpenseDestination": null, "ManualReceiptExpense": null, "Location": null, "ShipToLocationId": null, "LocationType": null, "Shipment": null, "Waybill": null, "Carrier": null, "FreightCode": null, "NumberOfContainers": null, "OwningPartyType": "Supplier site", "OwningTpType": 1, "TransferOwningTpType": 2, "OwningParty": "CI_SuppA00", "OwningPartySite": "CISuppA00Site01", "TransferOwningPartyType": "Inventory organization", "TransferOwningParty": "V1", "TransferOwningPartySite": null, "ConsumptionAdvice": "300100046952934", "ConsumptionAdviceLine": "5", "ConsumptionLineId": 300100046952939, "PurchaseOrder": null, "PurchaseOrderHeaderId": null, "PurchaseOrderLineId": null, "PurchaseOrderLine": null, "ParentTransaction": null, "Receipt": null, "RcvShipmentHeaderId": null, "ReceiptLine": null, "RcvShipmentLineId": null, "ConsumptionAdviceError": null, "ConsumptionAdviceErrorAction": null, "AssociatedOwnershipChangeTransaction": 22206247, "TaxationCountry": null, "DefaultTaxationCountry": "US", "TransactionBusinessCategory": null, "TrxBusinessCategory": null, "DocumentFiscalClassification": null, "DocumentSubType": null, "UserDefinedFiscalClassification": null, "UserDefinedFiscClass": "TPD_D", "ProductFiscalClassification": null, "CategoryId": null, "IntendedUse": null, "IntendedUseClassifId": null, "LocationOfFinalDischarge": null, "ProductCategory": null, "ProductCategoryCode": null, "TaxClassificationCode": null, "TaxClassification": null, "ProductType": null, "ProductTypeCode": null, "FirstPartyTaxRegistrationNumber": "4567890", "FirstPtyRegId": 35647, "ThirdPartyTaxRegistrationNumber": null, "ThirdPtyRegId": null, "ShipFromSite": null, "ShipFromLocationId": null, "TaxInvoiceNumber": null, "TaxInvoiceDate": null, "AssessableValue": 33220000, "Currency": "USD", "TaxExemptionCertificateNumber": null, "TaxExemptReasonCode": null, "ExemptReasonCode": null, "OperationNumber": null, "OperationSequenceNumber": null, "OperationSequenceNumberId": null, "OperationTransaction": null, "WIPSupplyType": null, "WIPSupplyTypeCode": null, "WorkCenter": null, "DepartmentCode": null, "DepartmentId": null, "AssemblySerialNumber": null, "ElectronicSignature": null, "Organization": "V1", "OrganizationName": "Vision Corporation", "OrganizationId": 204, "OwningPartyOrgName": "Vision Corporation", "OwningPartyLocation": null, "OwningPartyLocationId": 204, "TransactionSourceName": null, "TransactionSourceId": 2802398, "ReasonId": null, "ConsErrorTypeCode": null, "ConsErrorActionCode": null, "OwningOrganizationId": 300100039215262, "XfrOwningOrganizationId": 204, "StructureInstanceNumber": 101, "Category": null, "Lot": null, "SerialNumber": null, "SupplierLot": null, "ExternalSystemPackingUnit": null, "DistributionAccountId": null, "FinalDischargeLocationId": null } ] }, "items": [ {