Get one transfer order shipment line
get
/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeTransferOrderShipLines/{chargeTransferOrderShipLinesUniqID}
Request
Path Parameters
-
TradeOperationChargeId(required): integer(int64)
Value that uniquely identifies the trade operation charge.
-
TradeOperationId(required): integer(int64)
Value that uniquely identifies the trade operation.
-
chargeTransferOrderShipLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Charge Transfer Order Shipment Lines resource and used to uniquely identify an instance of Charge Transfer Order Shipment Lines. The client should not generate the hash key value. Instead, the client should query on the Charge Transfer Order Shipment Lines collection resource in order to navigate to a specific instance of Charge Transfer Order Shipment Lines to get the hash key.
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
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context: string
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: string
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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : tradeOperations-charges-chargeTransferOrderShipLines-item-response
Type:
Show Source
object
-
ActAmountInDocumentCurrency: number
Amount on the charge line in the trade operation currency.
-
ActAmountInFunctionalCurrrency: number
Amount on the charge line in the functional currency of the invoice.
-
ActAmountInMatRequisitionBUCurrency: number
Amount on the charge line in the material requisitioning BU functional currency.
-
ActAmountPERUnitInDocumentCurrency: number
Per unit amount on the charge line in the trade operation currency.
-
ActAmountPERUnitInFunctionalCurrency: number
Read Only:
true
Per unit amount on the charge line in the invoice functional currency. -
ActAmountPERUnitInMatRequisitionBUCurrency: number
Per unit amount on the charge line in the material requisitioning BU functional currency.
-
ActTaxInDocumentCurrency: number
Nonrecoverable tax on the charge line in the trade operation currency.
-
ActTaxInFunctionalCurrency: number
Read Only:
true
Nonrecoverable tax on the charge line in the invoice functional currency. -
ActTaxInMatRequisitionBUCurrency: number
Read Only:
true
Nonrecoverable tax on the charge line in the material requisitioning BU functional currency. -
ActTaxPERUnitInDocumentCurrency: number
Read Only:
true
Per unit nonrecoverable tax on the charge line in the trade operation currency. -
ActTaxPERUnitInFunctionalCurrency: number
Read Only:
true
Per unit nonrecoverable tax on the charge line in the invoice functional currency. -
ActTaxPERUnitInMatRequisitionBUCurrency: number
Read Only:
true
Per unit nonrecoverable tax on the charge line in the material requisitioning BU functional currency. -
AllocationFactor: number
Base factor value used for allocation.
-
AllocationPercentage: number
Read Only:
true
Percentage used for charge allocation. -
Currency: string
Title:
Currency Name
Read Only:true
Maximum Length:80
Currency on the transfer order. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Transfer order currency code. -
DestinationOrganizationCode: string
Read Only:
true
Maximum Length:18
Code for the organization receiving goods from the source organization. -
DestinationOrganizationId: integer
(int64)
Read Only:
true
Unique identifier for the destination organization. -
EstAmountInChargeCurrency: number
Read Only:
true
Allocated estimated amount in the charge BU. -
EstAmountInDocumentCurrency: number
Read Only:
true
Allocated estimated amount in the trade operation. -
EstAmountInFunctionalCurrency: number
Read Only:
true
Allocated estimated amount in the invoice functional currency. -
EstAmountInMatRequisitionBUCurrency: number
Read Only:
true
Allocated estimated amount in the material BU currency. -
EstAmountPERUnitInChargeCurrency: number
Read Only:
true
Allocated estimated per unit amount in the charge BU currency. -
EstAmountPERUnitInFunctionalCurrency: number
Read Only:
true
Allocated estimated per unit amount in the invoice functional currency. -
EstAmountPERUnitInMatRequisitionBUCurrency: number
Read Only:
true
Allocated estimated per unit amount in the material BU. -
EstAmountUnitInDocumentCurrency: number
Read Only:
true
Allocated estimated per unit amount in the trade operation. -
EstimatedTransferPrice: number
Estimated unit price from the source organization to the destination organization in the functional currency.
-
EstTaxInChargeCurrency: number
Read Only:
true
Estimated nonrecoverable tax on the charge line. -
EstTaxInDocumentCurrency: number
Read Only:
true
Estimated nonrecoverable tax on the charge line in the trade operation. -
EstTaxInFunctionalCurrency: number
Read Only:
true
Estimated nonrecoverable tax on the charge line in the invoice functional currency. -
EstTaxInMatRequisitionBUCurrency: number
Read Only:
true
Estimated nonrecoverable tax on the charge line in the material BU. -
EstTaxPERUnitInChargeCurrency: number
Read Only:
true
Estimated per unit nonrecoverable tax on the charge line. -
EstTaxPERUnitInFunctionalCurrency: number
Read Only:
true
Estimated per unit nonrecoverable tax on the charge line in the invoice functional currency. -
EstTaxPERUnitInMatRequisitionBUCurrency: number
Read Only:
true
Estimated per unit nonrecoverable tax on the charge line in the material BU. -
EstTaxUnitInDocumentCurrency: number
Read Only:
true
Estimated per unit nonrecoverable tax on the charge line in the trade operation. -
ExtendedPrecision: integer
(int32)
Title:
Extended Precision
Read Only:true
Value that identifies the extended precision. -
InventoryItemId: integer
(int64)
Read Only:
true
Identifier for an inventory item. -
InventoryOrganizationId: integer
(int64)
Read Only:
true
Identifier for the inventory organization. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Value that identifies the item number. -
LatestToShipLineChargeActualId: integer
Unique identifier of the latest charge invoice amounts allocated to the transfer order ship line in a trade operation.
-
LatestToShipLineChargeEstimateId: integer
Unique identifier of the latest charge estimate amounts allocated to the transfer order ship line in a trade operation.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
true
Unique identifier of the location at which the item is delivered. -
LocationName: string
Title:
Display Name
Read Only:true
Maximum Length:240
Location to which the item is delivered. -
MaterialRequisitionBUCurrencyCode: string
Maximum Length:
15
Material requisition BU currency code. -
Precision: integer
(int32)
Title:
Precision
Read Only:true
Value that identifies the currency precision. -
PrimaryUOMCode: string
Maximum Length:
3
Value that identifies the primary UOM. -
QuantityReceived: number
Read Only:
true
Quantity on the transfer order receipt. -
QuantityShipped: number
Read Only:
true
Quantity shipped against the transfer order line. -
Rate: number
Value that indicates the allocation rate.
-
RequestedQuantity: number
Title:
Requested Quantity
Read Only:true
Requested quantity on the transfer order line. -
SecondaryQuantityReceived: number
Read Only:
true
Quantity on the transfer order receipt in the secondary UOM. -
SecondaryQuantityShipped: number
Read Only:
true
Ordered quantity on the transfer order in the secondary UOM. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested Quantity
Read Only:true
Requested quantity on the transfer order line in the secondary UOM. -
ShipmentHeaderId: integer
(int64)
Read Only:
true
Unique identifier of the shipment header. -
ShipmentLineId: integer
(int64)
Unique identifier of the shipment line.
-
ShipmentLineNumber: integer
(int64)
Read Only:
true
Line number for the shipment for which landed cost charges are applied. -
ShipmentNumber: string
Read Only:
true
Maximum Length:30
Value that identifies the shipment number. -
SourceOrganizationCode: string
Read Only:
true
Maximum Length:18
Code for the organization transferring goods to the destination organization. -
SourceOrganizationId: integer
(int64)
Read Only:
true
Unique identifier for the organization transferring goods to the destination organization. -
ToshiplineChargeActualId: integer
(int64)
Read Only:
true
Unique identifier of the charge invoice amounts allocated to the transfer order ship line in a trade operation. -
ToshiplineChargeEstimateId: integer
(int64)
Read Only:
true
Unique identifier of the charge amounts allocated to the transfer order ship line in a trade operation. -
TrackedQuantity: number
Tracked quantity on the associated transfer order.
-
TradeOperationChargeId: integer
(int64)
Unique identifier of the trade operation charge.
-
TransferOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order. -
TransferOrderLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transfer order line. -
TransferOrderLineNumber: integer
(int32)
Title:
Transfer Order Line
Read Only:true
Transfer order line number for the shipment. -
TransferOrderNumber: string
Title:
Transfer Order
Read Only:true
Maximum Length:50
Transfer order number for the shipment. -
TropChargeToShipLineId: integer
(int64)
Unique identifier for the charge line transfer order shipment line association.
-
UOMCode: string
Maximum Length:
3
Unit of measure for the transfer order ship line quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.