API

API

Goals

The intent is to have a full API for LedgerSMB, eventually. This desire has existed for a long time. To help make the discussion less abstract, we're using two cases to evaluate help evaluate the design:

• API for GL accounts

• API for Contacts, including:

  • Customers
  • Vendors

  but excluding:

  • Employees
  • Users

In general, the API should support the following functionalities:

• Creation of a new element
• Listing of existing elements, optionally
  • limited by search parameters
• Transitioning through the [document state transition diagram](Document states)

Non-goals

Assumptions

• Any object may be subject to approval in one organization or another (not just financial transactions)
• It's best to have a single API for financial and non-financial objects
• A REST API will integrate best with existing tools and libraries