Update one receipt transaction request
patch
/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/{InterfaceTransactionId}
Request
Path Parameters
-
InterfaceTransactionId(required): integer(int64)
Value that uniquely identifies the interfaced receipt transaction line request.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Amount: number
Receipt amount in the purchase order currency. This attribute is mandatory when creating receipt for a fixed price service purchase order line.
-
ASNLineDFF: array
ASNLineDFF
-
ASNLineNumber: integer
(int64)
Number that identifies the line on the advance shipment notice. Either this attribute or ShipmentLineId must be provided when receiving an advanced shipment notice (ASN).
-
AssessableValue: number
Assessable value of the transaction for taxation purposes. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages attachments when creating a post receipt transaction. The attachments uploaded as part of this correspond to the entity name Receiving Transactions. -
AutoTransactCode: string
Maximum Length:
25
This attribute is not applicable and should be left blank. -
BarcodeLabel: string
Maximum Length:
35
Label of the barcode on the product. This attribute is not currently used. -
BusinessUnit: string
Maximum Length:
240
Name of the business unit. This attribute can be blank for this resource and is derived from the parent transaction. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit. This attribute can be blank for this resource and is derived from the parent transaction.
-
Comments: string
Maximum Length:
240
Text that the used entered when receiving the item. -
ConsignedLine: string
Maximum Length:
1
Value that indicates whether or not the receiving transaction is for consigned material. If this attribute is blank, the value is derived from the parent transaction. Enter N if returning an owned (once consigned) material. Else, leave this attribute blank. -
ContainerNumber: string
Maximum Length:
35
Container number. This attribute is not currently used. -
CountryOfOriginCode: string
Maximum Length:
2
Abbreviation that identifies the country of manufacture for this item. This attribute can be blank for this resource. -
CreateDebitMemoFlag: boolean
Contains one of the following values: true or false. If true, then the supplier site of the purchase order is setup to create a debit memo and the receipt (for which return is performed) has a corresponding evaluated receipt settlement (ERS) invoice. If false, then the supplier site of the purchase order is not setup for creating debit memo. The default value is false. This attribute determines whether to create the debit memo. This attribute is applicable only when transaction type is RETURN TO VENDOR.
-
CurrencyCode: string
Maximum Length:
15
Receipt amount in the purchase order currency. This attribute is mandatory when creating receipt for a fixed price service purchase order line. -
CurrencyConversionDate: string
(date)
Date when the currency conversion occurred for the receipt. Use this attribute only for a purchase order receipt where the option on the purchase order schedule is Receipt and the order currency is different from the ledger currency of the receiving organization.
-
CurrencyConversionRate: number
Currency conversion rate for the receipt. Use this attribute only for a purchase order receipt where the option on the purchase order schedule is Receipt, the order currency is different from the ledger currency of the receiving organization, and the rate type on the purchase order is User.
-
CustomerId: integer
(int64)
Value that uniquely identifies the customer. This attribute can be blank and the value is derived from the parent transaction.
-
CustomerItemId: integer
(int64)
Value that the customer uses to uniquely identify the item. This attribute can be blank and the value is derived from the parent transaction.
-
CustomerItemNumber: string
Maximum Length:
50
Number that the customer uses to identify the item. This attribute can be blank and the value is derived from the parent transaction. -
CustomerPartyName: string
Maximum Length:
360
Name of the customer. This attribute can be blank and the value is derived from the parent transaction. -
CustomerPartyNumber: string
Maximum Length:
30
Number that uniquely identifies the customer. This attribute can be blank and the value is derived from the parent transaction. -
DefaultLotsAndSerialNumbersFromASNFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) will be are defaulted when executing a receipt or a put away transaction. If false, then the lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) will not be defaulted when executing a receipt or a put away transaction. The default value is false. -
DefaultLotsAndSerialNumbersFromTransferOrderFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the lots and serial numbers from a transfer order are defaulted when executing a receipt or a put away transaction. If false, then the lots and serial numbers from a transfer order aren't defaulted when executing a receipt or a put away transaction. The default value is false. -
DefaultTaxationCountry: string
Maximum Length:
2
Value that indicates the default taxation country. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
DeliverToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the deliver-to location. This attribute is used to derive DeliverTolocationId. If this attribute is blank, the default value from the purchase order distribution or transfer order distribution is used. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the deliver-to location. If this attribute is blank, the default value from the purchase order distribution or transfer order distribution is used. DeliverToLocationId is mandatory when transaction type is DELIVER and source document code is PO or TRANSFER ORDER and the destination type code of the distribution is EXPENSE.
-
DeliverToPersonId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester. If this attribute is blank, the default value of the requester specified on the purchase order distribution or transfer order distribution is used.
-
DeliverToPersonName: string
Maximum Length:
240
Name of the deliver-to person or requester. This attribute is used to derive DeliverToPersonId. -
DestinationTypeCode: string
Maximum Length:
25
Abbreviation that identifies the destination type for the receiving transaction. This attribute should be left blank. It will be derived from the source document. -
DFF: array
Flexfields for Receipt Transactions
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages the information associated with receipt transactions. -
DocumentDistributionNumber: integer
(int64)
Number that identifies the document distribution for the receiving transaction. When receiving a purchase order that has multiple distributions, this attribute is the respective purchase order distribution number. When receiving a purchase order with multiple distributions, this attribute is mandatory.
-
DocumentFiscalClassification: string
Maximum Length:
240
Fiscal classification for the document. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
DocumentLineNumber: integer
(int64)
Number that identifies the document line number for the receipt line request or advanced shipment notice (ASN) line request. When the source document code is PO (create an ASN, receive a purchase order, or receive an ASN), this attribute is the purchase order line number. When the source document code is INVENTORY, this attribute is the in-transit shipment line number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment line number. When the source document code is RMA, this attribute is the return material authorization (RMA) line number. This attribute is mandatory.
-
DocumentNumber: string
Maximum Length:
30
Number that identifies the document for the receipt line request or advanced shipment notice (ASN) line request. When the source document code is PO (create an ASN, receive a purchase order or an ASN), this attribute is the purchase order number. When the source document code is INVENTORY, this attribute is the in-transit shipment number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment number. When the source document code is RMA, this attribute is the return material authorization (RMA) number. This attribute is mandatory. -
DocumentShipmentLineNumber: integer
(int64)
Number that identifies the document schedule for the receiving transaction. When the source document code is PO (create an advanced shipment notice (ASN), receive a purchase order, or receive an ASN), this attribute is the purchase order schedule number. When receiving a purchase order or creating an ASN line, this attribute is mandatory.
-
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transaction. If this attribute is blank, the value from the parent transaction is used.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transaction. This attribute is used to derive EmployeeId. If this attribute is blank, the value from the parent transaction is used. -
EwayBillDate: string
(date)
Date when the electronic waybill was generated. This attribute is not applicable and should be left blank.
-
EwayBillNumber: integer
(int64)
Number that identifies the electronic waybill provided by supplier for shipment of goods. This attribute is not applicable and should be left blank.
-
Exception: string
Maximum Length:
1
Value that indicates whether or not the receive transaction being created has an exception. If you want to flag the receiving transaction as an exception, populate this attribute with Y. Else, leave it blank. -
ExternalSystemPackingUnit: string
Maximum Length:
150
License plate number of the external warehouse management application. -
FinalDischargeLocationCode: string
Maximum Length:
60
Value that indicates the final discharge location. This attribute is used to derive FinalDischargeLocationId. Applicable only for return transactions. Even for returns, if left blank, defaulted from the parent transaction. -
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies the final discharge location. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
FirstPartyRegistrationId: integer
(int64)
Value that uniquely identifies the first party registration. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
FirstPartyRegistrationNumber: string
Maximum Length:
30
Number that is used for the first party registration. This attribute is used to derive FirstPartyRegistrationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
FromLocator: string
Maximum Length:
81
Name of the source locator for the receiving transaction. This attribute is used to derive FromLocatorId. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away. -
FromLocatorId: integer
(int64)
Value that uniquely identifies the source locator for the receiving transaction. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away.
-
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an interorganization transfer. This is applicable for receipts against in-transit shipment or transfer order shipment. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
FromSubinventory: string
Maximum Length:
10
Name of the source subinventory for the receiving transaction. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away. -
GroupId: integer
(int64)
Value that uniquely identifies the group of interface records submitted together for processing.
-
InsertAndProcessFlag: boolean
Default Value:
true
Contains one of the following values: true or false. If true, then the Manage Receiving Transactions API processes the posted interface data automatically and immediately returns the response. If false, then the records are created in interface tables but no processing is done. These interface records can subsequently processed by the Manage Receiving Transactions scheduled process. The default value is true. -
InspectionQualityCode: string
Maximum Length:
25
Abbreviation that identifies the inspection quality. This attribute is applicable only when the transaction type is ACCEPT or REJECT. A list of accepted values is defined in the lookup type RCV_QUALITY_CODE. -
IntendedUse: string
Maximum Length:
240
Value that indicates the intended use. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the intended use classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source that interfaced the receiving transaction. It can be populated with the source application name. -
InterfaceSourceLineId: integer
(int64)
Value that uniquely identifies the interfaced source line. This can be populated with the identifier of the line in the source application that initiated the receipt.
-
inventoryStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand. -
ItemDescription: string
Maximum Length:
240
Description of the item corresponding to the receipt transaction request. When you create a receipt transaction for a purchase order, it should match the item description of the corresponding purchase order line. For receipt transactions against In-transit shipment, transfer order, and return material authorization (RMA), this attribute should match the description of the inventory item. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription. If left blank, the value from the source document is used. -
ItemId: integer
(int64)
Value that uniquely identifies the inventory item. If left blank, the value from the source document is used. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription.
-
ItemNumber: string
Maximum Length:
300
Number that identifies the item. This attribute is used to derive ItemId. If blank, the value from the source document is used. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription. -
ItemRevision: string
Maximum Length:
18
Revision number of the item. This attribute is mandatory when delivering receipt lines whose item is revision controlled. -
LicensePlateNumber: string
Maximum Length:
30
Source license plate number. This attribute can be blank for this resource. -
Locator: string
Maximum Length:
81
Name of the destination locator for the receiving transaction. This is used to derive LocatorId. This attribute or LocatorId is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, locator control is predefined or dynamic and item transaction defaults or not entered (if item transaction default exists, it will be derived). -
LocatorId: integer
(int64)
Value that uniquely identifies the destination locator for the receiving transaction. This attribute or Locator is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, locator control is predefined or dynamic and item transaction defaults or not entered (if item transaction default exists, it will be derived).
-
lotItemLots: array
Lots for Lot Items
Title:
Lots for Lot Items
The Lots for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled. -
lotSerialItemLots: array
Lots for Lot and Serial Items
Title:
Lots for Lot and Serial Items
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled. -
LPNId: integer
(int64)
Value that uniquely identifies the source license plate number. This attribute can be blank for this resource.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. This attribute is used to derive OrganizationId. For every receipt transaction request, you must provide one of the following attributes: OrganizationCode or OrganizationId, otherwise the request will fail. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization. For every receipt transaction request, you must provide one of the following attributes: OrganizationCode or OrganizationId, otherwise the request will fail.
-
PackingSlip: string
Maximum Length:
25
Packing slip number for the container that contains this item. This attribute can be blank for this resource. -
ParentSourceTransactionNumber: string
Maximum Length:
25
Number that identifies the source transaction number of the parent receiving transaction. -
ParentTransactionId: integer
(int64)
Value that uniquely identifies the parent receiving transaction. This attribute is mandatory. Without this attribute, inspections, put away, corrections, and returns will not be processed.
-
PhysicalMaterialReturnRequiredFlag: boolean
Contains one of the following values: true or false. If true, then a new return transfer order is created that needs to be shipped to the source organization. If false, then the material is issued to scrap. The default value is false. This attribute determines whether the return against a transfer order requires a physical return of the item. This attribute is applicable only when the transaction type is RETURN TO ORGANIZATION.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
PrimaryQuantity: number
Transaction quantity in the primary unit of measure that the item uses.
-
PrimaryUnitOfMeasure: string
Maximum Length:
25
Primary unit of measure that the item in the receiving organization uses. This attribute is used to derive PrimaryUOMCode. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure that the item in the receiving organization uses. -
processingErrors: array
Processing Errors
Title:
Processing Errors
The Processing Errors resource gets the details for each error that was encountered while processing a request for post receipt transactions. -
ProcessingStatusCode: string
Maximum Length:
25
Default Value:PENDING
Value that indicates the processing status for the line request. Valid values include PENDING, RUNNING, COMPLETED. The default value is PENDING. Only the interface records with value PENDING will be picked for processing. If there is an error in the derive, default, and validate cycle, the status moves to ERROR. This attribute should be left blank during POST operation so that the default value of PENDING is picked. -
ProductCategory: string
Maximum Length:
240
Value that indicates the product category. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ProductFiscalClassificationId: integer
(int64)
Value that uniquely identifies the product fiscal classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
ProductFiscalClassName: string
Maximum Length:
250
Name used to indicate the product fiscal classification. This attribute is used to derive ProductFiscalClassificationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ProductType: string
Maximum Length:
240
Value that indicates the product type for taxation purposes. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
Quantity: number
Transaction quantity in the unit of measure that the receipt transaction request uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the inventory transaction reason for the receiving transaction.
-
ReasonName: string
Maximum Length:
30
Name of the inventory transaction reason for the receiving transaction. This attribute is used to derive ReasonId. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the line corresponding to the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallLineNumber: integer
(int64)
Number that identifies the recall notice line. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallNoticeNumber: string
Maximum Length:
60
Number that identifies the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type. -
ReceiptAdviceHeaderId: integer
(int64)
Value that uniquely identifies the receipt advice header.
-
ReceiptAdviceLineId: integer
(int64)
Value that uniquely identifies the receipt advice line.
-
ReceiptSourceCode: string
Maximum Length:
25
Value that identifies the source of the advanced shipment notice (ASN) or the receipt. Valid values include VENDOR when creating an ASN, receiving a purchase order, or receiving an ASN, INVENTORY when receiving an in-transit shipment, TRANSFER ORDER when receiving a transfer order, CUSTOMER when receiving a return material authorization (RMA). This attribute is mandatory. -
ReturnMessage: string
Maximum Length:
20000
Contains the message that's returned to the caller when the input payload is processed asynchronously through immediate or background processing. -
ReturnStatus: string
Value that indicates the status of the application call that's sent to the client. When the input payload is processed synchronously, values include SUCCESS or ERROR. When the input payload is processed asynchronously, values include SUBMITTED or QUEUED.
-
RMALineNumber: string
Maximum Length:
80
Line number of the return material authorization (RMA) against which receipt is being created. This attribute is used to derive ReceiptAdviceLineId. This attribute is mandatory when creating receipt for RMA. -
RMANumber: string
Maximum Length:
80
Number of the return material authorization (RMA) against which receipt is being done. This attribute along with RMASourceSystemName of the header is used to derive ReceiptAdviceHeaderId. This attribute is applicable when creating receipt transactions for RMA. -
RMAReference: string
Maximum Length:
30
Number that identifies the return material authorization that the supplier provides when returning goods to the supplier. This attribute is applicable only when the transaction type is RETURN TO VENDOR. -
RMAScheduleNumber: string
Maximum Length:
80
Schedule number of the return material authorization against which receipt is being done. -
RoutingCode: string
Maximum Length:
30
Value that indicates the receiving routing. This attribute need not be populated for this resource. It is derived from the parent transaction. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receiving routing. This attribute need not be populated for this resource. It is derived from the parent transaction.
-
SaveAndSubmitFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then the Manage Receiving Transactions API resubmits the patched interface data automatically and immediately returns the response. If false, then the records are updated in interface tables but not resubmitted. The default value is false. -
SecondaryQuantity: number
Transaction quantity in the secondary unit of measure that the item uses.
-
SecondaryUnitOfMeasure: string
Maximum Length:
25
Secondary unit of measure that the item in the receiving organization uses. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that the item in the receiving organization uses. -
serialItemSerials: array
Serials for Serial Items
Title:
Serials for Serial Items
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled. -
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the receiving shipment or receipt header. This attribute is applicable when receiving an advanced shipment notice (ASN), a in-transit shipment, or a transfer order.
-
ShipmentLineId: integer
(int64)
Value that uniquely identifies the shipment line. This attribute is applicable when receiving an advanced shipment notice (ASN), a in-transit shipment, or a transfer order.
-
ShipmentNumber: string
Maximum Length:
30
Number that identifies the shipment that the shipment source assigns. This number corresponds to the number that identifies one of the following objects: advance shipment notice, in-transit shipment, or transfer-order shipment. -
ShipToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the receiving location. This is used to derive ShipTolocationId. This attribute is applicable only when transaction type is ACCEPT, REJECT, and TRANSFER. If this attribute is blank, the value from the parent transaction is used. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the receiving location. If this attribute is blank during a POST operation, the value is derived from ShipToLocationId of the source document. This attribute is applicable only when transaction type is ACCEPT, REJECT, and TRANSFER. If this attribute is blank, the value from the parent transaction is used.
-
SoldtoLegalEntity: string
Maximum Length:
240
Name of the sold-to legal entity. Populate this attribute with the sold-to legal entity associated to the purchase order. This is used to derive SoldtoLegalEntityId. -
SoldtoLegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity. The combination of DocumentNumber and SoldtoLegalEntityId is needed to derive POHeaderId, which identifies the purchase order header for a purchase order-based transaction.
-
SourceDocumentCode: string
Maximum Length:
25
Abbreviation that identifies the type of source document. Valid values include PO to create an advanced shipment notice (ASN), receive a purchase order, or an ASN, INVENTORY to receive an in-transit shipment, TRANSFER ORDER to receive a transfer order, RMA to receive a transfer order. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE. This attribute is mandatory. -
SourceTransactionNumber: string
Maximum Length:
25
Number that identifies the unique transaction identifier in the source application. There can be only one record in receiving transactions for a source transaction number. -
Subinventory: string
Maximum Length:
10
Name of the destination subinventory for the receiving transaction. This attribute is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, subinventory is not specified on the document distribution or line (if provided in the document line, the default value is used), or no item transaction default exists (if item transaction default exists, it will be derived). -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute item. This attribute is not currently used.
-
SubstituteItemNumber: string
Maximum Length:
300
Substitute item number for the item on the receipt line. This attribute is not currently used. -
SubstituteUnorderedCode: string
Maximum Length:
25
Value that indicates whether the transaction is for a substitute item. This attribute is not currently used. -
TaxClassificationCode: string
Maximum Length:
50
Value that indicates the tax classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TaxInvoiceDate: string
(date)
Date when the tax invoice is created. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
TaxInvoiceNumber: string
Maximum Length:
150
Number of the tax invoice. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ThirdPartyRegistrationId: integer
(int64)
Value that uniquely identifies the third party registration. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
ThirdPartyRegistrationNumber: string
Maximum Length:
30
Number that is used for the third party registration. This attribute is used to derive ThirdPartyRegistrationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TransactionBusinessCategory: string
Maximum Length:
240
Business category of the transaction. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TransactionDate: string
(date-time)
Date when the transaction for the current line is created. This attribute is used for receipt accounting, invoicing, and other related processes. The default value is the current date and time. If the time zone is not provided, the value stored is the time zone of the database. This value cannot be a future date.
-
TransactionStatusCode: string
Maximum Length:
25
Default Value:PENDING
Value that indicates the status of the advanced shipment notice (ASN) line request or receipt transaction request. Valid values include PENDING, RUNNING or ERROR. The default value is PENDING. Only the interface records with value PENDING are picked for processing. If there is an error in running the transaction, the status changes to ERROR. This attribute should be blank during POST operations so that the default value of PENDING is used. -
TransactionType: string
Maximum Length:
25
Default Value:RECEIVE
Type of transaction for the receipt transaction line request. Valid values include ACCEPT, REJECT, TRANSFER, DELIVER, CORRECT, RETURN TO VENDOR, RETURN TO RECEIVING, RETURN TO CUSTOMER, and RETURN TO ORGANIZATION. -
TransferOrderDistributionId: integer
(int64)
Value that uniquely identifies the transfer order distribution. This attribute is applicable when receiving a transfer order with multiple distributions and direct routing.
-
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order header. This attribute is applicable when receiving a transfer order.
-
TransferOrderLineId: integer
(int64)
Value that uniquely identifies the transfer order line. This attribute is applicable receiving a transfer order.
-
TruckNumber: string
Maximum Length:
35
Number of the truck. This attribute is not currently used. -
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for the receipt transaction request. This attribute is used to derive UOMCode. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure that the receipt transaction uses. -
UserDefinedFiscalClassification: string
Maximum Length:
30
Value that indicates the fiscal classification defined by the user. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier. This attribute can be blank for this resource and is derived from the parent transaction.
-
VendorItemNumber: string
Maximum Length:
300
Number that the supplier uses to identify the item. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorName: string
Maximum Length:
240
Name of the supplier. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for a business unit. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site. This attribute can be blank for this resource and is derived from the parent transaction.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages attachments when creating a post receipt transaction. The attachments uploaded as part of this correspond to the entity name Receiving Transactions.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type:
array
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages the information associated with receipt transactions.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
array
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Lots for Lot Items
Type:
array
Title:
Lots for Lot Items
The Lots for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled.
Show Source
Nested Schema : Lots for Lot and Serial Items
Type:
array
Title:
Lots for Lot and Serial Items
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Processing Errors
Type:
array
Title:
Processing Errors
The Processing Errors resource gets the details for each error that was encountered while processing a request for post receipt transactions.
Show Source
Nested Schema : Serials for Serial Items
Type:
array
Title:
Serials for Serial Items
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-ASNLineDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
InterfaceTransactionId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for receipt transaction requests. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for receipt transaction requests. -
InterfaceTransactionId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-inventoryStripingDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory striping 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 striping 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 manufacture for this item. 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. -
InterfaceTransactionId: integer
(int64)
Value that uniquely identifies the transaction. 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. -
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 : receivingReceiptTransactionRequests-lotItemLots-item-patch-request
Type:
Show Source
object
-
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
-
lotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled. -
LotExpirationDate: string
(date)
Date when the item of the lot corresponding to receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
-
LotNumber: string
Maximum Length:
80
Number that identifies the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control. -
lotNumbersDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled. -
MaturityDate: string
(date)
Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
-
OriginationDate: string
(date)
Date when the lot originated corresponding to the ASN line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control. -
ParentLotNumber: string
Maximum Length:
80
Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control. -
PrimaryQuantity: number
Transaction quantity for the lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
-
ReasonName: string
Maximum Length:
30
Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot control. -
SecondaryTransactionQuantity: number
Transaction quantity for the lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
-
TransactionQuantity: number
Transaction quantity of the item for the lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot control.
-
VendorLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-lotNumbersDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
lotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled. -
LotExpirationDate: string
(date)
Date when the item of this lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot and serial control.
-
LotNumber: string
Maximum Length:
80
Number that identifies the lot for the item corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
lotNumbersDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled. -
lotSerialItemSerials: array
Serials for Lot and Serial Items
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled. -
MaturityDate: string
(date)
Date when the lot matures for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationDate: string
(date)
Date when this lot originated for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
ParentLotNumber: string
Maximum Length:
80
Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
PrimaryQuantity: number
Transaction quantity for this lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonName: string
Maximum Length:
30
Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control. -
SecondaryTransactionQuantity: number
Transaction quantity for this lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
TransactionQuantity: number
Transaction quantity of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
VendorLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Serials for Lot and Serial Items
Type:
array
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotAttributesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotNumbersDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
serialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled. -
serialNumbersDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotSerialItemSerials-serialNumbersDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-processingErrors-item-patch-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control. -
serialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled. -
serialNumbersDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-serialItemSerials-serialAttributesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receivingReceiptTransactionRequests-serialItemSerials-serialNumbersDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
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 : receivingReceiptTransactionRequests-item-response
Type:
Show Source
object
-
Amount: number
Receipt amount in the purchase order currency. This attribute is mandatory when creating receipt for a fixed price service purchase order line.
-
ASNLineDFF: array
ASNLineDFF
-
ASNLineNumber: integer
(int64)
Number that identifies the line on the advance shipment notice. Either this attribute or ShipmentLineId must be provided when receiving an advanced shipment notice (ASN).
-
AssessableValue: number
Assessable value of the transaction for taxation purposes. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages attachments when creating a post receipt transaction. The attachments uploaded as part of this correspond to the entity name Receiving Transactions. -
AutoTransactCode: string
Maximum Length:
25
This attribute is not applicable and should be left blank. -
BarcodeLabel: string
Maximum Length:
35
Label of the barcode on the product. This attribute is not currently used. -
BusinessUnit: string
Maximum Length:
240
Name of the business unit. This attribute can be blank for this resource and is derived from the parent transaction. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit. This attribute can be blank for this resource and is derived from the parent transaction.
-
Comments: string
Maximum Length:
240
Text that the used entered when receiving the item. -
ConsignedLine: string
Maximum Length:
1
Value that indicates whether or not the receiving transaction is for consigned material. If this attribute is blank, the value is derived from the parent transaction. Enter N if returning an owned (once consigned) material. Else, leave this attribute blank. -
ContainerNumber: string
Maximum Length:
35
Container number. This attribute is not currently used. -
CountryOfOriginCode: string
Maximum Length:
2
Abbreviation that identifies the country of manufacture for this item. This attribute can be blank for this resource. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the interface record for the receipt line request. -
CreateDebitMemoFlag: boolean
Contains one of the following values: true or false. If true, then the supplier site of the purchase order is setup to create a debit memo and the receipt (for which return is performed) has a corresponding evaluated receipt settlement (ERS) invoice. If false, then the supplier site of the purchase order is not setup for creating debit memo. The default value is false. This attribute determines whether to create the debit memo. This attribute is applicable only when transaction type is RETURN TO VENDOR.
-
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the interface record for receipt line request. -
CurrencyCode: string
Maximum Length:
15
Receipt amount in the purchase order currency. This attribute is mandatory when creating receipt for a fixed price service purchase order line. -
CurrencyConversionDate: string
(date)
Date when the currency conversion occurred for the receipt. Use this attribute only for a purchase order receipt where the option on the purchase order schedule is Receipt and the order currency is different from the ledger currency of the receiving organization.
-
CurrencyConversionRate: number
Currency conversion rate for the receipt. Use this attribute only for a purchase order receipt where the option on the purchase order schedule is Receipt, the order currency is different from the ledger currency of the receiving organization, and the rate type on the purchase order is User.
-
CustomerId: integer
(int64)
Value that uniquely identifies the customer. This attribute can be blank and the value is derived from the parent transaction.
-
CustomerItemId: integer
(int64)
Value that the customer uses to uniquely identify the item. This attribute can be blank and the value is derived from the parent transaction.
-
CustomerItemNumber: string
Maximum Length:
50
Number that the customer uses to identify the item. This attribute can be blank and the value is derived from the parent transaction. -
CustomerPartyName: string
Maximum Length:
360
Name of the customer. This attribute can be blank and the value is derived from the parent transaction. -
CustomerPartyNumber: string
Maximum Length:
30
Number that uniquely identifies the customer. This attribute can be blank and the value is derived from the parent transaction. -
DefaultLotsAndSerialNumbersFromASNFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) will be are defaulted when executing a receipt or a put away transaction. If false, then the lots and serial numbers from an advance shipment notice (ASN) or an advance shipment billing notice (ASBN) will not be defaulted when executing a receipt or a put away transaction. The default value is false. -
DefaultLotsAndSerialNumbersFromTransferOrderFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the lots and serial numbers from a transfer order are defaulted when executing a receipt or a put away transaction. If false, then the lots and serial numbers from a transfer order aren't defaulted when executing a receipt or a put away transaction. The default value is false. -
DefaultTaxationCountry: string
Maximum Length:
2
Value that indicates the default taxation country. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
DeliverToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the deliver-to location. This attribute is used to derive DeliverTolocationId. If this attribute is blank, the default value from the purchase order distribution or transfer order distribution is used. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the deliver-to location. If this attribute is blank, the default value from the purchase order distribution or transfer order distribution is used. DeliverToLocationId is mandatory when transaction type is DELIVER and source document code is PO or TRANSFER ORDER and the destination type code of the distribution is EXPENSE.
-
DeliverToPersonId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester. If this attribute is blank, the default value of the requester specified on the purchase order distribution or transfer order distribution is used.
-
DeliverToPersonName: string
Maximum Length:
240
Name of the deliver-to person or requester. This attribute is used to derive DeliverToPersonId. -
DestinationTypeCode: string
Maximum Length:
25
Abbreviation that identifies the destination type for the receiving transaction. This attribute should be left blank. It will be derived from the source document. -
DFF: array
Flexfields for Receipt Transactions
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages the information associated with receipt transactions. -
DocumentDistributionNumber: integer
(int64)
Number that identifies the document distribution for the receiving transaction. When receiving a purchase order that has multiple distributions, this attribute is the respective purchase order distribution number. When receiving a purchase order with multiple distributions, this attribute is mandatory.
-
DocumentFiscalClassification: string
Maximum Length:
240
Fiscal classification for the document. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
DocumentLineNumber: integer
(int64)
Number that identifies the document line number for the receipt line request or advanced shipment notice (ASN) line request. When the source document code is PO (create an ASN, receive a purchase order, or receive an ASN), this attribute is the purchase order line number. When the source document code is INVENTORY, this attribute is the in-transit shipment line number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment line number. When the source document code is RMA, this attribute is the return material authorization (RMA) line number. This attribute is mandatory.
-
DocumentNumber: string
Maximum Length:
30
Number that identifies the document for the receipt line request or advanced shipment notice (ASN) line request. When the source document code is PO (create an ASN, receive a purchase order or an ASN), this attribute is the purchase order number. When the source document code is INVENTORY, this attribute is the in-transit shipment number. When the source document code is TRANSFER ORDER, this attribute is the transfer order shipment number. When the source document code is RMA, this attribute is the return material authorization (RMA) number. This attribute is mandatory. -
DocumentShipmentLineNumber: integer
(int64)
Number that identifies the document schedule for the receiving transaction. When the source document code is PO (create an advanced shipment notice (ASN), receive a purchase order, or receive an ASN), this attribute is the purchase order schedule number. When receiving a purchase order or creating an ASN line, this attribute is mandatory.
-
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transaction. If this attribute is blank, the value from the parent transaction is used.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transaction. This attribute is used to derive EmployeeId. If this attribute is blank, the value from the parent transaction is used. -
EwayBillDate: string
(date)
Date when the electronic waybill was generated. This attribute is not applicable and should be left blank.
-
EwayBillNumber: integer
(int64)
Number that identifies the electronic waybill provided by supplier for shipment of goods. This attribute is not applicable and should be left blank.
-
Exception: string
Maximum Length:
1
Value that indicates whether or not the receive transaction being created has an exception. If you want to flag the receiving transaction as an exception, populate this attribute with Y. Else, leave it blank. -
ExternalSystemPackingUnit: string
Maximum Length:
150
License plate number of the external warehouse management application. -
ExternalSystemTransactionReference: string
Maximum Length:
300
Value that contains reference information for the corresponding transaction in external applications. -
FinalDischargeLocationCode: string
Maximum Length:
60
Value that indicates the final discharge location. This attribute is used to derive FinalDischargeLocationId. Applicable only for return transactions. Even for returns, if left blank, defaulted from the parent transaction. -
FinalDischargeLocationId: integer
(int64)
Value that uniquely identifies the final discharge location. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
FirstPartyRegistrationId: integer
(int64)
Value that uniquely identifies the first party registration. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
FirstPartyRegistrationNumber: string
Maximum Length:
30
Number that is used for the first party registration. This attribute is used to derive FirstPartyRegistrationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
FromLocator: string
Maximum Length:
81
Name of the source locator for the receiving transaction. This attribute is used to derive FromLocatorId. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away. -
FromLocatorId: integer
(int64)
Value that uniquely identifies the source locator for the receiving transaction. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away.
-
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an interorganization transfer. This is applicable for receipts against in-transit shipment or transfer order shipment. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
FromSubinventory: string
Maximum Length:
10
Name of the source subinventory for the receiving transaction. This attribute is applicable for negative corrections or returns and the value is derived from the parent DELIVER transaction. Enter this value if you want to return from a different location than where the material was put away. -
GroupId: integer
(int64)
Value that uniquely identifies the group of interface records submitted together for processing.
-
HeaderInterfaceId: integer
(int64)
Value that uniquely identifies the header interfaced receipt transaction line request.
-
InsertAndProcessFlag: boolean
Default Value:
true
Contains one of the following values: true or false. If true, then the Manage Receiving Transactions API processes the posted interface data automatically and immediately returns the response. If false, then the records are created in interface tables but no processing is done. These interface records can subsequently processed by the Manage Receiving Transactions scheduled process. The default value is true. -
InspectionQualityCode: string
Maximum Length:
25
Abbreviation that identifies the inspection quality. This attribute is applicable only when the transaction type is ACCEPT or REJECT. A list of accepted values is defined in the lookup type RCV_QUALITY_CODE. -
IntendedUse: string
Maximum Length:
240
Value that indicates the intended use. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies the intended use classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source that interfaced the receiving transaction. It can be populated with the source application name. -
InterfaceSourceLineId: integer
(int64)
Value that uniquely identifies the interfaced source line. This can be populated with the identifier of the line in the source application that initiated the receipt.
-
InterfaceTransactionId: integer
(int64)
Value that uniquely identifies the interfaced receipt transaction line request.
-
inventoryStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand. -
ItemDescription: string
Maximum Length:
240
Description of the item corresponding to the receipt transaction request. When you create a receipt transaction for a purchase order, it should match the item description of the corresponding purchase order line. For receipt transactions against In-transit shipment, transfer order, and return material authorization (RMA), this attribute should match the description of the inventory item. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription. If left blank, the value from the source document is used. -
ItemId: integer
(int64)
Value that uniquely identifies the inventory item. If left blank, the value from the source document is used. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription.
-
ItemNumber: string
Maximum Length:
300
Number that identifies the item. This attribute is used to derive ItemId. If blank, the value from the source document is used. When creating a receipt transaction, one of the following must be provided: ItemId, ItemNumber, or ItemDescription. -
ItemRevision: string
Maximum Length:
18
Revision number of the item. This attribute is mandatory when delivering receipt lines whose item is revision controlled. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the interface record for receipt line request. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who updated the interface record for receipt line request. -
LicensePlateNumber: string
Maximum Length:
30
Source license plate number. This attribute can be blank for this resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
81
Name of the destination locator for the receiving transaction. This is used to derive LocatorId. This attribute or LocatorId is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, locator control is predefined or dynamic and item transaction defaults or not entered (if item transaction default exists, it will be derived). -
LocatorId: integer
(int64)
Value that uniquely identifies the destination locator for the receiving transaction. This attribute or Locator is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, locator control is predefined or dynamic and item transaction defaults or not entered (if item transaction default exists, it will be derived).
-
lotItemLots: array
Lots for Lot Items
Title:
Lots for Lot Items
The Lots for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled. -
lotSerialItemLots: array
Lots for Lot and Serial Items
Title:
Lots for Lot and Serial Items
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled. -
LPNId: integer
(int64)
Value that uniquely identifies the source license plate number. This attribute can be blank for this resource.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. This attribute is used to derive OrganizationId. For every receipt transaction request, you must provide one of the following attributes: OrganizationCode or OrganizationId, otherwise the request will fail. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization. For every receipt transaction request, you must provide one of the following attributes: OrganizationCode or OrganizationId, otherwise the request will fail.
-
PackingSlip: string
Maximum Length:
25
Packing slip number for the container that contains this item. This attribute can be blank for this resource. -
ParentSourceTransactionNumber: string
Maximum Length:
25
Number that identifies the source transaction number of the parent receiving transaction. -
ParentTransactionId: integer
(int64)
Value that uniquely identifies the parent receiving transaction. This attribute is mandatory. Without this attribute, inspections, put away, corrections, and returns will not be processed.
-
PhysicalMaterialReturnRequiredFlag: boolean
Contains one of the following values: true or false. If true, then a new return transfer order is created that needs to be shipped to the source organization. If false, then the material is issued to scrap. The default value is false. This attribute determines whether the return against a transfer order requires a physical return of the item. This attribute is applicable only when the transaction type is RETURN TO ORGANIZATION.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule. This attribute is applicable when creating an advanced shipment notice (ASN), receiving a purchase order or an ASN.
-
PrimaryQuantity: number
Transaction quantity in the primary unit of measure that the item uses.
-
PrimaryUnitOfMeasure: string
Maximum Length:
25
Primary unit of measure that the item in the receiving organization uses. This attribute is used to derive PrimaryUOMCode. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure that the item in the receiving organization uses. -
processingErrors: array
Processing Errors
Title:
Processing Errors
The Processing Errors resource gets the details for each error that was encountered while processing a request for post receipt transactions. -
ProcessingStatusCode: string
Maximum Length:
25
Default Value:PENDING
Value that indicates the processing status for the line request. Valid values include PENDING, RUNNING, COMPLETED. The default value is PENDING. Only the interface records with value PENDING will be picked for processing. If there is an error in the derive, default, and validate cycle, the status moves to ERROR. This attribute should be left blank during POST operation so that the default value of PENDING is picked. -
ProductCategory: string
Maximum Length:
240
Value that indicates the product category. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ProductFiscalClassificationId: integer
(int64)
Value that uniquely identifies the product fiscal classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
ProductFiscalClassName: string
Maximum Length:
250
Name used to indicate the product fiscal classification. This attribute is used to derive ProductFiscalClassificationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ProductType: string
Maximum Length:
240
Value that indicates the product type for taxation purposes. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
Quantity: number
Transaction quantity in the unit of measure that the receipt transaction request uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the inventory transaction reason for the receiving transaction.
-
ReasonName: string
Maximum Length:
30
Name of the inventory transaction reason for the receiving transaction. This attribute is used to derive ReasonId. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the line corresponding to the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallLineNumber: integer
(int64)
Number that identifies the recall notice line. This attribute should only be used for the RETURN TO VENDOR transaction type.
-
RecallNoticeNumber: string
Maximum Length:
60
Number that identifies the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type. -
ReceiptAdviceHeaderId: integer
(int64)
Value that uniquely identifies the receipt advice header.
-
ReceiptAdviceLineId: integer
(int64)
Value that uniquely identifies the receipt advice line.
-
ReceiptSourceCode: string
Maximum Length:
25
Value that identifies the source of the advanced shipment notice (ASN) or the receipt. Valid values include VENDOR when creating an ASN, receiving a purchase order, or receiving an ASN, INVENTORY when receiving an in-transit shipment, TRANSFER ORDER when receiving a transfer order, CUSTOMER when receiving a return material authorization (RMA). This attribute is mandatory. -
ReturnMessage: string
Maximum Length:
20000
Contains the message that's returned to the caller when the input payload is processed asynchronously through immediate or background processing. -
ReturnStatus: string
Value that indicates the status of the application call that's sent to the client. When the input payload is processed synchronously, values include SUCCESS or ERROR. When the input payload is processed asynchronously, values include SUBMITTED or QUEUED.
-
RMALineNumber: string
Maximum Length:
80
Line number of the return material authorization (RMA) against which receipt is being created. This attribute is used to derive ReceiptAdviceLineId. This attribute is mandatory when creating receipt for RMA. -
RMANumber: string
Maximum Length:
80
Number of the return material authorization (RMA) against which receipt is being done. This attribute along with RMASourceSystemName of the header is used to derive ReceiptAdviceHeaderId. This attribute is applicable when creating receipt transactions for RMA. -
RMAReference: string
Maximum Length:
30
Number that identifies the return material authorization that the supplier provides when returning goods to the supplier. This attribute is applicable only when the transaction type is RETURN TO VENDOR. -
RMAScheduleNumber: string
Maximum Length:
80
Schedule number of the return material authorization against which receipt is being done. -
RoutingCode: string
Maximum Length:
30
Value that indicates the receiving routing. This attribute need not be populated for this resource. It is derived from the parent transaction. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receiving routing. This attribute need not be populated for this resource. It is derived from the parent transaction.
-
SaveAndSubmitFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then the Manage Receiving Transactions API resubmits the patched interface data automatically and immediately returns the response. If false, then the records are updated in interface tables but not resubmitted. The default value is false. -
SecondaryQuantity: number
Transaction quantity in the secondary unit of measure that the item uses.
-
SecondaryUnitOfMeasure: string
Maximum Length:
25
Secondary unit of measure that the item in the receiving organization uses. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure that the item in the receiving organization uses. -
serialItemSerials: array
Serials for Serial Items
Title:
Serials for Serial Items
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled. -
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the receiving shipment or receipt header. This attribute is applicable when receiving an advanced shipment notice (ASN), a in-transit shipment, or a transfer order.
-
ShipmentLineId: integer
(int64)
Value that uniquely identifies the shipment line. This attribute is applicable when receiving an advanced shipment notice (ASN), a in-transit shipment, or a transfer order.
-
ShipmentNumber: string
Maximum Length:
30
Number that identifies the shipment that the shipment source assigns. This number corresponds to the number that identifies one of the following objects: advance shipment notice, in-transit shipment, or transfer-order shipment. -
ShipToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the receiving location. This is used to derive ShipTolocationId. This attribute is applicable only when transaction type is ACCEPT, REJECT, and TRANSFER. If this attribute is blank, the value from the parent transaction is used. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the receiving location. If this attribute is blank during a POST operation, the value is derived from ShipToLocationId of the source document. This attribute is applicable only when transaction type is ACCEPT, REJECT, and TRANSFER. If this attribute is blank, the value from the parent transaction is used.
-
SoldtoLegalEntity: string
Maximum Length:
240
Name of the sold-to legal entity. Populate this attribute with the sold-to legal entity associated to the purchase order. This is used to derive SoldtoLegalEntityId. -
SoldtoLegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity. The combination of DocumentNumber and SoldtoLegalEntityId is needed to derive POHeaderId, which identifies the purchase order header for a purchase order-based transaction.
-
SourceDocumentCode: string
Maximum Length:
25
Abbreviation that identifies the type of source document. Valid values include PO to create an advanced shipment notice (ASN), receive a purchase order, or an ASN, INVENTORY to receive an in-transit shipment, TRANSFER ORDER to receive a transfer order, RMA to receive a transfer order. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE. This attribute is mandatory. -
SourceTransactionNumber: string
Maximum Length:
25
Number that identifies the unique transaction identifier in the source application. There can be only one record in receiving transactions for a source transaction number. -
Subinventory: string
Maximum Length:
10
Name of the destination subinventory for the receiving transaction. This attribute is mandatory when: the transaction type is DELIVER, destination type of the document schedule or document line is Inventory, subinventory is not specified on the document distribution or line (if provided in the document line, the default value is used), or no item transaction default exists (if item transaction default exists, it will be derived). -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute item. This attribute is not currently used.
-
SubstituteItemNumber: string
Maximum Length:
300
Substitute item number for the item on the receipt line. This attribute is not currently used. -
SubstituteUnorderedCode: string
Maximum Length:
25
Value that indicates whether the transaction is for a substitute item. This attribute is not currently used. -
TaxClassificationCode: string
Maximum Length:
50
Value that indicates the tax classification. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TaxInvoiceDate: string
(date)
Date when the tax invoice is created. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
TaxInvoiceNumber: string
Maximum Length:
150
Number of the tax invoice. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
ThirdPartyRegistrationId: integer
(int64)
Value that uniquely identifies the third party registration. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used.
-
ThirdPartyRegistrationNumber: string
Maximum Length:
30
Number that is used for the third party registration. This attribute is used to derive ThirdPartyRegistrationId. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TransactionBusinessCategory: string
Maximum Length:
240
Business category of the transaction. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
TransactionDate: string
(date-time)
Date when the transaction for the current line is created. This attribute is used for receipt accounting, invoicing, and other related processes. The default value is the current date and time. If the time zone is not provided, the value stored is the time zone of the database. This value cannot be a future date.
-
TransactionStatusCode: string
Maximum Length:
25
Default Value:PENDING
Value that indicates the status of the advanced shipment notice (ASN) line request or receipt transaction request. Valid values include PENDING, RUNNING or ERROR. The default value is PENDING. Only the interface records with value PENDING are picked for processing. If there is an error in running the transaction, the status changes to ERROR. This attribute should be blank during POST operations so that the default value of PENDING is used. -
TransactionType: string
Maximum Length:
25
Default Value:RECEIVE
Type of transaction for the receipt transaction line request. Valid values include ACCEPT, REJECT, TRANSFER, DELIVER, CORRECT, RETURN TO VENDOR, RETURN TO RECEIVING, RETURN TO CUSTOMER, and RETURN TO ORGANIZATION. -
TransferOrderDistributionId: integer
(int64)
Value that uniquely identifies the transfer order distribution. This attribute is applicable when receiving a transfer order with multiple distributions and direct routing.
-
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order header. This attribute is applicable when receiving a transfer order.
-
TransferOrderLineId: integer
(int64)
Value that uniquely identifies the transfer order line. This attribute is applicable receiving a transfer order.
-
TruckNumber: string
Maximum Length:
35
Number of the truck. This attribute is not currently used. -
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for the receipt transaction request. This attribute is used to derive UOMCode. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure that the receipt transaction uses. -
UserDefinedFiscalClassification: string
Maximum Length:
30
Value that indicates the fiscal classification defined by the user. This attribute is applicable only for return transactions. Even for returns, if blank, the default value from the parent transaction is used. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier. This attribute can be blank for this resource and is derived from the parent transaction.
-
VendorItemNumber: string
Maximum Length:
300
Number that the supplier uses to identify the item. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorName: string
Maximum Length:
240
Name of the supplier. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for a business unit. This attribute can be blank for this resource and is derived from the parent transaction. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site. This attribute can be blank for this resource and is derived from the parent transaction.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages attachments when creating a post receipt transaction. The attachments uploaded as part of this correspond to the entity name Receiving Transactions.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type:
array
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages the information associated with receipt transactions.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
array
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lots for Lot Items
Type:
array
Title:
Lots for Lot Items
The Lots for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled.
Show Source
Nested Schema : Lots for Lot and Serial Items
Type:
array
Title:
Lots for Lot and Serial Items
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Processing Errors
Type:
array
Title:
Processing Errors
The Processing Errors resource gets the details for each error that was encountered while processing a request for post receipt transactions.
Show Source
Nested Schema : Serials for Serial Items
Type:
array
Title:
Serials for Serial Items
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-ASNLineDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
InterfaceTransactionId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : receivingReceiptTransactionRequests-attachments-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
Value that uniquely identifies the attachment of a shipment line. It is a primary key that the application generates when a document is attached to the receipt transaction request. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
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
Date and time when the user most recently updated the document that is attached to the receipt transaction request. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who updated the document that is attached to the receipt transaction request. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the specification. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for receipt transaction requests. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for receipt transaction requests. -
InterfaceTransactionId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-inventoryStripingDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for inventory striping 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 striping 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 manufacture for this item. 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. -
InterfaceTransactionId: integer
(int64)
Value that uniquely identifies the transaction. 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. -
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 : receivingReceiptTransactionRequests-lotItemLots-item-response
Type:
Show Source
object
-
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled. -
LotExpirationDate: string
(date)
Date when the item of the lot corresponding to receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
-
LotNumber: string
Maximum Length:
80
Number that identifies the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control. -
lotNumbersDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled. -
MaturityDate: string
(date)
Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
-
OriginationDate: string
(date)
Date when the lot originated corresponding to the ASN line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control. -
ParentLotNumber: string
Maximum Length:
80
Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control. -
PrimaryQuantity: number
Transaction quantity for the lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
-
ReasonName: string
Maximum Length:
30
Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot control. -
SecondaryTransactionQuantity: number
Transaction quantity for the lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
-
TransactionQuantity: number
Transaction quantity of the item for the lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot control.
-
VendorLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-lotAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-lotNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-item-response
Type:
Show Source
object
-
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled. -
LotExpirationDate: string
(date)
Date when the item of this lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot and serial control.
-
LotNumber: string
Maximum Length:
80
Number that identifies the lot for the item corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
lotNumbersDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled. -
lotSerialItemSerials: array
Serials for Lot and Serial Items
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled. -
MaturityDate: string
(date)
Date when the lot matures for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationDate: string
(date)
Date when this lot originated for the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
ParentLotNumber: string
Maximum Length:
80
Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
PrimaryQuantity: number
Transaction quantity for this lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonName: string
Maximum Length:
30
Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control. -
SecondaryTransactionQuantity: number
Transaction quantity for this lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
TransactionQuantity: number
Transaction quantity of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
VendorLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Serials for Lot and Serial Items
Type:
array
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display name for lot attributes. This attribute is applicable when the warehouse places the item under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotSerialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled. -
serialNumbersDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under lot and serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotSerialItemSerials-serialAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotSerialItemLots-lotSerialItemSerials-serialNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-processingErrors-item-response
Type:
Show Source
object
-
BatchId: integer
(int64)
Read Only:
true
Value that uniquely identifies the batch into which the interface records are grouped for processing. -
ColumnName: string
Read Only:
true
Maximum Length:30
Name of the column for the attribute value that resulted in error during processing. -
ErrorMessage: string
Read Only:
true
Maximum Length:240
Text of the error message, if any, after the processing the records. -
ErrorMessageName: string
Read Only:
true
Maximum Length:240
Name of the error message, is any, after processing the records. -
ErrorType: string
Read Only:
true
Maximum Length:25
Type of the error, if any, after processing the records. Valid values include ERROR or WARNING. -
InterfaceErrorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving interface error record. -
InterfaceHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the header request that corresponds to the current receiving interface error record. -
InterfaceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line request that corresponds to the current receiving interface error record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TableName: string
Read Only:
true
Maximum Length:30
Name of the table for the attribute value that resulted in error during processing.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-serialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled. -
serialNumbersDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of serial attributes and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of serial numbers and is associated to a transaction line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-serialItemSerials-serialAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivingReceiptTransactionRequests-serialItemSerials-serialNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials. This attribute is applicable when the warehouse places the item under lot and serial control. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ASNLineDFF
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
- InterfaceTransactionId:
- DFF
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Flexfields for Receipt Transactions resource manages the information associated with receipt transactions. - InterfaceTransactionId:
- attachments
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Attachments resource manages attachments when creating a post receipt transaction. The attachments uploaded as part of this correspond to the entity name Receiving Transactions. - InterfaceTransactionId:
- inventoryStripingDFF
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Flexfields for Inventory Striping Attributes resource manages the inventory striping attributes that the descriptive flexfield references associated with a transaction. Inventory striping (inventory tracking) attributes are a set of named attributes (project, task, and country of origin) as well as user-configurable attributes, which when specified as part of the receipt or receiving transaction, are used to track the inventory on hand. - InterfaceTransactionId:
- lotItemLots
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Lots for Lot Items resource manages the lot information for a transaction line whose item is lot controlled and not serial controlled. - InterfaceTransactionId:
- lotSerialItemLots
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Lots for Lot and Serial Items resource manages the lot information for a transaction line whose item is both lot and serial controlled. - InterfaceTransactionId:
- processingErrors
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Processing Errors resource gets the details for each error that was encountered while processing a request for post receipt transactions. - InterfaceTransactionId:
- serialItemSerials
-
Parameters:
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
The Serials for Serial Items resource manages the serial number information for a transaction line whose item is serial controlled and not lot controlled. - InterfaceTransactionId:
Examples
This example describes how to update one receipt transaction request.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/InterfaceTransactionId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "Quantity" : 10, "SaveAndSubmitFlag" :true }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "InterfaceTransactionId": 100000012617135, "HeaderInterfaceId": 100000012617147, "CreatedBy": "ALL_FUNCTION_ALL_DATA", "CreationDate": "2009-10-12T23:48:11.945+00:00", "LastUpdateDate": "2018-11-01T09:24:24+00:00", "LastUpdatedBy": "WHSE_MGR_M1", "TransactionType": "RECEIVE", "AutoTransactCode": "DELIVER", "TransactionDate": "2009-10-12T23:47:40+00:00", "OrganizationCode": null, "OrganizationId": 207, "ItemDescription": "zBIA_Receipt Item_04", "ItemId": 100000012071884, "ItemNumber": "zBIA_Receipt Item_04", "ItemRevision": null, "ReceiptSourceCode": "VENDOR", "SourceDocumentCode": "PO", "DocumentNumber": "1000296", "DocumentLineNumber": 1, "DocumentShipmentLineNumber": 1, "DocumentDistributionNumber": 1, "PODistributionId": 100000012628296, "POHeaderId": 100000012628287, "POLineId": 100000012628294, "POLineLocationId": 100000012628295, "ShipmentHeaderId": null, "ShipmentLineId": null, "ShipmentNumber": "Goodway-ship9999", "ASNLineNumber": null, "TransferOrderHeaderId": null, "TransferOrderLineId": null, "TransferOrderDistributionId": null, "SoldtoLegalEntity": null, "SoldtoLegalEntityId": 204, "DestinationTypeCode": "INVENTORY", "Subinventory": "Stores", "Locator": null, "LocatorId": 801, "Quantity": 10, "UnitOfMeasure": null, "UOMCode": "Box", "PrimaryQuantity": 5, "PrimaryUOMCode": "Box", "PrimaryUnitOfMeasure": null, "ProcessingStatusCode": "ERROR", "SecondaryUOMCode": null, "SecondaryUnitOfMeasure": null, "SecondaryQuantity": null, "EmployeeId": 100010024202242, "EmployeeName": null, "ParentTransactionId": null, "SourceTransactionNumber": null, "ParentSourceTransactionNumber": null, "InterfaceSourceCode": "RCV", "InterfaceSourceLineId": null, "ShipToLocationCode": null, "ShipToLocationId": 207, "DeliverToLocationCode": null, "DeliverToLocationId": 207, "DeliverToPersonId": null, "DeliverToPersonName": null, "RoutingCode": null, "RoutingHeaderId": 3, "InspectionQualityCode": null, "Exception": null, "RMAReference": null, "RMANumber": null, "RMALineNumber": null, "RMAScheduleNumber": null, "ReceiptAdviceHeaderId": null, "ReceiptAdviceLineId": null, "CustomerId": null, "CustomerPartyName": null, "CustomerPartyNumber": null, "CustomerItemNumber": null, "CustomerItemId": null, "Amount": null, "CountryOfOriginCode": null, "CurrencyCode": "USD", "CurrencyConversionDate": null, "CurrencyConversionRate": null, "FromOrganizationCode": null, "FromOrganizationId": null, "ContainerNumber": null, "SubstituteItemNumber": null, "SubstituteItemId": null, "SubstituteUnorderedCode": null, "VendorName": null, "VendorId": 969, "VendorNumber": null, "VendorSiteCode": null, "VendorSiteId": 2198, "VendorItemNumber": "Lot item for receipt", "BusinessUnit": null, "BusinessUnitId": null, "ConsignedLine": null, "ReasonId": null, "ReasonName": null, "PackingSlip": "PLS -1023459", "Comments": null, "FromSubinventory": null, "FromLocator": null, "FromLocatorId": null, "TransactionStatusCode": "PENDING", "GroupId": 40574, "ExternalSystemPackingUnit": null, "DefaultTaxationCountry": null, "DocumentFiscalClassification": null, "FirstPartyRegistrationId": null, "ThirdPartyRegistrationId": null, "TransactionBusinessCategory": null, "TaxInvoiceNumber": null, "TaxInvoiceDate": null, "EwayBillNumber": null, "EwayBillDate": null, "UserDefinedFiscalClassification": null, "ProductFiscalClassificationId": null, "TaxClassificationCode": null, "IntendedUseClassificationId": null, "IntendedUse": null, "ProductCategory": null, "AssessableValue": null, "FinalDischargeLocationId": null, "ProductType": null, "FirstPartyRegistrationNumber": null, "ThirdPartyRegistrationNumber": null, "ProductFiscalClassName": null, "FinalDischargeLocationCode": null, "BarcodeLabel": null, "TruckNumber": null, "InsertAndProcessFlag": "false", "ReturnStatus": null, "LPNId": null, "LicensePlateNumber": null, "SaveAndSubmitFlag": "false", "CreateDebitMemoFlag": null, "PhysicalMaterialReturnRequiredFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135", "name": "receivingReceiptTransactionRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135", "name": "receivingReceiptTransactionRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/ASNLineDFF", "name": "ASNLineDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/serialItemSerials", "name": "serialItemSerials", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/processingErrors", "name": "processingErrors", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/lotItemLots", "name": "lotItemLots", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/lotSerialItemLots", "name": "lotSerialItemLots", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/100000012617135/child/attachments", "name": "attachments", "kind": "collection" } ] }