Credit Invoice Line Input
Input representation of the details of the invoice lines to be credited.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
addresses | Credit Memo Addresses Input[] | Addresses 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. | Optional | 62.0 |
amountToCredit | Double | Amount to be credited from this invoice line. | Required | 62.0 |
invoiceLineId | String | ID of the invoice line record to be credited. The invoice line ID must be related to the invoice ID specified in the API request. | Required | 62.0 |
isTaxOnlyCredit | Boolean | Indicates 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. | Optional | 62.0 |
taxEffectiveDate | String | Date when the tax takes effect and the invoice line is credited. | Optional | 62.0 |
taxStrategy | String | Tax strategy for crediting the invoice line. This tax strategy takes precedence over the taxStrategy property value specified in the Credit Invoice Input. | Optional | 62.0 |
taxes | Credit Invoice Line Tax Input[] | List of tax lines to be created manually for this invoice line. | Required if the taxStrategy property value is ManualOverride. | 62.0 |
Valid values are:
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.