Jump to

• Request
• Response

Update one delivery

patch

/fscmRestApi/resources/11.13.18.05/receivingReceiptDeliveries/{receivingReceiptDeliveriesUniqID}

Request

Path Parameters

• receivingReceiptDeliveriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Receiving Receipt Deliveries resource and used to uniquely identify an instance of Receiving Receipt Deliveries. The client should not generate the hash key value. Instead, the client should query on the Receiving Receipt Deliveries collection resource in order to navigate to a specific instance of Receiving Receipt Deliveries to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AddToDeliveryCartName: string
  Maximum Length: 80

  Name that uniquely identifies the receiving delivery cart. This should only be used when performing the Add to Delivery Cart action during the Update One Delivery operation.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Comments: string
  Maximum Length: 400

  Comment or message associated with the receipt delivery.
• CopyAttachmentDeliveryId: integer
  Value that uniquely identifies the receipt delivery from which the attachment should be copied to the current delivery.
• DeliveredByPersonId: integer (int64)
  Value that uniquely identifies the person who completed the current receiving receipt delivery.
• DeliveryCartId: integer (int64)
  Value that uniquely identifies the receiving delivery cart.
• DeliveryDate: string (date-time)
  Date on which the receipt delivery was completed.
• DeliveryStatusCode: string
  Maximum Length: 25

  Default Value: OPEN

  Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.
• NonEmployeeReceivedByName: string
  Maximum Length: 2000

  Name of the nonemployee who received the delivery.
• ReceivedByPersonId: integer (int64)
  Value that uniquely identifies the person that has received the current receiving receipt delivery.
• ReceiverSignature: string (byte)
  Image that captures the signature of the recipient of the delivery.
• SubmitFlag: boolean
  Default Value: false

  Value that indicates whether the delivery is being submitted for final closure. Valid values are true and false. The default values is false.
• TaskDuration: integer
  Duration, in seconds, to complete this receipt delivery task.
• TaskEndTime: string (date-time)
  Date and time when the user completed the task for this receipt delivery.
• TaskStartTime: string (date-time)
  Date and time when the user started the task for the current receipt delivery.
• ZoneTaskId: integer (int64)
  Value that uniquely identifies the task assigned to the delivery.

