1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Receipts (Deprecated)

Create receipts

post

/fscmRestApi/resources/11.13.18.05/receipts

Request

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Abbreviation that identifies the error message. If the call is successful, then this attribute is empty.
  • Message text of the error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt header that includes errors. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt line that includes an error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the group that contains the receipts and transactions from each service call. The system creates this value. It is recommended that you leave the value for this attribute empty.
  • Receipt Headers
    Title: Receipt Headers
    The Receipt Headers resource manages details about the receipt header or inbound shipment header.
  • Status of the current service call. Values include SUCCESS or FAILURE.
Nested Schema : Receipt Headers
Type: array
Title: Receipt Headers
The Receipt Headers resource manages details about the receipt header or inbound shipment header.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Flexfields for Receipt Headers
Type: array
Title: Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references.
Show Source
Nested Schema : Receipt Lines
Type: array
Title: Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line.
Show Source
Nested Schema : receipts-receiptHeaders-receiptHeaderDFF-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Lots That Control Items
Type: array
Title: Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type: array
Title: Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type: array
Title: Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references.
Show Source
Nested Schema : Serials That Control Items
Type: array
Title: Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item.
Show Source
Nested Schema : schema
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 lot attributes that the descriptive flexfield references. Use it when only the lot controls the item.
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. Use it when only the lot controls the item.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-item-post-request
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes That Share Control
Type: array
Title: Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Lots That Share Control
Type: array
Title: Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Serials That Share Control
Type: array
Title: Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes That Share Control
Type: array
Title: Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Serials That Share Control
Type: array
Title: Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-item-post-request
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 serial attributes that the descriptive flexfield references. Use it when only the serial controls the item.
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. Use it when only the serial controls the item.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialsDFF-item-post-request
Type: object
Show Source
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 : receipts-item-response
Type: object
Show Source
  • Abbreviation that identifies the error message. If the call is successful, then this attribute is empty.
  • Message text of the error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt header that includes errors. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt line that includes an error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the group that contains the receipts and transactions from each service call. The system creates this value. It is recommended that you leave the value for this attribute empty.
  • Links
  • Receipt Headers
    Title: Receipt Headers
    The Receipt Headers resource manages details about the receipt header or inbound shipment header.
  • Status of the current service call. Values include SUCCESS or FAILURE.
Nested Schema : Receipt Headers
Type: array
Title: Receipt Headers
The Receipt Headers resource manages details about the receipt header or inbound shipment header.
Show Source
Nested Schema : receipts-receiptHeaders-item-response
Type: object
Show Source
Nested Schema : Flexfields for Receipt Headers
Type: array
Title: Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references.
Show Source
Nested Schema : Receipt Lines
Type: array
Title: Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line.
Show Source
Nested Schema : receipts-receiptHeaders-receiptHeaderDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-item-response
Type: object
Show Source
Nested Schema : Lots That Control Items
Type: array
Title: Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type: array
Title: Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type: array
Title: Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references.
Show Source
Nested Schema : Serials That Control Items
Type: array
Title: Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-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 lot attributes that the descriptive flexfield references. Use it when only the lot controls the item.
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. Use it when only the lot controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes That Share Control
Type: array
Title: Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Lots That Share Control
Type: array
Title: Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Serials That Share Control
Type: array
Title: Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes That Share Control
Type: array
Title: Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Serials That Share Control
Type: array
Title: Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialsDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-receiptTransactionDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-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 serial attributes that the descriptive flexfield references. Use it when only the serial controls the item.
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. Use it when only the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialsDFF-item-response
Type: object
Show Source
Links
receiptHeaders
Parameters:
  • GroupId: $request.path.GroupId
The Receipt Headers resource manages details about the receipt header or inbound shipment header.
Back to Top

Examples

This example describes how to create one receipt.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example creates one receipt in organization M1, for vendor Advanced Network Devices, for item RCV-100:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/receipts"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates. 

