Credit Invoice Line Input

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

JSON Example

1"invoiceLines": [
2    {
3      "invoiceLineId": "5TVR00000004SiqOBE",
4      "amountToCredit": 100,
5      "taxStrategy": "ManualOverride",
6      "taxEffectiveDate": "2021-08-01T21:22:41.000Z",
7      "taxes": [
8        {
9          "taxAmount": 15,
10          "taxName": "abc",
11          "taxCode": "taxCode",
12          "taxRate": 7
13        }
14      ],
15      "addresses": {
16        "billingAddress": {
17          "street": "1 Market St #300",
18          "city": "San Francisco",
19          "state": "CA",
20          "country": "US",
21          "postalCode": "94105",
22          "latitude": "37.789901",
23          "longitude": "-122.396923"
24        },
25        "shippingAddress": {
26          "street": "415 Mission St",
27          "city": "San Francisco",
28          "state": "CA",
29          "country": "US",
30          "postalCode": "94105",
31          "latitude": "37.789901",
32          "longitude": "-122.396923"
33        }
34      }
35    },
36    {
37      "invoiceLineId": "5TVR00000004SiqOAE",
38      "amountToCredit": 200,
39      "taxStrategy": "CopyFromInvoiceLine"
40    }
41  ]

Properties

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.