Jump to

• Request
• Response

Generate receipt advice lines

post

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

Gets the receipt advice lines that haven't yet been sent to an external application or lines that have been changed since the last time they were sent, marks them as interfaced, and returns a group identifier for those lines to the service caller.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• CarrierId: number
  Value that uniquely identifies the carrier.
• CarrierName: string
  Name of the carrier.
• CustomerId: number
  Value that uniquely identifies the customer.
• CustomerName: string
  Name of the customer.
• DueDateCode: string
  Abbreviation that identifies the criteria for the expected receipt date for the receipt advice line. A list of accepted values is defined in the lookup type RCV_DUE_DATE_OPTION.
• IncludeAllChangedLinesFlag: boolean
  Contains one of the following values: true or false. If true, then interface any changes to previously interfaced purchase orders. If false, then don't interface any changes to previously interfaced purchase orders. The default value is true.
  If you create a purchase order and interface it to the warehouse management system or 3PL provider and you later change the ordered quantity or cancel the purchase order when the attribute value is true, then the change is communicated as an UPDATE or CANCEL action. If the attribute value is false, then the change isn't communicated to the 3PL provider.
• IntransitShipmentHeaderId: number
  Value that uniquely identifies the in-transit shipment header.
• IntransitShipmentLineId: number
  Value that uniquely identifies the in-transit shipment line.
• IntransitShipmentLineNumber: string
  Number that identifies the in-transit shipment line.
• IntransitShipmentNumber: string
  Number that identifies the in-transit shipment.
• ItemId: number
  Value that uniquely identifies the inventory item.
• ItemNumber: string
  Number that identifies the inventory item.
• OrganizationCode: string
  Abbreviation that identifies the inventory organization where the receipt advice will be received.
• OrganizationId: number
  Value that uniquely identifies the inventory organization.
• PurchaseOrderHeaderId: number
  Value that uniquely identifies the purchase order header.
• PurchaseOrderLineId: number
  Value that uniquely identifies the purchase order line.
• PurchaseOrderLineNumber: string
  Number that identifies the purchase order line.
• PurchaseOrderNumber: string
  Number that identifies the purchase order.
• PurchaseOrderScheduleId: number
  Value that uniquely identifies the purchase order schedule.
• PurchaseOrderScheduleNumber: string
  Number that identifies the purchase order schedule.
• ReceivingLocation: string
  Abbreviation that uniquely identifies the physical location in a warehouse where inventory is received.
• ReceivingLocationId: number
  Value that uniquely identifies the receiving location.
• ResendFlag: boolean
  Contains one of the following values: true or false. If true, then send the receipt advice lines for the order whether or not the order was previously interfaced. If false, then don't send the receipt advice lines if the order was previously interfaced. The default value is false.
  Note: If you interface a purchase order to 3PL provider and the purchase order is subsequently canceled when this attribute value is true, the 3PL provider gets the latest definition of the receipt advice lines, which includes the cancellation details.
• RMAHeaderId: number
  Value that uniquely identifies the return material authorization (RMA) receipt advice header.
• RMALineId: number
  Value that uniquely identifies the return material authorization (RMA) receipt advice line.
• RMALineNumber: string
  Number that identifies the return material authorization (RMA) line.
• RMANumber: string
  Number that identifies the return material authorization (RMA).
• SimulationFlag: boolean
  Contains one of the following values: true or false. If true, then the number of receipt advice lines will be returned to the caller without being processed. If false, then the receipt advice lines will be processed, and the new identifier will be returned to the caller along with the number of receipt advice lines. The default value is false.
• SupplierId: number
  Value that uniquely identifies the supplier.
• SupplierName: string
  Name of the supplier.
• SupplierSiteCode: string
  Abbreviation that identifies the supplier site.
• SupplierSiteId: number
  Value that uniquely identifies the supplier site.
• TransferOrderHeaderId: number
  Value that uniquely identifies the transfer order header.
• TransferOrderLineId: number
  Value that uniquely identifies the transfer order line.
• TransferOrderLineNumber: string
  Number that identifies the transfer order line.
• TransferOrderNumber: string
  Number that identifies the transfer order.

