Code Monkey home page Code Monkey logo

pos_api's Introduction

Point of Sales API

A simple API built with NodeJS designed for a backend customer invoice system with MongoDB.

WARNING: THIS CODE IS ACTIVELY BEING DEVELOPED AND IS NOT PRODUCTION READY.

Getting Started

Prerequisites

  • NodeJS
  • MongoDB
  • MongooseJS
  • ExpressJS

Everything else is covered in the npm included with this project.

Installation

Do 'npm install' and then run app.js from the main directory.

API usage

Listed below are the API codes.

Send a new invoice to be created (HTTP POST):

{
	"name": "John Smith", 
	"address": "742 Evergreen Terrace", 
	"services": "foo bar",
	"balanceTotal": "49.95"
}

Invoice created and added to the database succesfully:

{
  "status": {
    "message": "invoice_creation_success"
  }
}

Errors

One or more fields on the invoice are missing, invoice not created nor added to the database:

{
  "status": {
    "message": "invoice_creation_missing-data"
  }
}

The balance property sent is either too large or too small, ensure your balanceTotal property is correct:

{
  "status": {
    "message": "invoice_creation_balance-error-0"
  }
}

The balance property sent contains a letter, ensure your balanceTotal contains only numbers with the dividing dot:

{
  "status": {
    "message": "invoice_creation_balance-error-1"
  }
}

pos_api's People

Contributors

3-3-0-1 avatar

Watchers

Edin Jusupovic 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.