Finance APIs

Migration guide: supplier invoice deprecations

Posted on

In today’s sprint review, we talked about some newly deprecated attributes on the supplierInvoices endpoint. We’re trying to align attribute names more closely with what they actually contain. This post is a guide for integrators who need to migrate.

Deprecated attributes

  • amount: use totalAmount instead
  • invoiceNumber: use the record ID (outside the attributes section of the JSON response) instead
  • name: not used, no replacement
  • supplierInvoicesId: use supplierInvoiceNumber instead
  • supplierName: use company instead

Action needed

If you use any of the deprecated attributes in your integration, you’ll need to switch to the supported replacement attribute. The replacement attributes are available in the API now. The deprecated attributes will remain available in the API until February 3, 2026. At that time they’ll be removed, and any integrations that try to load the deprecated attributes may throw errors or fail.

The values of the supported replacement attributes match the values of the deprecated attributes. This change only affects the names of the attributes.

If you don’t make use of any of the deprecated attributes in your integrations, no action is needed.