How to use REST API

Update released, you can take a new version ;)

Thank you so much @Stojan, your Postman collection allowed me to figure out everything I needed to make my REST API calls.

that is my goal ;)

Thanx a lot, this really helped out! Is there a future release which will be able to get POST for invoices?

Tnx. It will be ;)

post request with: {{akaunting_url}}/documents?company_id={{akaunting_company_id}}&search=type:invoice you can post

setting[title] text
setting[subheading]
setting[company_logo][id] 9
setting[company_logo][name] ".png
setting[company_logo][size] 5585
setting[company_logo][type] image/png
setting[company_logo][download] false

document_number 000010-000
order_number
item_backup[0][name]
item_backup[0][quantity]
item_backup[0][description]
pre_discount
discount
type invoice
status draft
amount 0
notes
footer test here
issued_at 2021-05-10 00:00:00
due_at 2021-05-10 00:00:00
currency_code EUR
recurring_frequency no
recurring_interval 0
recurring_custom_frequency
recurring_count 0
category_id 2
currency_rate 1
contact_id 2
contact_name name
contact_email [email protected]
contact_tax_number
contact_phone
contact_address text here

hey this is super cool , I lost a day trying to find something like this in the documentation
https://drive.google.com/file/d/1ykZ-GNYpQPh7CcI8B3dAZCEXwadWzdT2/view?usp=sharing

why it is not there???? or maybe i missed it?

Hi guys.


I found some search filter in examples written in

https://github.com/akaunting/akaunting/blob/master/app/Traits/SearchString.php

"Get the value of a name in the search string"

# Search all Invoices for customer

curl --request GET \
--url 'https://app.akaunting.com/api/documents?company_id=1&search=type:invoice contact_id:1' \
--header 'Authorization: Basic YOUR_STRING_BASE64'

curl --request GET \
--url 'https://app.akaunting.com/api/documents?company_id=1&search=type:invoice contact_tax_number:12345678911' \
--header 'Authorization: Basic YOUR_STRING_BASE64'

# Search all Invoices in a date range

curl --request GET \
--url 'https://app.akaunting.com/api/documents?company_id=1&limit=100&page=1&search=type:invoice due_at>=2021-10-01 due_at

...

# Search all Invoices in a date range

curl --request GET \
--url 'https://app.akaunting.com/api/documents?company_id=1&limit=100&page=1&search=type:invoice due_at>=2021-10-01 due_at<=2021-10-31' \
--header 'Authorization: Basic YOUR_STRING_BASE64'

This isn't documented here https://developer.akaunting.com/documentation/restful-api

Hi, @Stojan can you update the postman collection with a sample on how to upload an attachment with a post request..in an Invoice for example?
Thanks