1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Receiving Receipt Requests
  5. Lines

Get one line

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : receivingReceiptRequests-lines-item-response
Type: object
Show Source
  • Receipt amount in the purchase order currency. This attribute is mandatory when creating a receipt for a fixed price service purchase order line.
  • Attachments for ASN Lines
    Title: Attachments for ASN Lines
    The Attachments for ASN Lines resource manages attachments when creating an advance shipment notice (ASN) line request.
  • Flexfields for ASN Line Requests
    Title: Flexfields for ASN Line Requests
    The Flexfields for ASN Line Requests resource manages the details of the advance shipment notice (ASN) line requests that the descriptive flexfield references.
  • 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).
  • Packing Units for ASNs
    Title: Packing Units for ASNs
    The Packing Units for the ASNs resource manages details about the packing units which are associated with the advance shipment notice (ASN) or advance shipment billing notice (ASBN) lines.
  • Assessable value of the transaction for taxation purposes.
  • Maximum Length: 25
    Abbreviation that determines how to finish subsequent transactions automatically, if needed. Valid values include SHIP, RECEIVE, and DELIVER. If you receive a document line (transaction type is RECEIVE) where the document routing is direct delivery, then set auto-transact code to DELIVER. This will receive and also deliver the material or services automatically. If you receive a document with standard or inspection required routing, set auto-transact code to RECEIVE, so that only the receipt is created and the material resides in the receiving bay. When you create an advanced shipment notice (ASN) line (transaction type is SHIP) and set the auto-transact code to RECEIVE, then the advanced shipment notice (ASN) will be created and a receipt is automatically created. If you set auto-transact code to DELIVER, then along with creation of an advanced shipment notice (ASN), receive and deliver take place automatically.
  • Maximum Length: 35
    Label of the barcode on the product. This attribute is applicable only for advanced shipment notice (ASN) line request.
  • 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.
  • 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. You can leave this attribute blank.
  • Maximum Length: 240
    Text that the used entered when receiving the item.
  • Maximum Length: 1
    Value that indicates whether or not the receiving transaction is for consigned material. If blank for a receipt line request, the value from the document is used.
  • Maximum Length: 35
    Container number for the advanced shipment notice (ASN) line request.
  • Maximum Length: 2
    Abbreviation that identifies the country of manufacture for this item.
  • Read Only: true
    Maximum Length: 64
    User who created the interface record for the receipt line request.
  • Contains one of the following values: true or false. If true, then create the debit memo. If false, then do not create the debit memo. The default value is false. This attribute is not currently used.
  • Read Only: true
    Date and time when the interface record for receipt line request was created.
  • Maximum Length: 15
    Abbreviation that identifies the currency that the receiving transaction uses. If you leave this attribute blank, the value from the document is used.
  • 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.
  • 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.
  • Value that uniquely identifies the customer. This attribute can be blank and the value is derived from the header.
  • Value that the customer uses to uniquely identify the item.
  • Maximum Length: 50
    Number that the customer uses to identify the item.
  • Maximum Length: 360
    Name of the customer. This attribute can be blank and the value is derived from the header.
  • Maximum Length: 30
    Number that uniquely identifies the customer. This attribute can be blank and the value is derived from the header.
  • 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.
  • 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.
  • Maximum Length: 2
    Value that indicates the default taxation country.
  • Maximum Length: 60
    Abbreviation that identifies the deliver-to location. This is used to derive DeliverTolocationId.
  • Value that uniquely identifies the deliver-to location. If this attribute is blank during a POST operation, this is derived from the DeliverToLocationId of the document distribution: purchase order distribution or transfer order distribution. DeliverToLocationId is mandatory when receiving a purchase order or transfer order with expense destination and the receipt routing is direct delivery.
  • Value that uniquely identifies the deliver-to person or requester. If this attribute is blank, this will default to the requester specified on the purchase order distribution or transfer order distribution.
  • Maximum Length: 240
    Name of the deliver-to person or requester. This attribute is used to derive DeliverToPersonId.
  • Maximum Length: 25
    Abbreviation that identifies the destination type for the receiving transaction. Contains one of the following values: blank, RECEIVING, value stored in destination type, or INVENTORY. When you set to blank, the application will default the appropriate value based on the document type and auto-transact code. This is recommended. When set to RECEIVING, the document routing is standard or inspection required. Set to the value stored in destination type for the corresponding purchase order schedule or transfer order line. When set to INVENTORY, receive in-transit shipment or return material authorization (RMA) and the document routing is direct delivery.
  • 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.
  • Maximum Length: 240
    Fiscal classification for the document.
  • 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.
  • 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.
  • 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.
  • Value that uniquely identifies the employee who performed the receiving transaction. If this attribute is blank during POST or PATCH operation, the value from the header request is used.
  • Maximum Length: 240
    Name of the employee who performed the receiving transaction. This attribute is used to derive the EmployeeId. If this attribute is blank during POST or PATCH operation, the value from the header request is used.
  • Date when the electronic waybill was generated. This value is used to calculate the goods and services tax for India.
  • Number that identifies the electronic waybill provided by supplier for shipment of goods. This value is used to calculate the goods and services tax for India.
  • 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.
  • Maximum Length: 150
    License plate number of the external warehouse management application.
  • Maximum Length: 300
    Value that contains reference information for the corresponding transaction in external applications. Do not enter this value at line level for RECEIVE or SHIP transactions, the value given at header is copied to lines. This value is entered at line level for other receiving transactions like inspection, put away, correct, and return.
  • Maximum Length: 60
    Value that indicates the final discharge location. This attribute is used to derive FinalDischargeLocationId.
  • Value that uniquely identifies the final discharge location.
  • Value that uniquely identifies the first party registration.
  • Maximum Length: 30
    Number that is used for the first party registration. This attribute is used to derive FirstPartyRegistrationId.
  • Maximum Length: 30
    Abbreviation that identifies the ownership of the items that are in transit.
  • Maximum Length: 81
    Name of the source locator for the receiving transaction. This attribute is not currently used.
  • Value that uniquely identifies the source locator for the receiving transaction. This attribute is not currently used.
  • 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.
  • Value that uniquely identifies the source organization for an in-transit shipment.
  • Maximum Length: 10
    Name of the source subinventory for the receiving transaction. This attribute is not currently used.
  • Value that uniquely identifies the group of interface records submitted together for processing.
  • Value that uniquely identifies the header request to which this line belongs to.
  • 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.
  • Maximum Length: 25
    Abbreviation that identifies the inspection quality. This attribute is not applicable for a receipt line request or an advanced shipment notice (ASN) line request.
  • Maximum Length: 240
    Value that indicates the intended use.
  • Value that uniquely identifies the intended use classification.
  • 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.
  • 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.
  • Value that uniquely identifies the interfaced receipt line request.
  • Flexfields for Inventory Striping Attributes
    Title: Flexfields for Inventory Striping Attributes
    The Flexfields for Inventory Striping Attributes resource manages the details of 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.
  • Maximum Length: 240
    Description of the item corresponding to the receipt line request or advanced shipment notice (ASN) line request. When you create an ASN or a receipt for a purchase order, it should match the item description of the corresponding purchase order line. For receipts against In-transit shipment, transfer order and return material authorization (RMA), this attribute should match the description of the inventory item. When creating an ASN or a receipt, one of the following must be provided: item identifier, item number, or item description.
  • Value that uniquely identifies the inventory item. When creating an advanced shipment notice (ASN) or a receipt, one of the following must be provided: item identifier, item number, or item description.
  • Maximum Length: 300
    Number that identifies the item. Used to derive the attribute ItemId. When creating an advanced shipment notice (ASN) or a receipt, one of the following must be provided: item identifier, item number, or item description.
  • Maximum Length: 18
    Number that identifies the revision of the item. This attribute is mandatory when creating receipt lines for an item that is revision controlled.
  • Read Only: true
    Date and time when the user most recently updated the interface record for receipt line request.
  • Read Only: true
    Maximum Length: 64
    Login of the user who updated the interface record for receipt line request.
  • Maximum Length: 30
    Source license plate number of the advanced shipment notice (ASN) request line. This attribute should be populated only for an advanced shipment notice (ASN) line request.
  • Links
  • 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 document routing is direct delivery or auto-transact code 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).
  • Value that uniquely identifies the destination locator for the receiving transaction. This attribute or Locator is mandatory when: the document routing is direct delivery or auto-transact code 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).
  • Lots for Lot Items
    Title: Lots for Lot Items
    The Lots for Lot Items resource manages the lot number information for a line whose item is lot controlled and not serial controlled.
  • Lots for Lot and Serial Items
    Title: Lots for Lot and Serial Items
    The Lots for Lot and Serial Items resource manages the lot number information for a line whose item is both lot and serial controlled.
  • Value that uniquely identifies the source license plate number. This attribute should be populated only for an advanced shipment notice (ASN) line request.
  • Maximum Length: 18
    Abbreviation that identifies the receiving organization. This attribute is used to derive the organization identifier. For every receipt line request or advanced shipment notice (ASN) line request, either organization code or organization identifier must be populated. If the values are not provided, the request will fail.
  • Value that uniquely identifies the receiving organization. For every receipt line request or advanced shipment notice (ASN) line request, either organization code or organization identifier must be populated. If the values are not provided, the request will fail.
  • Maximum Length: 25
    Packing slip number for the container that contains this item. This attribute is applicable when creating an advanced shipment notice (ASN) line request.
  • Maximum Length: 25
    Number that identifies the source transaction of the parent receiving transaction. This attribute should not be populated when creating a receipt or creating an advanced shipment notice (ASN).
  • Value that uniquely identifies the parent receiving transaction. This attribute should not be populated when creating an advanced shipment notice (ASN) or creating a receipt. Since this attribute is applicable only for post receipt transactions, leave this blank.
  • Contains one of the following values: true or false. If true, then return against a transfer order requires a physical return of the item. If false, then return against a transfer order does not require a physical return of the item. The default value is false. This attribute is not currently used.
  • 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.
  • 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.
  • 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.
  • 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.
  • Transaction quantity in the primary unit of measure that the item uses.
  • Maximum Length: 25
    Primary unit of measure that the item in the receiving organization uses. This attribute is used to derive PrimaryUOMCode.
  • Maximum Length: 3
    Abbreviation that identifies the primary unit of measure that the item in the receiving organization uses.
  • Processing Errors
    Title: Processing Errors
    The Processing Errors resource gets the details for each error that was encountered while processing a request for advance shipment notice (ASN) creation or receipt creation.
  • 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 blank during POST operation so that the default value of PENDING is picked.
  • Maximum Length: 240
    Value that indicates the product category.
  • Value that uniquely identifies the product fiscal classification.
  • Maximum Length: 250
    Name used to indicate the product fiscal classification. This attribute is used to derive ProductFiscalClassificationId.
  • Maximum Length: 240
    Value that indicates the product type for taxation purposes.
  • Value that uniquely identifies the quality inspection event corresponding to the receiving transaction. This attribute is not currently used.
  • Transaction quantity in the unit of measure that the receipt line request or advanced shipment notice (ASN) request uses.
  • Value that uniquely identifies the inventory transaction reason for the receiving transaction.
  • Maximum Length: 30
    Name of the inventory transaction reason for the receiving transaction. This attribute is used to derive ReasonId.
  • Value that uniquely identifies the recall notice number. This attribute should only be used for the RETURN TO VENDOR transaction type.
  • Value that uniquely identifies the line corresponding to the recall notice number. This attribute should only be used for the RETURN TO VENDOR transaction type.
  • Number that identifies the recall notice line. This attribute should only be used for the RETURN TO VENDOR transaction type.
  • Maximum Length: 60
    Number that identifies the recall notice. This attribute should only be used for the RETURN TO VENDOR transaction type.
  • Value that uniquely identifies the receipt advice header.
  • Value that uniquely identifies the receipt advice line.
  • 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.
  • Maximum Length: 20000
    Contains the message that is returned to the caller when the input payload is processed asynchronously through immediate or background processing.
  • Value that indicates the status of the application call that is 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.
  • Maximum Length: 80
    Line number of the return material authorization (RMA) against which the receipt is being created. This attribute is used to derive ReceiptAdviceLineId. This attribute is mandatory when creating a receipt for RMA.
  • Maximum Length: 80
    Number of the return material authorization (RMA) against which the receipt is being created. This attribute along with RMASourceSystemName of the header is used to derive ReceiptAdviceHeaderId. This attribute is mandatory when creating a receipt for RMA.
  • Maximum Length: 30
    Number that identifies the return material authorization that the supplier provides when returning goods to the supplier. This attribute is not currently used.
  • Maximum Length: 80
    Schedule number of the return material authorization against which receipt is being created.
  • Maximum Length: 30
    Value that indicates the receiving routing. A list of accepted values is defined in the lookup type RCV_ROUTING_HEADERS.
  • Value that uniquely identifies the receiving routing. Valid values include: 1 for standard receipt, 2 for inspection required, 3 for direct delivery. If this attribute is blank, the value is derived from the document line or schedule.
  • 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.
  • Transaction quantity in the secondary unit of measure that the item uses.
  • Maximum Length: 25
    Secondary unit of measure that the item in the receiving organization uses.
  • Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure that the item in the receiving organization uses.
  • Serials for Serial Items
    Title: Serials for Serial Items
    The Serials for Serial Items resource manages the serial number information for a line whose item is serial controlled and not lot controlled.
  • Value that uniquely identifies the ship-from location. It determines the tax for the item.
  • 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.
  • 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.
  • Maximum Length: 30
    Number that indicates 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.
  • Maximum Length: 60
    Abbreviation that identifies the receiving location. This is used to derive ShipTolocationId. When creating a receipt against in-transit shipment, either ShipToLocationCode or ShipToLocationId must be provided.
  • Value that uniquely identifies the receiving location. If this attribute is blank during a POST operation, this is derived from the ShipToLocationId of the source document. When creating a receipt against in-transit shipment, either ShipToLocationCode or ShipToLocationId must be provided.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the quality inspection is skipped. If false, then the quality inspection must be performed. The default value is false. This attribute is not currently used.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 25
    Number that identifies the unique transaction identifier in the source system. This is not applicable when creating an advanced shipment notice (ASN). This attribute should be unique across the application. There can be only one record in receiving transactions for a source transaction number.
  • Maximum Length: 10
    Name of the destination subinventory for the receiving transaction. This attribute is mandatory when: the document routing is direct delivery or auto-transact code 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).
  • Value that uniquely identifies the substitute item. This is applicable for purchase order receipts.
  • Maximum Length: 300
    Substitute item number for the item on the receipt line. This attribute is used to derive SubstituteItemId. This is applicable for purchase order receipts.
  • Maximum Length: 25
    Value that indicates whether the transaction is for a substitute item. Enter the value as SUBSTITUTE if you are creating a receipt for a substitute item.
  • Maximum Length: 50
    Value that indicates the tax classification.
  • Date when the tax invoice is created.
  • Maximum Length: 150
    Number of the tax invoice.
  • Value that uniquely identifies the third party registration.
  • Maximum Length: 30
    Number that is used for the third party registration. This attribute is used to derive ThirdPartyRegistrationId.
  • Attachments for Transactions
    Title: Attachments for Transactions
    The Attachments for Transactions resource manages attachments when creating a receipt line request.
  • Maximum Length: 240
    Business category of the transaction.
  • Receipt date for the current line. 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.
  • Flexfields for Receive Transaction Requests
    Title: Flexfields for Receive Transaction Requests
    The Flexfields for Receive Transaction Requests resource manages the details of the receive transaction request that the descriptive flexfield references.
  • 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.
  • Maximum Length: 25
    Default Value: RECEIVE
    Type if transaction for the line request. Valid values include RECEIVE or SHIP. When creating an advanced shipment notice (ASN) line, transaction type should be set to SHIP. When creating a receipt line request, transaction type should be set to RECEIVE.
  • Value that uniquely identifies the transfer order distribution. This attribute is applicable when receiving a transfer order with multiple distributions and direct routing.
  • Value that uniquely identifies the transfer order header. This attribute is applicable when receiving a transfer order.
  • Value that uniquely identifies the transfer order line. This attribute is applicable receiving a transfer order.
  • Maximum Length: 35
    Number of the truck. This attribute is applicable only for advanced shipment notice (ASN) line request.
  • Maximum Length: 25
    Unit of measure for the receipt line or ASN line request. This attribute is used to derive UOMCode.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure that the receipt line or advanced shipment notice (ASN) line uses.
  • Maximum Length: 30
    Value that indicates the fiscal classification defined by the user.
  • Value that uniquely identifies the supplier. You can leave this attribute blank.
  • Maximum Length: 300
    Number that the supplier uses to identify the item. If a value is entered for this attribute, It must match the supplier item on the purchase order line.
  • Maximum Length: 240
    Name of the supplier. You can leave this attribute blank.
  • Maximum Length: 30
    Number that identifies the supplier. You can leave this attribute blank.
  • Maximum Length: 240
    Abbreviation that identifies the supplier site for a business unit. This attribute is used to derive SupplierSiteId. It is applicable to creating an advanced shipment notice (ASN), receiving an ASN, or receiving a purchase order. You can leave this attribute blank.
  • Value that uniquely identifies the supplier site. It is applicable to creating an advanced shipment notice (ASN), receiving an ASN, or receiving a purchase order. You can leave this attribute blank.
Nested Schema : Attachments for ASN Lines
Type: array
Title: Attachments for ASN Lines
The Attachments for ASN Lines resource manages attachments when creating an advance shipment notice (ASN) line request.
Show Source
Nested Schema : Flexfields for ASN Line Requests
Type: array
Title: Flexfields for ASN Line Requests
The Flexfields for ASN Line Requests resource manages the details of the advance shipment notice (ASN) line requests that the descriptive flexfield references.
Show Source
Nested Schema : Packing Units for ASNs
Type: array
Title: Packing Units for ASNs
The Packing Units for the ASNs resource manages details about the packing units which are associated with the advance shipment notice (ASN) or advance shipment billing notice (ASBN) lines.
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 details of 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 number information for a 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 number information for a 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 advance shipment notice (ASN) creation or receipt creation.
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 line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : Attachments for Transactions
Type: array
Title: Attachments for Transactions
The Attachments for Transactions resource manages attachments when creating a receipt line request.
Show Source
Nested Schema : Flexfields for Receive Transaction Requests
Type: array
Title: Flexfields for Receive Transaction Requests
The Flexfields for Receive Transaction Requests resource manages the details of the receive transaction request that the descriptive flexfield references.
Show Source
Nested Schema : receivingReceiptRequests-lines-ASNLineAttachments-item-response
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • 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 advanced shipment notice (ASN) line request.
  • Title: Category
    Maximum Length: 30
    Category of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is true.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the attachment.
  • Title: Created By User Name
    Read Only: true
    Login that the user used when creating the attachment for the specification.
  • Title: Creation Date
    Read Only: true
    Date when the user created the attachment record.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that identifies the data type.
  • Title: Description
    Maximum Length: 255
    Description of the attachment for the advanced shipment notice (ASN) line request.
  • Maximum Length: 255
    Value that uniquely identifies the content server document.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Folder path of the attachment.
  • Maximum Length: 255
    Number that identifies a particular version of the content server document.
  • Title: DownloadInfo
    JSON-formatted string containing information required to programmatically retrieve a large file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Error Status Message
    Error message, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Expiration Date
    Date when the contents in the attachment for the advanced shipment notice (ASN) line request expire.
  • Title: File Contents
    Contents of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Name
    Maximum Length: 2048
    File name of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Url
    URL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request.
  • 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.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the document that is attached to the receipt header.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    Login of the user who updated the document that is attached to the receipt header.
  • Title: Last Updated By User
    Read Only: true
    Login that the user used when updating the attachment for the specification.
  • Links
  • Title: PostProcessingAction
    The name of the action that can be performed after an attachment is uploaded.
  • Title: Title
    Title of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Content Type
    Content type of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Size
    Length of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Name
    Name of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded Text
    Text of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uri
    Maximum Length: 4000
    URI (Uniform Resource Identifier) that identifies the attachment.
  • Title: Url
    Maximum Length: 4000
    URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Login that the user used when adding or modifying the attachment.
