Warning! Construction underway! Amatino is in an 'alpha' state. Not all features are operational. See roadmap

Primary
Account
Entity
Transaction
Derived
Balance
Ledger
Performance
Position
Recursive Balance
Recursive Ledger
Tree
Ancillary
Custom Unit
Entry
Global Unit
Global Unit List
Ledger Row
Session
Side
Tx Version List
Object
Type
User

Tree Node

A Tree Node is a specialised view of an Account. It provides a recursive and individual balance for an Account. You will never interact with Tree Nodes' directly, instead you will receive lists of Tree Nodes as components of requests for Trees, Positions, and Performances.

Tree Nodes are recursive objects that may contain other Tree Nodes, depending on whether the Account in question has any children.

Trees, Positions, and Performances describe entire Entities. The User from whose perspective you retrieve a Tree, Position, or Performance may not have read access to every Account in the Entity. In such cases, Tree Nodes describing Accounts to which a User does not have read access will be returned with null in their balance fields, and a generic Type in place of the actual Account name.

The Tree Node Object

The Amatino API returns Tree Node objects with the following structure

Root Type

JSON Object

Object Structure

description Integer identifier of the Account this Tree Node describes
key "account_id"
example 42
type JSON Number
description The number of levels into the hierarchy this account sits. Top level accounts are 1.
key "depth"
example 2
type JSON Number
description The magnitude of the balance of the described Account, or null if the retrieving User lacks read privileges.
key "account_balance"
example "400.30"
type JSON String
description The name of the Account this Tree Node describes, or the Type name if the retrieving User lacks read privileges.
key "name"
example False
type JSON String
description The magnitude of the recursive balance of the described Account, or null if the retrieving User lacks read privileges.
key "recursive_balance"
example 600.01
type JSON String or JSON Null
description The id of the Type of the Account this Tree Node describes
key "type"
example 1
type JSON Number
example See Tree Nodes
description A list of Tree Node objects for each child of the Account this Tree Node describes
key "children"
list objects Tree Node
type JSON Array