Create headers
post
/fscmRestApi/resources/11.13.18.05/receipts/{GroupId}/child/receiptHeaders
Request
Path Parameters
-
GroupId(required): integer
Value that uniquely identifies the group that contains the receipts and transactions from each service call. The system creates this value. It is recommended that you leave the value for this attribute empty.
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
-
BillOfLading: string
Maximum Length:
25
Number that identifies the bill of lading for this shipment. -
BUId: integer
(int64)
Value that uniquely identifies the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
-
BusinessUnit: string
Maximum Length:
240
Name of the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains. -
Comments: string
Maximum Length:
240
Text that describes the receiving that occurred when receiving the item. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerPartyName: string
Maximum Length:
360
Name of the customer. -
CustomerPartyNumber: string
Maximum Length:
30
Unique identifier for customer party number. -
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transactions.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transactions. -
FreightCarrierId: integer
(int64)
Value that uniquely identifies the freight carrier.
-
FreightCarrierName: string
Maximum Length:
360
Name of the freight carrier. -
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an in-transit shipment. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
GLDate: string
(date)
General ledger date.
-
NumberOfPackingUnits: integer
(int64)
Number of containers in the shipment.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization.
-
PackingSlip: string
Maximum Length:
25
Number that identifies the packing slip for a container on the shipment. -
RADOOSourceSystemId: integer
(int64)
Value that uniquely identifies the source system that created the receipt advice for this item.
-
RADOOSourceSystemName: string
Maximum Length:
80
Name of the source system that created the receipt advice for this item. -
receiptHeaderDFF: array
Flexfields for Receipt Headers
Title:
Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references. -
ReceiptHeaderId: integer
(int64)
Value that uniquely identifies the receipt header or shipment header. Use this attribute when you receive an inbound shipment or advance shipment notice, or when you add an item to a receipt that already exists.
-
receiptLines: array
Receipt Lines
Title:
Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line. -
ReceiptNumber: string
Maximum Length:
30
Number that identifies items that the warehouse receives in a single receipt. -
ReceiptSourceCode: string
Maximum Length:
25
Source of the shipment or the receipt. Values include Vendor, Inventory, Transfer Order, or Customer. -
ShipmentNumber: string
Maximum Length:
30
Shipment number 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. -
ShippedDate: string
(date-time)
Date when the supplier shipped the item.
-
TransactionDate: string
(date)
Date when the transaction occurred.
-
UniqueHeaderId: integer
(int64)
Value that uniquely identifies the receipt header.
-
VendorId: integer
(int64)
Value that uniquely identifies the supplier.
-
VendorName: string
Maximum Length:
240
Name of the supplier. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for the business unit. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
WaybillAirbillNumber: string
Maximum Length:
20
Number that identifies the waybill or airbill.
Nested Schema : Flexfields for Receipt Headers
Type:
array
Title:
Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references.
Show Source
Nested Schema : Receipt Lines
Type:
array
Title:
Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line.
Show Source
Nested Schema : receipts-receiptHeaders-receiptHeaderDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the receipt header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the receipt header. -
HeaderInterfaceId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
Amount: number
Transaction amount in the purchase order currency. Use this attribute for a fixed price line.
-
ASNLineNumber: integer
(int64)
Number that identifies the line on the advance shipment notice.
-
AutoTransactCode: string
Maximum Length:
25
Abbreviation that determines how to finish subsequent transactions. Values include SHIP, RECEIVE, or DELIVER. For example, if transaction type is RECEIVE, and if the auto transact code is DELIVER, then the warehouse will complete the putaway when it processes the receipt. -
BUId: integer
(int64)
Value that uniquely identifies the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
-
BusinessUnit: string
Maximum Length:
240
Name of the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains. -
Comments: string
Maximum Length:
240
Text that describes the receiving that occurred when receiving the item. -
ConsignmentLine: string
Maximum Length:
1
Indicates whether or not the receiving transaction is for consigned material. -
ContainerNumber: string
Maximum Length:
35
Container number for the receipt line. -
CountryOfOriginCode: string
Maximum Length:
2
Abbreviation that identifies the country of manufacture for this item. -
CreateDebitMemo: string
Maximum Length:
1
Determines whether to create the debit memo. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency that the receiving transaction uses. -
CurrencyConversionDate: string
(date)
Date when the currency conversion occurred for the receipt. Use this attribute only for a purchase order receipt.
-
CurrencyConversionRate: number
Currency conversion rate for the receipt. Use this attribute only for a purchase order receipt.
-
CurrencyConversionType: string
Maximum Length:
30
Type of currency conversion rate of the purchase order. Use this attribute only for a purchase order receipt. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerItemId: integer
(int64)
Value that the customer uses to uniquely identify the item.
-
CustomerItemNumber: string
Maximum Length:
50
Number that the customer uses to identify the item. -
CustomerPartyName: string
Maximum Length:
360
Name of the customer. -
CustomerPartyNumber: string
Maximum Length:
30
Unique identifier for customer party number. -
DeliverToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the deliver-to location. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the deliver-to location.
-
DeliverToPersonId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester.
-
DeliverToPersonName: string
Maximum Length:
240
Name of the deliver-to person or requester. -
DestinationTypeCode: string
Maximum Length:
25
Abbreviation that identifies the destination type for the receiving transaction. -
DocumentDistributionNumber: integer
(int64)
Number that identifies the document distribution for the receiving transaction.
-
DocumentLineNumber: integer
(int64)
Number that identifies the document line number for the receiving transaction.
-
DocumentNumber: string
Maximum Length:
30
Number that identifies the document for the receiving transaction. -
DocumentScheduleNumber: integer
(int64)
Number that identifies the document schedule for the receiving transaction.
-
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transaction.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transaction. -
Exception: string
Maximum Length:
1
Contains one of the following values. Yes: record that an exception occurred. No: do not record that an exception occurred. The default value is empty. -
ExternalSystemPackingUnit: string
Maximum Length:
150
License plate number of the external Warehouse Management System. -
FromLocator: string
Maximum Length:
81
Source locator name for the receiving transaction. -
FromLocatorId: integer
(int64)
Value that uniquely identifies the source locator for the receiving transaction.
-
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an interorganization transfer. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
FromSubinventory: string
Maximum Length:
10
Source subinventory name for the receiving transaction. -
InspectionQualityCode: string
Maximum Length:
25
Abbreviation that identifies the inspection quality. The RCV_QUALITY_CODE lookup defines the values that you can use with this attribute. -
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source that interfaced the receiving transaction. -
InterfaceSourceLineId: integer
(int64)
Value that uniquely identifies the interfaced source line.
-
ItemDescription: string
Maximum Length:
240
Description of the item. For a purchase order receipt, this attribute describes the item on the purchase order line. For other receipts, this attribute describes the inventory item. -
ItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemNumber: string
Maximum Length:
300
Name of the item. -
ItemRevision: string
Maximum Length:
18
Revision number of the item. -
Locator: string
Maximum Length:
81
Name of the destination locator for the receiving transaction. -
LocatorId: integer
(int64)
Value that uniquely identifies the destination locator for the receiving transaction.
-
lotItemLots: array
Lots That Control Items
Title:
Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item. -
lotSerialItemLots: array
Lots That Share Control
Title:
Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization.
-
PackingSlip: string
Maximum Length:
25
Packing slip number for the container that contains this item. -
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.
-
PhysicalMaterialReturnRequired: string
Maximum Length:
1
Determines whether the return against a transfer order requires a physical return of the item. -
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule.
-
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. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure that the item in the receiving organization uses. -
Quantity: number
Transaction quantity in the unit of measure that the receiving transaction 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. -
ReceiptAdviceDocumentLineNumber: string
Maximum Length:
80
Line number on the source document that the warehouse uses for the receipt advice. -
ReceiptAdviceDocumentNumber: string
Maximum Length:
80
Source document number that the warehouse uses for the receipt advice. -
ReceiptAdviceDocumentScheduleNumber: string
Maximum Length:
80
Schedule number on the source document that the warehouse uses for the receipt advice line. -
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
Source of the shipment or the receipt. Values include VENDOR, INVENTORY, TRANSFER ORDER, or CUSTOMER. -
receiptTransactionDFF: array
Flexfields for Receipt Transactions
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references. -
RMAReference: string
Maximum Length:
30
Number that identifies the return material authorization that the supplier provides when returning goods to the supplier. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receiving routing. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
-
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 That Control Items
Title:
Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item. -
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the receiving shipment or receipt header.
-
ShipmentLineId: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShipmentNumber: string
Maximum Length:
30
Shipment number 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. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the receiving location.
-
SoldtoLegalEntity: string
Maximum Length:
240
Name of the sold-to legal entity. -
SoldtoLegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity.
-
SourceDocumentCode: string
Maximum Length:
25
Abbreviation that identifies the type of source document. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute. -
SourceTransactionNumber: string
Maximum Length:
25
Number that identifies the unique transaction identifier in the source system. -
Subinventory: string
Maximum Length:
10
Name of the destination subinventory for the receiving transaction. -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute item.
-
SubstituteItemNumber: string
Maximum Length:
300
Substitute item number for the item on the receipt line. -
SubstituteUnorderedCode: string
Maximum Length:
25
Indicates whether the transaction is for a substitute item. Value is SUBSTITUTE. -
TransactionDate: string
(date-time)
Date when the receiving transaction occurred.
-
TransactionType(required): string
Maximum Length:
25
Type of receiving transaction. The RCV_TRANSACTION_TYPE lookup defines the values that you can use with this attribute. -
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order header.
-
TransferOrderLineId: integer
(int64)
Value that uniquely identifies the transfer order line.
-
UniqueTransactionId: integer
(int64)
Value that uniquely identifies the receiving transaction.
-
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for the receiving transaction. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure that the receiving transaction uses. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier.
-
VendorItemNumber: string
Maximum Length:
300
Number that the supplier uses to identify the item. -
VendorName: string
Maximum Length:
240
Name of the supplier. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for a business unit. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
Nested Schema : Lots That Control Items
Type:
array
Title:
Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type:
array
Title:
Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type:
array
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references.
Show Source
Nested Schema : Serials That Control Items
Type:
array
Title:
Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item.
Show Source
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.
-
LotExpirationDate: string
(date)
Date when the item of the lot expires.
-
lotItemLotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about lot attributes that the descriptive flexfield references. Use it when only the lot controls the item. -
lotItemLotsDFF: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references. Use it when only the lot controls the item. -
LotNumber(required): string
Maximum Length:
80
Lot number for the item. Applies when the warehouse places the item under lot control. -
MaturityDate: string
(date)
Date when the lot matures.
-
OriginationDate: string
(date)
Date when the lot originated.
-
OriginationType: string
Maximum Length:
30
Type of origination. -
ParentLotNumber: string
Maximum Length:
80
Parent lot number of the lot. -
PrimaryQuantity: number
Transaction quantity for the lot in the primary unit of measure that the item uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction. Applies 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. Applies 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.
-
TransactionQuantity(required): number
Transaction quantity of the item for the lot. Applies when the warehouse places the item under lot control.
-
VendorLotNumber: string
Maximum Length:
150
Supplier lot number.
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about lot attributes that the descriptive flexfield references. Use it when only the lot controls the item.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references. Use it when only the lot controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotAttributesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotsDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-item-post-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.
-
LotExpirationDate: string
(date)
Date when the item of this lot expires.
-
LotNumber(required): string
Maximum Length:
80
Lot number for the item. Applies when the warehouse places the item under lot and serial control. -
lotSerialItemLotAttributesDFF: array
Flexfields for Lot Attributes That Share Control
Title:
Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemLotsDFF: array
Flexfields for Lots That Share Control
Title:
Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemSerials: array
Serials That Share Control
Title:
Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item. -
MaturityDate: string
(date)
Date when the lot matures.
-
OriginationDate: string
(date)
Date when this lot originated.
-
OriginationType: string
Maximum Length:
30
Type of origination. -
ParentLotNumber: string
Maximum Length:
80
Parent lot number of the lot. -
PrimaryQuantity: number
Transaction quantity for this lot in the primary unit of measure that the item uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction for the lot. Applies 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. Applies 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.
-
TransactionQuantity(required): number
Transaction quantity of the item. Applies when the warehouse places the item under lot and serial control.
-
VendorLotNumber: string
Maximum Length:
150
Supplier lot number.
Nested Schema : Flexfields for Lot Attributes That Share Control
Type:
array
Title:
Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Lots That Share Control
Type:
array
Title:
Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Serials That Share Control
Type:
array
Title:
Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotAttributesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotsDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
FromSerialNumber(required): string
Maximum Length:
80
Starting serial number in a range of serial numbers. Applies when the warehouse places the item under lot and serial control. -
lotSerialItemSerialAttributesDFF: array
Flexfields for Serial Attributes That Share Control
Title:
Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemSerialsDFF: array
Flexfields for Serials That Share Control
Title:
Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers. Applies when the warehouse places the item under lot and serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number.
Nested Schema : Flexfields for Serial Attributes That Share Control
Type:
array
Title:
Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Serials That Share Control
Type:
array
Title:
Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-receiptTransactionDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the receipt transaction. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the receipt transaction. -
InterfaceTransactionId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-item-post-request
Type:
Show Source
object
-
FromSerialNumber(required): string
Maximum Length:
80
Starting serial number in a range of serial numbers. Applies when the warehouse places the item under serial control. -
serialItemSerialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes that the descriptive flexfield references. Use it when only the serial controls the item. -
serialItemSerialsDFF: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references. Use it when only the serial controls the item. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers Applies when the warehouse places the item under serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number.
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes that the descriptive flexfield references. Use it when only the serial controls the item.
Show Source
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references. Use it when only the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialAttributesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
FromSerialNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialsDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under 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(required):
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(required):
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 : receipts-receiptHeaders-item-response
Type:
Show Source
object
-
BillOfLading: string
Maximum Length:
25
Number that identifies the bill of lading for this shipment. -
BUId: integer
(int64)
Value that uniquely identifies the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
-
BusinessUnit: string
Maximum Length:
240
Name of the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains. -
Comments: string
Maximum Length:
240
Text that describes the receiving that occurred when receiving the item. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerPartyName: string
Maximum Length:
360
Name of the customer. -
CustomerPartyNumber: string
Maximum Length:
30
Unique identifier for customer party number. -
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transactions.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transactions. -
FreightCarrierId: integer
(int64)
Value that uniquely identifies the freight carrier.
-
FreightCarrierName: string
Maximum Length:
360
Name of the freight carrier. -
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an in-transit shipment. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
GLDate: string
(date)
General ledger date.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPackingUnits: integer
(int64)
Number of containers in the shipment.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization.
-
PackingSlip: string
Maximum Length:
25
Number that identifies the packing slip for a container on the shipment. -
RADOOSourceSystemId: integer
(int64)
Value that uniquely identifies the source system that created the receipt advice for this item.
-
RADOOSourceSystemName: string
Maximum Length:
80
Name of the source system that created the receipt advice for this item. -
receiptHeaderDFF: array
Flexfields for Receipt Headers
Title:
Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references. -
ReceiptHeaderId: integer
(int64)
Value that uniquely identifies the receipt header or shipment header. Use this attribute when you receive an inbound shipment or advance shipment notice, or when you add an item to a receipt that already exists.
-
receiptLines: array
Receipt Lines
Title:
Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line. -
ReceiptNumber: string
Maximum Length:
30
Number that identifies items that the warehouse receives in a single receipt. -
ReceiptSourceCode: string
Maximum Length:
25
Source of the shipment or the receipt. Values include Vendor, Inventory, Transfer Order, or Customer. -
ShipmentNumber: string
Maximum Length:
30
Shipment number 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. -
ShippedDate: string
(date-time)
Date when the supplier shipped the item.
-
TransactionDate: string
(date)
Date when the transaction occurred.
-
UniqueHeaderId: integer
(int64)
Value that uniquely identifies the receipt header.
-
VendorId: integer
(int64)
Value that uniquely identifies the supplier.
-
VendorName: string
Maximum Length:
240
Name of the supplier. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for the business unit. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
WaybillAirbillNumber: string
Maximum Length:
20
Number that identifies the waybill or airbill.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Receipt Headers
Type:
array
Title:
Flexfields for Receipt Headers
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references.
Show Source
Nested Schema : Receipt Lines
Type:
array
Title:
Receipt Lines
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line.
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 : receipts-receiptHeaders-receiptHeaderDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the receipt header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the receipt header. -
HeaderInterfaceId: 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 : receipts-receiptHeaders-receiptLines-item-response
Type:
Show Source
object
-
Amount: number
Transaction amount in the purchase order currency. Use this attribute for a fixed price line.
-
ASNLineNumber: integer
(int64)
Number that identifies the line on the advance shipment notice.
-
AutoTransactCode: string
Maximum Length:
25
Abbreviation that determines how to finish subsequent transactions. Values include SHIP, RECEIVE, or DELIVER. For example, if transaction type is RECEIVE, and if the auto transact code is DELIVER, then the warehouse will complete the putaway when it processes the receipt. -
BUId: integer
(int64)
Value that uniquely identifies the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains.
-
BusinessUnit: string
Maximum Length:
240
Name of the business unit. For a purchase order receipt, this attribute references the procurement business unit of the supplier site. For a receipt that includes a return material authorization, this attribute references the business unit that the return material authorization contains. -
Comments: string
Maximum Length:
240
Text that describes the receiving that occurred when receiving the item. -
ConsignmentLine: string
Maximum Length:
1
Indicates whether or not the receiving transaction is for consigned material. -
ContainerNumber: string
Maximum Length:
35
Container number for the receipt line. -
CountryOfOriginCode: string
Maximum Length:
2
Abbreviation that identifies the country of manufacture for this item. -
CreateDebitMemo: string
Maximum Length:
1
Determines whether to create the debit memo. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency that the receiving transaction uses. -
CurrencyConversionDate: string
(date)
Date when the currency conversion occurred for the receipt. Use this attribute only for a purchase order receipt.
-
CurrencyConversionRate: number
Currency conversion rate for the receipt. Use this attribute only for a purchase order receipt.
-
CurrencyConversionType: string
Maximum Length:
30
Type of currency conversion rate of the purchase order. Use this attribute only for a purchase order receipt. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer.
-
CustomerItemId: integer
(int64)
Value that the customer uses to uniquely identify the item.
-
CustomerItemNumber: string
Maximum Length:
50
Number that the customer uses to identify the item. -
CustomerPartyName: string
Maximum Length:
360
Name of the customer. -
CustomerPartyNumber: string
Maximum Length:
30
Unique identifier for customer party number. -
DeliverToLocationCode: string
Maximum Length:
60
Abbreviation that identifies the deliver-to location. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the deliver-to location.
-
DeliverToPersonId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester.
-
DeliverToPersonName: string
Maximum Length:
240
Name of the deliver-to person or requester. -
DestinationTypeCode: string
Maximum Length:
25
Abbreviation that identifies the destination type for the receiving transaction. -
DocumentDistributionNumber: integer
(int64)
Number that identifies the document distribution for the receiving transaction.
-
DocumentLineNumber: integer
(int64)
Number that identifies the document line number for the receiving transaction.
-
DocumentNumber: string
Maximum Length:
30
Number that identifies the document for the receiving transaction. -
DocumentScheduleNumber: integer
(int64)
Number that identifies the document schedule for the receiving transaction.
-
EmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the receiving transaction.
-
EmployeeName: string
Maximum Length:
240
Name of the employee who performed the receiving transaction. -
Exception: string
Maximum Length:
1
Contains one of the following values. Yes: record that an exception occurred. No: do not record that an exception occurred. The default value is empty. -
ExternalSystemPackingUnit: string
Maximum Length:
150
License plate number of the external Warehouse Management System. -
FromLocator: string
Maximum Length:
81
Source locator name for the receiving transaction. -
FromLocatorId: integer
(int64)
Value that uniquely identifies the source locator for the receiving transaction.
-
FromOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization for an interorganization transfer. -
FromOrganizationId: integer
(int64)
Value that uniquely identifies the source organization for an in-transit shipment.
-
FromSubinventory: string
Maximum Length:
10
Source subinventory name for the receiving transaction. -
InspectionQualityCode: string
Maximum Length:
25
Abbreviation that identifies the inspection quality. The RCV_QUALITY_CODE lookup defines the values that you can use with this attribute. -
InterfaceSourceCode: string
Maximum Length:
30
Default Value:REST
Abbreviation that identifies the source that interfaced the receiving transaction. -
InterfaceSourceLineId: integer
(int64)
Value that uniquely identifies the interfaced source line.
-
ItemDescription: string
Maximum Length:
240
Description of the item. For a purchase order receipt, this attribute describes the item on the purchase order line. For other receipts, this attribute describes the inventory item. -
ItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemNumber: string
Maximum Length:
300
Name of the item. -
ItemRevision: string
Maximum Length:
18
Revision number of the item. -
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. -
LocatorId: integer
(int64)
Value that uniquely identifies the destination locator for the receiving transaction.
-
lotItemLots: array
Lots That Control Items
Title:
Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item. -
lotSerialItemLots: array
Lots That Share Control
Title:
Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the receiving organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the receiving organization.
-
PackingSlip: string
Maximum Length:
25
Packing slip number for the container that contains this item. -
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.
-
PhysicalMaterialReturnRequired: string
Maximum Length:
1
Determines whether the return against a transfer order requires a physical return of the item. -
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule.
-
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. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure that the item in the receiving organization uses. -
Quantity: number
Transaction quantity in the unit of measure that the receiving transaction 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. -
ReceiptAdviceDocumentLineNumber: string
Maximum Length:
80
Line number on the source document that the warehouse uses for the receipt advice. -
ReceiptAdviceDocumentNumber: string
Maximum Length:
80
Source document number that the warehouse uses for the receipt advice. -
ReceiptAdviceDocumentScheduleNumber: string
Maximum Length:
80
Schedule number on the source document that the warehouse uses for the receipt advice line. -
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
Source of the shipment or the receipt. Values include VENDOR, INVENTORY, TRANSFER ORDER, or CUSTOMER. -
receiptTransactionDFF: array
Flexfields for Receipt Transactions
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references. -
RMAReference: string
Maximum Length:
30
Number that identifies the return material authorization that the supplier provides when returning goods to the supplier. -
RoutingHeaderId: integer
(int64)
Value that uniquely identifies the receiving routing. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
-
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 That Control Items
Title:
Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item. -
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the receiving shipment or receipt header.
-
ShipmentLineId: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShipmentNumber: string
Maximum Length:
30
Shipment number 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. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the receiving location.
-
SoldtoLegalEntity: string
Maximum Length:
240
Name of the sold-to legal entity. -
SoldtoLegalEntityId: integer
(int64)
Value that uniquely identifies the sold-to legal entity.
-
SourceDocumentCode: string
Maximum Length:
25
Abbreviation that identifies the type of source document. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute. -
SourceTransactionNumber: string
Maximum Length:
25
Number that identifies the unique transaction identifier in the source system. -
Subinventory: string
Maximum Length:
10
Name of the destination subinventory for the receiving transaction. -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute item.
-
SubstituteItemNumber: string
Maximum Length:
300
Substitute item number for the item on the receipt line. -
SubstituteUnorderedCode: string
Maximum Length:
25
Indicates whether the transaction is for a substitute item. Value is SUBSTITUTE. -
TransactionDate: string
(date-time)
Date when the receiving transaction occurred.
-
TransactionType: string
Maximum Length:
25
Type of receiving transaction. The RCV_TRANSACTION_TYPE lookup defines the values that you can use with this attribute. -
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order header.
-
TransferOrderLineId: integer
(int64)
Value that uniquely identifies the transfer order line.
-
UniqueTransactionId: integer
(int64)
Value that uniquely identifies the receiving transaction.
-
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for the receiving transaction. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure that the receiving transaction uses. -
VendorId: integer
(int64)
Value that uniquely identifies the supplier.
-
VendorItemNumber: string
Maximum Length:
300
Number that the supplier uses to identify the item. -
VendorName: string
Maximum Length:
240
Name of the supplier. -
VendorNumber: string
Maximum Length:
30
Number that identifies the supplier. -
VendorSiteCode: string
Maximum Length:
240
Abbreviation that identifies the supplier site for a business unit. -
VendorSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lots That Control Items
Type:
array
Title:
Lots That Control Items
The Lots That Control Items resource manages details about the lot when the lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type:
array
Title:
Lots That Share Control
The Lots That Share Control resource manages details about the lot when the lot and the serial controls the item.
Show Source
Nested Schema : Flexfields for Receipt Transactions
Type:
array
Title:
Flexfields for Receipt Transactions
The Flexfields for Receipt Transactions resource manages details about the receipt transaction that the descriptive flexfield references.
Show Source
Nested Schema : Serials That Control Items
Type:
array
Title:
Serials That Control Items
The Serial Item Serials resource manages details about the serial when the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-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.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotExpirationDate: string
(date)
Date when the item of the lot expires.
-
lotItemLotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages details about lot attributes that the descriptive flexfield references. Use it when only the lot controls the item. -
lotItemLotsDFF: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references. Use it when only the lot controls the item. -
LotNumber: string
Maximum Length:
80
Lot number for the item. Applies when the warehouse places the item under lot control. -
MaturityDate: string
(date)
Date when the lot matures.
-
OriginationDate: string
(date)
Date when the lot originated.
-
OriginationType: string
Maximum Length:
30
Type of origination. -
ParentLotNumber: string
Maximum Length:
80
Parent lot number of the lot. -
PrimaryQuantity: number
Transaction quantity for the lot in the primary unit of measure that the item uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction. Applies 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. Applies 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.
-
TransactionQuantity: number
Transaction quantity of the item for the lot. Applies when the warehouse places the item under lot control.
-
VendorLotNumber: string
Maximum Length:
150
Supplier lot number.
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 details about lot attributes that the descriptive flexfield references. Use it when only the lot controls the item.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages details about the lot that the descriptive flexfield references. Use it when only the lot controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about lot attributes. Applies 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 : receipts-receiptHeaders-receiptLines-lotItemLots-lotItemLotsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial 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 : receipts-receiptHeaders-receiptLines-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.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotExpirationDate: string
(date)
Date when the item of this lot expires.
-
LotNumber: string
Maximum Length:
80
Lot number for the item. Applies when the warehouse places the item under lot and serial control. -
lotSerialItemLotAttributesDFF: array
Flexfields for Lot Attributes That Share Control
Title:
Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemLotsDFF: array
Flexfields for Lots That Share Control
Title:
Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemSerials: array
Serials That Share Control
Title:
Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item. -
MaturityDate: string
(date)
Date when the lot matures.
-
OriginationDate: string
(date)
Date when this lot originated.
-
OriginationType: string
Maximum Length:
30
Type of origination. -
ParentLotNumber: string
Maximum Length:
80
Parent lot number of the lot. -
PrimaryQuantity: number
Transaction quantity for this lot in the primary unit of measure that the item uses.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction for the lot. Applies 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. Applies 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.
-
TransactionQuantity: number
Transaction quantity of the item. Applies when the warehouse places the item under lot and serial control.
-
VendorLotNumber: string
Maximum Length:
150
Supplier lot number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes That Share Control
Type:
array
Title:
Flexfields for Lot Attributes That Share Control
The Flexfields for Lot Attributes That Share Control resource manages details about lot attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Lots That Share Control
Type:
array
Title:
Flexfields for Lots That Share Control
The Flexfields for Lots That Share Control resource manages details about the lot that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Serials That Share Control
Type:
array
Title:
Serials That Share Control
The Serials That Share Control resource manages details about the serial when the lot and the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about lot attributes. Applies when the warehouse places the item under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about lot attributes. Applies 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 : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemLotsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the lot. Applies when the warehouse places the item under lot and serial 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 : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. Applies when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotSerialItemSerialAttributesDFF: array
Flexfields for Serial Attributes That Share Control
Title:
Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item. -
lotSerialItemSerialsDFF: array
Flexfields for Serials That Share Control
Title:
Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers. Applies when the warehouse places the item under lot and serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes That Share Control
Type:
array
Title:
Flexfields for Serial Attributes That Share Control
The Flexfields for Serial Attributes That Share Control resource manages details about the serial attributes that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : Flexfields for Serials That Share Control
Type:
array
Title:
Flexfields for Serials That Share Control
The Flexfields for Serials That Share Control resource manages details about the serial that the descriptive flexfield references. Use it when lots and serials control the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under 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 : receipts-receiptHeaders-receiptLines-lotSerialItemLots-lotSerialItemSerials-lotSerialItemSerialsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under 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 : receipts-receiptHeaders-receiptLines-receiptTransactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the receipt transaction. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the receipt transaction. -
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 : receipts-receiptHeaders-receiptLines-serialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. Applies when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialItemSerialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes that the descriptive flexfield references. Use it when only the serial controls the item. -
serialItemSerialsDFF: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references. Use it when only the serial controls the item. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers Applies when the warehouse places the item under serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number.
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 details about serial attributes that the descriptive flexfield references. Use it when only the serial controls the item.
Show Source
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about the serial that the descriptive flexfield references. Use it when only the serial controls the item.
Show Source
Nested Schema : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about serial attributes. Applies when the warehouse places the item under 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 : receipts-receiptHeaders-receiptLines-serialItemSerials-serialItemSerialsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Display value of the context for the descriptive flexfield that contains details about the serial. Applies when the warehouse places the item under 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
- receiptHeaderDFF
-
Parameters:
- GroupId:
$request.path.GroupId
- UniqueHeaderId:
$request.path.UniqueHeaderId
The Flexfields for Receipt Headers resource manages details about the receipt header that the descriptive flexfield references. - GroupId:
- receiptLines
-
Parameters:
- GroupId:
$request.path.GroupId
- UniqueHeaderId:
$request.path.UniqueHeaderId
The Receipt Lines resource manages details about the receipt line transaction or the inbound shipment line. - GroupId:
Examples
This example describes how to create one header for one receipt.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/receipts"
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 creates.
{ "receiptHeaders": [ { "OrganizationCode": "M1", "VendorName": "First Network Devices", "VendorSiteCode": "FRESNO", "EmployeeId": 4426, "BusinessUnit" : "Vision Operations", "ReceiptSourceCode" : "VENDOR "receiptLines": [ { "BusinessUnit" : "Vision Operations", "DestinationTypeCode" : "RECEIVING", "DocumentLineNumber" : 1, "DocumentNumber" : 1000125, "ItemNumber" : "RCV-100", "PrimaryQuantity": 3, "EmployeeId": 4426, "OrganizationCode": "M1", "Quantity": 3, "UOMCode": "Ea", "UnitOfMeasure" : "Each", "ReceiptSourceCode" : "VENDOR", "SoldtoLegalEntity" : "Vision Operations", "SourceDocumentCode" : "PO", "AutoTransactCode" : "RECEIVE", "TransactionType" : "RECEIVE" } ] } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "GroupId" : 56391, "ReturnStatus" : "SUCCESS", "ErrorCode" : null, "ErrorExplanation" : null, "ErrorUniqueHeaderId" : 0, "ErrorUniqueTransactionId" : "0", "receiptHeaders" : [ { "UniqueHeaderId" : 300100090015951, "ReceiptSourceCode" : "VENDOR", "TransactionDate" : null, "ShipmentNumber" : null, "ReceiptNumber" : null, "ReceiptHeaderId" : null, "VendorName" : "First Network Devices", "VendorNumber" : null, "VendorId" : null, "VendorSiteCode" : "FRESNO", "VendorSiteId" : null, "BUId" : null, "BusinessUnit" : "Vision Operations", "OrganizationCode" : "M1", "OrganizationId" : null, "ShippedDate" : null, "FreightCarrierId" : null, "FreightCarrierName" : null, "WaybillAirbillNumber" : null, "NumberOfPackingUnits" : null, "BillOfLading" : null, "PackingSlip" : null, "Comments" : null, "CustomerPartyName" : null, "CustomerId" : null, "EmployeeName" : null, "EmployeeId" : 4426, "FromOrganizationCode" : null, "FromOrganizationId" : null, "RADOOSourceSystemId" : null, "RADOOSourceSystemName" : null, "receiptLines" : [ { "UniqueTransactionId" : 300100090015952, "TransactionType" : "RECEIVE", "AutoTransactCode" : "RECEIVE", "TransactionDate" : "2016-06-05T23:11:47-07:00", "OrganizationCode" : "M1", "OrganizationId" : null, "ItemDescription" : null, "ItemId" : null, "ItemNumber" : "RCV-100", "ItemRevision" : null, "ReceiptSourceCode" : "VENDOR", "SourceDocumentCode" : "PO", "DocumentNumber" : "1000125", "DocumentLineNumber" : 1, "DocumentScheduleNumber" : null, "DocumentDistributionNumber" : null, "PODistributionId" : null, "POHeaderId" : null, "POLineId" : null, "POLineLocationId" : null, "ShipmentHeaderId" : null, "ShipmentLineId" : null, "ShipmentNumber" : null, "ASNLineNumber" : null, "TransferOrderHeaderId" : null, "TransferOrderLineId" : null, "SoldtoLegalEntity" : "Vision Operations", "SoldtoLegalEntityId" : null, "DestinationTypeCode" : "RECEIVING", "Subinventory" : null, "Locator" : null, "LocatorId" : null, "Quantity" : 3, "UnitOfMeasure" : "Each", "UOMCode" : "Ea", "PrimaryQuantity" : 3, "PrimaryUOMCode" : null, "PrimaryUnitOfMeasure" : null, "SecondaryUOMCode" : null, "SecondaryUnitOfMeasure" : null, "SecondaryQuantity" : null, "EmployeeId" : 4426, "EmployeeName" : null, "ParentTransactionId" : null, "SourceTransactionNumber" : null, "ParentSourceTransactionNumber" : null, "InterfaceSourceCode" : null, "InterfaceSourceLineId" : null, "ShipToLocationCode" : null, "ShipToLocationId" : null, "DeliverToLocationCode" : null, "DeliverToLocationId" : null, "DeliverToPersonId" : null, "DeliverToPersonName" : null, "RoutingHeaderId" : null, "InspectionQualityCode" : null, "Exception" : null, "CreateDebitMemo" : null, "RMAReference" : null, "PhysicalMaterialReturnRequired" : null, "ReceiptAdviceDocumentScheduleNumber" : null, "ReceiptAdviceDocumentLineNumber" : null, "ReceiptAdviceDocumentNumber" : null, "ReceiptAdviceHeaderId" : null, "ReceiptAdviceLineId" : null, "CustomerPartyName" : null, "CustomerId" : null, "CustomerItemNumber" : null, "CustomerItemId" : null, "Amount" : null, "CountryOfOriginCode" : null, "CurrencyCode" : null, "CurrencyConversionDate" : null, "CurrencyConversionRate" : null, "CurrencyConversionType" : null, "FromOrganizationCode" : null, "FromOrganizationId" : null, "ContainerNumber" : null, "SubstituteItemNumber" : null, "SubstituteItemId" : null, "SubstituteUnorderedCode" : null, "VendorName" : null, "VendorId" : null, "VendorNumber" : null, "VendorSiteCode" : null, "VendorSiteId" : null, "BusinessUnit" : "Vision Operations", "BUId" : null, "VendorItemNumber" : null, "ConsignmentLine" : null, "ReasonId" : null, "ReasonName" : null, "PackingSlip" : null, "Comments" : null, "FromSubinventory" : null, "FromLocator" : null, "FromLocatorId" : null } ] } ] }