API v1/recurring_invoices status=active returns completed.

[CarrnellTech]

Setup

• Version: v5.8.3
• Environment: Docker

Interface

• Flutter [X]
• React [X]
• Both [X]
• API [X]

Checklist

• Can you replicate the issue on our v5 demo site https://demo.invoiceninja.com or https://react.invoicing.co/demo?
  • Password is required to test on the demo site.
• Have you searched existing issues?
  • Yes, read below for more.
• Have you reported this to Slack/forum before posting?
  • No
• Have you inspected the logs in storage/logs/laravel.log for any errors?
  • Yes, no errors.

Describe the bug

Setting the parameter status to active it also returns completed recurring invoices.

Steps To Reproduce

First create a recurring invoice, start it, send it, and set its remaining cycles to 0.
On Flutter set the status filter to Active.
On React set the status filter to Active.
Use the API endpoint /api/v1/recurring_invoices?per_page=5000&status=active.

Expected Behavior

Completed, by definition is no longer active and is now past tense. My goal is to only return recurring invoices that are still active via API.

[turbo124]

active in this instance does not mean that the recurring invoice has additional cycles, it only means that the document is not archived / deleted.

[CarrnellTech]

Personally, I find that a little odd. (I am not an accountant or anything of the sort, so I will be safe and say this is entirely an opinion).

(See screenshots below for contexts.)

Under the filter dropdowns you have the expected Active / Archived / Deleted which makes sense in terms of that filter. However in the other drop down, Completed will return completed only but, active returns completed and active invoices.

Active in this case does not feel as an inclusive term since the list recurring invoices can say the status active and also change to say completed. To be clear, I do understand the differences and why it says active vs a different word. Its a simple word of which describes perfectly the state the entry is in. On the UI seeing the words active and completed separately makes perfect sense to me. Its when its filtering either through the API or the UI that I find that little bit of oddity.

Upon writing this I have also found that using status=active also returns pending invoices, but in the UI it does not. So its possible I am confusing status to be the dropdown on the right when it is actually the drop down on the left. It is possible that in my effort to understand the API docs that I may be using the wrong query parameter to filter the results. Is there a query parameter that will not return completed, but will return active and/or pending?

Additional Notes:
I have a need to connect an accounting platform of ours to invoice ninja and I am looking to return only ones that are still active in terms of on going and not ended.

I am concluding that I am expected to make an API request, filter the results with possible the meta of remaining_cycles or a last_sent_date vs next_send_date.

[CarrnellTech]

Upon further research on the topic. I decided to test in the React interface and open a browser inspector to see what API calls it makes. I discovered that when making calls client_status is the meta value I might be looking for. I completely skipped that due to it saying "client" assuming it was referring to a client/company/person connected to the recurring invoice. Wording here is a tad odd.

If this is in fact for filtering recurring invoice by its current status outside of display status then the following is a list of possible bugs or confusions I have found:

• client_status=completed returns no results.
• client_status=paused returns no results.
• client_status=all returns completed, active, and pending.
• client_status=pending returns completed, active, and pending.
• client_status=active returns completed, active, and pending.
• client_status=fbjfd it returns completed, active, and pending.

Screenshots below for when attempting to do this in the React UI as well: (Can be recreated on https://react.invoicing.co/demo.)

[turbo124]

i've checked a fix in for the completed status recurring invoices.