ConnectApi.ChangeItemFee​InputRepresentation

Input representation for Change Item Fee Input

PropertyTypeDescriptionRequired or OptionalAvailable Version
amountDoublePositive value used to calculate the fee amount, as described by the amountType.Required57.0
amountTypeStringDescribes how the fee amount is calculated. Valid values are:
  • AmountWithTax—Value of amount is the fee amount, including tax.
  • AmountWithoutTax—Value of amount is the fee amount, not including tax. Tax is calculated on the value and added.
  • Percentage—Value of amount is a percentage. To determine the fee amount, amount is divided by 100, and then multiplied by the TotalPrice and TotalTaxAmount of the associated OrderItemSummary, prorated for the quantity being returned.
  • PercentageGross—Value of amount is a percentage. To determine the fee amount, amount is divided by 100, and then multiplied by the TotalLineAmountWithTax of the associated OrderItemSummary, prorated for the quantity being returned.
Required57.0
descriptionStringDescription of the fee.Required57.0
priceBookEntryIdStringID of the price book entry associated with the fee product.Required unless price books are optional in the org57.0
product2IdStringID of the product representing the fee.Required57.0
reasonStringReason for the fee. The value must match an entry in the OrderProductSummaryChange object’s Reason picklist.Required57.0

See Also