1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Trade Operations
  5. Charges

Get all trade operation charges

get

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

Request

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

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

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • 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 trade operation charges according to the trade operation charge identifier as the primary key.
      Finder Variables:
      • TradeOperationChargeId; integer; Value that uniquely identifies the trade operation charge.
    • findCharges: Finds trade operation charges according to the specified attributes.
      Finder Variables:
      • bindActualAmount; number; Actual amount on the charge line in the trade operation currency.
      • bindAllocationBasis; string; Basis for allocating charges in a trade operation.
      • bindChargeBU; string; Requisitioning business unit that incurs the charge.
      • bindChargeBasis; string; Basis for estimating charges in a trade operation.
      • bindChargeCurrencyCode; string; Transaction currency in which the trade operation charge is entered.
      • bindChargeLineStatus; string; Value that indicates the status of the charge line.
      • bindChargeName; string; Name of the charge for which the estimates and actuals are entered.
      • bindChargeReferenceAvailable; string; Search parameter to include trade operation charges with charge references.
      • bindChargeSupplier; string; Supplier on the charge line.
      • bindEstimatedAmount; number; Estimated amount on the charge line in the trade operation currency.
      • bindItemNumber; string; Item on the purchase orders associated to the charges.
      • bindMissingInvoices; string; Value that identifies trade operation charges with missing invoices.
      • bindOrderedQty; number; Quantity ordered in the purchase orders associated to the charges.
      • bindPOAmount; string; Amount in the purchase orders associated to the charges.
      • bindPONumber; string; Number that identifies the purchase orders associated to the charges.
      • bindServicePONumber; string; Number that identifies the service purchase order for the charge line.
      • bindShipToLocation; string; Ship to Location of the purchase orders associated to the charges.
      • bindTaxApplicable; string; Value that identifies trade operation charges with tax.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActualAmountInTradeOperationCurrency; number; Actual amount on the charge line in the trade operation currency.
    • ActualNonrecoverableTaxInTradeOperationCurrency; number; Actual non-recoverable tax amount on the charge line in the trade operation currency.
    • AutoTaxCalculationFlag; boolean; Contains one of the following values: true or false. If true, then enable automatic tax calculation on the charge line. If false, then do not enable automatic tax calculation on the charge line. The default is false.
    • ChargeAllocationBasis; string; Basis for allocation of charges to purchase order schedules. Values include Equally, Quantity, Volume, Weight, Item Value, and Manual allocation factor. A list of accepted values is defined in the lookup type FND_LOOKUPS.
    • ChargeAllocationBasisBaseUOM; string; Base unit of measure to be used where allocation basis is quantity, weight, or volume.
    • ChargeBU; string; Value that uniquely identifies the business unit associated with the trade operation charge.
    • ChargeBUId; integer; Requisitioning business unit that incurs the charge.
    • ChargeBasis; string; Basis for estimating charges. Values include Aggregate, Fixed per unit, Percentage of item price, Percentage of other charges, Variable per unit, and Variable percentage of Item Price. A list of accepted values is defined in the lookup type FND_LOOKUPS.
    • ChargeBasisUOM; string; Unit of measure that is used when the charge basis is per unit.
    • ChargeCurrency; string; Transaction currency in which the charge is entered.
    • ChargeCurrencyConversionDate; string; Date when the charge amounts are converted from charge currency to other currency amounts. The default value is creation date of the trade operation charge line.
    • ChargeCurrencyConversionRateType; string; Type of charge currency conversion rate defaulted from the trade operation header. You have an option to override the conversion type for each charge line in a trade operation.
    • ChargeCurrencyConversionType; string; Type of charge currency conversion rate defaulted from the trade operation header. You have an option to override the conversion type for each charge line in a trade operation.
    • ChargeDescription; string; Description of the trade operation charge.
    • ChargeId; integer; Value that uniquely identifies the trade operation charge.
    • ChargeLineNumber; integer; Number that identifies the charge line entered in a trade operation.
    • ChargeLineStatusCode; string; Abbreviation that uniquely identifies the status of the charge line. Values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation.
    • ChargeLineStatusMeaning; string; Indicates the meaning of the charge line status.
    • ChargeName; string; Name of the charge for which the estimates and actuals are entered.
    • ChargeNameNew; string; Name of the charge for which the estimates and actuals are entered.
    • ChargeReferenceAvailable; string; Value that indicates that the charge reference is available.
    • ChargeServicePOLine; string; Number that identifies the service purchase order for the charge line.
    • ChargeServicePONumber; string; Number that identifies the service purchase order line for the charge line.
    • ChargeServicePOSchedule; string; Number that identifies the service purchase order schedule for the charge line.
    • ChargeSupplier; string; Supplier on the charge line.
    • ConversionType; string; Type of charge currency conversion rate defaulted from the trade operation header. You have an option to override the conversion type for each charge line in a trade operation.
    • EstimatedAmountinChargeCurrency; number; Estimated amount on the charge line in the charge currency.
    • EstimatedAmountinTradeOperationCurrency; number; Estimated amount on the charge line in the trade operation currency.
    • EstimatedNonrecoverableTaxinChargeCurrency; number; Estimated non-recoverable tax amount on the charge line in the charge currency.
    • EstimatedNonrecoverableTaxinFunctionalCurrency; number; Estimated non-recoverable tax amount on the charge line in the functional currency.
    • EstimatedTotalAmountinFunctionalCurrency; number; Estimated total amount on the charge line in the functional currency.
    • EstimatedTotalAmountinTradeOperationCurrency; number; Estimated total amount on the charge line in the trade operation currency.
    • FirstPartyTaxRegistrationNumber; integer; Number that identifies the first party tax registration on the transaction.
    • ObjectVersionNumber; integer; Number of times the charge line was changed.
    • ProductFiscalClassification; string; Value that indicates the name of the fiscal product classification that determines the tax.
    • Rate; number; Rate to be applied to the purchase order schedules to calculate the charge estimates.
    • ServicePOFlag; boolean; Contains one of the following values. Yes: charge line gets the amount from a service purchase order. No: charge line does not get the amount from a service purchase order. The default value is No.
    • ServicePOLineNumberofCharge; string; Number that identifies the service purchase order for the charge line.
    • ServicePONumberofCharge; string; Number that identifies the service purchase order line for the charge line.
    • ServicePOScheduleofCharge; string; Number that identifies the service purchase order schedule for the charge line.
    • SupplierId; integer; Value that uniquely identifies the supplier rendering the service.
    • SupplierSiteId; integer; Supplier site on the charge line.
    • SupplierSiteforCharge; string; Value that uniquely identifies the supplier site rendering the service.
    • SupplierforCharge; string; Supplier on the charge line.
    • TaxApplicableFlag; boolean; Contains one of the following values: true or false. If true, then indicate tax applicability on the charge line. If false, then do not indicate tax applicability on the charge line. The default value is true.
    • TaxClassificationCode; string; Abbreviation that identifies the tax classification that determines the tax.
    • TaxDocumentFiscalClassification; string; Value that indicates the classification of the fiscal document that determines the tax.
    • TaxDocumentType; string; Type of classification of the document for the charge line that determines the tax.
    • TaxFinalDischargeLocationId; integer; Value that indicates the classification of the fiscal tax document that determines the tax.
    • TaxLineIntendedUse; string; Purpose for which a product may be used for tax calculation.
    • TaxLineType; string; Type of tax line classification for the charge line.
    • TaxProductCategory; string; Product-related fiscal classification defined in Oracle Fusion Tax.
    • TaxProductType; string; Type of the product. This is a read-only attribute with value SERVICES.
    • TaxStatus; string; Text that indicates the meaning of tax status.
    • TaxStatusCode; string; Status of tax processing on the charge line.
    • TaxTransactionBusinessCategory; string; Category to derive the transaction classification for tax authority, which is used to categorize a transaction for tax.
    • TaxType; string; Type of tax on the charge line.
    • TaxationCountryCode; string; Value that identifies the country that determines the tax. This attribute is used for restricting the list of values for trx_business_category and other values.
    • TentativeFlag; boolean; Contains one of the following values: true or false. If true, then tax is in draft and not included in inventory valuation. If false, then tax is not in draft. The default value is false.
    • ThirdPartyTaxRegistrationNumber; integer; Number that identifies the third party tax registration on the transaction that determines the tax.
    • TrackMissingInvoicesFlag; boolean; Contains one of the following values. Yes: trade operation charge line has missing invoices. No: charge line include invoices. The default value is No.
    • TradeOperationChargeId; integer; Value that uniquely identifies the trade operation charge.
    • UserDefinedFiscalClassification; string; Name of the user-defined fiscal classification that determines the tax.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : tradeOperations-charges
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : tradeOperations-charges-item-response
Type: object
Show Source
Nested Schema : Charge Invoice Associations
Type: array
Title: Charge Invoice Associations
The Charge Invoice Associations resource gets information about the invoice associated with a charge line.
Show Source
Nested Schema : Charge Purchase Order Schedules
Type: array
Title: Charge Purchase Order Schedules
The Charge Purchase Order Schedules resource gets information about the purchase order schedules associated with a charge line.
Show Source
Nested Schema : Charge References
Type: array
Title: Charge References
The Charge References resource gets information about the charge references associated with a charge line.
Show Source
Nested Schema : Charge Related Lines
Type: array
Title: Charge Related Lines
The Charge Related Lines resource gets information about the related charge lines for a charge line.
Show Source
Nested Schema : Charge Transfer Order Shipment Lines
Type: array
Title: Charge Transfer Order Shipment Lines
Transfer order shipment lines which are associated with the charge line for the allocation of landed cost charges.
Show Source
Nested Schema : tradeOperations-charges-chargeInvoiceAssociations-item-response
Type: object
Show Source
Nested Schema : tradeOperations-charges-chargePurchaseOrderSchedules-item-response
Type: object
Show Source
  • Title: Allocated Actual Amount in Trade Operation Currency
    Read Only: true
    Actual amount on the charge line in the trade operation currency.
  • Title: Allocated Actual Amount in Functional Currency
    Read Only: true
    Actual amount on the charge line in the functional currency.
  • Title: Allocated Actual Amount in Material Requisition BU Currency
    Read Only: true
    Actual amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual per Unit Amount in Trade Operation Currency
    Read Only: true
    Actual per unit amount on the charge line in the trade operation currency.
  • Title: Allocated Actual per Unit Amount in Functional Currency
    Read Only: true
    Actual per unit amount on the charge line in the functional currency.
  • Title: Allocated Actual per Unit Amount in Material Requisition BU Currency
    Read Only: true
    Actual per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Actual NonRecoverable Tax in Functional Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Actual NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Functional Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocation Base Factor
    Base factor value used for charge allocation.
  • Title: Allocation Currency
    Maximum Length: 15
    Currency used for charge allocation.
  • Title: Allocation Percentage
    Percentage used for charge allocation.
  • Title: Allocation Rate
    Rate to be applied to purchase order schedules for deriving the charge estimates.
  • Title: Delivered-to Inventory Organization Name
    Read Only: true
    Maximum Length: 240
    Name of the inventory organization to which the item is delivered.
  • Title: Delivered-To Inventory Organization ID
    Read Only: true
    Value that uniquely identifies the inventory organization to which the item is delivered.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 80
    Destination type on the purchase order.
  • Title: Allocated Estimate Amount in Charge Currency
    Read Only: true
    Estimated amount on the charge line in the charge currency.
  • Title: Allocated Estimate Amount in Trade Operation Currency
    Read Only: true
    Estimated amount on the charge line in the trade operation currency.
  • Title: Allocated Estimate Amount in Functional Currency
    Read Only: true
    Estimated amount on the charge line in the functional currency.
  • Title: Allocated Estimate Amount in Material Requisition BU Currency
    Read Only: true
    Estimated amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate per Unit Amount in Charge Currency
    Read Only: true
    Estimated per unit amount on the charge line in the charge currency.
  • Title: Allocated Estimate per Unit Amount in Trade Operation Currency
    Read Only: true
    Estimated per unit amount on the charge line in the trade operation currency.
  • Title: Allocated Estimate per Unit Amount in Functional Currency
    Read Only: true
    Estimated per unit amount on the charge line in the functional currency.
  • Title: Allocated Estimate per Unit Amount in Material Requisition BU Currency
    Read Only: true
    Estimated per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Estimate NonRecoverable Tax in Functional Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Estimate NonRecoverable Tax in Material Requisitioning BU Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Charge Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the charge currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Functional Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate NonRecoverable Tax in Charge Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the charge currency.
  • Title: Item ID
    Read Only: true
    Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 300
    Item on the purchase order schedule.
  • Title: Landed Cost PO Schedule ID
    Value that uniquely identifies the purchase order schedule for landed cost.
  • Links
  • Title: Ordered Quantity
    Quantity on the purchase order schedule.
  • Title: Purchase Order Header ID
    Read Only: true
    Value that uniquely identifies the purchase order header.
  • Title: Item Price
    Item price on the purchase order.
  • Title: Purchase Order Line ID
    Read Only: true
    Value that uniquely identifies the purchase order line.
  • Title: Purchase Order Line Location ID
    Read Only: true
    Value that uniquely identifies the purchase order shipment schedule.
  • Title: Purchase Order Line
    Read Only: true
    Maximum Length: 40
    Number that identifies the line in the purchase order.
  • Title: Purchase Order
    Read Only: true
    Maximum Length: 40
    Number that identifies the material purchase order for the landed cost estimate.
  • Maximum Length: 3
    Value that identifies the primary unit of measure for the purchase order schedule quantity.
  • Title: Ordered Quantity (Secondary UOM)
    Ordered quantity on the purchase order in the primary unit of measure.
  • Title: Ordered Quantity (Secondary UOM)
    Ordered quantity on the purchase order in the secondary unit of measure.
  • Title: PO Schedule Amount
    Read Only: true
    Amount on the purchase order schedule line.
  • Title: PO Schedule Functional Currency Amount
    Read Only: true
    Functional currency amount on the purchase order schedule line.
  • Title: Purchase Order Schedule
    Read Only: true
    Maximum Length: 40
    Number that identifies the schedule of the material purchase order line used for the landed cost estimate.
  • Maximum Length: 3
    Value that identifies the secondary unit of measure for the purchase order schedule quantity.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Business Unit for Trade Operation can be based on Purchase Order schedules or Transfer Order
  • Title: Procurement Business Unit ID
    Read Only: true
    Value that uniquely identifies the procurement business unit for the material purchase order schedule.
  • Title: Profit Center BU
    Read Only: true
    Maximum Length: 240
    Profit center business unit on the purchase order schedule.
  • Title: Profit Center BU ID
    Read Only: true
    Value that uniquely identifies the profit center business unit for the material purchase order schedule.
  • Title: Receipt Quantity
    Read Only: true
    Received quantity corresponding to the purchase order schedule.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Requisitioning business unit on the purchase order schedule.
  • Title: Requisitioning BU ID
    Read Only: true
    Value that uniquely identifies the requisitioning business unit for the material purchase order schedule.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 240
    Location to which the item is delivered.
  • Title: Ship-To Location ID
    Read Only: true
    Value that uniquely identifies the location to which the item is delivered.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Supplier on the purchase order.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Supplier site on the purchase order.
  • Title: Supplier Site ID
    Read Only: true
    Value that uniquely identifies the supplier site on the purchase order.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 25
    Unit of measure for the purchase order schedule quantity.
  • Title: UOM Type
    Maximum Length: 30
    Value that identifies the unit of measure used for charge allocation.
