Update a charge related line

patch

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeRelatedLines/{TradeOperationChargeRelatedLineId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Related Charge Line Number
    Value that uniquely identifies the charge line number for the charge entered as related in a charge line.
  • 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.
  • 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.
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-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.
Back to Top