Update one return
patch
/fscmRestApi/resources/11.13.18.05/receivingReturns/{ReturnHeaderId}
Request
Path Parameters
-
ReturnHeaderId(required): integer(int64)
Value that uniquely identifies the return header.
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
-
Description: string
Title:
Description
Maximum Length:240
Description of the return. -
lines: array
Lines
Title:
Lines
Supplier return lines associated with a supplier return. -
OneTimeShipToLocation: string
Title:
One-Time Ship-to Location
Maximum Length:4000
One time ship-to address for the return. For example, in case of recall management, user may want to ship it back to the manufacturer instead of the supplier. -
SubmitFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then all the return lines are submitted for processing and the status is moved to fulfilled or pending fulfillment. If false, then all the lines remain in an incomplete status. The default value is false.
Nested Schema : Lines
Type:
array
Title:
Lines
Supplier return lines associated with a supplier return.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:2000
Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
AssessableValue: number
Assessable value of the transaction for taxation purposes. If blank, then the default value from the parent transaction is used.
-
Comments: string
Title:
Comments
Maximum Length:240
Comments entered by the user. -
ConsignedItemFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the item is consigned. If false, then the item isn't consigned. The default value is false. -
CreateDebitMemoFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then a debit memo will automatically be created. If false, then debit memo won't be automatically created. The default value is false. -
DefaultTaxationCountryCode: string
Maximum Length:
2
Abbreviation that identifies the default taxation country. If blank, the default value from the parent transaction is used. -
DocumentFiscalClassificationCode: string
Maximum Length:
240
Abbreviation that identifies the fiscal classification for the document. If blank, then the default value from the parent transaction is used. -
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies the final discharge location. If blank, then the default value from the parent transaction is used.
-
FirstPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the first party registration. If blank, then the default value from the parent transaction is used.
-
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the intended use classification. If blank, then the default value from the parent transaction is used.
-
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source of the return line. -
inventoryAttributesDFF: array
Inventory Attributes Descriptive Flexfields
Title:
Inventory Attributes Descriptive Flexfields
The descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
lineAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
Locator: string
Title:
Locator
Maximum Length:2000
Name of the locator where the item is located. -
LocatorId: integer
(int64)
Title:
Locator ID
Value that uniquely identifies the locator where the item is located. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
Manufacturer parts associated with a return line. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return Required
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then physical return of the material is required. If false, then physical return of the material isn't required. The default value is true. -
ProductCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the product category. If blank, then the default value from the parent transaction is used. -
ProductFiscalClassificationId: integer
(int64)
Value that uniquely identifies the product fiscal classification. If blank, then the default value from the parent transaction is used.
-
ProductTypeCode: string
Maximum Length:
240
Abbreviation that identifies the product type for taxation purposes. If blank, then the default value from the parent transaction is used. -
Reason: string
Title:
Reason
Maximum Length:30
Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason ID
Value that uniquely identifies the inventory transaction reason. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute is associated with a feature that requires opt in.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the recall notice line. This attribute is associated with a feature that requires opt in.
-
RecallNoticeLineNumber: integer
(int64)
Title:
Recall Notice Line Number
Number that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall Notice
Maximum Length:60
Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
referencedDFF: array
Referenced Line Descriptive Flexfields
Title:
Referenced Line Descriptive Flexfields
The additional details about referenced return lines. -
RequestedDate: string
(date-time)
Title:
Requested Date
Date when the user requested the return line to be shipped. -
RequestedQuantity: number
Title:
Requested Quantity
Quantity to be returned. -
ReturnedById: integer
(int64)
Title:
Returned By
Value that uniquely identifies the person who created the return line. -
ReturnedByName: string
Title:
Returned By
Maximum Length:240
Name of the person who created the return line. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested Quantity
Quantity to be returned in the secondary unit of measure of the item. -
serials: array
Serial Numbers
Title:
Serial Numbers
The serial numbers associated with a return line. -
ShipFromLocationId: integer
(int64)
Value that uniquely identifies the ship-from location for the return line. If blank, then the default value from the parent transaction is used.
-
Subinventory: string
Maximum Length:
10
Name of the subinventory where the item is located. -
SupplierItemNumber: string
Title:
Supplier Item
Maximum Length:300
Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierRMANumber: string
Title:
RMA
Maximum Length:30
Number that identifies the supplier return material authorization (RMA) reference. -
TaxClassificationCode: string
Maximum Length:
50
Abbreviation that identifies the tax classification. If blank, then the default value from the parent transaction is used. -
TaxInvoiceDate: string
(date)
Date when the tax invoice was created. If blank, then the default value from the parent transaction is used.
-
TaxInvoiceNumber: string
Maximum Length:
150
Number of the tax invoice. If blank, then the default value from the parent transaction is used. -
ThirdPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the third party registration. If blank, then the default value from the parent transaction is used.
-
TransactionBusinessCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the business category of the transaction. If blank, the default value from the parent transaction is used. -
UnitOfMeasure: string
Title:
UOM Name
Maximum Length:25
Unit of measure used for the return line. -
unreferencedDFF: array
Unreferenced Line Descriptive Flexfields
Title:
Unreferenced Line Descriptive Flexfields
The additional details about unreferenced return lines. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure used for the return line. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30
Abbreviation that identifies the fiscal classification defined by the user. If blank, then the default value from the parent transaction is used.
Nested Schema : Inventory Attributes Descriptive Flexfields
Type:
array
Title:
Inventory Attributes Descriptive Flexfields
The descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
Manufacturer parts associated with a return line.
Show Source
Nested Schema : Referenced Line Descriptive Flexfields
Type:
array
Title:
Referenced Line Descriptive Flexfields
The additional details about referenced return lines.
Show Source
Nested Schema : Serial Numbers
Type:
array
Title:
Serial Numbers
The serial numbers associated with a return line.
Show Source
Nested Schema : Unreferenced Line Descriptive Flexfields
Type:
array
Title:
Unreferenced Line Descriptive Flexfields
The additional details about unreferenced return lines.
Show Source
Nested Schema : receivingReturns-lines-inventoryAttributesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the project. This attribute is associated with a feature that requires opt in. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line. This attribute is associated with a feature that requires opt in.
-
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : receivingReturns-lines-lineAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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.
Nested Schema : receivingReturns-lines-manufacturerParts-item-patch-request
Type:
Show Source
object
Nested Schema : receivingReturns-lines-referencedDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for referenced return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for referenced return lines. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line.
Nested Schema : receivingReturns-lines-serials-item-patch-request
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
ToSerialNumber: string
Maximum Length:
80
Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Nested Schema : receivingReturns-lines-unreferencedDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for unreferenced return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for unreferenced return lines. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line.
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 : receivingReturns-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the return. -
CreationDate: string
(date-time)
Read Only:
true
Date when the return was created. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerName: string
Title:
Customer
Maximum Length:360
Name of the customer. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site.
-
CustomerSiteNumber: string
Title:
Customer Site
Maximum Length:30
Number that identifies the customer site. -
Description: string
Title:
Description
Maximum Length:240
Description of the return. -
ErrorMessage: string
Read Only:
true
Text of the error message, in case of any errors during processing. -
ErrorMessageName: string
Read Only:
true
Name of the error message, in case of any errors during processing. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the return was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the return. -
lines: array
Lines
Title:
Lines
Supplier return lines associated with a supplier return. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OneTimeShipToLocation: string
Title:
One-Time Ship-to Location
Maximum Length:4000
One time ship-to address for the return. For example, in case of recall management, user may want to ship it back to the manufacturer instead of the supplier. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Title:
Organization ID
Value that uniquely identifies the inventory organization. -
ReturnHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the return header. -
ReturnNumber: string
Title:
Supplier Return Number
Read Only:true
Maximum Length:50
Number that identifies the return. -
ReturnStatus: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the return. A list of accepted values is defined in the lookup ORA_RCV_SUPP_RET_LINE_STATUS. -
ReturnStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:INCOMPLETE
Abbreviation the identifies the status of the return. A list of accepted values is defined in the lookup ORA_RCV_SUPP_RET_LINE_STATUS. -
ReturnType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of return. A list of accepted values is defined in the lookup ORA_RCV_RETURN_TYPE_CODE. -
ReturnTypeCode: string
Maximum Length:
30
Default Value:UNREFERENCED
Abbreviation that identifies the return type. A list of accepted values is defined in the lookup ORA_RCV_RETURN_TYPE_CODE. -
SourceOrganizationCode: string
Title:
Source Organization
Maximum Length:18
Abbreviation that identifies the source organization for a transfer order. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for a transfer order.
-
SubmissionDate: string
(date)
Read Only:
true
Date when the return was submitted. -
SubmitFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then all the return lines are submitted for processing and the status is moved to fulfilled or pending fulfillment. If false, then all the lines remain in an incomplete status. The default value is false. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier. -
SupplierName: string
Title:
Supplier
Maximum Length:360
Name of the supplier. -
SupplierSiteCode: string
Title:
Supplier Site
Maximum Length:240
Abbreviation that identifies the supplier site. -
SupplierSiteCreateDebitMemoFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the supplier site creates a debit memo from the return transaction. If false, then the supplier site doesn't create this memo. The default value is false. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site ID
Value that uniquely identifies the supplier site.
Nested Schema : Lines
Type:
array
Title:
Lines
Supplier return lines associated with a supplier return.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReturns-lines-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:2000
Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
AssessableValue: number
Assessable value of the transaction for taxation purposes. If blank, then the default value from the parent transaction is used.
-
CanceledQuantity: number
Read Only:
true
Quantity that is canceled. -
Comments: string
Title:
Comments
Maximum Length:240
Comments entered by the user. -
ConsignedItemFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the item is consigned. If false, then the item isn't consigned. The default value is false. -
ConsumedQuantity: number
Read Only:
true
Quantity of the parent transaction consumed by the supplier consigned inventory. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the return line. -
CreateDebitMemoFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then a debit memo will automatically be created. If false, then debit memo won't be automatically created. The default value is false. -
CreationDate: string
(date-time)
Read Only:
true
Date when the return line was created. -
DefaultTaxationCountryCode: string
Maximum Length:
2
Abbreviation that identifies the default taxation country. If blank, the default value from the parent transaction is used. -
DestinationType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Destination type for the material on the parent transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DestinationTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the destination type for the material on the parent transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DirectTransferOrderFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the line belongs to a transfer order that has been shipped directly from source to destination locations. If false, then the line does not belong to a transfer order that has been shipped directly from source to destination locations. The default value is false. -
DocumentFiscalClassificationCode: string
Maximum Length:
240
Abbreviation that identifies the fiscal classification for the document. If blank, then the default value from the parent transaction is used. -
ErrorMessage: string
Title:
Error Message
Read Only:true
Maximum Length:1000
Text of the error message, in case of any errors during processing. -
ErrorMessageName: string
Read Only:
true
Maximum Length:240
Name of the error message, in case of any errors during processing. -
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies the final discharge location. If blank, then the default value from the parent transaction is used.
-
FirstPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the first party registration. If blank, then the default value from the parent transaction is used.
-
FulfilledQuantity: number
Read Only:
true
Quantity that is fulfilled. -
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the intended use classification. If blank, then the default value from the parent transaction is used.
-
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source of the return line. -
inventoryAttributesDFF: array
Inventory Attributes Descriptive Flexfields
Title:
Inventory Attributes Descriptive Flexfields
The descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemDualUOMDeviationHigh: number
Title:
Positive Deviation Factor
Read Only:true
Deviation allowed on the higher side for a transaction on the secondary quantity derived from the default conversion factor. -
ItemDualUOMDeviationLow: number
Title:
Negative Deviation Factor
Read Only:true
Deviation allowed on the lower side for a transaction on the secondary quantity derived from the default conversion factor. -
ItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the inventory item. -
ItemLocatorControlCode: number
Read Only:
true
Value that indicates the physical area within a subinventory where you store material, such as a row, aisle, bin, or shelf. A list of accepted values is defined in the lookup type EGP_LOCATOR_CONTROL_CODE_TYPE. -
ItemLotControlCode: number
Read Only:
true
Value that indicates the ability to use lot numbers during material transactions for tracking batches of the item in the receiving organization. A list of accepted values is defined in the lookup EGP_LOT_CONTROL_CODE_TYPE. -
ItemLotStatusEnabledFlag: boolean
Read Only:
true
Maximum Length:255
Value that indicates if this item is controlled by the material status at the lot level. Valid values are Y (the material status is specified for all lots for this item) and N (lots for this item are not status-controlled). -
ItemNumber: string
Maximum Length:
300
Number that identifies the inventory item. -
ItemRevision: string
Maximum Length:
18
Revision of the item. -
ItemRevisionControlCode: number
Read Only:
true
Value that indicates if the item is under revision control. Valid values are 1 (not under revision control) and 2 (revision is mandatory when transacting this item). -
ItemSecondaryDefaultIndicator: string
Title:
Defaulting Control
Read Only:true
Maximum Length:30
Value that indicates how the conversion between primary and secondary units of measure is handled. Valid values are Default (D), Fixed (F), and No Default (N). -
ItemSerialNumberControlCode: number
Read Only:
true
Value that identifies the number assigned to each unit of an item and is used to track the item in the receiving organization. A list of accepted values is defined in the lookup EGP_SERIAL_NUMBER_CONTROL_TYPE. -
ItemSerialStatusEnabledFlag: boolean
Read Only:
true
Maximum Length:255
Value that indicates if this item is controlled by the material status at the serial-number level. Valid values are Y (the material status is specified for all the serial numbers for this item) and N (serial numbers for this item are not status-controlled). -
ItemTrackingQuantityIndicator: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the unit of measure (UOM) that tracks the on-hand stock for the item. Valid values are P (tracks on-hand stock only in the primary UOM) and PS (tracks on-hand stock in both primary and secondary UOMs). -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the return line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the return line. -
lineAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
LineStatus: string
Title:
Line Status
Read Only:true
Maximum Length:80
Status of the return line. A list of accepted values is defined in the lookup ORA_RCV_SUPP_RET_LINE_STATUS. -
LineStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:INCOMPLETE
Abbreviation that identifies the status of the return line. A list of accepted values is defined in the lookup ORA_RCV_SUPP_RET_LINE_STATUS. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Title:
Locator
Maximum Length:2000
Name of the locator where the item is located. -
LocatorId: integer
(int64)
Title:
Locator ID
Value that uniquely identifies the locator where the item is located. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
Manufacturer parts associated with a return line. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Title:
Organization ID
Read Only:true
Value that uniquely identifies the inventory organization. -
ParentLineStatus: string
Read Only:
true
Maximum Length:80
Status of the parent line. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute. -
ParentTransactionId: integer
(int64)
Value that uniquely identifies the parent receiving transaction. This attribute is mandatory when creating a referenced return line.
-
ParentTransactionTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the parent transaction type. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return Required
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then physical return of the material is required. If false, then physical return of the material isn't required. The default value is true. -
PODistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order distribution. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
POLineNumber: number
Title:
Line
Read Only:true
Number that identifies the purchase order line. -
PONumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that identifies the purchase order header. -
POScheduleNumber: number
Title:
Schedule
Read Only:true
Number that identifies the purchase order schedule. -
PrimaryRequestedQuantity: number
Read Only:
true
Quantity to be returned in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Title:
Primary UOM
Read Only:true
Maximum Length:25
Primary unit of measure of the item. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure of the item. -
ProductCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the product category. If blank, then the default value from the parent transaction is used. -
ProductFiscalClassificationId: integer
(int64)
Value that uniquely identifies the product fiscal classification. If blank, then the default value from the parent transaction is used.
-
ProductTypeCode: string
Maximum Length:
240
Abbreviation that identifies the product type for taxation purposes. If blank, then the default value from the parent transaction is used. -
Reason: string
Title:
Reason
Maximum Length:30
Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason ID
Value that uniquely identifies the inventory transaction reason. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute is associated with a feature that requires opt in.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the recall notice line. This attribute is associated with a feature that requires opt in.
-
RecallNoticeLineNumber: integer
(int64)
Title:
Recall Notice Line Number
Number that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall Notice
Maximum Length:60
Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
ReceiptAdviceHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice header. -
ReceiptAdviceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice line. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the receipt of the shipment in the warehouse. -
referencedDFF: array
Referenced Line Descriptive Flexfields
Title:
Referenced Line Descriptive Flexfields
The additional details about referenced return lines. -
RequestedDate: string
(date-time)
Title:
Requested Date
Date when the user requested the return line to be shipped. -
RequestedQuantity: number
Title:
Requested Quantity
Quantity to be returned. -
ReturnedById: integer
(int64)
Title:
Returned By
Value that uniquely identifies the person who created the return line. -
ReturnedByName: string
Title:
Returned By
Maximum Length:240
Name of the person who created the return line. -
ReturnLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the return line. -
ReturnLineNumber: integer
(int64)
Title:
Line
Read Only:true
Number that identifies the return line. -
RMALineNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the return material authorization line. -
RMANumber: string
Read Only:
true
Maximum Length:80
Number that identifies the return material authorization header. -
SecondaryCanceledQuantity: number
Read Only:
true
Quantity that is canceled in the secondary unit of measure of the item. -
SecondaryFulfilledQuantity: number
Read Only:
true
Quantity that is fulfilled in the secondary unit of measure of the item. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested Quantity
Quantity to be returned in the secondary unit of measure of the item. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Maximum Length:25
Secondary unit of measure of the item. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure of the item. -
serials: array
Serial Numbers
Title:
Serial Numbers
The serial numbers associated with a return line. -
ShipFromLocationId: integer
(int64)
Value that uniquely identifies the ship-from location for the return line. If blank, then the default value from the parent transaction is used.
-
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the shipment header. -
Subinventory: string
Maximum Length:
10
Name of the subinventory where the item is located. -
SubinventoryQuantityTrackedCode: integer
(int32)
Title:
Quantity tracked
Read Only:true
Abbreviation that determines whether or not the warehouse tracks the on-hand quantity for the item in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse tracks the on-hand quantity for the item in the subinventory. If 2, then the warehouse does not track the on-hand quantity for the item in the subinventory. The default value is 1. -
SupplierItemNumber: string
Title:
Supplier Item
Maximum Length:300
Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierRMANumber: string
Title:
RMA
Maximum Length:30
Number that identifies the supplier return material authorization (RMA) reference. -
TaxClassificationCode: string
Maximum Length:
50
Abbreviation that identifies the tax classification. If blank, then the default value from the parent transaction is used. -
TaxInvoiceDate: string
(date)
Date when the tax invoice was created. If blank, then the default value from the parent transaction is used.
-
TaxInvoiceNumber: string
Maximum Length:
150
Number of the tax invoice. If blank, then the default value from the parent transaction is used. -
ThirdPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the third party registration. If blank, then the default value from the parent transaction is used.
-
TransactionBusinessCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the business category of the transaction. If blank, the default value from the parent transaction is used. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving transaction. -
TransferOrderDistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order distribution. -
TransferOrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order header. -
TransferOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order line. -
TransferOrderLineNumber: integer
(int32)
Title:
Transfer Order Line
Read Only:true
Number that identifies the transfer order line. -
TransferOrderNumber: string
Title:
Transfer Order
Read Only:true
Maximum Length:50
Number that identifies the transfer order header. -
UnitOfMeasure: string
Title:
UOM Name
Maximum Length:25
Unit of measure used for the return line. -
unreferencedDFF: array
Unreferenced Line Descriptive Flexfields
Title:
Unreferenced Line Descriptive Flexfields
The additional details about unreferenced return lines. -
UOMClass: string
Title:
UOM Class
Read Only:true
Maximum Length:10
Class that categorizes the unit of measure. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure used for the return line. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30
Abbreviation that identifies the fiscal classification defined by the user. If blank, then the default value from the parent transaction is used.
Nested Schema : Inventory Attributes Descriptive Flexfields
Type:
array
Title:
Inventory Attributes Descriptive Flexfields
The descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
Manufacturer parts associated with a return line.
Show Source
Nested Schema : Referenced Line Descriptive Flexfields
Type:
array
Title:
Referenced Line Descriptive Flexfields
The additional details about referenced return lines.
Show Source
Nested Schema : Serial Numbers
Type:
array
Title:
Serial Numbers
The serial numbers associated with a return line.
Show Source
Nested Schema : Unreferenced Line Descriptive Flexfields
Type:
array
Title:
Unreferenced Line Descriptive Flexfields
The additional details about unreferenced return lines.
Show Source
Nested Schema : receivingReturns-lines-inventoryAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the project. This attribute is associated with a feature that requires opt in. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line. This attribute is associated with a feature that requires opt in.
-
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
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.
Nested Schema : receivingReturns-lines-lineAttachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReturns-lines-manufacturerParts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Read Only:
true
Maximum Length:360
Name of the manufacturer. -
ManufacturerPartNumber: string
Read Only:
true
Maximum Length:150
Number issued by the manufacturer that uniquely identifies the individual product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReturns-lines-referencedDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for referenced return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for referenced return lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReturns-lines-serials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToSerialNumber: string
Maximum Length:
80
Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReturns-lines-unreferencedDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for unreferenced return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for unreferenced return lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the return line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- lines
-
Parameters:
- ReturnHeaderId:
$request.path.ReturnHeaderId
Supplier return lines associated with a supplier return. - ReturnHeaderId: