When managing orders in Orders module, adding the invoice to the order is a required step for its status to change to Invoiced
— which indicates that the order has been successfully completed. However, the amount which appears on the invoice does not always match the initial order amount. This may occur in the following scenarios:
- When the order amount changes due to discounts or additions.
- When order items are changed.
- When order items are returned.
In each of these cases, you must add a partial invoice, i.e., more than one invoice, to reach the total order amount.
Partial invoice behavior
Partial invoices generate the following actions in the Orders module and other VTEX systems:
- Partial invoices added to orders also result in partial settlements in the transaction. The total order amount will be updated after adding the invoice, and it corresponds to the amount settled in the VTEX payment gateway.
- The customer is automatically refunded in case there is a chargeback.
- In case an item and its value have to be removed from an order, the retailer can change the order, discounting the item's value — only if the previous invoices settle the corresponding amounts and keep the rest of the settled amount open.
- As the partial invoice only settles the amount corresponding to the invoice, requesting changes to the order amount is possible. A partial invoice keeps the transaction open.
- Orders with partial invoices cannot be canceled. If the customer wants to replace or remove items from the order, it is possible to change the order.
The partial invoices feature is available to all VTEX stores, but the partial settlement in the gateway is in beta. Besides, for partial invoices to trigger partial settlements in the transaction, it is necessary to use a connector with the Payment Provider Protocol. Legacy connectors do not support the functionality.
Sending a partial invoice
To send a partial invoice through the VTEX Admin, follow the steps below:
- In the VTEX Admin, go to Orders > All Orders, or type All Orders in the search bar at the top of the page.
- Search for the order by using the search bar or the filters.
- Click the order to access the Order details page.
- Click
Invoice
. - Click Submit single invoice.
- In the Amount field, select
Amount
. - Fill in the updated amount in the field below.
- Fill in the Billing Details information.
- Click
Save Invoice
.
After invoicing, proceed to change the order.
Once order changes have been made, you can view all the transaction events by clicking See transaction details.
The same actions can also be done using our Orders API. To do so, check out these endpoints: Register Change on Order, Invoice notification, Retrieve Payment transaction, and Update order's partial invoice (send tracking number).