Neuro-Pay Invoice API

outlining the functionality and implementaiton of the paiwise checkout API

• Requests
• Create [POST]
• Retrieve [POST]
• Update [POST]
• List [GET]
• Authentification
• Response
• The response object
• Data format
• Postman collection

Requests

Collection of possible requests

Create [POST]

https://api.neuro-admin.com/invoice/create [POST]

currency_id	String	EUR, SEK, USD… etc
invoice_date (optional)	String	The invoice date (if not have will get the sending date)
due_date (optional)	String	The due date
client_data (optional)	object *	The client data as name, address, ... and where to send and how
invoice_rows (optional)	array of object **	Array with invoice row object (item, description, quantity, unitCost, tax)

* client data object structure:

** 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
        }

 

Retrieve [POST]

https://api.neuro-admin.com/invoice/retrieve [POST]

Values

invoice_id

String

The invoice_id received when creating a checkout object

Update [POST]

https://api.neuro-admin.com/invoice/update[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.

invoice_id	String	The invoice_id in the creation response
currency_id	String	EUR, SEK, USD… etc
invoice_date (optional)	String	The invoice date (if not have will get the sending date)
due_date (optional)	String	The due date
client_data (optional)	object *	The client data as name, address, ... and where to send and how
invoice_rows (optional)	array of object **	Array with invoice row object (item, description, quantity, unitCost, tax)

* client data object structure:

** 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
        }

This example confirms all the data and add a new row (one without "invoice_row_id")

List [GET]

https://api.neuro-admin.com/invoice/index[GET]

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

Authentification

In order to use the invoice API the company in question needs to generate an API key through the Neuro-Admin platform. Said API key should be sent as a bearer token in each request.

Response

The response object

For each endpoint the invoice object will be returned in its “new state”
Example:

Possible statuses are
• draft
• sent
• paid
• partialpaid
• revoked

Every date and time returned are in UTC.

 

If the invoice status is "sent" the field "invoice_no" get value

Data format

The API currently accepts and returns JSON data in the body

Postman collection

attached to this page is a postman collection for testing

All requests inherits the authentication from the collection. as the bearer token you add your API key test or live,

You can find file attachments in top left corner of this page