Get one advice
get
/fscmRestApi/resources/11.13.18.05/inventoryConsumptionAdvices/{inventoryConsumptionAdvicesUniqID}
Request
Path Parameters
-
inventoryConsumptionAdvicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Inventory Consumption Advices resource and used to uniquely identify an instance of Inventory Consumption Advices. The client should not generate the hash key value. Instead, the client should query on the Inventory Consumption Advices collection resource in order to navigate to a specific instance of Inventory Consumption Advices to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type:
Show Source
object-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
BusinessUnitName: string
Title:
Business UnitRead Only:trueMaximum Length:240Abbreviation that identifies the business unit. -
ConsumptionAdvice: string
Title:
Consumption AdviceMaximum Length:20Value that identifies the consumption advice document. -
consumptionAdviceLines: array
Consumption Advice Lines
Title:
Consumption Advice LinesLine-level details such as 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 DateDate when the consumption advice was created. -
DisplayUnprintedConsumptionAdvices: string
Read Only:
trueValue that identifies the revision header records to display. -
EndCycleDate: string
(date)
Title:
End DateDate when periodic cycle for the consumption advice ended. -
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
LastRevisedDate: string
(date)
Read Only:
trueDate when most recent revision is applied to the consumption advice header. -
LatestRevisionNumber: integer
(int64)
Revision number of the consumption advice.
-
LegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity.
-
LegalEntityName: string
Title:
Legal Entity NameRead Only:trueMaximum Length:240Value that specifies the name of the legal entity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NeedPublishing: string
Maximum Length:
1Value that specifies the consumption advice needs reprinting. -
OrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the organization. -
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the organization. -
POHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase order header . -
PrcBusinessUnitId: integer
(int64)
Title:
Procurement BURead Only:trueValue that uniquely identifies the business unit. -
PrcBusinessUnitName: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the business unit. -
PurchaseAgreement: string
Title:
OrderRead Only:trueMaximum Length:30Value that specifies the purchase agreement associated with the consumption advice. -
Revision: integer
(int64)
Title:
RevisionRead Only:trueValue that represents the revision of the consumption advice document. -
StartCycleDate: string
(date)
Title:
Start DateDate when the periodic cycle for the consumption advice started. -
Supplier: string
Title:
NameRead Only:trueMaximum Length:360Abbreviation that identifies the supplier. -
SupplierId: integer
Read Only:
trueValue that uniquely identifies the supplier. -
VendorSiteCode: string
Title:
SiteRead Only:trueMaximum Length:240Abbreviation that identifies the vendor site. -
VendorSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the vendor site.
Nested Schema : Consumption Advice Lines
Type:
arrayTitle:
Consumption Advice LinesLine-level details such as item, organization, and purchase order details for a consumption advice.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-item-response
Type:
Show Source
object-
ConsumedQuantity: number
Title:
Consumed QuantityQuantity of the item consumed. -
ConsumedQuantityUnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure that the user chooses for the consuming quantity. -
ConsumedQuantityUOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure that the user chooses for the consuming quantity. -
ConsumptionAdviceLine: number
Title:
Consumption Advice LineValue that uniquely identifies the consumption advice line. -
consumptionAdviceLots: array
Consumption Advice Lots
Title:
Consumption Advice LotsLot-level details such as lot number and transaction quantity for items in the consumption advice line. -
consumptionAdviceSerials: array
Consumption Advice Serials
Title:
Consumption Advice SerialsSerial number for an item in the consumption advice line. -
consumptionAdviceTransactions: array
Consumption Advice Transactions
Title:
Consumption Advice TransactionsTransaction details such as 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:
10Abbreviation that identifies the currency. -
ExtendedPrice: number
Read Only:
trueRevised 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 DescriptionRead Only:trueMaximum Length:240Description of item. -
ItemNumber: string
Read Only:
trueMaximum Length:300Number that identifies the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotControlCode: number
Title:
Lot ControlRead Only:trueValue that identifies whether the item is lot controlled. -
OrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the organization. -
OrganizationName: string
Read Only:
trueMaximum Length:240Name 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:
LineRead Only:trueNumber that identifies the purchase order line. -
PONumber: string
Title:
OrderRead Only:trueMaximum Length:30Value that uniquely identifies the purchase order. -
POScheduleId: integer
(int64)
Value that uniquely identifies the purchase order schedule .
-
POScheduleNumber: number
Title:
ScheduleRead Only:trueNumber that identifies the purchase order schedule . -
PurchaseAgreementLine: number
Title:
LineRead Only:trueValue that specifies the purchase agreement line. -
PurchaseAgreementLineId: integer
(int64)
Value that uniquely identifies the purchase agreement line.
-
ReceiptLineNumber: integer
(int64)
Read Only:
trueNumber that identifies the receipt line. -
RevisionNumber: integer
(int64)
Title:
RevisionRead Only:trueRevision number corresponding to each change in the item price. -
SecondaryConsumedQuantity: number
Title:
Secondary Consumed QuantityQuantity consumed expressed in secondary unit of measure of the item. -
SecondaryQuantityUnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Name of the secondary unit of measure of the item. -
SecondaryQuantityUOMCode: string
Maximum Length:
3Abbreviation that identifies the secondary unit of measure. -
SerialNumberControlCode: number
Title:
Serial Number ControlRead Only:trueValue that identifies whether the item is serial controlled. -
ShipmentHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment line. -
ShipmentReceiptNumber: string
Read Only:
trueMaximum Length:30Number 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:
trueMaximum Length:80Abbreviation that identifies the type of transaction. -
UnitPrice: number
Read Only:
trueUnit price of the item.
Nested Schema : Consumption Advice Lots
Type:
arrayTitle:
Consumption Advice LotsLot-level details such as lot number and transaction quantity for items in the consumption advice line.
Show Source
Nested Schema : Consumption Advice Serials
Type:
arrayTitle:
Consumption Advice SerialsSerial number for an item in the consumption advice line.
Show Source
Nested Schema : Consumption Advice Transactions
Type:
arrayTitle:
Consumption Advice TransactionsTransaction details such as transaction quantity and transaction type at the line level.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SerialsLot-serial details for items in the consumption advice line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
TransactionQuantity: number
Title:
Transaction QuantityQuantity of lot that is consumed.
Nested Schema : Consumption Advice Lots And Serials
Type:
arrayTitle:
Consumption Advice Lots And SerialsLot-serial details for items in the consumption advice line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number of the item when a serial in a lot controls the transaction. -
VendorSerialNumber: array
Vendor Serial Numbers
Title:
Vendor Serial NumbersVendor-side serial number for an item in the consumption advice line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Vendor Serial Numbers
Type:
arrayTitle:
Vendor Serial NumbersVendor-side serial number for an item in the consumption advice line.
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 : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceLots-consumptionAdviceLotsAndSerials-VendorSerialNumber-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SupplierSerialNumber: string
Read Only:
trueMaximum Length:80Supplier-side serial number of the item in a transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceSerials-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number of the item in a transaction. -
VendorSerialNumber: array
Vendor Serial Numbers
Title:
Vendor Serial NumbersVendor-side serial number for an item in the consumption advice line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Vendor Serial Numbers
Type:
arrayTitle:
Vendor Serial NumbersVendor-side serial number for an item in the consumption advice line.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceSerials-VendorSerialNumber-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SupplierSerialNumber: string
Read Only:
trueMaximum Length:80Supplier-side serial number of the item in a transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
trueMaximum Length:30Status of the asset lifecycle management interface. -
AssemblySerialNumber: string
Read Only:
trueMaximum Length:80Serial number that identifies the assembly. -
AssessableValue: number
Read Only:
truePrice that the tax authority uses to calculate tax for the item. -
AssetTrackingStatus: string
Read Only:
trueTracking status of the asset. -
AssociatedOwnershipChangeTransaction: integer
(int64)
Read Only:
trueValue that indicates the change in ownership in a transfer transaction for a transfer consignment. -
Carrier: string
Read Only:
trueName of the party that transports the shipment. -
Category: string
Abbreviation that identifies the category.
-
CategoryId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fiscal classification for the item. It determines the tax for the item. -
ConsErrorActionCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the action when an error occurs on the consumption advice. -
ConsErrorTypeCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the type of error for the consumption advice. -
ConsumptionAdvice: string
Read Only:
trueValue that identifies the header of the consumption advice. -
ConsumptionAdviceError: string
Description of the error in the consumption advice.
-
ConsumptionAdviceErrorAction: string
Read Only:
trueName of the action that must be performed to resolve the consumption advice error. -
ConsumptionAdviceLine: string
Read Only:
trueValue that identifies the line for the consumption advice. -
ConsumptionAdviceStatus: string
Read Only:
trueValue that uniquely identifies the consumption advice status. -
ConsumptionAdviceStatusCode: string
Read Only:
trueLookup code corresponding to the consumption advice status of the transaction. -
ConsumptionLineId: integer
(int64)
Read Only:
trueValue 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.
-
CostedStatusCode: string
Read Only:
trueMaximum Length:1Default Value:NLookup code corresponding to the costed status of the transaction. -
CountryOfOrigin: string
Read Only:
trueMaximum Length:255Name of the country of origin. This attribute is associated with a feature that requires opt in. -
CountryOfOriginCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the transaction. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the transaction. -
Currency: string
Read Only:
trueMaximum Length:10Abbreviation that identifies the currency. -
DefaultTaxationCountry: string
Read Only:
trueMaximum Length:2Abbreviation that identifies the default country for taxation. It determines the tax for the item. -
DepartmentCode: string
Read Only:
trueMaximum Length:10Abbreviation that identifies the department. -
DepartmentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the department. -
DistributionAccountId: integer
(int64)
Read Only:
trueValue that uniquely identifies the distribution account. -
DocumentFiscalClassification: string
Classification of the fiscal document. It determines the tax for the item.
-
DocumentSubType: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the classification of the fiscal document. It determines the tax for the item. -
ElectronicSignature: integer
(int64)
Title:
Electronic SignatureRead Only:trueValue that identifies the electronic signature. -
ErrorExplanation: string
Read Only:
trueMaximum Length:240Message text of the error that occurred during an inventory transaction. -
ExemptReasonCode: string
Read Only:
trueMaximum Length:30Name of the tax exemption reason. -
ExternalSystemPackingUnit: string
Title:
External Packing UnitRead Only:trueMaximum Length:150Packing unit in an external application that resides outside of Oracle Fusion application. -
ExternalSystemTransactionReference: string
Title:
External System Transaction ReferenceRead Only:trueMaximum Length:300Value that refers to the corresponding transaction in external applications. -
FinalDischargeLocationId: integer
(int64)
Read Only:
trueValue 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:
trueValue that uniquely identifies the tax registration for first party of the transaction. It determines the tax for the item. -
FreightCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the freight for a shipment that is in transit. -
IntegrationStatus: string
Read Only:
trueMaximum Length:255Value that indicates the integration status of the material transactions interfaced to a warehouse management system or other external systems. -
IntendedUse: string
Value that identifies the classification for the intended use. It determines the tax for the item.
-
IntendedUseClassifId: integer
(int64)
Read Only:
trueValue that uniquely identifies the classification for the intended use. It determines the tax for the item. -
InventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory item. -
Item: string
Read Only:
trueMaximum Length:300Number that identifies the inventory item. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadRequestId: integer
(int64)
Title:
Load Request IDRead Only:trueValue that uniquely identifies the Load Interface File for Import scheduled process that uploaded the transaction. -
Location: string
Read Only:
truePhysical location of the warehouse. -
LocationOfFinalDischarge: string
Location of the final discharge. It determines the tax for the item.
-
LocationType: string
Read Only:
trueMaximum Length:30Type of ship-to location. -
Locator: string
Description of the stock locators.
-
LocatorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the stock locator. -
Lot: string
Read Only:
trueValue that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. -
LotControlCode: number
Title:
Lot ControlRead Only:trueValue that identifies whether the item is lot controlled. -
LotTransactionGroupName: string
Read Only:
trueMaximum Length:30Name of the group of lot split, merge, and translate transactions data. This value is defined by the user. -
LotTransactionSource: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the lot transaction source. -
ManualReceiptExpense: string
Title:
Receipt Required at Expense DestinationRead Only:trueMaximum Length:1Expense for the manual receipt. -
MovementRequestLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the movement request line. -
NumberOfContainers: integer
(int64)
Title:
Number of Packing UnitsRead Only:trueNumber of packing units. -
OperationNumber: string
Number that identifies the operation.
-
OperationSequenceNumber: integer
(int64)
Read Only:
trueSequence number of the operation in the routing request. -
OperationSequenceNumberId: integer
(int64)
Read Only:
trueValue that uniquely identifies the operation sequence number. -
OperationTransaction: integer
(int64)
Read Only:
trueValue that identifies the operation transaction. -
Organization: string
Abbreviation that identifies the organization.
-
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the organization. -
OrganizationName: string
Name of the organization.
-
OwningOrganizationId: integer
(int64)
Read Only:
trueValue 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:
trueName of the site of the party who owns the transaction. -
OwningPartyType: string
Read Only:
trueType of party who owns the transaction. -
OwningTpType: integer
(int64)
Read Only:
trueType of trading partner for the party who owns the transaction. -
PackingUnit: string
Title:
Packing UnitRead Only:trueMaximum Length:30Details of the packing unit. -
ParentTransaction: integer
(int64)
Title:
Parent TransactionRead Only:trueValue that identifies the parent transaction. -
PickSlip: integer
(int64)
Title:
Pick SlipRead Only:truePick 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:
trueMaximum Length:240Abbreviation 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:
trueMaximum Length:240Abbreviation 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:
trueValue that uniquely identifies the project. -
ProjectNumber: string
Read Only:
trueMaximum Length:255Number that identifies the project. -
PurchaseOrder: string
Read Only:
truePurchase order number that the transaction references. -
PurchaseOrderHeaderId: string
Read Only:
trueValue that uniquely identifies the purchase order header. -
PurchaseOrderLine: string
Read Only:
trueNumber that identifies the purchase order line. -
PurchaseOrderLineId: string
Read Only:
trueValue that uniquely identifies the purchase order line. -
Quantity: number
Title:
QuantityRead Only:trueTransaction 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:
trueValue that identifies the reason for the transaction. -
Receipt: string
Number that identifies the receipt.
-
ReceiptLine: string
Read Only:
trueMaximum Length:255Default Value:if (ReceivingTransaction!=null && RcvShipmentLineId!=null){ return ReceivingShipmentReceiptLinePVOVA?.first()?.getAttribute("LineNum"); }Number that identifies the receipt line. -
ReceiptRequiredAtExpenseDestination: string
Read Only:
trueContains True or False. True: the expense destination requires a receipt. False: receipt is not required. -
ReceivingTransaction: integer
(int64)
Title:
Receiving TransactionRead Only:trueCross-reference for the receiving transaction. -
Reference: string
Title:
ReferenceRead Only:trueMaximum Length:240Reference to the transaction. -
RequesterId: integer
(int64)
Read Only:
trueValue 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:
trueMaximum Length:18Revision of the inventory item. -
SecondaryQuantity: number
Title:
Secondary QuantityRead Only:trueTransaction quantity in the secondary unit of measure. -
SecondaryUOM: string
Read Only:
trueMaximum Length:255Name of the secondary unit of measure for the transaction. -
SecondaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the secondary unit of measure for the item. -
SerialNumber: string
Read Only:
trueSerial number that tracks items that are in inventory. -
SerialNumberControlCode: number
Title:
Serial Number ControlRead Only:trueValue that identifies whether the item is serial controlled. -
ShipFromLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-from location. It determines the tax for the item. -
ShipFromSite: string
Read Only:
trueName of the ship-from location. It determines the tax for the item. -
Shipment: string
Title:
ShipmentRead Only:trueMaximum Length:30Value that identifies the shipment that is in transit. -
ShipToLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-to location. -
Source: string
Read Only:
trueMaximum Length:30Line for the transaction in the source application. -
SourceLine: integer
(int64)
Title:
Source LineRead Only:trueValue that uniquely identifies the line for the transaction in the source application. -
SourceLotFlag: boolean
Read Only:
trueMaximum Length:3Contains 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 doesn't 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:
trueMaximum Length:10Abbreviation that identifies the subinventory. -
SubinventoryId: integer
(int64)
Read Only:
trueValue that uniquely identifies the subinventory. -
SupplierLot: string
Number that identifies the supplier lot.
-
TaskId: number
Read Only:
trueValue that uniquely identifies the task. -
TaskNumber: string
Read Only:
trueMaximum Length:255Number that identifies the task. -
TaxationCountry: string
Read Only:
trueCountry for the default taxation. It determines the tax for the item. -
TaxClassification: string
Read Only:
trueMaximum Length:50Classification 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:
trueMaximum Length:80Number that identifies the tax exemption certificate. -
TaxExemptReasonCode: string
Abbreviation that identifies the reason for the tax exemption.
-
TaxInvoiceDate: string
(date)
Read Only:
trueDate and time of generation of the fiscal document. It determines the tax for the item. -
TaxInvoiceNumber: string
Read Only:
trueMaximum Length:150Number 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:
trueValue 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:
trueValue 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 DateRead Only:trueDate when the transaction occurred. -
TransactionId: integer
(int64)
Title:
TransactionRead Only:trueValue that uniquely identifies the transaction. -
TransactionQuantity: number
Title:
Transaction QuantityRead Only:trueTransacted quantity of the item. -
TransactionSet: integer
(int64)
Title:
Transaction SetRead Only:trueValue that identifies the transaction group. -
TransactionSourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source of the transaction. -
TransactionSourceName: string
Read Only:
trueMaximum Length:120Name of the source of the transaction. -
TransactionSourceType: string
Type of the transaction source.
-
TransactionSourceTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the type of transaction source. -
TransactionType: string
Type of the transaction.
-
TransactionTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the type of transaction. -
TransactionUOM: string
Unit of measure for the transaction.
-
TransactionUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the transaction. -
TransferBusinessUnit: string
Read Only:
trueName of the transfer business unit. -
TransferCost: number
Title:
Transfer ChargeRead Only:trueCost incurred for the transaction. -
TransferLocator: string
Read Only:
trueName of the destination locator for a transfer transaction. -
TransferLocatorId: integer
(int64)
Read Only:
trueValue 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:
trueValue that uniquely identifies the destination organization for transfer transactions. -
TransferOrgLocation: string
Read Only:
truePhysical location of the transfer organization. -
TransferOrgLocationId: number
Value that uniquely identifies the location of the transfer organization.
-
TransferOwningParty: string
Read Only:
trueName of the party who owns the transfer. -
TransferOwningPartySite: string
Read Only:
trueName of the site of the party who owns the transfer. -
TransferOwningPartyType: string
Read Only:
trueType of the party who owns the transfer. -
TransferOwningTpType: integer
(int64)
Read Only:
trueType of trading partner for the transfer. -
TransferProjectId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transfer project. This attribute is associated with a feature that requires opt in. -
TransferProjectNumber: string
Read Only:
trueMaximum Length:255Number 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:
trueMaximum Length:10Abbreviation that uniquely identifies the destination subinventory for a transfer transaction. -
TransferTaskId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transfer task. This attribute is associated with a feature that requires opt in. -
TransferTaskNumber: string
Read Only:
trueMaximum Length:255Number that identifies the transfer task. This attribute is associated with a feature that requires opt in. -
TransferTransaction: integer
(int64)
Title:
Transfer TransactionRead Only:trueValue that identifies the transaction of the opposing transfer transaction. -
TransportationCost: number
Title:
Shipping CostRead Only:trueCost incurred for the transportation. -
TrxBusinessCategory: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the transaction business category. It determines the tax for the item. -
UOMName: string
Read Only:
trueName 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:
trueMaximum Length:30Abbreviation that identifies the fiscal classification that the user defines. It determines the tax for the item. -
Waybill: string
Title:
WaybillRead Only:trueMaximum Length:20Nonnegotiable document that describes the contract for transporting cargo. -
WIPSupplyType: string
Type of supply for work that the application is processing.
-
WIPSupplyTypeCode: number
Read Only:
trueAbbreviation that identifies the type of supply for work that the application is processing. -
WorkCenter: string
Name of the work center.
-
WorkOrderExternalSystemGroupId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work order external system group. -
XfrOwningOrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the organization who owns the transfer.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- consumptionAdviceLines
-
Parameters:
- inventoryConsumptionAdvicesUniqID:
$request.path.inventoryConsumptionAdvicesUniqID
Line-level details such as item, organization, and purchase order details for a consumption advice. - inventoryConsumptionAdvicesUniqID:
Examples
This example describes how to get one advice.
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/inventoryConsumptionAdvicesUniqID"
For example, the following command gets one advice:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryConsumptionAdvices?q=ConsumptionHeaderId=300100154820838;Revision=1"
Example Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"ConsumptionHeaderId": 300100154820838,
"ConsumptionAdvice": "300100154820838",
"CreationDate": "2018-06-14",
"StartCycleDate": "2018-05-30",
"EndCycleDate": "2018-05-30",
"BusinessUnitName": "Vision Corporation",
"BusinessUnitId": 204,
"InventoryOrganizationId": null,
"OrganizationCode": null,
"OrganizationName": null,
"LegalEntityId": 204,
"LegalEntityName": "Vision Corporation",
"PurchaseAgreement": "1001923",
"POHeaderId": 300100037627125,
"Revision": 1,
"VendorSiteCode": "CVSuppA01Site01",
"VendorSiteId": 2444,
"LastRevisedDate": "2018-06-14",
"SupplierId": 12496,
"Supplier": "CV_SuppA01",
"DisplayUnprintedConsumptionAdvices": null,
"consumptionAdviceLines": [
{
"ConsumptionLineId": 300100154820839,
"ConsumptionAdviceLine": 1,
"ConsumptionHeaderId": 300100154820838,
"PurchaseAgreementLine": 5,
"PurchaseAgreementLineId": 300100037627160,
"ConsumedQuantity": 1,
"ConsumedQuantityUOMCode": "Ea",
"ConsumedQuantityUnitOfMeasure": "Each",
"InventoryItemId": 663912,
"ItemNumber": "RCV-110",
"ItemDescription": "LSR Item",
"InventoryOrganizationId": 204,
"OrganizationName": "Vision Corporation",
"OrganizationCode": "V1",
"POHeaderId": 300100037657541,
"PONumber": "1002723",
"POLineId": 300100037694956,
"POLineNumber": 5,
"POScheduleId": 300100037694957,
"POScheduleNumber": 1,
"SecondaryConsumedQuantity": null,
"SecondaryQuantityUOMCode": null,
"SecondaryQuantityUnitOfMeasure": null,
"TransactionDate": "2018-05-30",
"TransactionTypeId": null,
"TransactionTypeName": null,
"ShipmentReceiptNumber": "9112",
"ShipmentHeaderId": 2798403,
"ReceiptLineNumber": 5,
"ShipmentLineId": 2882280,
"CurrencyCode": "USD",
"UnitPrice": 10,
"ExtendedPrice": 10,
"RevisionNumber": 1,
"consumptionAdviceLots": [
{
"LotNumber": "29012",
"TransactionQuantity": 1
}
],
"consumptionAdviceSerials": [],
"consumptionAdviceTransactions": [
{
"TransactionId": 22410641,
"Item": "RCV-110",
"ItemDescription": "LSR Item",
"InventoryItemId": 663912,
"Revision": "A",
"SubinventoryCode": "KKCONSUB",
"SubinventoryId": 300100023187777,
"LocatorId": null,
"Locator": null,
"TransactionQuantity": -1,
"TransactionUOMCode": "Ea",
"TransactionUOM": "Each",
"TransactionDate": "2018-05-30T14:55:31+00:00",
"TransactionTypeId": 74,
"TransactionType": "Intransit Shipment",
"TransactionSourceTypeId": 1,
"TransactionSourceType": "Inventory",
"SourceReference": null,
"Account": null,
"Reason": null,
"Reference": null,
"ErrorExplanation": null,
"TransferOrganization": "Vision Corporation",
"TransferOrganizationCode": "V1",
"TransferOrganizationId": 204,
"TransferOrgLocation": null,
"TransferOrgLocationId": 204,
"TransferSubinventory": "KKCONSUB",
"TransferSubinventoryCode": "KKCONSUB",
"TransferLocator": null,
"TransferLocatorId": null,
"TransferBusinessUnit": "Vision Corporation",
"Quantity": -1,
"UOMName": "Each",
"PrimaryUOMCode": "Ea",
"SecondaryQuantity": null,
"SecondaryUOM": null,
"SecondaryUOMCode": null,
"Source": null,
"SourceLine": null,
"TransactionAction": "Ownership transfer",
"TransactionActionId": 6,
"TransactionSet": 300100150215931,
"TransferTransaction": 22410640,
"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": "2968507",
"Waybill": null,
"Carrier": null,
"FreightCode": null,
"NumberOfContainers": 3,
"OwningPartyType": "Supplier site",
"OwningTpType": 1,
"TransferOwningTpType": 2,
"OwningParty": "CV_SuppA01",
"OwningPartySite": "CVSuppA01Site01",
"TransferOwningPartyType": "Inventory organization",
"TransferOwningParty": "V1",
"TransferOwningPartySite": null,
"ConsumptionAdvice": "300100154820838",
"ConsumptionAdviceLine": "1",
"ConsumptionLineId": 300100154820839,
"PurchaseOrder": null,
"PurchaseOrderHeaderId": null,
"PurchaseOrderLineId": null,
"PurchaseOrderLine": null,
"ParentTransaction": 22410639,
"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": null,
"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": 24031,
"TaxInvoiceNumber": null,
"TaxInvoiceDate": null,
"AssessableValue": 1000,
"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": 2798403,
"ReasonId": null,
"ConsErrorTypeCode": null,
"ConsErrorActionCode": null,
"OwningOrganizationId": 2444,
"XfrOwningOrganizationId": 204,
"StructureInstanceNumber": 101,
"Category": null,
"Lot": null,
"SerialNumber": null,
"SupplierLot": null,
"ExternalSystemPackingUnit": null,
"DistributionAccountId": null,
"FinalDischargeLocationId": null
}
]
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inventoryConsumptionAdvices",
"name": "inventoryConsumptionAdvices",
"kind": "collection"
}
]
}