Skip to content

Instantly share code, notes, and snippets.

@psy-q
Created October 31, 2011 12:47
Show Gist options
  • Save psy-q/1327425 to your computer and use it in GitHub Desktop.
Save psy-q/1327425 to your computer and use it in GitHub Desktop.
Rough outline of web service API that would be necessary to marry Stizun to LedgerSMB
Stizun is a small web store we are developing for lincomp.ch. Stizun is developed here:
https://github.com/psy-q/stizun
We would like to move anything that has to do with users and user accounts, invoices, orders,
products and parts to an ERP system so that Stizun is only a thin online store frontend to the
ERP system.
What we'd need to be able to do, ideally via REST:
1. Invoices
1.1. Read list of invoices
1.2. Read details and line items of particular invoice. Line items consist of a product and a quantity.
1.3. Create new invoice, adding and removing line items.
1.4. Read invoice status.
1.5. Update invoice status, e.g. to "cancelled", so that a reverse booking is triggered.
------
2. Users
2.1. Read list of customers (i.e. "people", "companies", anything that has a postal address)
2.2. Create new customers.
2.3. Update customer status (i.e. set a free-form text field called "status" to any string)
2.4. Read the totals and amounts of a customer's account, e.g. to let them check payment status.
------
3. Orders
3.1. Read list of orders, also scoped by customer. Includes line items of an order.
3.2. Create new orders.
3.3. Update order status, e.g. set to "cancelled"
------
4. Quotations
4.1. List quotations, also scoped by customer.
4.2. Create new quotations based on products that are already in the ERP system.
------
5. Products
5.1. Read list of products.
5.2. Update product attributes (price, stock level...)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment