Get one line
get
/fscmRestApi/resources/11.13.18.05/linesToCorrect/{ParentTransactionId}
Request
Path Parameters
-
ParentTransactionId(required): integer(int64)
Value that uniquely identifies the parent transaction.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : linesToCorrect-item-response
Type:
Show Source
object
-
ASNLineNumber: number
Read Only:
true
Line number of the advanced shipment notice. -
ASNNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the advanced shipment notice for the shipment from the supplier. -
AvailableQuantity: number
Read Only:
true
Quantity that is available to correct the parent transaction. -
BackToBack: string
Read Only:
true
Maximum Length:1
Contains Y or N. Y: use back-to-back shipping. N: reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the category name. -
CategoryName: string
Read Only:
true
Maximum Length:250
Name of the category that classifies the item. A category groups items that possess similar characteristics, such as plastics, paints, inks, foods, and so on. -
ConsignedItems: string
Read Only:
true
Maximum Length:1
Contains Y, N or empty. Y: the item is consigned. N: the item is not consigned. The default value is N. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency, such as USD. -
CurrencyConversionDate: string
(date)
Read Only:
true
Date to use when determining the rates to use when calculating the currency conversion. -
CurrencyConversionRate: number
Read Only:
true
Rate to use when calculating the currency conversion. -
CurrencyConversionType: string
Read Only:
true
Maximum Length:30
Currency conversion type. -
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. -
CustomerPartyName: string
Read Only:
true
Maximum Length:360
Name of the party who purchases the product, typically for a fee. -
DestinationType: string
Read Only:
true
Maximum Length:80
Destination type for the item on the transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DestinationTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the destination type for the item on the transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DocumentDistributionNumber: number
Read Only:
true
Distribution number for the document schedule. This attribute applies only for a purchase order or transfer order. -
DocumentLineNumber: string
Read Only:
true
Maximum Length:80
Line number for the document number. -
DocumentNumber: string
Read Only:
true
Maximum Length:80
Document number that identifies one of the following: a purchase order number for a purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for a source document code of type RMA; the in-transit shipment number for a source document code of type INVENTORY; or the transfer order number for a source document code of type TRANSFER ORDER. -
DocumentScheduleNumber: string
Read Only:
true
Maximum Length:80
Schedule number for the document line number. -
DocumentType: string
Read Only:
true
Maximum Length:80
Document type according to the originating source, such as purchase order or return material authorization. The RCV_SOURCE_DOCUMENT_TYPE lookup defines the values that you can use with this attribute. -
EmployeeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the employee. -
EmployeeName: string
Read Only:
true
Maximum Length:2000
Name of the person who performed the transaction. -
FromOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices. -
FromOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices. -
GrandParentTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the grandparent transaction. -
InventoryTransactionTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory transaction type. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Revision of the item. -
LineStatus: string
Read Only:
true
Maximum Length:80
Current status of the received line, such as Received, Delivered, or Inspected. The RCV_LINE_STATUS lookup defines the values that you can use with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:60
Physical location of the warehouse that receives items. -
LocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving location. -
Locator: string
Read Only:
true
Maximum Length:4000
Name of the locator where the item currently resides. -
LocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the locator. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line. -
ParentTransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent transaction. -
ParentTransactionType: string
Read Only:
true
Maximum Length:25
Transaction type of the parent transaction. -
PODistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order distribution. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
Reason: string
Read Only:
true
Maximum Length:30
Describes the rationale for classifying a transaction. -
ReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transaction reason. -
ReceiptAdviceHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice header. -
ReceiptAdviceLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt advice line. -
ReceiptException: string
Read Only:
true
Maximum Length:1
Contains Y, N, or empty. Y: the transaction contains an exception. N or empty: no exception. -
ReceiptNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the receipt of the shipment in the warehouse. -
ReceiptSourceCode: string
Read Only:
true
Maximum Length:25
Source type of the shipment. -
Routing: string
Read Only:
true
Maximum Length:80
Routing name for the type of transaction entry that determines the steps that receive the item. The RCV_ROUTING_HEADERS lookup defines the values that you can use with this attribute. -
RoutingHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving routing. -
SecondaryAvailableQuantity: number
Read Only:
true
Quantity that is available to correct the parent transaction, using the secondary unit of measure. -
SecondaryUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Secondary unit of measure to use for the quantity that is available to correct the parent transaction. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure to use for the quantity that is available to correct the parent transaction. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line. -
SourceDocumentCode: string
Read Only:
true
Maximum Length:25
Document type of the shipment. You can use one of the following values with this attribute: PO, RMA, TRANSFER ORDER, or INVENTORY. -
Subinventory: string
Read Only:
true
Maximum Length:10
Name of the subinventory where the item currently resides. -
ToOrganizationCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the ship-to organization of the received line. -
ToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to organization of the received line. -
TOShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the transfer order shipment. -
TransactionDate: string
(date)
Read Only:
true
Date when the transaction finished. -
TransferOrderDistId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order distribution. -
TransferOrderHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location. -
TransferOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order line. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Unit of measure to use for the quantity that is available to correct the parent transaction. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure to use for the quantity that is available to correct the parent transaction. -
VendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
VendorItemNumber: string
Read Only:
true
Maximum Length:300
Number that the supplier uses to identify the item. -
VendorName: string
Read Only:
true
Maximum Length:360
Name of the party who provides a product in return for an item that might or might not require payment. -
VendorSiteCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the buying organization that conducts business with the supplier. -
VendorSiteId: integer
(int64)
Read Only:
true
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 : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt 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 : linesToCorrect-manufacturerParts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Title:
Manufacturer
Read Only:true
Maximum Length:700
Name of the manufacturer. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
Maximum Length:255
Number issued by the manufacturer that uniquely identifies the individual product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- manufacturerParts
-
Operation: /fscmRestApi/resources/11.13.18.05/linesToCorrect/{ParentTransactionId}/child/manufacturerPartsParameters:
- ParentTransactionId:
$request.path.ParentTransactionId
The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line. - ParentTransactionId:
Examples
This example describes how to get one line to correct.
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/linesToCorrect?q=ParentTransactionId=value"
For example, the following command gets line to correct for transaction 3096:
curl -u username:password "https://servername/fscmRestApi/resources/version/linesToCorrect?q=ParentTransactionId=3096"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "ToOrganizationCode": "M1", "ToOrganizationId": 207, "FromOrganizationCode": "M2", "FromOrganizationId": 209, "ItemNumber": "AS92689", "ItemId": 151, "ItemDescription": "Envoy Standard", "ItemRevision": null, "ReceiptNumber": "333", "LineStatus": "Received", "DocumentType": "Internal Requisition", "SourceDocumentCode": "REQ", "DocumentNumber": null, "DocumentLineNumber": null, "DocumentScheduleNumber": null, "DocumentDistributionNumber": null, "TransactionDate": "1999-10-18", "VendorName": null, "VendorId": null, "VendorSiteCode": null, "VendorSiteId": null, "VendorItemNumber": null, "TOShipmentNumber": null, "ASNNumber": null, "ASNLineNumber": null, "CustomerPartyName": null, "CustomerId": null, "AvailableQuantity": 0, "UOMCode": "Ea", "UnitOfMeasure": "Each", "SecondaryAvailableQuantity": null, "SecondaryUOMCode": null, "SecondaryUnitOfMeasure": null, "DestinationType": "Receiving", "DestinationTypeCode": "RECEIVING", "Location": "M1- Seattle Mfg", "LocationId": 207, "Routing": "Direct delivery", "RoutingHeaderId": 3, "POHeaderId": null, "POLineLocationId": null, "POLineId": null, "PODistributionId": null, "ShipmentHeaderId": 1905, "ShipmentLineId": 1936, "TransferOrderHeaderId": null, "TransferOrderLineId": null, "TransferOrderDistId": null, "ReceiptAdviceHeaderId": null, "ReceiptAdviceLineId": null, "ReceiptSourceCode": "INTERNAL ORDER", "ConsignedItems": "N", "BackToBack": "N", "CategoryName": "Finished Goods_91", "CategoryId": 91, "CurrencyCode": "USD", "CurrencyConversionRate": 1, "CurrencyConversionDate": null, "CurrencyConversionType": null, "InventoryTransactionTypeId": null, "ParentTransactionType": "RECEIVE", "ParentTransactionId": 3096, "GrandParentTransactionId": -1, "Reason": null, "ReasonId": null, "ReceiptException": null, "EmployeeName": "Smith, Mr. Jonathan", "EmployeeId": 57, "Subinventory": null, "Locator": null, "LocatorId": null, } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/logisticsApi/resources/version/linesToCorrect", "name": "linesToCorrect", "kind": "collection" } ], }