Replaces top-level tax-related properties with improved tax modeling on Invoices, Invoice Line Items, and Credit Note Line ItemsBreaking changes

What’s new

We’re introducing a new taxes concept on Invoice Line Items and Credit Note Line Items that contains tax-related data and unifies the structure of tax objects in preparation for adding new types of tax objects. This replaces the top-level tax-related properties on the Invoice Line Item and Credit Note Line Item objects.

We’re also introducing a new total_taxes property on the Invoice and Credit Note objects for aggregated tax information.

Why is this a breaking change?

• tax_rates and tax_amounts are no longer available on the Invoice Line Item and Credit Note Line Item objects.
• total_tax_amounts is no longer available on the Invoice object.

Impact

Tax Rate IDs on Invoice Line Items and Credit Note Line Items are now nested inside the new taxes property:

• Replace line_item.tax_rates[0] with line_item.taxes[0].tax_rate_details.tax_rate (after verifying that line_item.taxes[0].type is tax_rate_details)
• Replace line_item.tax_amounts[0].amount with line_item.taxes[0].amount

Tax totals on Invoices and Credit Notes are now stored in total_taxes:

• Replace invoice.total_tax_amounts[0].amount with invoice.total_taxes[0].amount (after verifying that invoice.total_taxes[0].type is tax_rate_details)

Changes

Upgrade