Nested Schema : tradeOperations-charges-chargeReferences-item-response
Type: object
Show Source
Nested Schema : tradeOperations-charges-chargeRelatedLines-item-response
Type: object
Show Source
  • Title: Charge BU
    Read Only: true
    Maximum Length: 240
    Value that indicates the requisitioning business unit that incurs the charge.
  • Title: Related Charge Line Number
    Value that uniquely identifies the charge line number for the charge entered as related in a charge line.
  • Title: Charge Line Status Meaning
    Read Only: true
    Maximum Length: 80
    Value that indicates the meaning of the charge line status.
  • Title: Charge Line Status
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the status of the charge line. Values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation.
  • Title: Related Charge Name
    Read Only: true
    Maximum Length: 80
    Name of the charge for the related charge line entered in a charge line.
  • Title: Charge Currency
    Read Only: true
    Maximum Length: 15
    Transaction currency in which the charge is entered.
  • Title: Include item value
    Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.
  • Links
  • Title: Percentage of Item Value
    Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.
  • Title: Related Charge Line ID
    Value that uniquely identifies the related charge line for a trade operation charge.
  • Title: Related Charge Line Percentage
    Percent for each of the related charge line based on which the charge line amount will be derived.
  • Title: Total Amount
    Read Only: true
    Estimated total amount on the charge line.
  • Title: Trade Operation Charge ID
    Value that uniquely identifies the trade operation charge.
  • Title: Trade Operation Charge Related Line ID
    Value that uniquely identifies the trade operation charge related line.
Nested Schema : tradeOperations-charges-chargeTransferOrderShipLines-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all trade operation charges.

Example 1 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/charges"

Example 1 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": null,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "PC_OTHER_CHARGE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 4,
"ChargeLineStatusCode": "REQ_REALLOC",
"ChargeLineStatusMeaning": "Requires reallocation",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 188.25,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 188.25,
"EstimatedAmountinTradeOperationCurrency": null,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": null,
"EstimatedAmountinFunctionalCurrency": null,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": null,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591700,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ...]
  },
  ...
  ],
  "count" : 18,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ... ]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation that are successfully allocated:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeLineStatus=Successfully+allocated"

Example 2 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": false,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "AGGREGATE",
"ChargeBasisUOM": null,
"ChargeBUId": 911,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "EUR",
"ChargeCurrencyConversionDate": "2018-05-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 6,
"ChargeLineStatusCode": "ALLOCATED",
"ChargeLineStatusMeaning": "Successfully allocated",
"ChargeId": 300100071793255,
"ChargeName": "SS_Handling",
"ChargeDescription": "SS_Handling",
"ChargeReferenceAvailable": "Yes",
"EstimatedAmountinChargeCurrency": 500,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 500,
"EstimatedAmountinTradeOperationCurrency": 374.408,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": 374.408,
"EstimatedAmountinFunctionalCurrency": 500,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": 500,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 2675,
"SupplierSiteforCharge": "35",
"TaxApplicableFlag": false,
"TentativeFlag": false,
"TradeOperationChargeId": 300100130453707,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : 
 [ 
 ...
 ]
 ],
  "count" : 5,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ... ]
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation that are for Vision Corporation business unit:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeBU=Vision+Services"

