Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-06-23 20:00:33 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add update client example to API docs

Browse Source
This commit is contained in:
Hillel Coren 2017-04-24 18:44:08 +03:00
parent bc94d02e4a
commit 1b01beebe5
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/api.rst
View File

@ -85,6 +85,15 @@ You can also update a client by specifying a value for ‘id’. Next, here’s
If the product_key is set and matches an existing record the product fields will be auto-populated. If the email field is set then we’ll search for a matching client. If no matches are found a new client will be created. If the product_key is set and matches an existing record the product fields will be auto-populated. If the email field is set then we’ll search for a matching client. If no matches are found a new client will be created.
Options
^^^^^^^
The following options are available when creating an invoice.
- ``email_invoice``: Email the invoice to the client.
- ``auto_bill``: Attempt to auto-bill the invoice using stored payment methods or credits.
- ``paid``: Create a payment for the defined amount.
Updating Data Updating Data
""""""""""""" """""""""""""
@ -96,12 +105,6 @@ Updating Data
-d '{"name":"test", "contacts":[{"id": 1, "first_name": "test"}]}' -d '{"name":"test", "contacts":[{"id": 1, "first_name": "test"}]}'
-H "X-Ninja-Token: TOKEN" -H "X-Ninja-Token: TOKEN"
Options
^^^^^^^
- ``email_invoice``: Email the invoice to the client.
- ``auto_bill``: Attempt to auto-bill the invoice using stored payment methods or credits.
- ``paid``: Create a payment for the defined amount.
Emailing Invoices Emailing Invoices
""""""""""""""""" """""""""""""""""