{
    "type":"object",
    "properties":{
        "PurchaseOrderScheduleId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true
        },
        "IntransitShipmentHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the in-transit shipment header.",
            "nullable":true
        },
        "RMALineNumber":{
            "type":"string",
            "description":"Number that identifies the return material authorization (RMA) line.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":true
        },
        "ItemId":{
            "type":"number",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true
        },
        "PurchaseOrderHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order header.",
            "nullable":true
        },
        "SupplierSiteCode":{
            "type":"string",
            "description":"Abbreviation that identifies the supplier site.",
            "nullable":true
        },
        "CarrierId":{
            "type":"number",
            "description":"Value that uniquely identifies the carrier.",
            "nullable":true
        },
        "DueDateCode":{
            "type":"string",
            "description":"Abbreviation that identifies the criteria for the expected receipt date for the receipt advice line. A list of accepted values is defined in the lookup type RCV_DUE_DATE_OPTION.",
            "nullable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true
        },
        "SupplierSiteId":{
            "type":"number",
            "description":"Value that uniquely identifies the supplier site.",
            "nullable":true
        },
        "RMAHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the return material authorization (RMA) receipt advice header.",
            "nullable":true
        },
        "RMANumber":{
            "type":"string",
            "description":"Number that identifies the return material authorization (RMA).",
            "nullable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the receipt advice will be received.",
            "nullable":true
        },
        "CustomerName":{
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true
        },
        "PurchaseOrderScheduleNumber":{
            "type":"string",
            "description":"Number that identifies the purchase order schedule.",
            "nullable":true
        },
        "TransferOrderHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the transfer order header.",
            "nullable":true
        },
        "PurchaseOrderLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true
        },
        "PurchaseOrderLineNumber":{
            "type":"string",
            "description":"Number that identifies the purchase order line.",
            "nullable":true
        },
        "TransferOrderLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the transfer order line.",
            "nullable":true
        },
        "CarrierName":{
            "type":"string",
            "description":"Name of the carrier.",
            "nullable":true
        },
        "PurchaseOrderNumber":{
            "type":"string",
            "description":"Number that identifies the purchase order.",
            "nullable":true
        },
        "CustomerId":{
            "type":"number",
            "description":"Value that uniquely identifies the customer.",
            "nullable":true
        },
        "ReceivingLocation":{
            "type":"string",
            "description":"Abbreviation that uniquely identifies the physical location in a warehouse where inventory is received.",
            "nullable":true
        },
        "IntransitShipmentLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the in-transit shipment line.",
            "nullable":true
        },
        "IntransitShipmentLineNumber":{
            "type":"string",
            "description":"Number that identifies the in-transit shipment line.",
            "nullable":true
        },
        "TransferOrderNumber":{
            "type":"string",
            "description":"Number that identifies the transfer order.",
            "nullable":true
        },
        "SupplierId":{
            "type":"number",
            "description":"Value that uniquely identifies the supplier.",
            "nullable":true
        },
        "RMALineId":{
            "type":"number",
            "description":"Value that uniquely identifies the return material authorization (RMA) receipt advice line.",
            "nullable":true
        },
        "IncludeAllChangedLinesFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then interface any changes to previously interfaced purchase orders. If false, then don't interface any changes to previously interfaced purchase orders. The default value is true.<br>If you create a purchase order and interface it to the warehouse management system or 3PL provider and you later change the ordered quantity or cancel the purchase order when the attribute value is true, then the change is communicated as an UPDATE or CANCEL action. If the attribute value is false, then the change isn't communicated to the 3PL provider.",
            "nullable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true
        },
        "ReceivingLocationId":{
            "type":"number",
            "description":"Value that uniquely identifies the receiving location.",
            "nullable":true
        },
        "SimulationFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the number of receipt advice lines will be returned to the caller without being processed. If false, then the receipt advice lines will be processed, and the new identifier will be returned to the caller along with the number of receipt advice lines. The default value is false.",
            "nullable":true
        },
        "IntransitShipmentNumber":{
            "type":"string",
            "description":"Number that identifies the in-transit shipment.",
            "nullable":true
        },
        "ResendFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then send the receipt advice lines for the order whether or not the order was previously interfaced. If false, then don't send the receipt advice lines if the order was previously interfaced. The default value is false.<br>Note: If you interface a purchase order to 3PL provider and the purchase order is subsequently canceled when this attribute value is true, the 3PL provider gets the latest definition of the receipt advice lines, which includes the cancellation details.",
            "nullable":true
        },
        "TransferOrderLineNumber":{
            "type":"string",
            "description":"Number that identifies the transfer order line.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Result of processing the request, which includes the unique identifier the group of receipt advice lines that are marked for generation (External System Group Id), and the number of lines that were updated with this identifier in the current run (Total Receipt Advice Lines Generated).

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"number"
            },
            "description":"Result of processing the request, which includes the unique identifier the group of receipt advice lines that are marked for generation (External System Group Id), and the number of lines that were updated with this identifier in the current run (Total Receipt Advice Lines Generated)."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• number

{
    "type":"object",
    "additionalProperties":{
        "type":"number"
    },
    "description":"Result of processing the request, which includes the unique identifier the group of receipt advice lines that are marked for generation (External System Group Id), and the number of lines that were updated with this identifier in the current run (Total Receipt Advice Lines Generated)."
}

Result of processing the request, which includes the unique identifier the group of receipt advice lines that are marked for generation (External System Group Id), and the number of lines that were updated with this identifier in the current run (Total Receipt Advice Lines Generated).

Back to Top