Example 3 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": false,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "AGGREGATE",
"ChargeBasisUOM": null,
"ChargeBUId": 911,
"ChargeBU": "Vision Services",
"ChargeCurrency": "EUR",
"ChargeCurrencyConversionDate": "2018-05-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 6,
"ChargeLineStatusCode": "ALLOCATED",
"ChargeLineStatusMeaning": "Successfully allocated",
"ChargeId": 300100071793255,
"ChargeName": "SS_Handling",
"ChargeDescription": "SS_Handling",
"ChargeReferenceAvailable": "Yes",
"EstimatedAmountinChargeCurrency": 500,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 500,
"EstimatedAmountinTradeOperationCurrency": 374.408,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": 374.408,
"EstimatedAmountinFunctionalCurrency": 500,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": 500,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 2675,
"SupplierSiteforCharge": "35",
"TaxApplicableFlag": false,
"TentativeFlag": false,
"TradeOperationChargeId": 300100130453707,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ... ]
  }, 
  ...
  ],
  "count" : 18,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 4 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation of type Miscellaneous:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeName=Miscellaneous"

Example 4 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": false,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "AGGREGATE",
"ChargeBasisUOM": null,
"ChargeBUId": 911,
"ChargeBU": "Vision Services",
"ChargeCurrency": "EUR",
"ChargeCurrencyConversionDate": "2018-05-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 6,
"ChargeLineStatusCode": "ALLOCATED",
"ChargeLineStatusMeaning": "Successfully allocated",
"ChargeId": 300100071793255,
"ChargeName": "Miscellaneous",
"ChargeDescription": "SS_Handling",
"ChargeReferenceAvailable": "Yes",
"EstimatedAmountinChargeCurrency": 500,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 500,
"EstimatedAmountinTradeOperationCurrency": 374.408,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": 374.408,
"EstimatedAmountinFunctionalCurrency": 500,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": 500,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 2675,
"SupplierSiteforCharge": "35",
"TaxApplicableFlag": false,
"TentativeFlag": false,
"TradeOperationChargeId": 300100130453707,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ...],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ... ]
}