Nested Schema : receivingReceiptRequests-lines-ASNLineDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-ASNPackingUnits-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the packing unit interface record of the advanced shipment notice (ASN) line request.
  • Read Only: true
    Date and time when the packing unit interface record of the advanced shipment notice (ASN) line request was created.
  • Read Only: true
    Date and time when the user most recently updated the packing unit interface record of the advanced shipment notice (ASN) line request.
  • Read Only: true
    Maximum Length: 64
    User who last updated the packing unit interface record of the advanced shipment notice (ASN) line request.
  • Read Only: true
    Maximum Length: 32
    Login of the user who updated the packing unit interface record of the advanced shipment notice (ASN) line request.
  • Maximum Length: 30
    License plate number of the current license plate number hierarchy of the advanced shipment notice (ASN) line request.
  • Links
  • Value that uniquely identifies the license plate number of the current license plate number hierarchy of the advanced shipment notice (ASN) line request.
  • Value that uniquely identifies the interfaced license plate number of the current license plate number hierarchy of the advanced shipment notice (ASN) line request.
  • Maximum Length: 30
    Parent license plate number of the current license plate number hierarchy of the advanced shipment notice (ASN) line request.
  • Value that uniquely identifies the parent license plate number of the current license plate number hierarchy of the advanced shipment notice (ASN) line request.
