OBAPI

Please have a look at our "Idea" bellow for more informations about that nice project...

Idea

The main goal of that spec is to be able to have a obapi client who could download all of my invoices each month without any human intervention (or minimal).

There is some solutions for that, for example woob.tech or cozy.io but each time the provider change his website they have to rebuild the dedicated web scapper script.

obapi reverse the problem with a solution at the source: providers could offer a unified way of accessing invoices. That's all.

example

Here is a simple proof of concept, i hope you will understand easily the main idea with that

11:24 $ php 02-get_invoices_listing.php
Connexion sur votre serveur obapi:
  http://192.168.16.183/16/obapi/v1/invoices

Invoices listing :
+------+-------------+------------+----------------------------------------+--------------+--------------+--------+
| UUID | Ref         | Date       | Label                                  | HT           | TTC          | Status |
+------+-------------+------------+----------------------------------------+--------------+--------------+--------+
| 54   | FA1912-0053 | 2019-12-12 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 57   | FA2001-0002 | 2020-01-22 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 60   | FA2001-0004 | 2020-01-31 |                                        | ...12 500,00 | ...15 000,00 | payed  |
| 62   | FA2002-0006 | 2020-02-21 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 67   | FA2003-0011 | 2020-03-19 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 70   | FA2004-0014 | 2020-04-18 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 77   | FA2005-0021 | 2020-05-19 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 81   | FA2006-0025 | 2020-06-18 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 99   | FA2012-0041 | 2020-12-06 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 850  | FA2209-0646 | 2022-09-09 |                                        | ....1 527,00 | ....1 832,40 | payed  |
| 1081 | FA2212-0842 | 2022-12-06 | Accompagnement technique Novembre 2022 | ....1 527,00 | ....1 832,40 | payed  |
+------+-------------+------------+----------------------------------------+--------------+--------------+--------+

Then choose the invoice you want to download (for example number 850, ref FA2209-0646) wait some seconds and the PDF is here on your computer ! Easy

That result could be the same with standard Dolibarr API but my obapi client could be used agains others obapi compatible providers without any changes ...

So let me try with an other obapi compatible webservice (other than dolibarr: doliscan.devtemp.fr is not a dolibarr instance):

12:59 $ php 02-get_invoices_listing.php
Connexion sur votre serveur obapi:
  https://doliscan.devtemp.fr/obapi/v1/invoices

Invoices listing :
+----------+----------+------------+----------+--------------+--------------+---------+
| UUID     | Ref      | Date       | Label    | HT           | TTC          | Status  |
+----------+----------+------------+----------+--------------+--------------+---------+
| 10215488 | 01025488 | 2022-11-05 | Nov.2022 | ........9,99 | .......11,99 | payed   |
| 10215496 | 01025496 | 2022-12-05 | Dec.2022 | ........9,99 | .......11,99 | payed   |
+----------+----------+------------+----------+--------------+--------------+---------+
✔ ~/dev/obapi/client-php [master L|✚ 1…1]

well done !

more than invoices

if i spoke about invoices that's not the only target of obapi : obapi means open business api, then i hope we could make obapi gateway for all sort of business ressources like:

  • my product listing, i would share my listing with my cooperative
  • my thirdparty listing, i would share some part of my thirdparty listing with other entities of my consortium
  • orders
  • invoices
  • .../...

join us

Here is the project : https://inligit.fr/obapi/ but it could be more easy if it was on github ? -> so please follow that link https://github.com/OpenBusinessAPI