Standalone Credit Memo Input

Input representation of the details required to create a standalone credit memo.

This example shows a sample request with the Ignore tax strategy.

This example shows a sample request with the ManualOverride tax strategy.

This example shows a sample request with the Calculate tax strategy for a charge line.

NameTypeDescriptionRequired or OptionalAvailable Version
billTo​ContactIdStringContact related to the credit memo.Optional62.0
billing​AccountIdStringID of the account that the credit is issued to.Required62.0
chargesStandalone Credit Memo Charge Input[]Charge lines of the credit memo. Requires at least one charge line.Required62.0
currency​IsoCodeStringISO code currency of the new credit that’s issued.Optional62.0
custom​FieldsMapCustom field values on the credit memo record, as key-value pairs.Optional68.0
descriptionStringDescription for the new credit that’s issued.Optional62.0
effective​DateStringEffective date of the credit memo. If the value isn’t specified, then it’s null.Optional62.0
external​ReferenceStringID of the external reference for the credit memo.Optional62.0
externalReference​Data​SourceStringSource of the external reference for the credit memo.Optional62.0
taxEffective​DateStringEffective date of the credit memo tax. If the value isn’t specified, then it’s null.Optional62.0
tax​StrategyStringSpecifies how tax lines must be created for the standalone credit memos.Required62.0
typeString 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.