{
    "type":"object",
    "properties":{
        "AddToDeliveryCartName":{
            "maxLength":80,
            "type":"string",
            "description":"Name that uniquely identifies the receiving delivery cart. This should only be used when performing the Add to Delivery Cart action during the Update One Delivery operation.",
            "nullable":true,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptDeliveries-Attachments-item-patch-request"
            }
        },
        "Comments":{
            "maxLength":400,
            "type":"string",
            "description":"Comment or message associated with the receipt delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "CopyAttachmentDeliveryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt delivery from which the attachment should be copied to the current delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveredByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who completed the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeliveryCartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving delivery cart.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeliveryDate":{
            "type":"string",
            "description":"Date on which the receipt delivery was completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveryStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.",
            "nullable":true,
            "default":"OPEN"
        },
        "NonEmployeeReceivedByName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the nonemployee who received the delivery.",
            "nullable":true
        },
        "ReceivedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person that has received the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReceiverSignature":{
            "type":"string",
            "description":"Image that captures the signature of the recipient of the delivery.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SubmitFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the delivery is being submitted for final closure. Valid values are true and false. The default values is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "TaskDuration":{
            "type":"integer",
            "description":"Duration, in seconds, to complete this receipt delivery task.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskEndTime":{
            "type":"string",
            "description":"Date and time when the user completed the task for this receipt delivery.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskStartTime":{
            "type":"string",
            "description":"Date and time when the user started the task for the current receipt delivery.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ZoneTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task assigned to the delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object receivingReceiptDeliveries-Attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptDeliveries-Attachments-item-patch-request"
    }
}

Nested Schema : receivingReceiptDeliveries-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : receivingReceiptDeliveries-item-response

Type: object

Show Source

• AddToDeliveryCartName: string
  Maximum Length: 80

  Name that uniquely identifies the receiving delivery cart. This should only be used when performing the Add to Delivery Cart action during the Update One Delivery operation.
• AdhocDeliveryIndicator: string
  Maximum Length: 1

  Default Value: Y

  Abbreviation that identifies if the current delivery is receipt-based or not. Valid values are Y and N. The default value is N.
• AdhocDeliveryOrganizationCode: string
  Maximum Length: 80

  Abbreviation that uniquely identifies the receiving organization in which the delivery is created. This should only be used when creating a nonreceipt based delivery using the create one delivery operation.
• AdhocDeliveryUOMName: string
  Maximum Length: 80

  Unit of measure for the current nonreceipt-based delivery. This should only be used when creating a nonreceipt based delivery using the REST API.
• AdhocLocationName: string
  Title: Deliver-to Location

  Maximum Length: 60

  Destination for a delivery that's not based on a receipt.
• AdhocReceiverName: string
  Title: Deliver-to Person

  Maximum Length: 2000

  Name of the person specified for a delivery that's not based on a receipt.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Comments: string
  Maximum Length: 400

  Comment or message associated with the receipt delivery.
• CopyAttachmentDeliveryId: integer
  Value that uniquely identifies the receipt delivery from which the attachment should be copied to the current delivery.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• DeliveredByPersonId: integer (int64)
  Value that uniquely identifies the person who completed the current receiving receipt delivery.
• DeliveredByPersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person who completed the current receiving receipt delivery.
• DeliverToLocation: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  Number that uniquely identifies the advance shipment notice.
• DeliverToLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the expense deliver-to location.
• DeliverToPersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the deliver-to person or the requester.
• DeliverToPersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the deliver-to person or the requester.
• DeliveryCartId: integer (int64)
  Value that uniquely identifies the receiving delivery cart.
• DeliveryCartName: string
  Read Only: true

  Maximum Length: 80

  Name that uniquely identifies the receiving delivery cart.
• DeliveryDate: string (date-time)
  Date on which the receipt delivery was completed.
• DeliveryNumber: string
  Maximum Length: 80

  Number that uniquely identifies the receiving receipt delivery.
• DeliveryStatus: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that represents the status of the receiving receipt delivery.
• DeliveryStatusCode: string
  Maximum Length: 25

  Default Value: OPEN

  Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.
• DestinationTypeCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.
• DocumentLineNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the document line number for the current receiving receipt delivery. When the source document code is PO, this attribute is the purchase order line number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment line number.
• DocumentNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the document for the current receiving receipt delivery. When the source document code is PO, this attribute is the purchase order number. When the source document code is TRANSFER ORDER, this attribute is the transfer order number.
• DocumentScheduleNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the purchase order schedule for the current receiving receipt delivery.
• ItemDescription: string
  Maximum Length: 240

  Description of the inventory item for the current delivery.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item for the current delivery.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Name of the inventory item for the current delivery.
• ItemPrimaryImageURL: string
  Title: Primary Image URL

  Read Only: true

  Maximum Length: 4000

  URL for the primary image of the inventory item for the current delivery.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LicensePlateNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the LPN.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Read Only: true

  Maximum Length: 255

  Name of the destination locator for the current receiving receipt delivery.
• LocatorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the destination locator for the current receiving receipt delivery.
• LPNId: integer (int64)
  Read Only: true

  Value that uniquely identifies the LPN.
• NonEmployeeReceivedByName: string
  Maximum Length: 2000

  Name of the nonemployee who received the delivery.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the receiving organization in which the delivery is created.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that the user has selected.
• ParentTransactionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent receiving transaction that created the current receiving receipt delivery.
• PARSubinventoryLocation: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  Name of the location corresponding to the par subinventory.
• PARSubinventoryLocationId: integer (int64)
  Read Only: true

  Unique identifier of the location associated with the destination periodic automatic replenishment (PAR) subinventory.
• PODistributionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order distribution.
• Quantity: number
  Quantity of items received in the delivery.
• ReceiptDeliveryId: integer (int64)
  Value that uniquely identifies the receiving receipt delivery.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt as part of which the current receiving receipt delivery is created.
• ReceivedByName: string
  Read Only: true

  Maximum Length: 255

  Name of the person who received the receipt delivery.
• ReceivedByPersonId: integer (int64)
  Value that uniquely identifies the person that has received the current receiving receipt delivery.
• ReceivedByPersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the employee who received the delivery.
• ReceiverSignature: string (byte)
  Image that captures the signature of the recipient of the delivery.
• RequisitionNumber: string
  Read Only: true

  Maximum Length: 64

  Number that identifies the requisition that the application used to create the purchase order or the transfer order for the current receiving receipt delivery.
• ShipmentHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt header as part of which the current receiving receipt delivery is created.
• ShipmentLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt line as part of which the current receiving receipt delivery is created.
• SourceDocumentCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the source document type for the current receiving receipt delivery. Valid values include PO (purchase order) and TRANSFER ORDER.
• StructureInstanceNumber: integer
  Read Only: true

  A number representing the structure instance of the source locator.
• Subinventory: string
  Read Only: true

  Maximum Length: 10

  Name of the destination subinventory for the current receiving receipt delivery.
• SubinventoryId: integer
  Read Only: true

  Value that uniquely identifies the source subinventory.
• SubinventoryName: string
  Read Only: true

  Maximum Length: 30

  Name of the destination subinventory for the current receiving receipt delivery.
• SubmitFlag: boolean
  Default Value: false

  Value that indicates whether the delivery is being submitted for final closure. Valid values are true and false. The default values is false.
• TaskDuration: integer
  Duration, in seconds, to complete this receipt delivery task.
• TaskEndTime: string (date-time)
  Date and time when the user completed the task for this receipt delivery.
• TaskName: string
  Read Only: true

  Maximum Length: 240

  Name that uniquely identifies the task assigned to the delivery.
• TaskStartTime: string (date-time)
  Date and time when the user started the task for the current receipt delivery.
• ToOrganizationId: integer (int64)
  Value that uniquely identifies the receiving organization in which the delivery is created.
• TrackingNumber: string
  Maximum Length: 30

  Tracking number of the receipt delivery.
• TransferOrderDistributionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order distribution.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the receiving transaction that created the current receiving receipt delivery.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that uniquely identifies the unit of measure for the receiving transaction that created the current receiving receipt delivery.
• ZoneTaskId: integer (int64)
  Value that uniquely identifies the task assigned to the delivery.

{
    "type":"object",
    "properties":{
        "AddToDeliveryCartName":{
            "maxLength":80,
            "type":"string",
            "description":"Name that uniquely identifies the receiving delivery cart. This should only be used when performing the Add to Delivery Cart action during the Update One Delivery operation.",
            "nullable":true,
            "x-queryable":false
        },
        "AdhocDeliveryIndicator":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that identifies if the current delivery is receipt-based or not. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "AdhocDeliveryOrganizationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the receiving organization in which the delivery is created. This should only be used when creating a nonreceipt based delivery using the create one delivery operation.",
            "nullable":true,
            "x-queryable":false
        },
        "AdhocDeliveryUOMName":{
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure for the current nonreceipt-based delivery. This should only be used when creating a nonreceipt based delivery using the REST API.",
            "nullable":true,
            "x-queryable":false
        },
        "AdhocLocationName":{
            "title":"Deliver-to Location",
            "maxLength":60,
            "type":"string",
            "description":"Destination for a delivery that's not based on a receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "AdhocReceiverName":{
            "title":"Deliver-to Person",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the person specified for a delivery that's not based on a receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptDeliveries-Attachments-item-response"
            }
        },
        "Comments":{
            "maxLength":400,
            "type":"string",
            "description":"Comment or message associated with the receipt delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "CopyAttachmentDeliveryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt delivery from which the attachment should be copied to the current delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliverToLocation":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Number that uniquely identifies the advance shipment notice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the expense deliver-to location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliverToPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the deliver-to person or the requester.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliverToPersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the deliver-to person or the requester.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveredByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who completed the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliveredByPersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who completed the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryCartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving delivery cart.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliveryCartName":{
            "maxLength":80,
            "type":"string",
            "description":"Name that uniquely identifies the receiving delivery cart.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryDate":{
            "type":"string",
            "description":"Date on which the receipt delivery was completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveryNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the receiving receipt delivery.",
            "nullable":false,
            "x-queryable":true
        },
        "DeliveryStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that represents the status of the receiving receipt delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.",
            "nullable":true,
            "default":"OPEN",
            "x-queryable":true
        },
        "DestinationTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the destination for the receiving receipt delivery. The value INVENTORY means that the delivery is for a par location. The value EXPENSE means that the delivery is intended for an expense location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the document line number for the current receiving receipt delivery. When the source document code is PO, this attribute is the purchase order line number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment line number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the document for the current receiving receipt delivery. When the source document code is PO, this attribute is the purchase order number. When the source document code is TRANSFER ORDER, this attribute is the transfer order number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentScheduleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the purchase order schedule for the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the inventory item for the current delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item for the current delivery.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item for the current delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemPrimaryImageURL":{
            "title":"Primary Image URL",
            "maxLength":4000,
            "type":"string",
            "description":"URL for the primary image of the inventory item for the current delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LicensePlateNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the LPN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the destination locator for the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"locatorCombinationsLOV",
                "FND_ACFF_ResourceName":"receivingReceiptDeliveries",
                "ojStructureInstanceNumber":"StructureInstanceNumber"
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination locator for the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NonEmployeeReceivedByName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the nonemployee who received the delivery.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the receiving organization in which the delivery is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that the user has selected.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PARSubinventoryLocation":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Name of the location corresponding to the par subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PARSubinventoryLocationId":{
            "type":"integer",
            "description":"Unique identifier of the location associated with the destination periodic automatic replenishment (PAR) subinventory.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PODistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent receiving transaction that created the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of items received in the delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceiptDeliveryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving receipt delivery.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt as part of which the current receiving receipt delivery is created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedByName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who received the receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedByPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person that has received the current receiving receipt delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceivedByPersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the employee who received the delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiverSignature":{
            "type":"string",
            "description":"Image that captures the signature of the recipient of the delivery.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RequisitionNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Number that identifies the requisition that the application used to create the purchase order or the transfer order for the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt header as part of which the current receiving receipt delivery is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt line as part of which the current receiving receipt delivery is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the source document type for the current receiving receipt delivery. Valid values include PO (purchase order) and TRANSFER ORDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StructureInstanceNumber":{
            "type":"integer",
            "description":"A number representing the structure instance of the source locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the destination subinventory for the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubinventoryName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the destination subinventory for the current receiving receipt delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the delivery is being submitted for final closure. Valid values are true and false. The default values is false.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "TaskDuration":{
            "type":"integer",
            "description":"Duration, in seconds, to complete this receipt delivery task.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskEndTime":{
            "type":"string",
            "description":"Date and time when the user completed the task for this receipt delivery.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskName":{
            "maxLength":240,
            "type":"string",
            "description":"Name that uniquely identifies the task assigned to the delivery.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStartTime":{
            "type":"string",
            "description":"Date and time when the user started the task for the current receipt delivery.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving organization in which the delivery is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrackingNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Tracking number of the receipt delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferOrderDistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the unit of measure for the receiving transaction that created the current receiving receipt delivery.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the receiving transaction that created the current receiving receipt delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "ZoneTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task assigned to the delivery.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object receivingReceiptDeliveries-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptDeliveries-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : receivingReceiptDeliveries-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/receivingReceiptDeliveries/{receivingReceiptDeliveriesUniqID}/child/Attachments

Parameters:

• receivingReceiptDeliveriesUniqID: $request.path.receivingReceiptDeliveriesUniqID

The attachments resource is used to view, create, and update attachments.

Back to Top