GithubHelp home page GithubHelp logo

billing-system-backend's Introduction

API Documentation

If you're looking to interact with our system programmatically, all our API routes are accessible at this link.

Managing Products

  • Need to add, update, or remove products? Check out the Product Section for the right APIs to use.

Managing Employees

  • For tasks related to employees like adding new ones, updating their details, or removing them, head to the Employee Section.

Billing Process

  • To create a bill for a customer, follow these steps:
    1. Start by making an empty bill using the POST /bills/ endpoint. This sets up the structure for the bill.
    2. Then, add the items the customer wants to purchase using POST /bill-items. This links the products to the bill.
    3. Finally, you can retrieve the bill for any customer by using the GET /bills/ endpoint.

Registering as an Employee

  • If you're an employee, you'll first need to register on our application through POST /api/login/. This gives you access to perform tasks like creating bills, managing products, and handling customer details.
  • After registering, grab the access token from the response and enter it into the authorize button on the top right corner of the application. This ensures you're recognized as an authorized employee.
  • Once authorized, simply log in using your email and password.

Additional Notes

  • If you're adding a new customer, use POST /api/customers/ to create their profile. If the customer is already registered, you can find them in our database using a simple GET request.

billing-system-backend's People

Contributors

ashish7515 avatar

Watchers

 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.