If you see an Invoice Item is still having a positive balance when the Outstanding Balance of the whole Invoice is already zero.
Here is an example. This is an Invoice with Outstanding Balance 0.
When getting the balance of one of the Invoice Item, it is still having a positive value 50:
This is because there are other items in the invoices with a negative amount and the Application Rule in the tenant has been configured as Proration mode.
Other items in the invoice and their balance:
Application Rule:
With the above rule is set to Proration, Zuora only applies the payment to positive invoice items and tax items.
If we look at the invoice items and tax items below, we can see the negative tax items are not paid, which have negative balances. With those negative tax items, we can't fully pay all the invoice items, otherwise the total payment amount will exceed the invoice balance.
If you would like to write off the balance of each item to 0, then the proposed solution is to create a 0 amount credit memo and apply it to the invoice via the below REST API.
https://www.zuora.com/developer/api-reference/#operation/PUT_ApplyCreditMemo
With this REST API, you could specify which credit memo item should be applied to which invoice item or tax item respectively.
e.g.
{
"effectiveDate": "2020-05-09",
"invoices": [
{
"amount": 0,
"invoiceId": "2c92c09a6dd8b245016dee67254e3ded",
"items": [
{
"amount": 50,
"creditMemoItemId": "2c92c0fa71f5a8200171f9648d1a3654",
"invoiceItemId": "2c92c09a6dd8b245016dee67255a3def"
},
{
"amount": 3.13,
"creditMemoItemId": "2c92c0fa71f5a8200171f9648d2d3655",
"taxItemId": "2c92c09a6dd8b245016dee6725453deb"
},
{
"amount": -50,
"creditMemoItemId": "2c92c0fa71f5a8200171f9648cf73652",
"invoiceItemId": "2c92c09a6dd8b245016dee67255a3dee"
},
{
"amount": -3.13,
"creditMemoItemId": "2c92c0fa71f5a8200171f9648d073653",
"taxItemId": "2c92c09a6dd8b245016dee6725453dec"
}
]
}
]
}
Then the balance of each invoice item & tax item will be 0.
