Documentation

Hugh Jeremy edited this page Aug 17, 2018 · 8 revisions

The Amatino API is structured as model of objects, like "Account", and actions that may be taken with respect to those objects, such as "Create". Amatino JS mirrors the HTTP API structure. In place of raw HTTP requests, Amatino JS provides expressive, object-oriented syntax.

Amatino objects can be categorised as primary, derived, and ancillary. The primary objects are Entity, Account, and Transaction. Every other object exists to support or extend those primary objects in some manner.

Derived objects organise and present accounting information stored using primary objects. For example, a Ledger (derived) presents Transactions (primary) in a list form.

Ancillary objects support interactions with primary and derived objects. For example, a Session object holds authentication information that must be supplied with any request for other objects.

Note: Where objects are not hyperlinked, the object is still under construction. Follow @AmatinoAPI on Twitter or subscribe to the development newsletter to be notified when new versions of Amatino JS are released.

Objects

Primary

Derived

  • Balance
  • Ledger
  • Performance
  • Position
  • Recursive Ledger
  • Recursive Balance
  • Tree

Ancillary

  • Custom Unit
  • Entry
  • Global Unit
  • Global Unit List
  • Ledger Row
  • Session
  • Side
  • Transaction Version List
  • Tree Node
  • Type
  • User
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.