V2 - List Credit Notes and Customer Invoices
by Integrations SquadDeprecation 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"}]