Invoices API improvements

Convenience fees

In the invoices API endpoints, we have introduced the capability of adding convenience fees. In the Create an invoice (POST /v3/invoices), Replace an invoice (PUT /v3/invoices/{invoice_id} ), and Update an invoice (PATCH /v3/invoices/{invoice_id} ) requests, you can now set convenience fees in the convenienceFee object. To set the convenience fee, the new enableCardPayment field must be set as true.

In the convenienceFee object, you can now set a convenience fee percentage that you want to charge your customer when they pay the invoice using a card.

Sales tax

In the invoices API endpoints, we have introduced the capability of adding a sales tax to taxable invoice line items. In the Create an invoice (POST /v3/invoices), Replace an invoice (PUT /v3/invoices/{invoice_id} ), and Update an invoice (PATCH /v3/invoices/{invoice_id} ) requests, you can now set a sales tax with the new salesTaxItemId field.

You can set salesTaxItemId as the BILL-generated ID of the SALES_TAX item. The value begins with 0ii. The tax rate is applied to all the invoice line items set as taxable. You can set up a SALES_TAX percentage item with POST /v3/classifications/items.

Invoice PDF

In the invoices API endpoints, we have introduced the invoicePdfId field. In all the invoices API responses, you can now get the BILL-generated ID of the invoice PDF.

The invoice PDF is sent as an email attachment when you send an invoice to a customer. The invoice PDF also appears when the customer clicks the invoice payment link to complete the invoice payment.

See POST /v3/invoices in the API reference for more information.