Example 5 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation whose charge basis is PC_OTHER_CHARGE:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeBasis=PC_OTHER_CHARGE"

Example 5 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": null,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "PC_OTHER_CHARGE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 4,
"ChargeLineStatusCode": "REQ_REALLOC",
"ChargeLineStatusMeaning": "Requires reallocation",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 188.25,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 188.25,
"EstimatedAmountinTradeOperationCurrency": null,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": null,
"EstimatedAmountinFunctionalCurrency": null,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": null,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591700,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ...]
  }, ...
  ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 6 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation with Supplier PennyPack Systems:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeSupplier=Advanced+Network+Devices"

Example 6 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": null,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "PC_OTHER_CHARGE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 4,
"ChargeLineStatusCode": "REQ_REALLOC",
"ChargeLineStatusMeaning": "Requires reallocation",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 188.25,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 188.25,
"EstimatedAmountinTradeOperationCurrency": null,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": null,
"EstimatedAmountinFunctionalCurrency": null,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": null,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591700,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ... ]
  }, 
  ...
  ],
  "count" : 6,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 7 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation whose Charge Currency is USD:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindChargeCurrency=USD"

Example 7 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": null,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "PC_OTHER_CHARGE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 4,
"ChargeLineStatusCode": "REQ_REALLOC",
"ChargeLineStatusMeaning": "Requires reallocation",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 188.25,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 188.25,
"EstimatedAmountinTradeOperationCurrency": null,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": null,
"EstimatedAmountinFunctionalCurrency": null,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": null,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591700,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ... ]
  }, 
  ...
  ],
  "count" : 5,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 8 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation whose Allocation Bases is QUANTITY:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindAllocationBasis=QUANTITY"

