1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Inventory Consumption Advices
  5. Consumption Advice Lines

Get all advice lines

get

/fscmRestApi/resources/11.13.18.05/inventoryConsumptionAdvices/{inventoryConsumptionAdvicesUniqID}/child/consumptionAdviceLines

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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: Finds inventory consumption advice lines.
      Finder Variables:
      • ConsumptionLineId; integer; Value that uniquely identifies the inventory consumption advice line.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ConsumedQuantity; number; Quantity of the item consumed.
    • ConsumedQuantityUOMCode; string; Abbreviation that identifies the unit of measure that the user chooses for the consuming quantity.
    • ConsumedQuantityUnitOfMeasure; string; Unit of measure that the user chooses for the consuming quantity.
    • ConsumptionAdviceLine; number; Value that uniquely identifies the consumption advice line.
    • ConsumptionHeaderId; integer; Value that uniquely identifies the consumption header.
    • ConsumptionLineId; integer; Value that uniquely identifies the consumption line.
    • CurrencyCode; string; Abbreviation that identifies the currency.
    • ExtendedPrice; number; Revised price of the item.
    • InventoryItemId; integer; Value that uniquely identifies the item.
    • InventoryOrganizationId; integer; Value that uniquely identifies the inventory organization.
    • ItemDescription; string; Description of item.
    • ItemNumber; string; Number that identifies the item.
    • OrganizationCode; string; Abbreviation that identifies the organization.
    • OrganizationName; string; Name of the organization.
    • POHeaderId; integer; Value that uniquely identifies the purchase order header.
    • POLineId; integer; Value that uniquely identifies the purchase order line.
    • POLineNumber; number; Number that identifies the purchase order line.
    • PONumber; string; Value that uniquely identifies the purchase order.
    • POScheduleId; integer; Value that uniquely identifies the purchase order schedule .
    • POScheduleNumber; number; Number that identifies the purchase order schedule .
    • PurchaseAgreementLine; number; Value that specifies the purchase agreement line.
    • PurchaseAgreementLineId; integer; Value that uniquely identifies the purchase agreement line.
    • ReceiptLineNumber; integer; Number that identifies the receipt line.
    • RevisionNumber; integer; Revision number corresponding to each change in the item price.
    • SecondaryConsumedQuantity; number; Quantity consumed expressed in secondary unit of measure of the item.
    • SecondaryQuantityUOMCode; string; Abbreviation that identifies the secondary unit of measure.
    • SecondaryQuantityUnitOfMeasure; string; Name of the secondary unit of measure of the item.
    • ShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
    • ShipmentLineId; integer; Value that uniquely identifies the shipment line.
    • ShipmentReceiptNumber; string; Number that identifies the shipment receipt .
    • TransactionDate; string; Date when the transaction was performed.
    • TransactionTypeId; integer; Value that uniquely identifies the transaction type.
    • TransactionTypeName; string; Abbreviation that identifies the type of transaction.
    • UnitPrice; number; Unit price of the item.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : inventoryConsumptionAdvices-consumptionAdviceLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-item-response
Type: object
Show Source
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 : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceLots-item-response
Type: object
Show Source
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 : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceLots-consumptionAdviceLotsAndSerials-item-response
Type: object
Show Source
  • Links
  • Title: Serial Number
    Maximum Length: 80
    Serial number of the item when a serial in a lot controls the transaction.
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceSerials-item-response
Type: object
Show Source
Nested Schema : inventoryConsumptionAdvices-consumptionAdviceLines-consumptionAdviceTransactions-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all advice lines.

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/child/consumptionAdviceLines"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "ConsumptionLineId": 300100154820806,
            "ConsumptionAdviceLine": 1,
            "ConsumptionHeaderId": 300100154820805,
            "PurchaseAgreementLine": 3,
            "PurchaseAgreementLineId": 460961,
            "ConsumedQuantity": 15,
            "ConsumedQuantityUOMCode": "Ea",
            "ConsumedQuantityUnitOfMeasure": "Each",
            "InventoryItemId": 663908,
            "ItemNumber": "RCV-101",
            "ItemDescription": "Lot Item",
            "InventoryOrganizationId": 204,
            "OrganizationName": "Vision Corporation",
            "OrganizationCode": "V1",
            "POHeaderId": 300100148911402,
            "PONumber": "1004344",
            "POLineId": 300100148911411,
            "POLineNumber": 2,
            "POScheduleId": 300100148911412,
            "POScheduleNumber": 1,
            "SecondaryConsumedQuantity": null,
            "SecondaryQuantityUOMCode": null,
            "SecondaryQuantityUnitOfMeasure": null,
            "TransactionDate": "2018-05-25",
            "TransactionTypeId": null,
            "TransactionTypeName": null,
            "ShipmentReceiptNumber": "9306",
            "ShipmentHeaderId": 2963473,
            "ReceiptLineNumber": 2,
            "ShipmentLineId": 3039318,
            "CurrencyCode": "USD",
            "UnitPrice": 10,
            "ExtendedPrice": 150,
            "RevisionNumber": 1 }
    ]  {"ConsumptionLineId" : .......}}
Back to Top