ConnectApi.CreditInvoiceInputRequest

Input representation of the details of the request to create a credit memo.

PropertyTypeDescriptionRequired or OptionalAvailable Version
descriptionStringDescription for the credit memo to be created.Optional62.0
effective​DateStringDate when the credit memo takes effect.Optional62.0
invoice​LinesList<ConnectApi.CreditInvoiceInvoiceLine>List of the invoice lines to be credited. The invoice line IDs must be related to the invoice ID specified in the API request. If invoice lines aren’t specified, the API request results in an error.Required62.0
taxEffective​DateStringDate when the tax takes effect to recalculate the taxes.Optional62.0
tax​StrategyConnectApi.TaxStrategyEnumTax strategy to be applied across invoice lines. You can override the tax strategy at the individual invoice line level or at the tax line level.Required62.0
typeConnectApi.CreditMemoTypeEnumType of credit memo to be created. Valid values are Posted and Draft. Specify Draft as a value in your request to create draft credit memos.Optional62.0

tax​Strategy values:

  • Ignore—Specifies that the creation of tax lines must be ignored.
  • ManualOverride—Specifies that the provided tax values must be considered for taxes.
  • CopyFromInvoiceLine—Specifies that tax values must be copied from the invoice line.
  • Calculate—Specifies that tax must be calculated by using the API.