Nested Schema : receivingReceiptRequests-lines-inventoryStripingDFF-item-response
Type: object
Show Source
  • 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.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory striping attributes. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Country of Origin
    Name of the country of manufacture. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the transaction. This attribute is not currently used.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : receivingReceiptRequests-lines-lotItemLots-item-response
Type: object
Show Source
  • Maximum Length: 32
    Abbreviation that identifies the expiration action.
  • Date when the warehouse performed the expiration action.
  • Maximum Length: 150
    Abbreviation that identifies the grade.
  • Date when the warehouse applied a hold on 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.
  • Links
  • Flexfields for Lot Attributes
    Title: Flexfields for Lot Attributes
    The Flexfields for Lot Attributes resource manages the details of the lot attributes that the descriptive flexfield references and is associated with a line whose item is lot controlled and not serial controlled.
  • Date when the item of 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.
  • Maximum Length: 80
    Number that identifies 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.
  • Flexfields for Lot Numbers
    Title: Flexfields for Lot Numbers
    The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is lot controlled and not serial controlled.
  • Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
  • Date when the lot originated 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.
  • 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.
  • Maximum Length: 80
    Number that identifies the parent lot of 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.
  • 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.
  • Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
  • 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.
  • Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
  • 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.
  • Value that uniquely identifies the material status.
  • Transaction quantity of the item for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request expires. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 150
    Number that identifies the supplier lot 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.
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 that the descriptive flexfield references and is associated with a line whose item is lot controlled and not serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type: array
Title: Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is lot controlled and not serial controlled.
Show Source
Nested Schema : receivingReceiptRequests-lines-lotItemLots-lotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-lotItemLots-lotNumbersDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-item-response
Type: object
Show Source
  • Maximum Length: 32
    Abbreviation that identifies the expiration action.
  • Date when the warehouse performed the expiration action.
  • Maximum Length: 150
    Abbreviation that identifies the grade.
  • Date when the warehouse applied a hold on 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 and serial control.
  • Links
  • Flexfields for Lot Attributes
    Title: Flexfields for Lot Attributes
    The Flexfields for Lot Attributes resource manages the details of the lot attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
  • Date when the item of this lot corresponding to the advanced shipment notice (ASN) line request or receipt line request expires. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 80
    Number that identifies the lot for the item 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 and serial control.
  • Flexfields for Lot Numbers
    Title: Flexfields for Lot Numbers
    The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
  • 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 line whose item is both lot and serial controlled.
  • Date when the lot matures for the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Date when this lot originated for the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • 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 and serial control.
  • Maximum Length: 80
    Number that identifies the parent lot of 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 and serial control.
  • 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.
  • 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.
  • 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.
  • Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
  • 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.
  • Value that uniquely identifies the material status.
  • Transaction quantity of 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 and serial control.
  • Maximum Length: 150
    Number that identifies the supplier lot 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 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 that the descriptive flexfield references and is associated with a 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 the details of the lot numbers that the descriptive flexfield references and is associated with a 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 line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotNumbersDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-item-response
