Create transactions

post

/fscmRestApi/resources/11.13.18.05/receivingTransactions

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 that occurred when calling the service. If the call is successful, then this attribute is empty.
  • Message text of the error that occurred when calling the service. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt line that caused the error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the group of transactions from each service call. The application provides this value. It is recommended that you leave this attribute empty.
  • Status of the current service call. Values include SUCCESS or FAILURE.
  • Transaction Lines
    Title: Transaction Lines
    The Transaction Lines resource manages details about the transaction and the inbound shipment line.
Nested Schema : Transaction Lines
Type: array
Title: Transaction Lines
The Transaction Lines resource manages details about the transaction and the inbound shipment line.
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. You can use this resource if the lot controls the item that the receipt references.
Show Source
Nested Schema : Serials and Lots That Control Items
Type: array
Title: Serials and Lots That Control Items
The Serials and Lots That Control Items resource manages details about the serial. You can use this resource if the lot and serial control 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 Serials That Control Items resource manages details about the serial. You can use this resource if the serial controls the item.
Show Source
Nested Schema : receivingTransactions-transactionLines-lotItemLots-item-post-request
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 : schema
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 the 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 : Lots and Serials That Control Items
Type: array
Title: Lots and Serials That Control Items
The Lots and Serials That Control Items resource manages details about the lot. You can use this resource if the lot and serial controls the item.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemSerials-item-post-request
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 : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialAttributesDFF-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-receiptTransactionDFF-item-post-request
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-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 the 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 serials 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 : schema
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 : receivingTransactions-item-response
Type: object
Show Source
  • Abbreviation that identifies the error that occurred when calling the service. If the call is successful, then this attribute is empty.
  • Message text of the error that occurred when calling the service. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the receipt line that caused the error. If the call is successful, then this attribute is empty.
  • Value that uniquely identifies the group of transactions from each service call. The application provides this value. It is recommended that you leave this attribute empty.
  • Links
  • Status of the current service call. Values include SUCCESS or FAILURE.
  • Transaction Lines
    Title: Transaction Lines
    The Transaction Lines resource manages details about the transaction and the inbound shipment line.
Nested Schema : Transaction Lines
Type: array
Title: Transaction Lines
The Transaction Lines resource manages details about the transaction and the inbound shipment line.
Show Source
Nested Schema : receivingTransactions-transactionLines-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. You can use this resource if the lot controls the item that the receipt references.
Show Source
Nested Schema : Serials and Lots That Control Items
Type: array
Title: Serials and Lots That Control Items
The Serials and Lots That Control Items resource manages details about the serial. You can use this resource if the lot and serial control 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 Serials That Control Items resource manages details about the serial. You can use this resource if the serial controls the item.
Show Source
Nested Schema : receivingTransactions-transactionLines-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 : receivingTransactions-transactionLines-lotItemLots-lotItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-lotItemLots-lotItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-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 the 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 : Lots and Serials That Control Items
Type: array
Title: Lots and Serials That Control Items
The Lots and Serials That Control Items resource manages details about the lot. You can use this resource if the lot and serial controls the item.
Show Source
Nested Schema : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemLotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemLotsDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-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 : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialsDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-receiptTransactionDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-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 the 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 serials that the descriptive flexfield references. Use it when only the serial controls the item.
Show Source
Nested Schema : receivingTransactions-transactionLines-serialItemSerials-serialItemSerialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingTransactions-transactionLines-serialItemSerials-serialItemSerialsDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to post receiving transactions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example posts an ACCEPT transaction for a quantity of 3 Each, in organization M1, for parent receive transaction 3112409:

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

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.

{
         "transactionLines": [
                {
                    "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",
                    "TransactionType" : "ACCEPT",
                    "ParentTransactionId" : 3112409
                },
   ]
  }

Example Response Body

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

{
  "GroupId" : 57399,
  "ReturnStatus" : "SUCCESS",
{
  "GroupId" : 57399,
  "ReturnStatus" : "SUCCESS",
  "ErrorCode" : null,
  "ErrorExplanation" : null,
  "ErrorUniqueTransactionId" : "0",
  "transactionLines" : [ {
    "UniqueTransactionId" : 300100090016106,
    "TransactionType" : "ACCEPT",
    "AutoTransactCode" : null,
    "TransactionDate" : "2016-06-06T03:50:52-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" : 3112409,
    "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