Standalone Credit Memo Charge Input

Input representation of the details of the charge lines of a credit memo.
JSON example
"charges": [
    {
      "chargeAmount": 100,
      "productId": "01tR0000000njDiIAI"
    }
  ]
Properties
Name Type Description Required or Optional Available Version
addresses Credit Memo Addresses Input

Details of the billing and shipping addresses.

Optional 62.0
charge​Amount Double

Charge amount for the credit memo.

Required 62.0
description String

Description of the created credit memo charge line.

Optional 62.0
endDate String

End date of the credit memo charge line.

Optional 62.0
isTax​OnlyCredit Boolean

Indicates whether the credit is for tax only (true) or not (false).

Optional 62.0
product​Id String

ID of the product record that the credit memo is issued on.

Optional 62.0
product​Name String

Name of the product that the credit memo is issued on.

Optional 62.0
startDate String

Start date of the credit memo charge line.

Optional 62.0
taxEffective​Date String

Date from when the tax is applicable.

Optional 62.0
taxes Standalone Credit Memo Tax Input[]

List of credit memo tax lines.

Optional 62.0
taxStrategy String

Tax 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. Valid values are:

  • Ignore—Specifies that the creation of tax lines must be ignored.
  • Calculate—Specifies that tax must be calculated by using the API.
Optional 62.0
treatment​Id String

ID of the tax treatment record that’s used to calculate tax.

Optional 62.0