Deprecation Notice

The Listing Credit Notes 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 "List customer invoices" supports listing both customer invoices and credit notes through a unified interface.

⚠️ Transitional Behavior

To ensure backward compatibility during the transition period:

• Current default behavior: The endpoint returns only finalized customer invoices by default (excluding credit notes and draft)
• Future default behavior: At the end of the transition period (may 15th 2025), the endpoint will return all invoices (customer invoices and credit notes, draft and not draft) by default.

New Filtering Capability

A new filter parameter for the credit_note is now available, allowing to specifically filter for credit notes or customer invoices.

During the deprecation period, if you need to retrieve both customer invoices and credit notes , you will need to make separate requests using the appropriate filters:

# Filter to get all credit notes
[{"field": "credit_note", "operator": "eq", "value": "true"}]

# Filter to get all customer invoices (excluding credit notes)
[{"field": "credit_note", "operator": "eq", "value": "false"}]

Deprecation Notice

Update a finalized credit note is now deprecated in favor of Update a customer invoice.

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

Breaking changes Notice

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

As a reminder it is not possible to link categories to a draft invoice.

List categories of 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.

Categorize 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"

Deprecation Notice

List categories of a credit note and Categorize a credit note is now deprecated in favor of List categories of a customer invoice and Categorize a customer invoice. For more details on this initiative, please refer to our documentation.

Enhanced Endpoint Functionality

The endpoint "Turn the draft invoice into a finalized invoice." now also supports finalizing draft credit notes. For more details on this initiative, please refer to our documentation.

Deprecation Notice

The Create a credit notes 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 "Create a customer invoice" now supports the creation of credit notes (using negative amounts).

New Functionality

A credited invoice can also be linked using the credited_invoice_id attribute.

Backward Compatibility

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

Deprecation Notice

Delete draft invoice is now deprecated in favor of URL To confirm Delete draft invoice new url.

This endpoint is only applicable for draft customer invoices or credit note.e

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

Deprecation Notice

List categories of a credit note is now deprecated in favor of List categories of a customer invoice.

Categorize a credit note is now deprecated in favor of Categorize a customer invoice.

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

Deprecation Notice

Import a credit note with file attached is now deprecated in favor of Import an invoice with file attached.

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

Deprecation Notice

Retrieve a credit note is now deprecated in favor of Retrieve a customer invoice.

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