1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Receiving Transactions History

Get all transactions

get

/fscmRestApi/resources/11.13.18.05/receivingTransactionsHistory

Request

Query Parameters
  • 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: Find receiving transactions according to primary key.
      Finder Variables:
      • TransactionId; integer; Value that uniquely identifies the receiving transaction.
    • findByLotAndSerial: Find receiving transactions for a lot or a serial or both.
      Finder Variables:
      • ItemId; integer; Value that uniquely identifies the item.
      • ItemNumber; string; Name of the item.
      • LotNumber; string; Number that identifies the lot.
      • OrganizationCode; string; Abbreviation that identifies the receiving organization.
      • OrganizationId; integer; Value that uniquely identifies the receiving organization.
      • SerialNumber; string; Serial number of the item. Do not use this finder if the transaction has more than 15 serial numbers.
  • 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:
    • AccrualStatusCode; string; Abbreviation that identifies the interface status of the receiving transaction from receiving to costing. Values are Pending, Interfaced, or Error.
    • Amount; number; Amount for the transaction.
    • AmountBilled; number; Amount invoiced by Oracle Payables Cloud for the transaction in terms of the purchase order currency.
    • AssessableValue; number; Value that indicates the price that the tax authorities use to calculate the tax for the item.
    • BackToBackFlag; boolean; Contains one of the following values: true or false. If true, then the application created the receiving transaction for a back-to-back order. If false, then the application did not create the receiving transaction for a back-to-back order. The default value is false.
    • BillingUOMCode; string; Abbreviation that identifies the UOM used for billing by Oracle Fusion Payables.
    • BillingUnitOfMeasure; string; UOM used for billing by Oracle Fusion Payables.
    • BusinessEventPublishedFlag; boolean; Contains one of the following values: true or false. If true, then Oracle Fusion Receiving created a business event for this receiving transaction. If false, then Oracle Fusion Receiving did not create a business event for this receiving transaction. The default value is false.
    • Comments; string; Note that the receiver created.
    • ConsignedFlag; boolean; Contains one of the following values: true or false. If true, then the application created the transaction for consigned material. If false, then the application did not create the transaction for consigned material. The default value is false.
    • CountryOfOriginCode; string; Abbreviation that identifies the country of manufacture for this item.
    • CurrencyCode; string; Abbreviation that identifies the currency of the receiving transaction.
    • CurrencyConversionDate; string; Date when the currency conversion occurred for the receipt.
    • CurrencyConversionRate; number; Currency conversion rate for the receipt.
    • CurrencyConversionType; string; Type of currency conversion rate for the purchase order.
    • CurrencyName; string; Currency of the receiving transaction.
    • CustomerId; integer; Value that uniquely identifies the customer.
    • CustomerName; string; Name of the customer.
    • DefaultTaxationCountryCode; string; Value that identifies the country for the receiving transaction, which is used to determine the tax for the item.
    • DeliverToLocationId; integer; Value that uniquely identifies the deliver-to location.
    • DeliverToLocationName; string; Name of the deliver-to location.
    • DeliverToPersonId; integer; Value that uniquely identifies the deliver-to person or the requester.
    • DeliverToPersonName; string; Name of the deliver-to person or requester.
    • DestinationType; string; Destination type of the receiving transaction.
    • DestinationTypeCode; string; Abbreviation that identifies the destination type of the receiving transaction. A list of accepted values is defined in the lookup type RCV_DESTINATION_TYPE.
    • DocumentFiscalClassification; string; Value that identifies the classification of the fiscal document, which is used to determine the tax. It is also known as tax document subtype.
    • ElectronicRecordId; integer; Value that uniquely identifies the electronic record.
    • EmployeeId; integer; Value that uniquely identifies the employee who performed the receiving transaction.
    • EmployeeName; string; Name of the employee who performed the receiving transaction.
    • ExternalSystemPackingUnit; string; Packing unit from a warehouse management system that resides outside of Oracle Fusion applications.
    • ExternalSystemTransactionReference; string; Value that contains reference information for the corresponding transaction in external applications.
    • FinalDischargeLocationId; integer; Value that indicates the final discharge location, which is used to calculate the tax for the item.
    • FirstPartyTaxRegistrationId; integer; Value that identifies the tax registration for the first party of the receiving transaction, which is used to determine the tax for the item.
    • FromLocator; string; Name of the source locator.
    • FromLocatorId; integer; Value that uniquely identifies the source locator.
    • FromOrganizationCode; string; Abbreviation that identifies the source organization for an in-transit shipment.
    • FromOrganizationId; integer; Value that uniquely identifies the source organization for an in-transit shipment.
    • FromOrganizationName; string; Name of the source organization for an in-transit shipment.
    • FromSubinventory; string; Name of the source subinventory.
    • GroupId; integer; Value that uniquely identifies the group of receiving transactions.
    • InspectionQuality; string; Inspection quality.
    • InspectionStatus; string; Inspection status.
    • InspectionStatusCode; string; Abbreviation that identifies the inspection status. A list of accepted values is defined in the lookup type RCV_TRANSACTION_TYPE.
    • IntendedUseClassificationId; integer; Value that identifies the intended use classification for the receiving transaction, which is used to determine the tax for the item.
    • IntendedUseCode; string; Value that identifies the intended use for the receiving item for the item, which is used to determine the tax for the item.
    • InterfaceReturnsToShippingFlag; boolean; Contains one of the following values: true or false. If true, then the application interfaced a return transaction to shipping to print the shipping documents. If false, then the application did not interface a return transaction to shipping to print shipping documents. The default value is false.
    • ItemDescription; string; Description of the item.
    • ItemId; integer; Value that uniquely identifies the item.
    • ItemNumber; string; Name of the item.
    • ItemRevision; string; Revision number of the item.
    • LineNumber; integer; Line number of the receipt.
    • Locator; string; Name of the destination locator.
    • LocatorId; integer; Value that uniquely identifies the destination locator.
    • LotControlCode; number; Abbreviation that identifies the lot control code of the inventory item. A list of accepted values is defined in the lookup type EGP_LOT_CONTROL_CODE_TYPE.
    • OrganizationCode; string; Abbreviation that identifies the receiving organization.
    • OrganizationId; integer; Value that uniquely identifies the receiving organization.
    • OrganizationName; string; Name of the receiving organization.
    • PODistributionId; integer; Value that uniquely identifies the purchase order distribution.
    • PODistributionNumber; number; Number that identifies the purchase order distribution.
    • POHeaderId; integer; Value that uniquely identifies the purchase order header.
    • POLineId; integer; Value that uniquely identifies the purchase order line.
    • POLineLocationId; integer; Value that uniquely identifies the purchase order schedule.
    • POLineNumber; number; Number that identifies the purchase order line.
    • PONumber; string; Number that identifies the purchase order header.
    • POShipmentNumber; number; Number that identifies the purchase order schedule.
    • ParentTransactionId; integer; Value that uniquely identifies the parent receiving transaction.
    • ParentTransactionType; string; Transaction type of the parent receiving transaction.
    • ParentTransactionTypeCode; string; Abbreviation that identifies the transaction type of the parent receiving transaction. A list of accepted values is defined in the lookup type RCV_TRANSACTION_TYPE.
    • PhysicalReturnRequiredFlag; boolean; Contains one of the following values: true or false. If true, then the application created the transaction for material that should be physically returned. If false, then the application created the transaction for material that should be scrapped. The default value is false.
    • PrimaryQuantity; number; Transaction quantity in the primary unit of measure that the item uses.
    • PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure that the item uses.
    • PrimaryUnitOfMeasure; string; Primary unit of measure for the item.
    • ProductCategoryCode; string; Value that identifies the product category for the receiving transaction, which is used to determine the tax for the item.
    • ProductFiscalClassificationId; integer; Value that identifies the product fiscal classification for the inventory item, which is used to determine the tax for the item.
    • ProductTypeCode; string; Value that identifies the product type of the inventory item, which is used to determine the tax for the item. Values include Goods or Services.
    • Quantity; number; Transaction quantity in the unit of measure that the receiving transaction uses.
    • QuantityBilled; number; Quantity invoiced by Oracle Payables Cloud for the current receiving transaction.
    • RMAReference; string; Number that identifies the return material authorization to use when returning goods to the supplier.
    • Reason; string; Name of the inventory transaction reason for the receiving transaction.
    • ReceiptAdviceDocument; string; Type of receipt advice document.
    • ReceiptAdviceDocumentCode; string; Abbreviation that identifies the document type for the receipt advice. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE.
    • ReceiptAdviceDocumentLineNumber; string; Value that identifies the line number for the receipt advice.
    • ReceiptAdviceDocumentNumber; string; Value that identifies the number of the receipt advice.
    • ReceiptAdviceHeaderId; integer; Value that uniquely identifies the receipt advice header.
    • ReceiptAdviceLineId; integer; Value that uniquely identifies the receipt advice line.
    • ReceiptConfirmationMessageNumber; integer; Message number that groups the receiving transactions that the receipt confirmation communicates.
    • ReceiptConfirmationStatusCode; string; Value that indicates whether or not the receipt confirmation is sent from Oracle Receiving Cloud to the source application for a document number. Valid values include Pending or Sent.
    • ReceiptExceptionFlag; boolean; Contains one of the following values: true or false. If true, then the application found an exception when creating the receiving transaction. If false, then the application did not find any exception when creating the receiving transaction. The default value is false.
    • ReceiptNumber; string; Number that identifies the receipt.
    • ReturnTransferOrderHeaderId; integer; Value that uniquely identifies the order header for the return transfer.
    • ReturnTransferOrderLineId; integer; Value that uniquely identifies the order line for the return transfer.
    • ReturnTransferOrderLineNumber; integer; Value that identifies the line number for the return transfer order.
    • ReturnTransferOrderNumber; string; Number that identifies the return transfer order.
    • SerialNumberControlCode; number; Abbreviation that identifies the serial number control code of the inventory item. A list of accepted values is defined in the lookup type EGP_SERIAL_NUMBER_CONTROL_TYPE.
    • ShipFromLocationId; integer; Value that uniquely identifies the ship from location for the receiving transaction, which is used to determine the tax for the item.
    • ShipmentHeaderId; integer; Value that uniquely identifies the shipment header.
    • ShipmentLineId; integer; Value that uniquely identifies the shipment line.
    • ShipmentNumber; string; Number that the shipment source assigns. This number corresponds to the number for one of the following documents: advanced shipment notice, in-transit shipment, or transfer order shipment.
    • SourceDocument; string; Type of source document.
    • SourceDocumentCode; string; Abbreviation that identifies the source document type. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE.
    • Subinventory; string; Name of the destination subinventory.
    • TaxClassificationCode; string; Value that identifies the tax classification for the receiving transaction, which is used to determine the tax for the item.
    • TaxInvoiceDate; string; Value that indicates the date and time of the fiscal document generation, which is used to determine the tax for the item.
    • TaxInvoiceNumber; string; Value that identifies the fiscal document, which is used to determine the tax for the item.
    • ThirdPartyTaxRegistrationId; integer; Value that identifies the tax registration for the third party of the receiving transaction, which is used to determine the tax for the item.
    • TransactionBusinessCategoryCode; string; Value that identifies the transaction business category for the receiving transaction, which is used to determine the tax for the item.
    • TransactionDate; string; Date when the receiving transaction occurred.
    • TransactionDateTime; string; Date and time when the receiving transaction occurred.
    • TransactionId; integer; Value that uniquely identifies the receiving transaction.
    • TransactionType; string; Type of receiving transaction.
    • TransactionTypeCode; string; Abbreviation that identifies the receiving transaction type. A list of accepted values is defined in the lookup type RCV_TRANSACTION_TYPE.
    • TransferOrderDistributionId; integer; Value that uniquely identifies the transfer order distribution.
    • TransferOrderDistributionNumber; number; Number that identifies the transfer order distribution.
    • TransferOrderHeaderId; integer; Value that uniquely identifies the transfer order header.
    • TransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
    • TransferOrderLineNumber; integer; Number that identifies the transfer order line.
    • TransferOrderNumber; string; Number that identifies the transfer order header.
    • UOMCode; string; Abbreviation that identifies the unit of measure that the receiving transaction uses.
    • UnitOfMeasure; string; Unit of measure for the receiving transaction.
    • UserDefinedFiscalClassificationCode; string; Value that identifies the fiscal classification for the receiving transaction, which is used to determine the tax for the item This is a user-defined value.
    • VendorId; integer; Value that uniquely identifies the supplier.
    • VendorName; string; Name of the supplier.
    • VendorSiteCode; string; Abbreviation that identifies the supplier site.
    • VendorSiteId; integer; Value that uniquely identifies the supplier site.
  • 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 : receivingTransactionsHistory
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receivingTransactionsHistory-item-response
Type: object
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type: array
Title: Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a receiving transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource manages the lots associated to a receiving transaction.
Show Source
Nested Schema : Receipt Header Attachments
Type: array
Title: Receipt Header Attachments
This resource manages details about receipt header attachments.
Show Source
Nested Schema : Receipt Header Descriptive Flexfields
Type: array
Title: Receipt Header Descriptive Flexfields
This resource manages the descriptive flexfield information for a receipt header.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the serials associated to a receiving transaction.
Show Source
Nested Schema : Transaction Attachments
Type: array
Title: Transaction Attachments
This resource manages details about receiving transaction attachments.
Show Source
Nested Schema : Flexfields for Receiving Transactions
Type: array
Title: Flexfields for Receiving Transactions
The Flexfields for Receiving Transactions resource manages details about the receiving transaction attributes that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-inventoryStripingDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for inventory striping attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory striping attributes. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of manufacture for this item. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of manufacture. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the receiving transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : receivingTransactionsHistory-lots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about the lot attributes that the descriptive flexfield references.
Show Source
Nested Schema : Serials for Lots
Type: array
Title: Serials for Lots
The Serials for Lots resource manages the serials associated to a lot.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Serial Attributes
Type: array
Title: Flexfields for Lot Serial Attributes
The Flexfields for Lot Serial Attributes resource manages details about the lot serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Lot Serials
Type: array
Title: Flexfields for Lot Serials
The Flexfields for Lot Serials resource manages details about the lot serial that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-lotSerialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotSerials-lotSerialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-lots-lotStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-receiptAttachments-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-receiptDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-serials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about the serial attributes that the descriptive flexfield references.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references.
Show Source
Nested Schema : receivingTransactionsHistory-serials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-serials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-transactionAttachments-item-response
Type: object
Show Source
Nested Schema : receivingTransactionsHistory-transactionDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all transactions.

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/receivingTransactionsHistory"