Type: object
Show Source
  • Maximum Length: 80
    Starting serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Links
  • Flexfields for Serial Attributes
    Title: Flexfields for Serial Attributes
    The Flexfields for Serial Attributes resource manages the details of the serial attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
  • Flexfields for Serial Numbers
    Title: Flexfields for Serial Numbers
    The Flexfields for Serial Numbers resource manages the details of the serial numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
  • Maximum Length: 80
    Ending serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
  • Maximum Length: 80
    Supplier serial number for the serial range of the advanced shipment notice (ASN) line request or receipt line 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 the serial attributes that the descriptive flexfield references and is associated with a 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 the serial numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-serialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-serialNumbersDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-processingErrors-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the batch into which the interface records are grouped for processing.
  • Read Only: true
    Maximum Length: 30
    Name of the column for the attribute value that resulted in error during processing.
  • Read Only: true
    Maximum Length: 240
    Text of the error message, if any, after the processing the records.
  • Read Only: true
    Maximum Length: 240
    Name of the error message, is any, after processing the records.
  • Read Only: true
    Maximum Length: 25
    Type of the error, if any, after processing the records. Valid values include ERROR or WARNING.
  • Read Only: true
    Value that uniquely identifies the receiving interface error record.
  • Read Only: true
    Value that uniquely identifies the header request that corresponds to the current receiving interface error record.
  • Read Only: true
    Value that uniquely identifies the line request that corresponds to the current receiving interface error record.
  • Links
  • Read Only: true
    Maximum Length: 30
    Name of the table for the attribute value that resulted in error during processing.