{
    	"receiptHeaders": [     	   {
           	 "OrganizationCode": "M1",
          	  "VendorName": "First Network Devices",
            	  "VendorSiteCode": "FRESNO",
                "EmployeeId": 4426,
                "BusinessUnit" : "Vision Operations",
                "ReceiptSourceCode" : "VENDOR
                "receiptLines": [
                {
                    "BusinessUnit" : "Vision Operations",
                    "DestinationTypeCode" : "RECEIVING",
                    "DocumentLineNumber" : 1,
                    "DocumentNumber" : 1000125,
                    "ItemNumber" : "RCV-100",
                    "PrimaryQuantity": 3,
                    "EmployeeId": 4426,
                    "OrganizationCode": "M1",
                    "Quantity": 3,
                    "UOMCode": "Ea",
                    "UnitOfMeasure" : "Each",
                    "ReceiptSourceCode" : "VENDOR",
                    "SoldtoLegalEntity" : "Vision Operations",
                    "SourceDocumentCode" : "PO",
                    "AutoTransactCode" : "RECEIVE",
                    "TransactionType" : "RECEIVE"
                }              
            ]
        }
    ]	
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "GroupId" : 56391,
  "ReturnStatus" : "SUCCESS",
  "ErrorCode" : null,
  "ErrorExplanation" : null,
  "ErrorUniqueHeaderId" : 0,
  "ErrorUniqueTransactionId" : "0",
  "receiptHeaders" : [ {
    "UniqueHeaderId" : 300100090015951,
    "ReceiptSourceCode" : "VENDOR",
    "TransactionDate" : null,
    "ShipmentNumber" : null,
    "ReceiptNumber" : null,
    "ReceiptHeaderId" : null,
    "VendorName" : "First Network Devices",
    "VendorNumber" : null,
    "VendorId" : null,
    "VendorSiteCode" : "FRESNO",
    "VendorSiteId" : null,
    "BUId" : null,
    "BusinessUnit" : "Vision Operations",
    "OrganizationCode" : "M1",
    "OrganizationId" : null,
    "ShippedDate" : null,
    "FreightCarrierId" : null,
    "FreightCarrierName" : null,
    "WaybillAirbillNumber" : null,
    "NumberOfPackingUnits" : null,
    "BillOfLading" : null,
    "PackingSlip" : null,
    "Comments" : null,
    "CustomerPartyName" : null,
    "CustomerId" : null,
    "EmployeeName" : null,
    "EmployeeId" : 4426,
    "FromOrganizationCode" : null,
    "FromOrganizationId" : null,
    "RADOOSourceSystemId" : null,
    "RADOOSourceSystemName" : null,
    "receiptLines" : [ {
      "UniqueTransactionId" : 300100090015952,
      "TransactionType" : "RECEIVE",
      "AutoTransactCode" : "RECEIVE",
      "TransactionDate" : "2016-06-05T23:11:47-07:00",
      "OrganizationCode" : "M1",
      "OrganizationId" : null,
      "ItemDescription" : null,
      "ItemId" : null,
      "ItemNumber" : "RCV-100",
      "ItemRevision" : null,
      "ReceiptSourceCode" : "VENDOR",
      "SourceDocumentCode" : "PO",
      "DocumentNumber" : "1000125",
      "DocumentLineNumber" : 1,
      "DocumentScheduleNumber" : null,
      "DocumentDistributionNumber" : null,
      "PODistributionId" : null,
      "POHeaderId" : null,
      "POLineId" : null,
      "POLineLocationId" : null,
      "ShipmentHeaderId" : null,
      "ShipmentLineId" : null,
      "ShipmentNumber" : null,
      "ASNLineNumber" : null,
      "TransferOrderHeaderId" : null,
      "TransferOrderLineId" : null,
      "SoldtoLegalEntity" : "Vision Operations",
      "SoldtoLegalEntityId" : null,
      "DestinationTypeCode" : "RECEIVING",
      "Subinventory" : null,
      "Locator" : null,
      "LocatorId" : null,
      "Quantity" : 3,
      "UnitOfMeasure" : "Each",
      "UOMCode" : "Ea",
      "PrimaryQuantity" : 3,
      "PrimaryUOMCode" : null,
      "PrimaryUnitOfMeasure" : null,
      "SecondaryUOMCode" : null,
      "SecondaryUnitOfMeasure" : null,
      "SecondaryQuantity" : null,
      "EmployeeId" : 4426,
      "EmployeeName" : null,
      "ParentTransactionId" : null,
      "SourceTransactionNumber" : null,
      "ParentSourceTransactionNumber" : null,
      "InterfaceSourceCode" : null,
      "InterfaceSourceLineId" : null,
      "ShipToLocationCode" : null,
      "ShipToLocationId" : null,
      "DeliverToLocationCode" : null,
      "DeliverToLocationId" : null,
      "DeliverToPersonId" : null,
      "DeliverToPersonName" : null,
      "RoutingHeaderId" : null,
      "InspectionQualityCode" : null,
      "Exception" : null,
      "CreateDebitMemo" : null,
      "RMAReference" : null,
      "PhysicalMaterialReturnRequired" : null,
      "ReceiptAdviceDocumentScheduleNumber" : null,
      "ReceiptAdviceDocumentLineNumber" : null,
      "ReceiptAdviceDocumentNumber" : null,
      "ReceiptAdviceHeaderId" : null,
      "ReceiptAdviceLineId" : null,
      "CustomerPartyName" : null,
      "CustomerId" : null,
      "CustomerItemNumber" : null,
      "CustomerItemId" : null,
      "Amount" : null,
      "CountryOfOriginCode" : null,
      "CurrencyCode" : null,
      "CurrencyConversionDate" : null,
      "CurrencyConversionRate" : null,
      "CurrencyConversionType" : null,
      "FromOrganizationCode" : null,
      "FromOrganizationId" : null,
      "ContainerNumber" : null,
      "SubstituteItemNumber" : null,
      "SubstituteItemId" : null,
      "SubstituteUnorderedCode" : null,
      "VendorName" : null,
      "VendorId" : null,
      "VendorNumber" : null,
      "VendorSiteCode" : null,
      "VendorSiteId" : null,
      "BusinessUnit" : "Vision Operations",
      "BUId" : null,
      "VendorItemNumber" : null,
      "ConsignmentLine" : null,
      "ReasonId" : null,
      "ReasonName" : null,
      "PackingSlip" : null,
      "Comments" : null,
      "FromSubinventory" : null,
      "FromLocator" : null,
      "FromLocatorId" : null
    } ]
  } ]
}
Back to Top