Example Response Body

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

{
    "items": [
        {
            "TransactionId": 3037399,
            "TransactionTypeCode": "RECEIVE",
            "TransactionType": "Receive",
            "TransactionDate": "2014-07-31",
            "Quantity": 20,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "PrimaryQuantity": 20,
            "PrimaryUOMCode": "Ea",
            "PrimaryUnitOfMeasure": "Each",
            "Amount": null,
            "CurrencyCode": "USD",
            "CurrencyName": "US Dollar",
            "CurrencyConversionType": null,
            "CurrencyConversionRate": null,
            "CurrencyConversionDate": null,
            "ItemId": 663912,
            "ItemNumber": "RCV-110",
            "ItemDescription": "LSR Item"
            ...
        },
        {
            "TransactionId": 3035417,
            "TransactionTypeCode": "DELIVER",
            "TransactionType": "Deliver",
            "TransactionDate": "2014-07-31",
            "Quantity": 20,
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "PrimaryQuantity": 20,
            "PrimaryUOMCode": "Ea",
            "PrimaryUnitOfMeasure": "Each",
            "Amount": null,
            "CurrencyCode": "USD",
            "CurrencyName": "US Dollar",
            "CurrencyConversionType": null,
            "CurrencyConversionRate": null,
            "CurrencyConversionDate": null,
            "ItemId": 663912,
            "ItemNumber": "RCV-110",
            "ItemDescription": "LSR Item"
            ...
        },
        ...
    ],
    ...
}
Back to Top