Forum

Ask, reply and learn. Join the community of Akaunting.

New Discussion

How to use REST API

Stojan   ( User )

Commented 3 years ago

Hi guys. I am waiting for to dev team to approve the postman collection so I can post it here or on the git project or on any other place :) Hope that will be soon :)

Timo Brüntjen   ( User )

Commented 3 years ago

Also awaiting the postman project! Would be great!

I Kadek Ariawan   ( User )

Commented 3 years ago

I am waiting too :-)

Timo Brüntjen   ( User )

Commented 3 years ago

Hi Tecocraftltd, well, I´d like to use my standard env. which is postman. The Problem is not the endpoint, it's the parameters and what works how in combination. I really would appreciate to get either a good documentation about the api or as suggested a finished project to import into postman.

P.S.: Im using the cloud version of akaunting.

What I would like to do:
- Post Invoice Status (draft, sent, paid)
- Search all Invoices for customer
- Search all Invoices in a date range

I have figoured out so far:
- https://app.akaunting.com/api/documents?company_id=1&search=type:invoice gets me all invoices in pagination.
- https://app.akaunting.com/api/contacts?company_id=1&search=type:customer gets me all my customers

I´m not aware to filter out the wanted rows by program logic but there should be parameters for this, that might not be documented.

Roberto   ( User )

Commented 3 years ago

Any luck with postman collection?

Rhap Eskies   ( User )

Commented 3 years ago

Adding up:
to set how many invoices per page use 'limit' and to set which page we want to look at use 'page'.
For example:

https://app.akaunting.com/api/documents?company_id=1&search=type:invoice&limit=100&page=2

It will show page number 2 with 100 invoices. It will be enough for me to filter it based on 'contact_id'.

Leonardo Gomes   ( User )

Commented 3 years ago

Hi, Stojan!

Any news on the postman collection?

It would be very helpfull

Stojan   ( User )

Commented 3 years ago

Hi guys.
We work on something new to make you happy as Akaunting users so it takes us more time to start and do it in the right way, but think that it will be easy to continue doing it in this direction. I put part of Postman collection temporary here
https://drive.google.com/file/d/1ykZ-GNYpQPh7CcI8B3dAZCEXwadWzdT2/view?usp=sharing

Soon will be updated on how we progress on that project, which we like to have in the Postman collection also ;) so stay tuned and tell me what do you think about this collection, do you like it or you prefer some other way to we make it?

Simon Moreau   ( User )

Commented 3 years ago

Hi Stojan! The Postman collection is great, thanks a lot for putting it online!

If I may, you can set the base url (https://app.akaunting.com/api/) as a variable for those like me who are using a local Akaunting instance with their own url. Do you have any method for creating items?

Thanks again!

Stojan   ( User )

Commented 3 years ago

Tnx. It will be more updates soon.

Sure, I will put it in the next version. Tnx for the feedback.

Please login or register to leave a response.

Showing 11 to 20 of 62 discussions