This API allows you to update the invoice Billing/Shipping address, VAT, custom fields, and PO number. During this operation if Billing Info (Billing Address, vat_number), Shipping info and PO number are not already present in the system the data will be added. If data is already present, the existing values will be replaced. If info is present in the system, but not passed as part of the request, the info will not be removed from the system.
Note:
This updates the invoice only; it does not change the corresponding customer or subscription details. You cannot update the VAT number if the billing address is not present in the API request. If tax would change due to an address update, the update is rejected. For AvaTax for Sales, line1–line3, city, state, state_code, and zip may be updated when the Avalara document is SUCCESS and UNCOMMITTED and a re-estimate shows unchanged tax. Updates that change country or vat_number, use line-item-level addresses, or apply to other third-party tax integrations are rejected.
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
VAT/ Tax registration number of the customer. Learn more .
An overridden value for the first two characters of the full VAT number.
Only applicable specifically for customers with billing_address
country
as XI
(which is United Kingdom - Northern Ireland
).
When you have enabled EU VAT
in 2021 or have manually enabled
the Brexit configuration, you have the option of setting billing_address
country
as XI.
That's the code for United Kingdom - Northern Ireland.
The first two characters of the VAT number in such a case is
XI
by default. However, if the VAT number was registered in UK, the value should be GB.
Set
vat_number_prefix
to GB
for such cases.
An internal comment to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Invoice PDF .
Returns
Resource object representing invoice