Integrate Receipt Advice and Receipt Confirmation Processes for External Applications

A third-party logistics (3PL) provider typically specializes in integrated operation, warehousing, and transportation services that can be scaled and configured to customer need based on market conditions. A warehouse management system (WMS) is a software application designed to support warehouse or distribution center management and staff. This application facilitates management of available resources to move and store materials into, within, and out of a warehouse, while supporting staff in material movement and storage.

Oracle Fusion Applications provide a central integration framework that coordinates communication with a 3PL application or WMS to support purchase order receipts, returns to suppliers, internal material transfers, inventory transactions, and sales order shipments. Using REST API, Oracle Inventory Management Cloud communicates receiving advice and shipment requests to a 3PL provider or external WMS for processing. After completion of processing in the 3PL application or WMS, Inventory Management accepts receipt confirmations, shipment confirmations, and inventory transactions from the 3PL application or WMS.

The following figure illustrates how Inventory Management integrates with 3PL and WMS applications.

High-level overview of Inventory Management integration with 3PL and WMS applications

Let's discuss this scenario briefly:

  • Get receipt advice lines
  • Manage receipts
  • Manage receipt transactions

Here's a typical application processing flow for the scenarios:

  1. You use the generateReceiptAdviceLines custom action in the receiptAdviceLines resource to get the receipt advice lines that have not yet been sent to an external application or lines that have been changed since the last time they were sent and generates a group identifier for those lines.
  2. You use the receiptAdviceLines resource to get the receipt advice lines by using the group identifier generated by the generateReceiptAdviceLines custom action.
  3. You map the output to the WMS service and call the appropriate WMS service.
  4. WMS receives the material and send the message to the integration layer.
  5. You map the message details to the receivingReceiptRequests resource and use the resource to manage receipts or advance shipment notice (ASN) request headers that are used to communicate with Oracle Fusion applications and process requests.
  6. You can use WMS to perform subsequent activities like inspection, put away, and so on and send the messages to the integration layer.
  7. You can map the message details to the receivingReceiptTransactionRequests resource and use the resource to communicate requests to inspect, put away, correct, and return received goods and services with Oracle Fusion applications and process these requests.

Get a Receipt Advice

Let's consider that Amy Smith is a receiving agent who sends a receipt advice to the WMS for the various documents, such as purchase order (POs), advanced shipment notices (ASNs), and return material authorizations (RMAs).

To accomplish sending a receipt advice:

  1. Use the generateReceiptAdviceLines custom action in the receiptAdviceLines resource to generate a group identifier for receipt advice lines that have not yet been sent to an external application or lines that have been changed since the last time they were sent.
  2. Use the receiptAdviceLines resource to get the receipt advice lines by using the group identifier generated by the generateReceiptAdviceLines custom action.

Generate Receipt Advice Lines Example URL

Use this resource URL format to generate a group identifier for receipt advice lines.

POST

fscmRestApi/resources/11.13.18.05/receiptAdviceLines/action/generateReceiptAdviceLines/

Here's an example:

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

To see the error messages, you need to also provide REST-Framework-Version = 4.

Example 1 Request

Here's an example of the request body in JSON format to generate receipt advice lines that are due in the last one month.

{
  "OrganizationCode":"M1",
  "DueDateCode":"ONE_MONTH_BACK"
}

Example 1 Response

Here's an example of the response body in JSON format.

{
	"result": {
		"ExternalSystemGroupId": "300100191331386",
		"TotalReceiptAdviceLinesGenerated": "30"
	}
}

Example 2 Request

Here's an example of the request body in JSON formatto generate receipt advice lines according to a purchase order. Note: You can use the Resend flag, which is used to send the latest state of a document.

{
	"OrganizationCode":"M1",
	"PurchaseOrderNumber":"1004268",
	"ResendFlag" : true  
}

Example 2 Response

Here's an example of the response body in JSON format.

{
	"result": {
		"ExternalSystemGroupId": "300100191363658",
		"TotalReceiptAdviceLinesGenerated": "1"
	}
}

Get Receipt Advice Lines Example URL

Use this resource URL format to get the receipt advice lines.

GET

fscmRestApi/resources/11.13.18.05/receiptAdviceLines

For example, to query the generated receipt advice lines using ExternalSystemGroupId

https://servername/fscmRestApi/resources/version/receiptAdviceLines?q=ExternalSystemGroupId=300100191331387&onlyData=true

Example Response

Here's an example of the response body in JSON format.