Example 8 Response Body

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

{
  "items" : [ {
"ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": true,
"ChargeAllocationBasis": "QUANTITY",
"ChargeAllocationBasisBaseUOM": "EA",
"ChargeBasis": "AGGREGATE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 2,
"ChargeLineStatusCode": "ALLOCATED",
"ChargeLineStatusMeaning": "Successfully allocated",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 1000,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 1000,
"EstimatedAmountinTradeOperationCurrency": 1000,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": 1000,
"EstimatedAmountinFunctionalCurrency": 1000,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": 1000,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591692,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": "SUCCESS",
"TaxStatus": "Success",
"TaxationCountryCode": "US",
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": "PURCHASE_TRANSACTION",
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ... ]
  }, 
  ...
  ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 9 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation which are Missing Invoices associated:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/Charges?finder=findCharges;bindMissingInvoices=Y"

Example 9 Response Body

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

{
  "items" : [ {
""ActualAmountinTradeOperationCurrency": null,
"ActualNonrecoverableTaxinTradeOperationCurrency": null,
"AutoTaxCalculationFlag": null,
"ChargeAllocationBasis": "EQUALLY",
"ChargeAllocationBasisBaseUOM": null,
"ChargeBasis": "PC_OTHER_CHARGE",
"ChargeBasisUOM": null,
"ChargeBUId": 204,
"ChargeBU": "Vision Corporation",
"ChargeCurrency": "USD",
"ChargeCurrencyConversionDate": "2015-12-11",
"ChargeCurrencyConversionRateType": "Corporate",
"ChargeLineNumber": 4,
"ChargeLineStatusCode": "REQ_REALLOC",
"ChargeLineStatusMeaning": "Requires reallocation",
"ChargeId": 1,
"ChargeName": "Freight",
"ChargeDescription": "The charge incurred on shipping the goods from one location to another.",
"ChargeReferenceAvailable": "No",
"EstimatedAmountinChargeCurrency": 188.25,
"EstimatedNonrecoverableTaxinChargeCurrency": null,
"EstimatedTotalAmountinChargeCurrency": 188.25,
"EstimatedAmountinTradeOperationCurrency": null,
"EstimatedNonrecoverableinTradeOperationCurrency": null,
"EstimatedTotalAmountinTradeOperationCurrency": null,
"EstimatedAmountinFunctionalCurrency": null,
"EstimatedNonrecoverableTaxinFunctionalCurrency": null,
"EstimatedTotalAmountinFunctionalCurrency": null,
"Rate": null,
"ServicePOFlag": false,
"ServicePONumberofCharge": null,
"ServicePOLineNumberofCharge": null,
"ServicePOScheduleofCharge": null,
"SupplierId": 21,
"SupplierforCharge": "PennyPack Systems",
"SupplierSiteId": 1969,
"SupplierSiteforCharge": "FRESNO",
"TaxApplicableFlag": true,
"TentativeFlag": false,
"TradeOperationChargeId": 300100085591700,
"TaxLineIntendedUse": null,
"TrackMissingInvoicesFlag": true,
"TaxStatusCode": null,
"TaxStatus": null,
"TaxationCountryCode": null,
"TaxDocumentFiscalClassification": null,
"TaxDocumentType": "CHARGE_ESTIMATE",
"FirstPartyTaxRegistrationNumber": null,
"TaxClassificationCode": null,
"TaxLineType": "SERVICES",
"TaxProductCategory": null,
"TaxProductType": "SERVICES",
"ThirdPartyTaxRegistrationNumber": null,
"TaxTransactionBusinessCategory": null,
"TaxType": "TAX_ON_CHARGE",
"UserDefinedFiscalClassification": null,
"TaxFinalDischargeLocationId": null,
"ProductFiscalClassification": null,
"LocationOfFinalDischarge": null,
    "links" : [ ... ]
  }, 
  ...
  ],
  "count" : 18,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ ...]
}

Example 10 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation which are associated to POs for Item ZCML-Plain-Asset1:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/charges?finder=findCharges;bindItemNumber=ZCML-Plain-Asset1"

