# Requests

Collection of possible requests

# Create [POST]

<span style="background-color: #c2e0f4;">**https://api.neuro-admin.com/invoice/create**</span> \[POST\]

<table border="1" id="bkmrk-amount-int-smallest-" style="border-collapse: collapse; width: 100%; height: 489.125px;"><tbody><tr style="height: 29.7969px;"><td style="width: 33.2922%; height: 29.7969px;">currency\_id</td><td style="width: 33.2922%; height: 29.7969px;">String</td><td style="width: 33.2922%; height: 29.7969px;">EUR, SEK, USD… etc</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2922%; height: 46.5938px;">invoice\_date (optional)</td><td style="width: 33.2922%; height: 46.5938px;">String</td><td style="width: 33.2922%; height: 46.5938px;">The invoice date (if not have will get the sending date)</td></tr><tr style="height: 36.1875px;"><td style="width: 33.2922%; height: 36.1875px;">due\_date (optional)  
</td><td style="width: 33.2922%; height: 36.1875px;">String</td><td style="width: 33.2922%; height: 36.1875px;">The due date  
</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">client\_data (optional)</td><td style="width: 33.2922%; height: 63.3906px;">object \*</td><td style="width: 33.2922%; height: 63.3906px;">The client data as name, address, ... and where to send and how</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">invoice\_rows (optional)</td><td style="width: 33.2922%; height: 63.3906px;">array of object \*\*</td><td style="width: 33.2922%; height: 63.3906px;">Array with invoice row object (item, description, quantity, unitCost, tax)</td></tr></tbody></table>

\* client data object structure:

<div id="bkmrk-%C2%A0-%C2%A0-%7B-%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%22name%22"><div> {</div><div> "name": "Test client 01", // (string) optional</div><div> "address_line1": "Street Nowhere, 3", // (string) optional</div><div> "address_line2": null, // (string) optional</div><div> "zip_code": "12345", // (string) optional</div><div> "city": "My City", // (string) optional</div><div> "country": "My Country", // (string) optional</div><div> "vat_number": "123456798", // (string) optional</div><div> "sendVia": "Email", // (string) optional (only one of the following: "Email" or "Sms")</div><div> "sendTo": "johndoe@test.com" // (string) optional</div><div> }</div></div>\*\* array of object containing the datas for every invoice row

  
 {  
 "item": "Item name", // (string) optional but mandatory if not have description  
 "description": "description", // (string) optional but mandatory if not have item  
 "quantity": 3.1, // (float) optional  
 "unitCost": 10.50, // (float) optional  
 "tax": 12 // (float) optional  
 }

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/scaled-1680-/Jc5image.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/Jc5image.png)

# Retrieve [POST]

<span style="background-color: #c2e0f4;">**<span style="background-color: #c2e0f4;">https://api.neuro-admin.com/invoice</span>/retrieve**</span> \[POST\]

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">invoice\_id</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">The invoice\_id received when creating a checkout object</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/scaled-1680-/2WWimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/2WWimage.png)

# Update [POST]

<span style="background-color: #c2e0f4;">**<span style="background-color: #c2e0f4;">https://api.neuro-admin.com/invoice</span>/update**</span>\[POST\]

The update can be used on objects that only have status "draft".

Pay attention: datas not passed will be reset or delete in case of invoice rows.

<table border="1" id="bkmrk-amount-int-smallest-" style="border-collapse: collapse; width: 100%; height: 489.125px;"><tbody><tr><td style="width: 33.2922%;">invoice\_id</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">The invoice\_id in the creation response</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2922%; height: 29.7969px;">currency\_id</td><td style="width: 33.2922%; height: 29.7969px;">String</td><td style="width: 33.2922%; height: 29.7969px;">EUR, SEK, USD… etc</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2922%; height: 46.5938px;">invoice\_date (optional)</td><td style="width: 33.2922%; height: 46.5938px;">String</td><td style="width: 33.2922%; height: 46.5938px;">The invoice date (if not have will get the sending date)</td></tr><tr style="height: 36.1875px;"><td style="width: 33.2922%; height: 36.1875px;">due\_date (optional)  
</td><td style="width: 33.2922%; height: 36.1875px;">String</td><td style="width: 33.2922%; height: 36.1875px;">The due date  
</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">client\_data (optional)</td><td style="width: 33.2922%; height: 63.3906px;">object \*</td><td style="width: 33.2922%; height: 63.3906px;">The client data as name, address, ... and where to send and how</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">invoice\_rows (optional)</td><td style="width: 33.2922%; height: 63.3906px;">array of object \*\*</td><td style="width: 33.2922%; height: 63.3906px;">Array with invoice row object (item, description, quantity, unitCost, tax)</td></tr></tbody></table>

\* client data object structure:

<div id="bkmrk-%C2%A0-%C2%A0-%7B-%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%22name%22"><div> {</div><div> "name": "Test client 01", // (string) optional</div><div> "address_line1": "Street Nowhere, 3", // (string) optional</div><div> "address_line2": null, // (string) optional</div><div> "zip_code": "12345", // (string) optional</div><div> "city": "My City", // (string) optional</div><div> "country": "My Country", // (string) optional</div><div> "vat_number": "123456798", // (string) optional</div><div> "sendVia": "Email", // (string) optional (only one of the following: "Email" or "Sms")</div><div> "sendTo": "johndoe@test.com" // (string) optional</div><div> }</div></div>\*\* array of object containing the datas for every invoice row

 {  
 "invoice\_row\_id": "c24fre56th23.......", // (string) optional but mandatory if you want to change or confirm a row, if not presents means that is a new row  
 "item": "Item name", // (string) optional but mandatory if not have description  
 "description": "description", // (string) optional but mandatory if not have item  
 "quantity": 3.1, // (float) optional  
 "unitCost": 10.50, // (float) optional  
 "tax": 12 // (float) optional  
 }

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/scaled-1680-/WgJimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-11/WgJimage.png)

This example confirms all the data and add a new row (one without "invoice\_row\_id")

# List [GET]

<span style="background-color: #c2e0f4;">**<span style="background-color: #c2e0f4;">https://api.neuro-admin.com/invoice</span>/index**</span>\[GET\]

This EP returns the list of all invoices for the company associated to the api key in form of array of object.