Jump to

• Request
• Response

Get all transfer order shipment lines

get

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeTransferOrderShipLines

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.

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>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey :Finds the transfer order shipment lines associated with the charge line with the specified primary key.
    Finder Variables:
    • TropChargeToShipLineId :Value that identifies the charge line transfer order shipment line association.
  • findChargeTransferOrderShipLines :Finds the transfer order shipment lines associated with the charge line that match the specified criteria.
    Finder Variables:
    • bindActAmtInDocCurr :Value that identifies the allocated actual amount in the document currency.
    • bindDestinationOrganization :Value that identifies the name of the organization receiving goods.
    • bindEstAmtinDocCurr :Value that identifies the allocated estimated amount in the document currency.
    • bindItemNumber :Value that identifies the item on the transfer order.
    • bindQuantityShipped :Value that identifies the quantity shipped against the transfer order line.
    • bindRequestedQuantity :Value that identifies the requested quantity on the transfer order line.
    • bindShipmentLineNum :Value that identifies the shipment line number for which landed cost charges are applied.
    • bindShipmentNumber :Value that identifies the shipment number.
    • bindSourceOrganization :Value that identifies the name of the organization transferring goods to the destination organization.
    • bindTOLineNumber :Value that identifies the transfer order line number.
    • bindTransferOrder :Value that identifies the transfer order.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • 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; 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; Nonrecoverable tax on the charge line in the invoice functional currency.
  • ActTaxInMatRequisitionBUCurrency; number; Nonrecoverable tax on the charge line in the material requisitioning BU functional currency.
  • ActTaxPERUnitInDocumentCurrency; number; Per unit nonrecoverable tax on the charge line in the trade operation currency.
  • ActTaxPERUnitInFunctionalCurrency; number; Per unit nonrecoverable tax on the charge line in the invoice functional currency.
  • ActTaxPERUnitInMatRequisitionBUCurrency; number; 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; Percentage used for charge allocation.
  • Currency; string; Currency on the transfer order.
  • CurrencyCode; string; Transfer order currency code.
  • DestinationOrganizationCode; string; Code for the organization receiving goods from the source organization.
  • DestinationOrganizationId; integer; Unique identifier for the destination organization.
  • EstAmountInChargeCurrency; number; Allocated estimated amount in the charge BU.
  • EstAmountInDocumentCurrency; number; Allocated estimated amount in the trade operation.
  • EstAmountInFunctionalCurrency; number; Allocated estimated amount in the invoice functional currency.
  • EstAmountPERUnitInChargeCurrency; number; Allocated estimated per unit amount in the charge BU currency.
  • EstAmountPERUnitInFunctionalCurrency; number; Allocated estimated per unit amount in the invoice functional currency.
  • EstAmountUnitInDocumentCurrency; number; Allocated estimated per unit amount in the trade operation.
  • EstTaxInChargeCurrency; number; Estimated nonrecoverable tax on the charge line.
  • EstTaxInDocumentCurrency; number; Estimated nonrecoverable tax on the charge line in the trade operation.
  • EstTaxInFunctionalCurrency; number; Estimated nonrecoverable tax on the charge line in the invoice functional currency.
  • EstTaxInMatRequisitionBUCurrency; number; Estimated nonrecoverable tax on the charge line in the material BU.
  • EstTaxPERUnitInChargeCurrency; number; Estimated per unit nonrecoverable tax on the charge line.
  • EstTaxPERUnitInFunctionalCurrency; number; Estimated per unit nonrecoverable tax on the charge line in the invoice functional currency.
  • EstTaxPERUnitInMatRequisitionBUCurrency; number; Estimated per unit nonrecoverable tax on the charge line in the material BU.
  • EstTaxUnitInDocumentCurrency; number; Estimated per unit nonrecoverable tax on the charge line in the trade operation.
  • EstimatedTransferPrice; number; Estimated unit price from the source organization to the destination organization in the functional currency.
  • ExtendedPrecision; integer; Value that identifies the extended precision.
  • InventoryItemId; integer; Identifier for an inventory item.
  • InventoryOrganizationId; integer; Identifier for the inventory organization.
  • ItemNumber; string; Value that identifies the item number.
  • LocationId; integer; Unique identifier of the location at which the item is delivered.
  • LocationName; string; Location to which the item is delivered.
  • MaterialRequisitionBUCurrencyCode; string; Material requisition BU currency code.
  • Precision; integer; Value that identifies the currency precision.
  • PrimaryUOMCode; string; Value that identifies the primary UOM.
  • QuantityReceived; number; Quantity on the transfer order receipt.
  • QuantityShipped; number; Quantity shipped against the transfer order line.
  • Rate; number; Value that indicates the allocation rate.
  • RequestedQuantity; number; Requested quantity on the transfer order line.
  • SecondaryQuantityReceived; number; Quantity on the transfer order receipt in the secondary UOM.
  • SecondaryQuantityShipped; number; Ordered quantity on the transfer order in the secondary UOM.
  • SecondaryRequestedQuantity; number; Requested quantity on the transfer order line in the secondary UOM.
  • ShipmentHeaderId; integer; Unique identifier of the shipment header.
  • ShipmentLineId; integer; Unique identifier of the shipment line.
  • ShipmentLineNumber; integer; Line number for the shipment for which landed cost charges are applied.
  • ShipmentNumber; string; Value that identifies the shipment number.
  • SourceOrganizationCode; string; Code for the organization transferring goods to the destination organization.
  • SourceOrganizationId; integer; Unique identifier for the organization transferring goods to the destination organization.
  • ToshiplineChargeActualId; integer; Unique identifier of the charge invoice amounts allocated to the transfer order ship line in a trade operation.
  • ToshiplineChargeEstimateId; integer; 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; Unique identifier of the trade operation charge.
  • TransferOrderId; integer; Value that uniquely identifies the transfer order.
  • TransferOrderLineId; integer; Value that uniquely identifies the transfer order line.
  • TransferOrderLineNumber; integer; Transfer order line number for the shipment.
  • TransferOrderNumber; string; Transfer order number for the shipment.
  • TropChargeToShipLineId; integer; Unique identifier for the charge line transfer order shipment line association.
  • UOMCode; string; Unit of measure for the transfer order ship line quantity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : tradeOperations-charges-chargeTransferOrderShipLines

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/tradeOperations-charges-chargeTransferOrderShipLines-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object tradeOperations-charges-chargeTransferOrderShipLines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/tradeOperations-charges-chargeTransferOrderShipLines-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : tradeOperations-charges-chargeTransferOrderShipLines-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EstTaxPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line in the material BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TropChargeToShipLineId":{
            "type":"integer",
            "description":"Unique identifier for the charge line transfer order shipment line association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ShipmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the shipment number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantityReceived":{
            "type":"number",
            "description":"Quantity on the transfer order receipt in the secondary UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestToShipLineChargeActualId":{
            "type":"integer",
            "description":"Unique identifier of the latest charge invoice amounts allocated to the transfer order ship line in a trade operation.",
            "nullable":true,
            "x-queryable":false
        },
        "EstTaxInChargeCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxInDocumentCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ToshiplineChargeEstimateId":{
            "type":"integer",
            "description":"Unique identifier of the charge amounts allocated to the transfer order ship line in a trade operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Transfer order currency code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountInChargeCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the charge BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the material BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ToshiplineChargeActualId":{
            "type":"integer",
            "description":"Unique identifier of the charge invoice amounts allocated to the transfer order ship line in a trade operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EstTaxPERUnitInFunctionalCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "type":"integer",
            "description":"Identifier for the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the transfer order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActAmountInFunctionalCurrrency":{
            "type":"number",
            "description":"Amount on the charge line in the functional currency of the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Unique identifier of the shipment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrackedQuantity":{
            "type":"number",
            "description":"Tracked quantity on the associated transfer order.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure for the transfer order ship line quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "EstimatedTransferPrice":{
            "type":"number",
            "description":"Estimated unit price from the source organization to the destination organization in the functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllocationPercentage":{
            "type":"number",
            "description":"Percentage used for charge allocation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityShipped":{
            "type":"number",
            "description":"Quantity shipped against the transfer order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "type":"number",
            "description":"Value that indicates the allocation rate.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Identifier for an inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstTaxUnitInDocumentCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line in the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActAmountPERUnitInDocumentCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the trade operation currency.",
            "nullable":true,
            "x-queryable":true
        },
        "TradeOperationChargeId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActTaxInFunctionalCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialRequisitionBUCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Material requisition BU currency code.",
            "nullable":false,
            "x-queryable":true
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"Value that identifies the currency precision.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Code for the organization transferring goods to the destination organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInDocumentCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line in the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountInDocumentCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line in the material BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"Value that identifies the extended precision.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "RequestedQuantity":{
            "title":"Requested Quantity",
            "type":"number",
            "description":"Requested quantity on the transfer order line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountUnitInDocumentCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActAmountInDocumentCurrency":{
            "type":"number",
            "description":"Amount on the charge line in the trade operation currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the destination organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActTaxPERUnitInDocumentCurrency":{
            "type":"number",
            "description":"Per unit nonrecoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Location to which the item is delivered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Code for the organization receiving goods from the source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the item number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInFunctionalCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationFactor":{
            "type":"number",
            "description":"Base factor value used for allocation.",
            "nullable":true,
            "x-queryable":true
        },
        "ActTaxPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Per unit nonrecoverable tax on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActAmountInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Amount on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ActTaxInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentLineNumber":{
            "type":"integer",
            "description":"Line number for the shipment for which landed cost charges are applied.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstAmountPERUnitInChargeCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the charge BU currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the organization transferring goods to the destination organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the primary UOM.",
            "nullable":false,
            "x-queryable":true
        },
        "EstAmountInFunctionalCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryRequestedQuantity":{
            "title":"Secondary Requested Quantity",
            "type":"number",
            "description":"Requested quantity on the transfer order line in the secondary UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestToShipLineChargeEstimateId":{
            "type":"integer",
            "description":"Unique identifier of the latest charge estimate amounts allocated to the transfer order ship line in a trade operation.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the location at which the item is delivered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the shipment header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstTaxPERUnitInChargeCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderNumber":{
            "title":"Transfer Order",
            "maxLength":50,
            "type":"string",
            "description":"Transfer order number for the shipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInFunctionalCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActAmountPERUnitInFunctionalCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantityShipped":{
            "type":"number",
            "description":"Ordered quantity on the transfer order in the secondary UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the material BU currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActAmountPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityReceived":{
            "type":"number",
            "description":"Quantity on the transfer order receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxPERUnitInFunctionalCurrency":{
            "type":"number",
            "description":"Per unit nonrecoverable tax on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderLineNumber":{
            "title":"Transfer Order Line",
            "type":"integer",
            "description":"Transfer order line number for the shipment.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top