Example 10 Response Body

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

{
  "items" : [ {
    "ActualAmountInTradeOperationCurrency" : null,
    "ActualNonrecoverableTaxInTradeOperationCurrency" : null,
    "AutoTaxCalculationFlag" : null,
    "ChargeAllocationBasis" : "EQUALLY",
    "ChargeAllocationBasisBaseUOM" : null,
    "ChargeBasis" : "PC_OTHER_CHARGE",
    "ChargeBasisUOM" : null,
    "ChargeBUId" : 204,
    "ChargeBU" : "Vision Corporation",
    "ChargeCurrency" : "USD",
    "ChargeCurrencyConversionDate" : "2018-04-13",
    "ChargeCurrencyConversionRateType" : "Corporate",
    "ChargeLineNumber" : 4,
    "ChargeLineStatusCode" : "REQ_REALLOC",
    "ChargeLineStatusMeaning" : "Requires reallocation",
    "ChargeId" : 1,
    "ChargeName" : "Freight",
    "ChargeDescription" : "The charge incurred on shipping the goods from one location to another.",
    "ChargeReferenceAvailable" : "No",
    "EstimatedAmountinChargeCurrency" : 556.3404,
    "EstimatedNonrecoverableTaxinChargeCurrency" : null,
    "EstimatedTotalAmountinChargeCurrency" : 556.3404,
    "EstimatedAmountinTradeOperationCurrency" : null,
    "EstimatedNonrecoverableinTradeOperationCurrency" : null,
    "EstimatedTotalAmountinTradeOperationCurrency" : null,
    "EstimatedAmountinFunctionalCurrency" : null,
    "EstimatedNonrecoverableTaxinFunctionalCurrency" : null,
    "EstimatedTotalAmountinFunctionalCurrency" : null,
    "Rate" : null,
    "ServicePOFlag" : false,
    "ServicePONumberofCharge" : null,
    "ServicePOLineNumberofCharge" : null,
    "ServicePOScheduleofCharge" : null,
    "SupplierId" : 999992000322170,
    "SupplierforCharge" : "Green Corp.",
    "SupplierSiteId" : 999992000342462,
    "SupplierSiteforCharge" : "POZ12655",
    "TaxApplicableFlag" : true,
    "TentativeFlag" : false,
    "TradeOperationChargeId" : 300100125234081,
    "TaxLineIntendedUse" : null,
    "TrackMissingInvoicesFlag" : false,
    "TaxStatusCode" : null,
    "TaxStatus" : null,
    "TaxationCountryCode" : null,
    "TaxDocumentFiscalClassification" : null,
    "TaxDocumentType" : "CHARGE_ESTIMATE",
    "FirstPartyTaxRegistrationNumber" : null,
    "TaxClassificationCode" : null,
    "TaxLineType" : "SERVICES",
    "TaxProductCategory" : null,
    "TaxProductType" : "SERVICES",
    "ThirdPartyTaxRegistrationNumber" : null,
    "TaxTransactionBusinessCategory" : null,
    "TaxType" : "TAX_ON_CHARGE",
    "UserDefinedFiscalClassification" : null,
    "TaxFinalDischargeLocationId" : null,
    "ProductFiscalClassification" : null,
    "LocationOfFinalDischarge" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081",
      "name" : "charges",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081",
      "name" : "charges",
      "kind" : "item"
    }, {

Example 11 cURL Command

Use the following cURL command to submit a request on the REST resource to get all trade operation charge details for one trade operation which have POs associated for Item ZCML-Plain-Asset1 and purchase order number is VFC1003648:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/charges?finder=findCharges;bindItemNumber=ZCML-Plain-Asset1,bindPONumber=VFC1003648"

Example 11 Response Body

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

{
  "items" : [ {
    "ActualAmountInTradeOperationCurrency" : null,
    "ActualNonrecoverableTaxInTradeOperationCurrency" : null,
    "AutoTaxCalculationFlag" : null,
    "ChargeAllocationBasis" : "EQUALLY",
    "ChargeAllocationBasisBaseUOM" : null,
    "ChargeBasis" : "PC_OTHER_CHARGE",
    "ChargeBasisUOM" : null,
    "ChargeBUId" : 204,
    "ChargeBU" : "Vision Corporation",
    "ChargeCurrency" : "USD",
    "ChargeCurrencyConversionDate" : "2018-04-13",
    "ChargeCurrencyConversionRateType" : "Corporate",
    "ChargeLineNumber" : 4,
    "ChargeLineStatusCode" : "REQ_REALLOC",
    "ChargeLineStatusMeaning" : "Requires reallocation",
    "ChargeId" : 1,
    "ChargeName" : "Freight",
    "ChargeDescription" : "The charge incurred on shipping the goods from one location to another.",
    "ChargeReferenceAvailable" : "No",
    "EstimatedAmountinChargeCurrency" : 556.3404,
    "EstimatedNonrecoverableTaxinChargeCurrency" : null,
    "EstimatedTotalAmountinChargeCurrency" : 556.3404,
    "EstimatedAmountinTradeOperationCurrency" : null,
    "EstimatedNonrecoverableinTradeOperationCurrency" : null,
    "EstimatedTotalAmountinTradeOperationCurrency" : null,
    "EstimatedAmountinFunctionalCurrency" : null,
    "EstimatedNonrecoverableTaxinFunctionalCurrency" : null,
    "EstimatedTotalAmountinFunctionalCurrency" : null,
    "Rate" : null,
    "ServicePOFlag" : false,
    "ServicePONumberofCharge" : null,
    "ServicePOLineNumberofCharge" : null,
    "ServicePOScheduleofCharge" : null,
    "SupplierId" : 999992000322170,
    "SupplierforCharge" : "Green Corp.",
    "SupplierSiteId" : 999992000342462,
    "SupplierSiteforCharge" : "POZ12655",
    "TaxApplicableFlag" : true,
    "TentativeFlag" : false,
    "TradeOperationChargeId" : 300100125234081,
    "TaxLineIntendedUse" : null,
    "TrackMissingInvoicesFlag" : false,
    "TaxStatusCode" : null,
    "TaxStatus" : null,
    "TaxationCountryCode" : null,
    "TaxDocumentFiscalClassification" : null,
    "TaxDocumentType" : "CHARGE_ESTIMATE",
    "FirstPartyTaxRegistrationNumber" : null,
    "TaxClassificationCode" : null,
    "TaxLineType" : "SERVICES",
    "TaxProductCategory" : null,
    "TaxProductType" : "SERVICES",
    "ThirdPartyTaxRegistrationNumber" : null,
    "TaxTransactionBusinessCategory" : null,
    "TaxType" : "TAX_ON_CHARGE",
    "UserDefinedFiscalClassification" : null,
    "TaxFinalDischargeLocationId" : null,
    "ProductFiscalClassification" : null,
    "LocationOfFinalDischarge" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081",
      "name" : "charges",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081",
      "name" : "charges",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704",
      "name" : "tradeOperations",
      "kind" : "item"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ServicePOScheduleLOV",
      "name" : "ServicePOScheduleLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ProductFiscClassificationsLOV",
      "name" : "ProductFiscClassificationsLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/InputTaxClassificationsLOV",
      "name" : "InputTaxClassificationsLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ThirdPtyTaxRegNumLOV",
      "name" : "ThirdPtyTaxRegNumLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/TaxApplicableLOV",
      "name" : "TaxApplicableLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/RequisitioningBULOV",
      "name" : "RequisitioningBULOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ProductTypesLOV",
      "name" : "ProductTypesLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/TaxDocumentTypeLOV",
      "name" : "TaxDocumentTypeLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/UnitOfMeasureCodeLOV",
      "name" : "UnitOfMeasureCodeLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/SupplierSiteLOV",
      "name" : "SupplierSiteLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/TaxationCountriesLOV",
      "name" : "TaxationCountriesLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/TentativeLOV",
      "name" : "TentativeLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ServicePOLineLOV",
      "name" : "ServicePOLineLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ServicePOHeaderLOV",
      "name" : "ServicePOHeaderLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ProductCategoriesLOV",
      "name" : "ProductCategoriesLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/XlaEventClassLOV",
      "name" : "XlaEventClassLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/LineStatusLOV",
      "name" : "LineStatusLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ChargeBasisLOV",
      "name" : "ChargeBasisLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/LineIntendedUseLOV",
      "name" : "LineIntendedUseLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/SupplierLOV",
      "name" : "SupplierLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/ChargeNameLOV",
      "name" : "ChargeNameLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/FirstPtyTaxRegNumLOV",
      "name" : "FirstPtyTaxRegNumLOV",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/charges/300100125234081/lov/FinalDischargeLocationLOV",
      "name" : "FinalDischargeLocationLOV",
      "kind" : "collection"
    }, {
Back to Top