deprecated
V2 - List Draft and Finalized customer invoices
March 27th, 2025 by Integrations Squad
Deprecation Notice
The Listing 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 "List finalized invoices" has been renamed to "List customer invoices" and now supports listing both draft and finalized invoices through a unified interface.
⚠️ Transitional Behavior
To ensure backward compatibility during the transition period:
- Current default behavior: The endpoint returns only finalized invoices by default.
- Future default behavior: At the end of the transition period (may 15th 2025), the endpoint will return all invoices (both finalized and draft) by default.
New Filtering Capability
A new filter parameter for the draft attribute is now available, allowing to specifically filter for draft or finalized invoices.
During the deprecation period, if you need to retrieve both draft and finalized invoices, you will need to make separate requests using the appropriate filters:
# Filter to get all draft invoices
[{"field": "draft", "operator": "eq", "value": "true"}]
# Filter to get all finalized invoices
[{"field": "draft", "operator": "eq", "value": "false"}]
# Filter to get all draft invoices
[{"field": "draft", "operator": "eq", "value": "true"}]
# Filter to get all finalized invoices
[{"field": "draft", "operator": "eq", "value": "false"}]