ConnectApi.CreditInvoiceInvoiceLine

Input representation of the details of the invoice lines to be credited.

PropertyTypeDescriptionRequired or OptionalAvailable Version
addressesConnectApi.CreditMemoAddressesInputRequestAddresses to be created manually for this invoice line and the overridden tax lines. These addresses are only applicable if this invoice line is using the ManualOverride tax strategy.Optional62.0
amountToCreditDoubleAmount to be credited from this invoice line.Required62.0
invoiceLineIdStringID of the invoice line record to be credited. The invoice line ID must be related to the invoice ID specified in the API request.Required62.0
isTaxOnlyCreditBooleanIndicates whether the applicable tax amount is credited for the charge or adjustment amount (true), or the applicable tax amount is credited along with the charge or adjustment amount (false). The default value is false.Optional62.0
taxEffectiveDateStringDate when the tax takes effect and the invoice line is credited.Optional62.0
taxStrategyConnectApi.TaxStrategyEnumTax strategy for crediting the invoice line. This tax strategy takes precedence over the taxStrategy property value specified in the Credit Invoice Input.Optional62.0
taxesList<ConnectApi.CreditInvoiceInvoiceLineTax>List of tax lines to be created manually for this invoice line.Required if the taxStrategy property value is ManualOverride.62.0

taxStrategy 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.