Standalone Credit Memo Charge Input

Input representation of the details of the charge lines of a credit memo.

JSON Example 

1"charges": [
2    {
3      "chargeAmount": 100,
4      "productId": "01tR0000000njDiIAI"
5    }
6  ]

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
addressesCredit Memo Addresses InputDetails of the billing and shipping addresses.Optional62.0
charge​AmountDoubleCharge amount for the credit memo.Required62.0
custom​FieldsMapCustom field values on each credit memo line in the charges list, as key-value pairs.Optional68.0
descriptionStringDescription of the created credit memo charge line.Optional62.0
endDateStringEnd date of the credit memo charge line.Optional62.0
isTax​OnlyCreditBooleanIndicates whether the credit is for tax only (true) or not (false).Optional62.0
product​IdStringID of the product record that the credit memo is issued on.Optional62.0
product​NameStringName of the product that the credit memo is issued on.Optional62.0
startDateStringStart date of the credit memo charge line.Optional62.0
taxEffective​DateStringDate from when the tax is applicable.Optional62.0
taxesStandalone Credit Memo Tax Input[]List of credit memo tax lines.Optional62.0
taxStrategyStringTax strategy to be applied to this credit memo charge line, child treatment lines, and tax lines. You can override the tax strategy at the individual credit memo lines or tax lines level.Optional62.0
treatment​IdStringID of the tax treatment record that’s used to calculate tax.Optional62.0

Valid values are:

  • Ignore—Specifies that the creation of tax lines must be ignored.
  • Manual Override—Specifies that the provided tax values must be considered for taxes.
  • Calculate—Specifies that tax must be calculated by using the API.