Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update API docs (#2641)

Browse Source 
* fix permissions

* Api update
This commit is contained in:
David Bomba 2019-01-31 08:20:22 +11:00 committed by GitHub
parent aefe133ba0
commit dc49fad81a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.rst
View File

@ -27,15 +27,13 @@ For invoices, quotes, tasks and payments simply change the object type.
curl -X GET "ninja.test/api/v1/invoices" -H "X-Ninja-Token: TOKEN"
You can search clients by their email address or id number and invoices by their invoice number, status and type. (Check `Constants.php </app/Constants.php/>`_ for valid values of status and type.)
You can search clients by their email address or id number and invoices by their invoice number.
.. code-block:: shell
curl -X GET "ninja.test/api/v1/clients?email=<value>" -H "X-Ninja-Token: TOKEN"
curl -X GET "ninja.test/api/v1/clients?id_number=<value>" -H "X-Ninja-Token: TOKEN"
curl -X GET "ninja.test/api/v1/invoices?invoice_number=<value>" -H "X-Ninja-Token: TOKEN"
curl -X GET "ninja.test/api/v1/invoices?status_id=<value>" -H "X-Ninja-Token: TOKEN"
curl -X GET "ninja.test/api/v1/invoices?invoice_type_id=<value>" -H "X-Ninja-Token: TOKEN"
To load a single record specify the Id in the URL.