Create validation
post
/fscmRestApi/resources/11.13.18.05/validateReceiveQuantities
Request
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
ASNLineNumber: string
Line number of the advance shipment notice.
-
DocumentLineNumber: string
Line number for the document.
-
DocumentNumber: string
Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
-
DocumentScheduleNumber: string
Schedule number for the document.
-
ErrorCode: string
Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
-
ErrorExplanation: string
Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
-
FromOrganizationCode: string
Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
-
FromOrganizationId: string
Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.
-
ItemId: integer
Value that uniquely identifies the item.
-
ItemNumber: string
Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
-
POHeaderId: integer
Value that uniquely identifies the purchase order header.
-
POLineId: integer
Value that uniquely identifies the purchase order line.
-
POLineLocationId: integer
Value that uniquely identifies the purchase order schedule.
-
Quantity: string
Quantity recommended to receive.
-
ReceiptAdviceHeaderId: integer
Value that uniquely identifies the receipt advice header.
-
ReceiptAdviceLineId: integer
Value that uniquely identifies receipt advice line.
-
RedwoodFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then navigation to the Validate Receive Quantities REST API is from the Responsive Redwood Self-Service Receiving Application. If false, then navigation to the Validate Receive Quantities REST API isn't from the Responsive Redwood Self-Service Receiving Application. The default value is false. -
ReturnStatus: string
Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
-
SecondaryQuantity: number
Secondary quantity recommended to receive.
-
SecondaryUnitOfMeasure: string
Unit of measure for the secondary quantity recommended to receive.
-
SecondaryUOMCode: string
Abbreviation that identifies the secondary unit of measure.
-
ShipmentHeaderId: integer
Value that uniquely identifies the shipment header.
-
ShipmentLineId: integer
Value that uniquely identifies the shipment line.
-
ShipmentNumber: string
Number that identifies the shipment for an advance shipment notice or transfer order depending on the document type.
-
SoldToLegalEntity: string
Legal entity that is liable for the purchase order amount.
-
SourceDocumentCode: string
Document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
-
SourceSystem: string
Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Oracle Order Management Cloud, the customer of a logistics service, or an order management application that resides outside of Oracle.
-
ToOrganizationCode: string
Abbreviation that identifies the ship-to organization.
-
ToOrganizationId: integer
Value that uniquely identifies the ship-to organization.
-
UnitOfMeasure: string
Unit of measure for the quantity recommended to receive.
-
UOMCode: string
Abbreviation that identifies the unit of measure.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : validateReceiveQuantities-item-response
Type:
Show Source
object
-
ASNLineNumber: string
Line number of the advance shipment notice.
-
AvailableQuantity: number
Read Only:
true
Quantity available to receive. -
DocumentLineNumber: string
Line number for the document.
-
DocumentNumber: string
Document number that identifies one of the following: the purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER.
-
DocumentScheduleNumber: string
Schedule number for the document.
-
ErrorCode: string
Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
-
ErrorExplanation: string
Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
-
FromOrganizationCode: string
Abbreviation that identifies the name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
-
FromOrganizationId: string
Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices.
-
ItemId: integer
Value that uniquely identifies the item.
-
ItemNumber: string
Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POHeaderId: integer
Value that uniquely identifies the purchase order header.
-
POLineId: integer
Value that uniquely identifies the purchase order line.
-
POLineLocationId: integer
Value that uniquely identifies the purchase order schedule.
-
Quantity: string
Quantity recommended to receive.
-
ReceiptAdviceHeaderId: integer
Value that uniquely identifies the receipt advice header.
-
ReceiptAdviceLineId: integer
Value that uniquely identifies receipt advice line.
-
RedwoodFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then navigation to the Validate Receive Quantities REST API is from the Responsive Redwood Self-Service Receiving Application. If false, then navigation to the Validate Receive Quantities REST API isn't from the Responsive Redwood Self-Service Receiving Application. The default value is false. -
ReturnStatus: string
Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
-
SecondaryQuantity: number
Secondary quantity recommended to receive.
-
SecondaryUnitOfMeasure: string
Unit of measure for the secondary quantity recommended to receive.
-
SecondaryUOMCode: string
Abbreviation that identifies the secondary unit of measure.
-
ShipmentHeaderId: integer
Value that uniquely identifies the shipment header.
-
ShipmentLineId: integer
Value that uniquely identifies the shipment line.
-
ShipmentNumber: string
Number that identifies the shipment for an advance shipment notice or transfer order depending on the document type.
-
SoldToLegalEntity: string
Legal entity that is liable for the purchase order amount.
-
SourceDocumentCode: string
Document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
-
SourceSystem: string
Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Oracle Order Management Cloud, the customer of a logistics service, or an order management application that resides outside of Oracle.
-
ToOrganizationCode: string
Abbreviation that identifies the ship-to organization.
-
ToOrganizationId: integer
Value that uniquely identifies the ship-to organization.
-
UnitOfMeasure: string
Unit of measure for the quantity recommended to receive.
-
UOMCode: string
Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to validate receive quantities.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example validates a quantity of 1, in organization M1, for item RCV-100, for source document PO, on line number 1:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/validateReceiveQuantities"
Example Request Body
The following example includes the contents of the request body in JSON format:
{ "ToOrganizationCode" : "M1", "Quantity" : "1", "UOMCode" : "Ea", "ItemNumber" : "RCV-100", "DocumentNumber" : "1000125", "SourceDocumentCode" : "PO", "DocumentLineNumber" : "1", "DocumentScheduleNumber" : "1", "SoldToLegalEntity" : "Vision Operations" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ToOrganizationCode" : "M1", "ToOrganizationId" : 207, "FromOrganizationCode" : null, "FromOrganizationId" : "0", "SourceDocumentCode" : "PO", "ItemNumber" : "RCV-100", "ItemId" : 663907, "Quantity" : "1", "UnitOfMeasure" : null, "UOMCode" : "Ea", "SecondaryQuantity" : null, "SecondaryUnitOfMeasure" : null, "SecondaryUOMCode" : null, "DocumentNumber" : "1000125", "DocumentLineNumber" : "1", "DocumentScheduleNumber" : "1", "POHeaderId" : 100000012026081, "POLineId" : 100000012026085, "POLineLocationId" : 100000012026086, "SoldToLegalEntity" : "Vision Operations", "SourceSystem" : null, "ShipmentNumber" : null, "ASNLineNumber" : null, "ShipmentHeaderId" : 0, "ShipmentLineId" : 0, "ReceiptAdviceHeaderId" : 0, "ReceiptAdviceLineId" : 0, "ReturnStatus" : "SUCCESS", "ErrorCode" : null, "ErrorExplanation" : null }