Getting the client name in an invoice API call

Self-Hosted | v5
1

Hi, we’ve been trying to get some additional data (i.e. the client name) for a query of invoices. This is our current query:

/api/v1/invoices?client_status=unpaid&status=active&is_deleted=false&per_page=1000

However, this does not include a name in the response. Examples in the docs have an additional ‘settings’ sub-object which seems to have a company name, and I assume is included with an &include=somethinghere. How do I determine the ‘somethinghere’, and what value would I use? Or is there a better way to get the client name?

Otherwise, we’ve resorted to doing another ‘client’ request for each response from the 1st query, leading to quite a slow response time. Thanks for your help, and keep up the good work!

Kind regards,
Peter

2

Hi,

You can add &include=client to the URL to add the client to the response.

3

Awesome, thanks Hillel, that works perfectly. I must have tried ‘clients’ but not ‘client’!

1 Like