{
	"items": [
	{
		"ActionCode": "CREATE",
		"ExternalSystemGroupId": 300100191331387,
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentTypeCode": "PO",
		"ReceiptAdviceLineStatusCode": "OPEN",
		"SoldToLegalEntityName": "Vision Operations",
		"OrganizationId": 207,
		"OrganizationCode": "M1",
		"FromOrganizationId": null,
		"FromOrganizationCode": null,
		"DocumentNumber": "1004268",
		"DocumentLineNumber": "1",
		"DocumentScheduleNumber": "1",
		"DocumentRevision": "0",
		"DocumentRevisionDate": null,
		"DocumentCreationDate": "2018-03-27T11:59:16+00:00",
		"DocumentLastUpdateDate": "2018-03-27T12:00:16.308+00:00",
		"DocumentLineCreationDate": "2018-03-27T11:59:16+00:00",
		"DocumentLineLastUpdateDate": "2018-03-27T12:00:17+00:00",
		"TransferOrderNumber": null,
		"TransferOrderLineNumber": null,
		"SourceOrderNumber": null,
		"SourceOrderLineNumber": null,
		"SourceOrderFulfillmentLineNumber": null,
		"OriginalSourceOrderNumber": null,
		"OriginalSourceOrderLineNumber": null,
		"OriginalSourceOrderFulfillmentLineNumber": null,
		"OriginalOrderNumber": null,
		"OriginalOrderLineNumber": null,
		"PurchaseOrderHeaderId": 498240,
		"PurchaseOrderLineId": 467896,
		"PurchaseOrderScheduleId": 440283,
		"IntransitShipmentHeaderId": null,
		"IntransitShipmentLineId": null,
		"TransferOrderHeaderId": null,
		"TransferOrderLineId": null,
		"RMAHeaderId": null,
		"RMALineId": null,
		"Quantity": 10,
		"UOMCode": "Ea",
		"UnitOfMeasure": "Each",
		"PrimaryQuantity": 10,
		"PrimaryUOMCode": "Ea",
		"PrimaryUnitOfMeasure": "Each",
		"SecondaryQuantity": 0,
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"SupplierId": 21,
		"SupplierName": "Advanced Network Devices",
		"SupplierSiteId": 1969,
		"SupplierSiteCode": "FRESNO",
		"CustomerId": null,
		"CustomerName": null,
		"ItemId": 149,
		"ItemNumber": "AS54888",
		"ItemDescription": "Standard Desktop",
		"ItemRevision": null,
		"ItemCategoryId": 91,
		"ItemCategory": "Finished Goods_91",
		"SupplierItemNumber": null,
		"CustomerItemNumber": null,
		"ReceivingLocationId": 207,
		"ReceivingLocation": "M1- Seattle Mfg",
		"CarrierId": 12519,
		"CarrierName": "Airborne",
		"FreightTerms": "Due",
		"NoteToReceiver": null,
		"Comments": null,
		"ExpectedReceiptDate": "2018-03-27",
		"EarlyReceiptToleranceInDays": 10,
		"LateReceiptToleranceInDays": 10,
		"ReceiptExceedDaysActionCode": "WARNING",
		"AllowSubstituteReceiptsFlag": true,
		"ShipToExceptionActionCode": "WARNING",
		"OverReceiptTolerance": 10,
		"OverReceiptActionCode": "WARNING",
		"ReceiptRoutingId": 3,
		"ReceiptRouting": "Direct delivery",
		"IntegrationStatusCode": "INTERFACED",
		"ProjectId": null,
		"ProjectNumber": null,
		"TaskId": null,
		"TaskNumber": null,
		"CountryOfOriginCode": null,
		"CountryOfOrigin": null
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receiptAdviceLines",
		"name": "receiptAdviceLines",
		"kind": "collection"
	},
	{
		"rel": "action",
		"href": "https://servername/fscmRestApi/resources/version/receiptAdviceLines/action/generateReceiptAdviceLines",
		"name": "generateReceiptAdviceLines",
		"kind": "other"
	}
	]
}

Manage Receipts

Let's consider that Amy Scott is a receiving agent who manages receipts or advance shipment notice (ASN) request headers that are used to communicate with Oracle Fusion applications and process requests.

To manage receipts:

  1. Create receipts for all receiving documents, such as purchase orders, return material authorizations (RMAs), transfer orders, and in-transit shipments.
  2. Interface an ASN or advance shipment billing notice (ASBN) against one or more purchase orders.
  3. If there are errors in processing, search for the error records.
  4. Make the necessary corrections and resubmit requests that have resulted in errors.
  5. Delete the requests that have resulted in errors.

Create Receipts Example URL

Use this resource URL format.

POST

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests

Use the following cURL command:

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

Example Request

Here's an example of the request body in JSON format.

