Forum

Detailed API Docs?

Posted in CategoryDevelopment
  • Rct    ( User ) 2 years ago

    Is there any detailed documentation on how to use the REST API?


    The only document I found (https://akaunting.com/docs/developer-manual/restful-api) explains the authentication piece of it and the data format seems to be JSON from googling, but I'm looking specifically for a map of what API endpoints are available, what method should be used to send/get data for each, and what fields are accepted for each endpoint. 


    My goal is to build a script to connect an existing work order system to Akaunting. These functions are the ones I'm primarily looking for:



    • Create, modify, add payment, and get invoice

    • Trigger emailing invoice to customer

    • Create, modify, and get customer

    • Create, modify, and get item


    Does anyone have a link to such information beyond the single doc page I linked above?


    Thanks in advance!

  • Marco Bridge    ( User ) 2 years ago

    There is no other document but you can dive into the code here https://github.com/akaunting/akaunting/tree/master/app/Http/Controllers/Api


    And then contribute to the docs https://github.com/akaunting/docs

Please login or register to leave a response.