Nested Schema : receivingReceiptRequests-lines-serialItemSerials-item-response
Type: object
Show Source
  • Maximum Length: 80
    Starting serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under serial control.
  • Links
  • Flexfields for Serial Attributes
    Title: Flexfields for Serial Attributes
    The Flexfields for Serial Attributes resource manages the details of the serial attributes that the descriptive flexfield references and is associated with a line whose item is serial controlled and not lot controlled.
  • Flexfields for Serials
    Title: Flexfields for Serials
    The Flexfields for Serials resource manages the details of the serials that the descriptive flexfield references and is associated with a line whose item is serial controlled and not lot controlled.
  • Maximum Length: 80
    Ending serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under serial control.
  • Maximum Length: 80
    Supplier serial number for the serial range of the advanced shipment notice (ASN) line request or receipt line 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 the serial attributes that the descriptive flexfield references and is associated with a line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the details of the serials that the descriptive flexfield references and is associated with a line whose item is serial controlled and not lot controlled.
Show Source
Nested Schema : receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptRequests-lines-transactionAttachments-item-response
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • 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 advanced shipment notice (ASN) line request.
  • Title: Category
    Maximum Length: 30
    Category of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is true.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the attachment.
  • Title: Created By User Name
    Read Only: true
    Login that the user used when creating the attachment for the specification.
  • Title: Creation Date
    Read Only: true
    Date when the user created the attachment record.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that identifies the data type.
  • Title: Description
    Maximum Length: 255
    Description of the attachment for the advanced shipment notice (ASN) line request.
  • Maximum Length: 255
    Value that uniquely identifies the content server document.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Folder path of the attachment.
  • Maximum Length: 255
    Number that identifies a particular version of the content server document.
  • Title: DownloadInfo
    JSON-formatted string containing information required to programmatically retrieve a large file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Error Status Message
    Error message, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Expiration Date
    Date when the contents in the attachment for the advanced shipment notice (ASN) line request expire.
  • Title: File Contents
    Contents of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Name
    Maximum Length: 2048
    File name of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Url
    URL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request.
  • 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.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the document that is attached to the receipt header.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    Login of the user who updated the document that is attached to the receipt header.
  • Title: Last Updated By User
    Read Only: true
    Login that the user used when updating the attachment for the specification.
  • Links
  • Title: PostProcessingAction
    The name of the action that can be performed after an attachment is uploaded.
  • Title: Title
    Title of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Content Type
    Content type of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Size
    Length of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Name
    Name of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded Text
    Text of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uri
    Maximum Length: 4000
    URI (Uniform Resource Identifier) that identifies the attachment.
  • Title: Url
    Maximum Length: 4000
    URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Login that the user used when adding or modifying the attachment.
