Jump to

• Request
• Response

Update one transfer order shipment line

patch

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

Request

Path Parameters

• TradeOperationChargeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TradeOperationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• AllocationFactor: number
  Base factor value used for allocation.
• EstimatedTransferPrice: number
  Estimated unit price from the source organization to the destination organization in the functional currency.
• 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.
• Rate: number
  Value that indicates the allocation rate.

{
    "type":"object",
    "properties":{
        "ActAmountInDocumentCurrency":{
            "type":"number",
            "description":"Amount on the charge line in the trade operation currency.",
            "nullable":true
        },
        "ActAmountInFunctionalCurrrency":{
            "type":"number",
            "description":"Amount on the charge line in the functional currency of the invoice.",
            "nullable":true
        },
        "ActAmountInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Amount on the charge line in the material requisitioning BU functional currency.",
            "nullable":true
        },
        "ActAmountPERUnitInDocumentCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the trade operation currency.",
            "nullable":true
        },
        "ActAmountPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the material requisitioning BU functional currency.",
            "nullable":true
        },
        "ActTaxInDocumentCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the trade operation currency.",
            "nullable":true
        },
        "AllocationFactor":{
            "type":"number",
            "description":"Base factor value used for allocation.",
            "nullable":true
        },
        "EstimatedTransferPrice":{
            "type":"number",
            "description":"Estimated unit price from the source organization to the destination organization in the functional currency.",
            "nullable":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
        },
        "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
        },
        "Rate":{
            "type":"number",
            "description":"Value that indicates the allocation rate.",
            "nullable":true
        }
    }
}

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-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.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the transfer order ship line quantity.
• UOMCode: string
  Maximum Length: 3

  Unit of measure for the transfer order ship line quantity.

{
    "type":"object",
    "properties":{
        "ActAmountInDocumentCurrency":{
            "type":"number",
            "description":"Amount on the charge line in the trade operation currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ActAmountInFunctionalCurrrency":{
            "type":"number",
            "description":"Amount on the charge line in the functional currency of the invoice.",
            "nullable":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
        },
        "ActAmountPERUnitInDocumentCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the trade operation currency.",
            "nullable":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
        },
        "ActAmountPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Per unit amount on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ActTaxInDocumentCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "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
        },
        "ActTaxInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Nonrecoverable tax on the charge line in the material requisitioning BU functional currency.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "ActTaxPERUnitInFunctionalCurrency":{
            "type":"number",
            "description":"Per unit nonrecoverable tax on the charge line in the invoice functional currency.",
            "nullable":true,
            "readOnly":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
        },
        "AllocationFactor":{
            "type":"number",
            "description":"Base factor value used for allocation.",
            "nullable":true,
            "x-queryable":true
        },
        "AllocationPercentage":{
            "type":"number",
            "description":"Percentage used for charge allocation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the transfer order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Transfer order currency code.",
            "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
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the destination organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstAmountInChargeCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the charge BU.",
            "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
        },
        "EstAmountInFunctionalCurrency":{
            "type":"number",
            "description":"Allocated estimated amount in the invoice functional currency.",
            "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
        },
        "EstAmountPERUnitInChargeCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the charge BU currency.",
            "nullable":true,
            "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
        },
        "EstAmountPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the material BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EstAmountUnitInDocumentCurrency":{
            "type":"number",
            "description":"Allocated estimated per unit amount in the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInChargeCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line.",
            "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
        },
        "EstTaxInFunctionalCurrency":{
            "type":"number",
            "description":"Estimated nonrecoverable tax on the charge line in the invoice functional currency.",
            "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
        },
        "EstTaxPERUnitInChargeCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line.",
            "nullable":true,
            "readOnly":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
        },
        "EstTaxPERUnitInMatRequisitionBUCurrency":{
            "type":"number",
            "description":"Estimated per unit nonrecoverable tax on the charge line in the material BU.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "EstimatedTransferPrice":{
            "type":"number",
            "description":"Estimated unit price from the source organization to the destination organization in the functional currency.",
            "nullable":true,
            "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
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Identifier for an inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the item number.",
            "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
        },
        "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
        },
        "LocationName":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Location to which the item is delivered.",
            "nullable":false,
            "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
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the primary UOM.",
            "nullable":false,
            "x-queryable":true
        },
        "QuantityReceived":{
            "type":"number",
            "description":"Quantity on the transfer order receipt.",
            "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
        },
        "RequestedQuantity":{
            "title":"Requested Quantity",
            "type":"number",
            "description":"Requested quantity on the transfer order line.",
            "nullable":false,
            "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
        },
        "SecondaryQuantityShipped":{
            "type":"number",
            "description":"Ordered quantity on the transfer order in the secondary UOM.",
            "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
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the shipment header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Unique identifier of the shipment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ShipmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the shipment number.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "TrackedQuantity":{
            "type":"number",
            "description":"Tracked quantity on the associated transfer order.",
            "nullable":false,
            "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
        },
        "TransferOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "TransferOrderNumber":{
            "title":"Transfer Order",
            "maxLength":50,
            "type":"string",
            "description":"Transfer order number for the shipment.",
            "nullable":false,
            "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
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure for the transfer order ship line quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the transfer order ship line quantity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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