Giter VIP home page Giter VIP logo

frontaccounting-simpleapi's Introduction

Simple API for Front Accounting

Build Status

I needed some basic integration functions to another software and decided to create this REST API and contribute to the Front Accounting community. I hope you find it usefull!

Installation

DO NOT use git to clone this repo into your FrontAccounting modules folder unless you are a developer.

DO download the latest release in either zip or tgz and unpack into a folder such as .../modules/api.

API Quick Start

  1. Just copy the files into the modules directory under a folder called "api".
  2. OPTIONAL: To test your installation Edit the file util.php and change the $company, $username and $password variables so you can test. Use it at your own risk, to provide login from another software you need to send X-COMPANY, X-USER and X-PASSWORD headers in the request and the API will use those credentials, if they're wrong you will get a nice message saying "Bad Login"
  3. Try to access the API, for example, try the Items Category List, type this on your explorer: http://YOUR_FA_URL/modules/api/category/ You will see a JSON response with all your items categories, if not check your credentials in the util.php file, or the X headers if set in the client.

Documentation

See the API Documentation for descriptions of each endpoint.

Methods

The following API endpoints have been implemented:

  • Sales
  • Customers
  • Items / Inventory
  • Items Categories
  • Suppliers
  • Inventory Movements
  • Locations
  • Tax Groups
  • Tax Types
  • Bank Accounts
  • GL Accounts
  • GL Account Types.
  • Journal

Some of them have not been tested yet so be carefull.

How to Help

Report issues you find in our GitHub Issue Tracker. Please report with as much detail as you can. Simply saying "It doesn't work" will gain you sympathy, but not a lot else.

Want to contribute code? Go right ahead, fork the project on GitHub, pull requests are welcome. Note that we're trying to follow the PSR-2 Coding Style Guide.

Contact

Any question about this you can always contact me: [email protected]

frontaccounting-simpleapi's People

Contributors

cambell-prince avatar andresamayadiaz avatar christianestrella avatar madelineau avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.