{
	"ReceiptSourceCode": "VENDOR",
	"OrganizationCode": "M1",
	"VendorName": "PennyPack Systems",
	"VendorSiteCode": "FRESNO",
	"BusinessUnit": "Vision Operations",
	"EmployeeId": "25",
	"attachments": [
	{
		"DatatypeCode": "FILE",
		"Title": "HeaderAttachments.txt",
		"Description": "TEXT UPLOAD from REST",
		"FileName": "headerAttachments.txt",
		"UploadedFileContentType": "text/plain",
		"CategoryName": "MISC",
		"FileContents": "UE9TVCBVcGxvYWQgRnJvbSBSRVNUIHR4dA=="
	}
	],
	"DFF": [
	{
		"newseg": "abc",
		"__FLEX_Context": "newctx",
		"newctxseg": "a"
	}
	],
	"lines": [
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 1,
		"ItemNumber": "RCV-100",
		"ItemId": "663907",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"transactionAttachments": [
		{
			"DatatypeCode": "TEXT",
			"Description": "TEXT created from REST",
			"UploadedText": "Sample Text test",
			"CategoryName": "MISC",
			"UploadedFileLength": "19"
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 2,
		"ItemNumber": "RCV-101",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"lotItemLots": [
		{
			"LotNumber": "LOT18-18068",
			"TransactionQuantity": 3,
			"lotNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"lotAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 3,
		"ItemNumber": "RCV-102",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"serialItemSerials": [
		{
			"FromSerialNumber": "S1-180630",
			"ToSerialNumber": "S1-180632",
			"serialNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"serialAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 8,
		"ItemNumber": "VC110",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"lotSerialItemLots": [
		{
			"LotNumber": "LOT1180609",
			"TransactionQuantity": 3,
			"lotSerialItemSerials": [
			{
				"FromSerialNumber": "S1180659",
				"ToSerialNumber": "S1180661",
				"serialAttributesDFF": [
				{
					"newseg": "abc",
					"__FLEX_Context": "newctx",
					"newctxseg": "a"
				}
				],
				"serialNumbersDFF": [
				{
					"newseg": "abc",
					"__FLEX_Context": "newctx",
					"newctxseg": "a"
				}
				]
			}
			],
			"lotAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"lotNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	}
	]
}

Example Response

Here's an example of the response body in JSON format.

{
	"HeaderInterfaceId": 300100175669363,
	"ASNType": "STD",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-09-25T08:05:15.013+00:00",
	"LastUpdateDate": "2018-09-25T08:05:16.220+00:00",
	"LastUpdatedBy": "WHSE_MGR_M1",
	"ReceiptSourceCode": "VENDOR",
	"TransactionDate": null,
	"ShipmentNumber": null,
	"ReceiptNumber": "33817",
	"ReceiptHeaderId": 2989633,
	"VendorName": "PennyPack Systems",
	"VendorNumber": "1013",
	"VendorId": 21,
	"VendorSiteCode": "FRESNO",
	"VendorSiteId": 1969,
	"BusinessUnitId": 204,
	"BusinessUnit": "Vision Operations",
	"OrganizationCode": "M1",
	"OrganizationId": 207,
	"ShippedDate": null,
	"ExpectedReceiptDate": "2018-09-25",
	"FreightTerms": null,
	"FreightCarrierId": null,
	"FreightCarrierName": null,
	"NumberOfPackingUnits": null,
	"BillOfLading": null,
	"WaybillAirbillNumber": null,
	"PackingSlip": null,
	"PackagingCode": null,
	"SpecialHandlingCode": null,
	"TarWeight": null,
	"TarWeightUOMCode": null,
	"TarWeightUnitOfMeasure": null,
	"NetWeight": null,
	"NetWeightUOMCode": null,
	"NetWeightUnitOfMeasure": null,
	"Comments": null,
	"CustomerPartyName": null,
	"CustomerPartyNumber": null,
	"CustomerId": null,
	"EmployeeName": "Smith, Ms. Pat",
	"EmployeeId": 25,
	"FromOrganizationCode": null,
	"FromOrganizationId": null,
	"RMASourceSystemId": null,
	"RMASourceSystemName": null,
	"GroupId": 163412,
	"ProcessingStatusCode": "SUCCESS",
	"GLDate": "2018-09-25",
	"InvoiceDate": null,
	"InvoiceNumber": null,
	"TotalInvoiceAmount": null,
	"FreightAmount": null,
	"TaxAmount": null,
	"PaymentTermsId": null,
	"PaymentTermsName": null,
	"CurrencyCode": null,
	"InsertAndProcessFlag": "true",
	"ReturnStatus": "SUCCESS",
	"SaveAndSubmitFlag": "false",
	"DFF": [
	{
		"HeaderInterfaceId": 300100175669363,
		"_Global__Segment": null,
		"_zBIADFF1": null,
		"_BI_2DGlob_2DRH": null,
		"newseg": "abc",
		"__FLEX_Context": "newctx",
		"__FLEX_Context_DisplayValue": "newctx",
		"newctxseg": "a",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363",
			"name": "DFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363",
			"name": "DFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
			"name": "receivingReceiptRequests",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363/lov/LVVO___FLEX_Context",
			"name": "LVVO___FLEX_Context",
			"kind": "collection"
		}
		],
	}
	],
	"lines": [
	{},
	{},
	{},
	{}
	],
	"attachments": [
	{
		"AttachedDocumentId": 300100175669365,
		"LastUpdateDate": "2018-09-25T08:05:19.636+00:00",
		"LastUpdatedBy": "WHSE_MGR_M1",
		"DatatypeCode": "FILE",
		"FileName": "headerAttachments.txt",
		"DmFolderPath": null,
		"Url": null,
		"CategoryName": "MISC",
		"UserName": "Miscellaneous",
		"Uri": null,
		"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a23398?XFND_SCHEME_ID=1&XFND_CERT_FP=D84395567668D096754572972566AC6E59C9A9C8&XFND_RANDOM=-8793838422033064660&XFND_EXPIRES=1537863371046&XFND_SIGNATURE=QoLMGC5f-NXzcJTNFO1tpaUCf~7cBYbhOxDx5F~hQ2tZuvAH-WS930BOVyW4xjQk4ABHN14hrV5XQKpzTyDSCa3FhDj6U5tGBbIYesHXpFWLVcrcyjAiqN7llKReTcv-6T1jWjqHvOZi-K-KEMJ7S3esxbN1XtbKRb-EdjaBK76Ybo4bAY-rPAx3MQdHx2d~EC0ciBv6YaU9SsKrgjxLyCnm3xDwepVzWgSwCQJQ-N8x9K62LrmdXbm-wfMlmZGiEX4sFBlSVNMNIpoJywKQuiczF9INBLtNqM0N01CFD4ab9WzLDQmwRAe0vdu0fj-rS915eqe4gA6eO0GssqblaQ__&Id=23398&download",
		"UploadedText": null,
		"UploadedFileContentType": "text/plain",
		"UploadedFileLength": 25,
		"UploadedFileName": "headerAttachments.txt",
		"ContentRepositoryFileShared": "false",
		"Title": "HeaderAttachments.txt",
		"Description": "TEXT UPLOAD from REST",
		"ErrorStatusCode": null,
		"ErrorStatusMessage": null,
		"CreatedBy": "WHSE_MGR_M1",
		"CreationDate": "2018-09-25T08:05:15.044+00:00",
		"ExpirationDate": null,
		"LastUpdatedByUserName": "Sam Smith",
		"CreatedByUserName": "Sam Smith",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874",
			"name": "attachments",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874",
			"name": "attachments",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
			"name": "receivingReceiptRequests",
			"kind": "item"
		},
		{
			"rel": "enclosure",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874/enclosure/FileContents",
			"name": "FileContents",
			"kind": "other"
		}
		],
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
		"name": "receivingReceiptRequests",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
		"name": "receivingReceiptRequests",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/lines",
		"name": "lines",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	],
}

Get One Receipt Request Example URL

Use this resource URL format.

GET

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/HeaderInterfaceId

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583"

Example Response

Here's an example of the response body in JSON format.

{
	"HeaderInterfaceId": 300100169632583,
	"ASNType": "STD",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-11-02T07:11:07.017+00:00",
	"LastUpdateDate": "2018-11-02T07:11:07.693+00:00",
	"LastUpdatedBy": "WHSE_MGR_M1",
	"ReceiptSourceCode": "VENDOR",
	"TransactionDate": null,
	"ShipmentNumber": null,
	"ReceiptNumber": null,
	"ReceiptHeaderId": null,
	"VendorName": "PennyPack Systems",
	"VendorNumber": null,
	"VendorId": null,
	"VendorSiteCode": "FRESNO",
	"VendorSiteId": null,
	"BusinessUnitId": null,
	"BusinessUnit": "Vision Operations",
	"OrganizationCode": "M1",
	"OrganizationId": null,
	"ShippedDate": null,
	"ExpectedReceiptDate": null,
	"FreightTerms": null,
	"FreightCarrierId": null,
	"FreightCarrierName": null,
	"NumberOfPackingUnits": null,
	"BillOfLading": null,
	"WaybillAirbillNumber": null,
	"PackingSlip": null,
	"PackagingCode": null,
	"SpecialHandlingCode": null,
	"TarWeight": null,
	"TarWeightUOMCode": null,
	"TarWeightUnitOfMeasure": null,
	"NetWeight": null,
	"NetWeightUOMCode": null,
	"NetWeightUnitOfMeasure": null,
	"Comments": null,
	"CustomerPartyName": null,
	"CustomerPartyNumber": null,
	"CustomerId": null,
	"EmployeeName": null,
	"EmployeeId": 25,
	"FromOrganizationCode": null,
	"FromOrganizationId": null,
	"RMASourceSystemId": null,
	"RMASourceSystemName": null,
	"GroupId": 164427,
	"ProcessingStatusCode": "PENDING",
	"GLDate": null,
	"InvoiceDate": null,
	"InvoiceNumber": null,
	"TotalInvoiceAmount": null,
	"FreightAmount": null,
	"TaxAmount": null,
	"PaymentTermsId": null,
	"PaymentTermsName": null,
	"CurrencyCode": null,
	"InsertAndProcessFlag": "false",
	"ReturnStatus": null,
	"SaveAndSubmitFlag": "false",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583",
		"name": "receivingReceiptRequests",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583",
		"name": "receivingReceiptRequests",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines",
		"name": "lines",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	]
}

Update One Receipt Request Example URL

Use this resource URL format.

PATCH

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}

Example Request

Here's an example of the request body in JSON format.

{
	"ReceiptSourceCode": "VENDOR",
	"OrganizationCode": "M1",
	"SaveAndSubmitFlag": "false"
}

Example Response

Here's an example of the response body in JSON format.

{
	"HeaderInterfaceId": 45023,
	"ASNType": null,
	"CreatedBy": "0",
	"CreationDate": "2004-03-23T06:03:20+00:00",
	"LastUpdateDate": "2018-09-25T09:02:15+00:00",
	"LastUpdatedBy": "WHSE_MGR_M1",
	"ReceiptSourceCode": "VENDOR",
	"TransactionDate": null,
	"ShipmentNumber": "43657",
	"ReceiptNumber": null,
	"ReceiptHeaderId": 63670,
	"VendorName": "PennyPack Systems",
	"VendorNumber": null,
	"VendorId": null,
	"VendorSiteCode": null,
	"VendorSiteId": null,
	"BusinessUnitId": null,
	"BusinessUnit": null,
	"OrganizationCode": "M1",
	"OrganizationId": 209,
	"ShippedDate": null,
	"ExpectedReceiptDate": "2004-03-24",
	"FreightTerms": null,
	"FreightCarrierId": null,
	"FreightCarrierName": null,
	"NumberOfPackingUnits": null,
	"BillOfLading": null,
	"WaybillAirbillNumber": null,
	"PackingSlip": null,
	"PackagingCode": null,
	"SpecialHandlingCode": null,
	"TarWeight": null,
	"TarWeightUOMCode": null,
	"TarWeightUnitOfMeasure": null,
	"NetWeight": null,
	"NetWeightUOMCode": null,
	"NetWeightUnitOfMeasure": null,
	"Comments": null,
	"CustomerPartyName": null,
	"CustomerPartyNumber": null,
	"CustomerId": null,
	"EmployeeName": null,
	"EmployeeId": 57,
	"FromOrganizationCode": null,
	"FromOrganizationId": null,
	"RMASourceSystemId": null,
	"RMASourceSystemName": null,
	"GroupId": 1,
	"ProcessingStatusCode": "SUCCESS",
	"GLDate": null,
	"InvoiceDate": null,
	"InvoiceNumber": null,
	"TotalInvoiceAmount": null,
	"FreightAmount": null,
	"TaxAmount": null,
	"PaymentTermsId": null,
	"PaymentTermsName": null,
	"CurrencyCode": null,
	"InsertAndProcessFlag": "false",
	"ReturnStatus": null,
	"SaveAndSubmitFlag": "false",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023",
		"name": "receivingReceiptRequests",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023",
		"name": "receivingReceiptRequests",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023/child/lines",
		"name": "lines",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	],
}

Delete One Receipt Request Example URL

Use this resource URL format.

DELETE

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/HeaderInterfaceId

For example, the following command deletes one receipt request with header interface identifier 45023:

curl -u username:password -X DELETE "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/45023"

Manage Receipt Transactions

Let's consider that Amy Scott is a receiving agent who uses the receivingReceiptTransactionRequests resource to communicate requests to inspect, put away, correct, and return received goods and services with Oracle Fusion applications and process these requests.

To communicate and process the receipt transaction requests:

  1. Create a receipt to move the material and for acknowledging services.
  2. Search for the error records.
  3. Make the necessary corrections and resubmit the request that have resulted in errors.
  4. Delete the requests that have resulted in errors.

Create Receipt Transactions Example URL

Use this resource URL format.

POST

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests

Example Request

Here's an example of the request body in JSON format.

{
	"parts": [
	{
		"id": "part1",
		"path": "/receivingReceiptTransactionRequests",
		"operation": "create",
		"payload": {
			"BusinessUnit": "Vision Operations",
			"DestinationTypeCode": "INVENTORY",
			"DocumentLineNumber": 1,
			"DocumentNumber": 1000125,
			"ItemNumber": "RCV-100",
			"EmployeeId": 4426,
			"OrganizationCode": "M1",
			"Quantity": 2,
			"UOMCode": "Ea",
			"UnitOfMeasure": "Each",
			"ReceiptSourceCode": "VENDOR",
			"SoldtoLegalEntity": "Vision Operations",
			"SourceDocumentCode": "PO",
			"TransactionType": "DELIVER",
			"Subinventory": "Stores",
			"ParentTransactionId": 3206432,
			"InsertAndProcessFlag": "false",
			"attachments": [
			{
				"DatatypeCode": "WEB_PAGE",
				"Description": "WEB_PAGE created from REST",
				"CategoryName": "MISC",
				"Title": "Link to example1.com",
				"Url": "https://www.example1.com"
			}
			]
		}
	},
	{
		"id": "part2",
		"path": "/receivingReceiptTransactionRequests",
		"operation": "create",
		"payload": {
			"BusinessUnit": "Vision Operations",
			"DestinationTypeCode": "INVENTORY",
			"DocumentLineNumber": 2,
			"DocumentNumber": 1000125,
			"ItemNumber": "RCV-101",
			"EmployeeId": 4426,
			"OrganizationCode": "M1",
			"Quantity": 2,
			"UOMCode": "Ea",
			"UnitOfMeasure": "Each",
			"ReceiptSourceCode": "VENDOR",
			"SoldtoLegalEntity": "Vision Operations",
			"SourceDocumentCode": "PO",
			"TransactionType": "DELIVER",
			"Subinventory": "Stores",
			"ParentTransactionId": 3206433,
			"lotItemLots": [
			{
				"LotNumber": "KK0927L1",
				"TransactionQuantity": 3,
				"lotNumbersDFF": [
				{
					"newseg": "LND",
					"__FLEX_Context": "newctx",
					"newctxseg": "LNCTX"
				}
				],
				"lotAttributesDFF": [
				{
					"newseg": "KKc",
					"__FLEX_Context": "newctx",
					"newctxseg": "K"
				}
				]
			}
			],
			"attachments": [
			{
				"DatatypeCode": "WEB_PAGE",
				"Description": "WEB_PAGE created from REST",
				"CategoryName": "MISC",
				"Title": "Link to example2.com",
				"Url": "https://www.example2.com"
			}
			],
			"DFF": [
			{
				"newseg": "a",
				"__FLEX_Context": "newctx",
				"newctxseg1": "abc"
			}
			]
		}
	},
	{
		"id": "part3",
		"path": "/receivingReceiptTransactionRequests",
		"operation": "create",
		"payload": {
			"BusinessUnit": "Vision Operations",
			"DestinationTypeCode": "INVENTORY",
			"DocumentLineNumber": 3,
			"DocumentNumber": 1000125,
			"ItemNumber": "RCV-102",
			"EmployeeId": 4426,
			"OrganizationCode": "M1",
			"Quantity": 2,
			"UOMCode": "Ea",
			"UnitOfMeasure": "Each",
			"ReceiptSourceCode": "VENDOR",
			"SoldtoLegalEntity": "Vision Operations",
			"SourceDocumentCode": "PO",
			"TransactionType": "DELIVER",
			"Subinventory": "Stores",
			"ParentTransactionId": 3206434,
			"serialItemSerials": [
			{
				"FromSerialNumber": "S1-1809271",
				"ToSerialNumber": "S1-1809272",
				"serialNumbersDFF": [
				{
					"newseg": "SNDG",
					"__FLEX_Context": "newctx",
					"newctxseg": "SNDC"
				}
				],
				"serialAttributesDFF": [
				{
					"newseg": "SAD",
					"__FLEX_Context": "newctx",
					"newctxseg": "SAC"
				}
				]
			}
			],
			"attachments": [
			{
				"DatatypeCode": "WEB_PAGE",
				"Description": "WEB_PAGE created from REST",
				"CategoryName": "MISC",
				"Title": "Link to example3",
				"Url": "https://example3.com"
			}
			]
		}
	},
	{
		"id": "part4",
		"path": "/receivingReceiptTransactionRequests",
		"operation": "create",
		"payload": {
			"BusinessUnit": "Vision Operations",
			"DestinationTypeCode": "INVENTORY",
			"DocumentLineNumber": 8,
			"DocumentNumber": 1000125,
			"ItemNumber": "VC110",
			"EmployeeId": 4426,
			"OrganizationCode": "M1",
			"Quantity": 2,
			"UOMCode": "Ea",
			"UnitOfMeasure": "Each",
			"ReceiptSourceCode": "VENDOR",
			"SoldtoLegalEntity": "Vision Operations",
			"SourceDocumentCode": "PO",
			"TransactionType": "DELIVER",
			"Subinventory": "Stores",
			"ParentTransactionId": 3206435,
			"lotSerialItemLots":[
			{
				"LotNumber": "LOT180609",
				"TransactionQuantity": 3,
				"lotSerialItemSerials":[
				{
					"FromSerialNumber":"D-180659",
					"ToSerialNumber" :"D-180660",
					"serialNumbersDFF": [
					{
						"newseg": "SNDG",
						"__FLEX_Context": "newctx",
						"newctxseg": "SNDC"
					}
					],
					"serialAttributesDFF": [
					{
						"newseg": "SAD",
						"__FLEX_Context": "newctx",
						"newctxseg": "SAC"
					}
					]
				}
				],
				"lotNumbersDFF": [
				{
					"newseg": "LND",
					"__FLEX_Context": "newctx",
					"newctxseg": "LNCTX"
				}
				],
				"lotAttributesDFF": [
				{
					"newseg": "KKc",
					"__FLEX_Context": "newctx",
					"newctxseg": "K"
				}

				]
			}
			]
		}
	}

	]
}

Example Response

Here's an example of the response body in JSON format.

{
	"parts": [
	{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests",
		"operation": "create",
		"payload": {
			"InterfaceTransactionId": 300100169538362,
			"HeaderInterfaceId": null,
			"CreatedBy": "WHSE_MGR_M1",
			"CreationDate": "2018-11-01T08:42:47.017+00:00",
			"LastUpdateDate": "2018-11-01T08:42:47.885+00:00",
			"LastUpdatedBy": "WHSE_MGR_M1",
			"TransactionType": "DELIVER",
			"AutoTransactCode": null,
			"TransactionDate": "2018-11-01T08:42:47+00:00",
			"OrganizationCode": "M1",
			"OrganizationId": null,
			"ItemDescription": null,
			"ItemId": null,
			"ItemNumber": "RCV-100",
			"ItemRevision": null,
			"ReceiptSourceCode": "VENDOR",
			"SourceDocumentCode": "PO",
			"DocumentNumber": "1000125",
			"DocumentLineNumber": 1,
			"DocumentShipmentLineNumber": null,
			"DocumentDistributionNumber": null,
			"PODistributionId": null,
			"POHeaderId": null,
			"POLineId": null,
			"POLineLocationId": null,
			"ShipmentHeaderId": null,
			"ShipmentLineId": null,
			"ShipmentNumber": null,
			"ASNLineNumber": null,
			"TransferOrderHeaderId": null,
			"TransferOrderLineId": null,
			"TransferOrderDistributionId": null,
			"SoldtoLegalEntity": "Vision Operations",
			"SoldtoLegalEntityId": null,
			"DestinationTypeCode": "INVENTORY",
			"Subinventory": "Stores",
			"Locator": null,
			"LocatorId": null,
			"Quantity": 2,
			"UnitOfMeasure": "Each",
			"UOMCode": "Ea",
			"PrimaryQuantity": null,
			"PrimaryUOMCode": null,
			"PrimaryUnitOfMeasure": null,
			"ProcessingStatusCode": "PENDING",
			"SecondaryUOMCode": null,
			"SecondaryUnitOfMeasure": null,
			"SecondaryQuantity": null,
			"EmployeeId": 4426,
			"EmployeeName": null,
			"ParentTransactionId": 3206432,
			"SourceTransactionNumber": null,
			"ParentSourceTransactionNumber": null,
			"InterfaceSourceCode": "REST",
			"InterfaceSourceLineId": null,
			"ShipToLocationCode": null,
			"ShipToLocationId": null,
			"DeliverToLocationCode": null,
			"DeliverToLocationId": null,
			"DeliverToPersonId": null,
			"DeliverToPersonName": null,
			"RoutingCode": null,
			"RoutingHeaderId": null,
			"InspectionQualityCode": null,
			"Exception": null,
			"RMAReference": null,
			"RMANumber": null,
			"RMALineNumber": null,
			"RMAScheduleNumber": null,
			"ReceiptAdviceHeaderId": null,
			"ReceiptAdviceLineId": null,
			"CustomerId": null,
			"CustomerPartyName": null,
			"CustomerPartyNumber": null,
			"CustomerItemNumber": null,
			"CustomerItemId": null,
			"Amount": null,
			"CountryOfOriginCode": null,
			"CurrencyCode": null,
			"CurrencyConversionDate": null,
			"CurrencyConversionRate": null,
			"FromOrganizationCode": null,
			"FromOrganizationId": null,
			"ContainerNumber": null,
			"SubstituteItemNumber": null,
			"SubstituteItemId": null,
			"SubstituteUnorderedCode": null,
			"VendorName": null,
			"VendorId": null,
			"VendorNumber": null,
			"VendorSiteCode": null,
			"VendorSiteId": null,
			"VendorItemNumber": null,
			"BusinessUnit": "Vision Operations",
			"BusinessUnitId": null,
			"ConsignedLine": null,
			"ReasonId": null,
			"ReasonName": null,
			"PackingSlip": null,
			"Comments": null,
			"FromSubinventory": null,
			"FromLocator": null,
			"FromLocatorId": null,
			"TransactionStatusCode": "PENDING",
			"GroupId": 163459,
			"ExternalSystemPackingUnit": null,
			"DefaultTaxationCountry": null,
			"DocumentFiscalClassification": null,
			"FirstPartyRegistrationId": null,
			"ThirdPartyRegistrationId": null,
			"TransactionBusinessCategory": null,
			"TaxInvoiceNumber": null,
			"TaxInvoiceDate": null,
			"EwayBillNumber": null,
			"EwayBillDate": null,
			"UserDefinedFiscalClassification": null,
			"ProductFiscalClassificationId": null,
			"TaxClassificationCode": null,
			"IntendedUseClassificationId": null,
			"IntendedUse": null,
			"ProductCategory": null,
			"AssessableValue": null,
			"FinalDischargeLocationId": null,
			"ProductType": null,
			"FirstPartyRegistrationNumber": null,
			"ThirdPartyRegistrationNumber": null,
			"ProductFiscalClassName": null,
			"FinalDischargeLocationCode": null,
			"BarcodeLabel": null,
			"TruckNumber": null,
			"InsertAndProcessFlag": "false",
			"ReturnStatus": "SUCCESS",
			"LPNId": null,
			"LicensePlateNumber": null,
			"SaveAndSubmitFlag": "false",
			"CreateDebitMemoFlag": null,
			"PhysicalMaterialReturnRequiredFlag": null,
			"attachments": [
			{
				"AttachedDocumentId": 300100169538364,
				"LastUpdateDate": "2018-11-01T08:42:47.959+00:00",
				"LastUpdatedBy": "WHSE_MGR_M1",
				"DatatypeCode": "WEB_PAGE",
				"FileName": null,
				"DmFolderPath": null,
				"Url": "https://www.example.com",
				"CategoryName": "MISC",
				"UserName": "Miscellaneous",
				"Uri": null,
				"FileUrl": null,
				"UploadedText": null,
				"UploadedFileContentType": null,
				"UploadedFileLength": null,
				"UploadedFileName": null,
				"ContentRepositoryFileShared": "false",
				"Title": "Link to example.com",
				"Description": "WEB_PAGE created from REST",
				"ErrorStatusCode": null,
				"ErrorStatusMessage": null,
				"CreatedBy": "WHSE_MGR_M1",
				"CreationDate": "2018-11-01T08:42:47.051+00:00",
				"ExpirationDate": null,
				"LastUpdatedByUserName": "Sam Smith",
				"CreatedByUserName": "Sam Smith",
				"links": [
				{
					"rel": "self",
					"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B",
					"name": "attachments",
					"kind": "item"
				},
				{
					"rel": "canonical",
					"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B",
					"name": "attachments",
					"kind": "item"
				},
				{
					"rel": "parent",
					"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362",
					"name": "receivingReceiptTransactionRequests",
					"kind": "item"
				},
				{
					"rel": "enclosure",
					"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B/enclosure/FileContents",
					"name": "FileContents",
					"kind": "other"
				}
				],
			}
			],
			"links": [
			{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362",
				"name": "receivingReceiptTransactionRequests",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			},
			{
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362",
				"name": "receivingReceiptTransactionRequests",
				"kind": "item"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/ASNLineDFF",
				"name": "ASNLineDFF",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/serialItemSerials",
				"name": "serialItemSerials",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/processingErrors",
				"name": "processingErrors",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/DFF",
				"name": "DFF",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/lotItemLots",
				"name": "lotItemLots",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/lotSerialItemLots",
				"name": "lotSerialItemLots",
				"kind": "collection"
			},
			{
				"rel": "child",
				"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538362/child/attachments",
				"name": "attachments",
				"kind": "collection"
			}
			],
		}
	}
	]
}

Get One Receipt Transaction Request Example URL

Use this resource URL format.

GET

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/InterfaceTransactionId

For example, the following command gets one receipt transaction request using a finder:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests?finder=findByTransactionAttributes;ProcessingStatusCode=ERROR,GroupId=40380&expand=DFF,attachments,processingErrors,lotItemLots,lotItemLots.lotAttributesDFF,lotItemLots.lotNumbersDFF,serialItemSerials,serialItemSerials.serialAttributesDFF,serialItemSerials.serialNumbersDFF,lotSerialItemLots,lotSerialItemLots.lotAttributesDFF,lotSerialItemLots.lotNumbersDFF,lotSerialItemLots.lotSerialItemSerials,lotSerialItemLots.lotSerialItemSerials.serialAttributesDFF,lotSerialItemLots.lotSerialItemSerials.serialNumbersDFF,transactionAttachments,transactionDFF&onlyData=true"

Example Response

Here's an example of the response body in JSON format.

{
	"items": [
	{
		"InterfaceTransactionId": 100000012481130,
		"HeaderInterfaceId": 100000012481132,
		"CreatedBy": "ALL_FUNCTION_ALL_DATA",
		"CreationDate": "2009-10-08T22:00:33.001+00:00",
		"LastUpdateDate": "2009-10-08T22:11:37.410+00:00",
		"LastUpdatedBy": "ALL_FUNCTION_ALL_DATA",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"TransactionDate": "2009-10-08T22:00:33+00:00",
		"OrganizationCode": null,
		"OrganizationId": 204,
		"ItemDescription": "zBIA_Purchase Item_07",
		"ItemId": 100000012071152,
		"ItemNumber": "zBIA_proc_item_07",
		"ItemRevision": "A",
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"DocumentNumber": "1000256",
		"DocumentLineNumber": 1,
		"DocumentShipmentLineNumber": 1,
		"DocumentDistributionNumber": null,
		"PODistributionId": null,
		"POHeaderId": 100000012303578,
		"POLineId": 100000012303596,
		"POLineLocationId": 100000012303597,
		"ShipmentHeaderId": null,
		"ShipmentLineId": null,
		"ShipmentNumber": null,
		"ASNLineNumber": null,
		"TransferOrderHeaderId": null,
		"TransferOrderLineId": null,
		"TransferOrderDistributionId": null,
		"SoldtoLegalEntity": null,
		"SoldtoLegalEntityId": null,
		"DestinationTypeCode": "RECEIVING",
		"Subinventory": "Stores",
		"Locator": null,
		"LocatorId": null,
		"Quantity": 275,
		"UnitOfMeasure": null,
		"UOMCode": "DZ",
		"PrimaryQuantity": 275,
		"PrimaryUOMCode": "DZ",
		"PrimaryUnitOfMeasure": null,
		"ProcessingStatusCode": "ERROR",
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"SecondaryQuantity": null,
		"EmployeeId": 31,
		"EmployeeName": null,
		"ParentTransactionId": null,
		"SourceTransactionNumber": null,
		"ParentSourceTransactionNumber": null,
		"InterfaceSourceCode": "RCV",
		"InterfaceSourceLineId": null,
		"ShipToLocationCode": null,
		"ShipToLocationId": 204,
		"DeliverToLocationCode": null,
		"DeliverToLocationId": null,
		"DeliverToPersonId": null,
		"DeliverToPersonName": null,
		"RoutingCode": null,
		"RoutingHeaderId": 1,
		"InspectionQualityCode": null,
		"Exception": null,
		"RMAReference": null,
		"RMANumber": null,
		"RMALineNumber": null,
		"RMAScheduleNumber": null,
		"ReceiptAdviceHeaderId": null,
		"ReceiptAdviceLineId": null,
		"CustomerId": null,
		"CustomerPartyName": null,
		"CustomerPartyNumber": null,
		"CustomerItemNumber": null,
		"CustomerItemId": null,
		"Amount": null,
		"CountryOfOriginCode": null,
		"CurrencyCode": "USD",
		"CurrencyConversionDate": null,
		"CurrencyConversionRate": null,
		"FromOrganizationCode": null,
		"FromOrganizationId": null,
		"ContainerNumber": null,
		"SubstituteItemNumber": null,
		"SubstituteItemId": null,
		"SubstituteUnorderedCode": null,
		"VendorName": null,
		"VendorId": 100000011548737,
		"VendorNumber": null,
		"VendorSiteCode": null,
		"VendorSiteId": 100000011548781,
		"VendorItemNumber": null,
		"BusinessUnit": null,
		"BusinessUnitId": 204,
		"ConsignedLine": null,
		"ReasonId": null,
		"ReasonName": null,
		"PackingSlip": null,
		"Comments": null,
		"FromSubinventory": null,
		"FromLocator": null,
		"FromLocatorId": null,
		"TransactionStatusCode": "PENDING",
		"GroupId": 40380,
		"ExternalSystemPackingUnit": null,
		"DefaultTaxationCountry": null,
		"DocumentFiscalClassification": null,
		"FirstPartyRegistrationId": null,
		"ThirdPartyRegistrationId": null,
		"TransactionBusinessCategory": null,
		"TaxInvoiceNumber": null,
		"TaxInvoiceDate": null,
		"EwayBillNumber": null,
		"EwayBillDate": null,
		"UserDefinedFiscalClassification": null,
		"ProductFiscalClassificationId": null,
		"TaxClassificationCode": null,
		"IntendedUseClassificationId": null,
		"IntendedUse": null,
		"ProductCategory": null,
		"AssessableValue": null,
		"FinalDischargeLocationId": null,
		"ProductType": null,
		"FirstPartyRegistrationNumber": null,
		"ThirdPartyRegistrationNumber": null,
		"ProductFiscalClassName": null,
		"FinalDischargeLocationCode": null,
		"BarcodeLabel": null,
		"TruckNumber": null,
		"InsertAndProcessFlag": "false",
		"ReturnStatus": null,
		"LPNId": null,
		"LicensePlateNumber": null,
		"SaveAndSubmitFlag": "false",
		"CreateDebitMemoFlag": null,
		"PhysicalMaterialReturnRequiredFlag": null,
		"serialItemSerials": [],
		"processingErrors": [],
		"DFF": [
		{
			"InterfaceTransactionId": 100000012481130,
			"_Global__Segment": null,
			"_zBIADFF1": null,
			"_BI_2DGlob_2DRT": null,
			"newseg": null,
			"__FLEX_Context": null,
			"__FLEX_Context_DisplayValue": null
		}
		],
		"lotItemLots": [],
		"lotSerialItemLots": [],
		"attachments": []
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests",
		"name": "receivingReceiptTransactionRequests",
		"kind": "collection"
	}
	]
}

Update One Receipt Transaction Request Example URL

Use this resource URL format.

PATCH

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/InterfaceTransactionId

Example Request

Here's an example of the request body in JSON format.

{
	"Quantity" : 10, 
	"SaveAndSubmitFlag" :true
}

Example Response

Here's an example of the response body in JSON format.

{
    "InterfaceTransactionId": 100000012617135,
    "HeaderInterfaceId": 100000012617147,
    "CreatedBy": "ALL_FUNCTION_ALL_DATA",
    "CreationDate": "2009-10-12T23:48:11.945+00:00",
    "LastUpdateDate": "2018-11-01T09:24:24+00:00",
    "LastUpdatedBy": "WHSE_MGR_M1",
    "TransactionType": "RECEIVE",
    "AutoTransactCode": "DELIVER",
    "TransactionDate": "2009-10-12T23:47:40+00:00",
    "OrganizationCode": null,
    "OrganizationId": 207,
    "ItemDescription": "zBIA_Receipt Item_04",
    "ItemId": 100000012071884,
    "ItemNumber": "zBIA_Receipt Item_04",
    "ItemRevision": null,
    "ReceiptSourceCode": "VENDOR",
    "SourceDocumentCode": "PO",
    "DocumentNumber": "1000296",
    "DocumentLineNumber": 1,
    "DocumentShipmentLineNumber": 1,
    "DocumentDistributionNumber": 1,
    "PODistributionId": 100000012628296,
    "POHeaderId": 100000012628287,
    "POLineId": 100000012628294,
    "POLineLocationId": 100000012628295,
    "ShipmentHeaderId": null,
    "ShipmentLineId": null,
    "ShipmentNumber": "Goodway-ship9999",
    "ASNLineNumber": null,
    "TransferOrderHeaderId": null,
    "TransferOrderLineId": null,
    "TransferOrderDistributionId": null,
    "SoldtoLegalEntity": null,
    "SoldtoLegalEntityId": 204,
    "DestinationTypeCode": "INVENTORY",
    "Subinventory": "Stores",
    "Locator": null,
    "LocatorId": 801,
    "Quantity": 10,
    "UnitOfMeasure": null,
    "UOMCode": "Box",
    "PrimaryQuantity": 5,
    "PrimaryUOMCode": "Box",
    "PrimaryUnitOfMeasure": null,
    "ProcessingStatusCode": "ERROR",
    "SecondaryUOMCode": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryQuantity": null,
    "EmployeeId": 100010024202242,
    "EmployeeName": null,
    "ParentTransactionId": null,
    "SourceTransactionNumber": null,
    "ParentSourceTransactionNumber": null,
    "InterfaceSourceCode": "RCV",
    "InterfaceSourceLineId": null,
    "ShipToLocationCode": null,
    "ShipToLocationId": 207,
    "DeliverToLocationCode": null,
    "DeliverToLocationId": 207,
    "DeliverToPersonId": null,
    "DeliverToPersonName": null,
    "RoutingCode": null,
    "RoutingHeaderId": 3,
    "InspectionQualityCode": null,
    "Exception": null,
    "RMAReference": null,
    "RMANumber": null,
    "RMALineNumber": null,
    "RMAScheduleNumber": null,
    "ReceiptAdviceHeaderId": null,
    "ReceiptAdviceLineId": null,
    "CustomerId": null,
    "CustomerPartyName": null,
    "CustomerPartyNumber": null,
    "CustomerItemNumber": null,
    "CustomerItemId": null,
    "Amount": null,
    "CountryOfOriginCode": null,
    "CurrencyCode": "USD",
    "CurrencyConversionDate": null,
    "CurrencyConversionRate": null,
    "FromOrganizationCode": null,
    "FromOrganizationId": null,
    "ContainerNumber": null,
    "SubstituteItemNumber": null,
    "SubstituteItemId": null,
    "SubstituteUnorderedCode": null,
    "VendorName": null,
    "VendorId": 969,
    "VendorNumber": null,
    "VendorSiteCode": null,
    "VendorSiteId": 2198,
    "VendorItemNumber": "Lot item for receipt",
    "BusinessUnit": null,
    "BusinessUnitId": null,
    "ConsignedLine": null,
    "ReasonId": null,
    "ReasonName": null,
    "PackingSlip": "PLS -1023459",
    "Comments": null,
    "FromSubinventory": null,
    "FromLocator": null,
    "FromLocatorId": null,
    "TransactionStatusCode": "PENDING",
    "GroupId": 40574,
    "ExternalSystemPackingUnit": null,
    "DefaultTaxationCountry": null,
    "DocumentFiscalClassification": null,
    "FirstPartyRegistrationId": null,
    "ThirdPartyRegistrationId": null,
    "TransactionBusinessCategory": null,
    "TaxInvoiceNumber": null,
    "TaxInvoiceDate": null,
    "EwayBillNumber": null,
    "EwayBillDate": null,
    "UserDefinedFiscalClassification": null,
    "ProductFiscalClassificationId": null,
    "TaxClassificationCode": null,
    "IntendedUseClassificationId": null,
    "IntendedUse": null,
    "ProductCategory": null,
    "AssessableValue": null,
    "FinalDischargeLocationId": null,
    "ProductType": null,
    "FirstPartyRegistrationNumber": null,
    "ThirdPartyRegistrationNumber": null,
    "ProductFiscalClassName": null,
    "FinalDischargeLocationCode": null,
    "BarcodeLabel": null,
    "TruckNumber": null,
    "InsertAndProcessFlag": "false",
    "ReturnStatus": null,
    "LPNId": null,
    "LicensePlateNumber": null,
    "SaveAndSubmitFlag": "false",
    "CreateDebitMemoFlag": null,
    "PhysicalMaterialReturnRequiredFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135",
            "name": "receivingReceiptTransactionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135",
            "name": "receivingReceiptTransactionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/ASNLineDFF",
            "name": "ASNLineDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/serialItemSerials",
            "name": "serialItemSerials",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/processingErrors",
            "name": "processingErrors",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/lotItemLots",
            "name": "lotItemLots",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/lotSerialItemLots",
            "name": "lotSerialItemLots",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/attachments",
            "name": "attachments",
            "kind": "collection"
        }
    ]
}

Delete One Receipt Transaction Request Example URL

Use this resource URL format.

DELETE

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/InterfaceTransactionId

For example, the following command deletes one receipt transaction request:

curl -u username:password -X DELETE "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135"