Nested Schema : receivingReceiptRequests-lines-transactionDFF-item-response
Type: object
Show Source
Links
ASNLineAttachments
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Attachments for ASN Lines resource manages attachments when creating an advance shipment notice (ASN) line request.
ASNLineDFF
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Flexfields for ASN Line Requests resource manages the details of the advance shipment notice (ASN) line requests that the descriptive flexfield references.
ASNPackingUnits
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Packing Units for the ASNs resource manages details about the packing units which are associated with the advance shipment notice (ASN) or advance shipment billing notice (ASBN) lines.
inventoryStripingDFF
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Flexfields for Inventory Striping Attributes resource manages the details of 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.
lotItemLots
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Lots for Lot Items resource manages the lot number information for a line whose item is lot controlled and not serial controlled.
lotSerialItemLots
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Lots for Lot and Serial Items resource manages the lot number information for a line whose item is both lot and serial controlled.
processingErrors
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Processing Errors resource gets the details for each error that was encountered while processing a request for advance shipment notice (ASN) creation or receipt creation.
serialItemSerials
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Serials for Serial Items resource manages the serial number information for a line whose item is serial controlled and not lot controlled.
transactionAttachments
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Attachments for Transactions resource manages attachments when creating a receipt line request.
transactionDFF
Parameters:
  • HeaderInterfaceId: $request.path.HeaderInterfaceId
  • InterfaceTransactionId: $request.path.InterfaceTransactionId
The Flexfields for Receive Transaction Requests resource manages the details of the receive transaction request that the descriptive flexfield references.
Back to Top

