Deprecation Notice

Retrieve a draft invoice is now deprecated in favor of Retrieve a customer invoice.

For more details on this initiative, please refer to our documentation.

Breaking changes Notice

Mark a customer invoice as paid

Before, when the requested invoice was a draft the response status was 404.

Now, the following response is returned

{
  status: 422,
  error: "This endpoint is not applicable for draft invoices"
}

Before, when the requested invoice was a credit note the response status was 404.

Now, the following response is returned

{
  status: 422,
  error: "This endpoint is not applicable for credit notes"
}

Breaking changes Notice

Few changes on status code rendered due to the Merge Project for Customer Invoices Matched Transactions endpoints. For more details on this initiative, please refer to our documentation.

As a reminder it is not possible to match a transaction to a draft invoice.

List matched transactions for a customer invoice

Before, when the requested invoice was a draft, the response status code was 404.

Now this endpoint returns a 200 with an empty array.

Match a transaction to a customer invoice

Before, when the requested invoice was a draft, the response status code was 404.

Now this endpoint returns a 422 with following error message: "This endpoint is not applicable for draft invoices"

Unmatch a transaction to a customer invoice

Before, when the requested invoice was a draft, the response status code was 404.

Now this endpoint returns a 422 with following error message: "This endpoint is not applicable for draft invoices"

Breaking changes Notice

List payments for a customer invoice

Before, when the requested invoice was a draft or credit note, the response status was 404.

Now this endpoint returns a 200 with an empty array.

Deprecation Notice

Turn the draft invoice into a finalized invoice is now deprecated in favor of the new endpoint on the customer invoices resource.

For more details on this initiative, please refer to our documentation.

Deprecation Notice

The Update a draft invoice and Update a finalized invoice endpoints are now deprecated as part of the Merge Project. For more details on this initiative, please refer to our documentation.

New update endpoint

The 2 deprecated endpoints mentioned above will be replaced by a single update endpoint that works for both draft and finalized customer invoices.

The Retrieve a customer invoice endpoint is now able to retrieve both draft and finalized customer invoices.

🎉 We are happy to announce that part of the Merge Project, it is now possible to list and upload appendices for draft invoices. For more details on this initiative, please refer to our documentation.

List appendices for a customer invoice and Upload an appendix for a customer invoice endpoints previously returned a 404 response when the invoice was draft. There are now allow to list and create appendices for both draft and finalized invoices.

Deprecation Notice

The List invoice lines for a draft invoice and List invoice line sections for a draft invoice endpoints are now deprecated as part of the Merge Project. For more details on this initiative, please refer to our documentation.

List invoice lines for a customer invoice and List invoice line sections endpoints previously returned a 404 response when the invoice was draft. There are now allow to request associated resources for both draft and finalized invoices.

Deprecation Notice

The Create Draft Invoices endpoint is now deprecated as part of the Merge Project. For more details on this initiative, please refer to our documentation.

Enhanced Endpoint Functionality

The endpoint previously known as "Create a finalized invoice" has been renamed to "Create a customer invoice" and now supports the creation of both draft and finalized invoices through a unified interface.

New Functionality

A new boolean attribute draft has been introduced, which allows you to specify whether the invoice should be created as a draft. When set to true, the invoice will be created in draft status.

Limitations for Draft Invoices

Please note the following restrictions for draft invoices:

• It is not possible to set a transaction_reference on draft invoices
• It is not possible to set invoice_linesimputation_dates on draft invoices

Backward Compatibility

Important: This update maintains full backward compatibility with your existing implementation for creating finalized invoices. No changes to your current code are required if you're only creating finalized invoices.