Skip to content

NafieAlhilaly/fast-fatoora

Repository files navigation


GitHub stars GitHub forks Code style: black GitHub license ZATCA FastAPI Heroku

fast-fatoora

fast-fatoora is an open API to help generating QR-code for ZATCA's e-invoice known as "Fatoorah" You can try it with simple ui @ Heroku full API documentations

Business

Wanna create a custom API for your business ? Please contact me on Linkedin 😉


how to use it

lets say you have the following data

{
  "seller_name":"Nafie",
  "tax_number":"981293479834",
  "date":"2021-12-06 16:14:17.374909",
  "total_amount":"100.00",
  "tax_amount":"0.50"
}

To base64

Use /to_base64 to get base64 encoded information

Parameter :
  seller_name: required
  tax_number: required
  date: optional, if not provided created date and time will be added
  total: required
  tax_amount: required
  
  
https://api-fatoora.herokuapp.com/to_base64?seller_name=Nafie&tax_number=981293479834&total=100.00&tax_amount=0.50&date=2021-12-06%2016%3A14%3A17.374909

Try it

To QR-Code image

Use /to_qrcode_image to generate QR-Code image

Parameter :
  seller_name: required
  tax_number: required
  date: optional, if not provided created date and time will be added
  total: required
  tax_amount: required
  
  

https://api-fatoora.herokuapp.com/to_qrcode_image?seller_name=Nafi&tax_number=981293479834&total=100.00&tax_amount=0.50&date=2021-12-06%2016%3A14%3A17.374909

Try it

Full E-Invoice(fatoora)

Use /full_fatoora to get e-invoice with qrcode image

Parameter :
  fat_number: Optional, e-ivoice number/id if not ptovided it will be filled with random numbers
  seller_name: required
  tax_number: required
  date: optional, if not provided created date and time will be added
  total: required
  tax_amount: required
  
  

https://api-fatoora.herokuapp.com/full_fatoora?seller_name=Nafie&tax_number=981293479834&total=100.00&tax_amount=0.50&date=2021-12-06%2016%3A14%3A17.374909&fat_number=5837

Try it

Devolepment

To start your local devolepment

clone repo

git clone https://github.com/NafieAlhilaly/fast-fatoora.git
cd fast-fatoora

install dependencies

using pip:

pip install -r requirements.txt

using poetry(recommended):

poerty install

run the local devolepment server

python app/main.py

server will run on https://127.0.0.1:8000

About

API to help generating QR-code for ZATCA's e-invoice known as "Fatoora" with any programming language

Topics

Resources

License

Stars

Watchers

Forks