Examples

This example describes how to get one line.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/HeaderInterfaceId/child/lines/InterfaceTransactionId"

For example, the following command gets one line:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "InterfaceTransactionId": 300100169632593,
    "HeaderInterfaceId": 300100169632583,
    "CreatedBy": "WHSE_MGR_M1",
    "CreationDate": "2018-11-02T07:11:07.505+00:00",
    "LastUpdateDate": "2018-11-02T07:11:07.697+00:00",
    "LastUpdatedBy": "WHSE_MGR_M1",
    "TransactionType": "RECEIVE",
    "AutoTransactCode": "RECEIVE",
    "TransactionDate": "2018-11-02T07:11:07+00:00",
    "OrganizationCode": "M1",
    "OrganizationId": null,
    "ItemDescription": null,
    "ItemId": null,
    "ItemNumber": "VC110",
    "ItemRevision": null,
    "ReceiptSourceCode": "VENDOR",
    "SourceDocumentCode": "PO",
    "DocumentNumber": "1000125",
    "DocumentLineNumber": 8,
    "DocumentShipmentLineNumber": null,
    "DocumentDistributionNumber": null,
    "PODistributionId": null,
    "POHeaderId": null,
    "POLineId": null,
    "POLineLocationId": null,
    "ShipmentHeaderId": null,
    "ShipmentLineId": null,
    "ShipmentNumber": null,
    "ASNLineNumber": null,
    "TransferOrderHeaderId": null,
    "TransferOrderLineId": null,
    "TransferOrderDistributionId": null,
    "SoldtoLegalEntity": "Vision Operations",
    "SoldtoLegalEntityId": null,
    "DestinationTypeCode": null,
    "Subinventory": null,
    "Locator": null,
    "LocatorId": null,
    "Quantity": 3,
    "UnitOfMeasure": "Each",
    "UOMCode": null,
    "PrimaryQuantity": null,
    "PrimaryUOMCode": null,
    "PrimaryUnitOfMeasure": null,
    "ProcessingStatusCode": "PENDING",
    "SecondaryUOMCode": null,
    "SecondaryUnitOfMeasure": null,
    "SecondaryQuantity": null,
    "EmployeeId": null,
    "EmployeeName": null,
    "ParentTransactionId": null,
    "SourceTransactionNumber": null,
    "ParentSourceTransactionNumber": null,
    "InterfaceSourceCode": "REST",
    "InterfaceSourceLineId": null,
    "ShipToLocationCode": null,
    "ShipToLocationId": null,
    "DeliverToLocationCode": null,
    "DeliverToLocationId": null,
    "DeliverToPersonId": null,
    "DeliverToPersonName": null,
    "RoutingCode": null,
    "RoutingHeaderId": null,
    "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": null,
    "CurrencyConversionDate": null,
    "CurrencyConversionRate": null,
    "FromOrganizationCode": null,
    "FromOrganizationId": null,
    "ContainerNumber": null,
    "SubstituteItemNumber": null,
    "SubstituteItemId": null,
    "SubstituteUnorderedCode": null,
    "VendorName": null,
    "VendorId": null,
    "VendorNumber": null,
    "VendorSiteCode": null,
    "VendorSiteId": null,
    "VendorItemNumber": null,
    "BusinessUnit": null,
    "BusinessUnitId": null,
    "ConsignedLine": null,
    "ReasonId": null,
    "ReasonName": null,
    "PackingSlip": null,
    "Comments": null,
    "FromSubinventory": null,
    "FromLocator": null,
    "FromLocatorId": null,
    "TransactionStatusCode": "PENDING",
    "GroupId": 164427,
    "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/receivingReceiptRequests/300100169632583/child/lines/300100169632593",
            "name": "lines",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593",
            "name": "lines",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583",
            "name": "receivingReceiptRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/ASNPackingUnits",
            "name": "ASNPackingUnits",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/ASNLineDFF",
            "name": "ASNLineDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/serialItemSerials",
            "name": "serialItemSerials",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/transactionAttachments",
            "name": "transactionAttachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/processingErrors",
            "name": "processingErrors",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/lotItemLots",
            "name": "lotItemLots",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/ASNLineAttachments",
            "name": "ASNLineAttachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/transactionDFF",
            "name": "transactionDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632583/child/lines/300100169632593/child/lotSerialItemLots",
            "name": "lotSerialItemLots",
            "kind": "collection"
        }
    ]
}
Back to Top