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
Object
Retrieve
Recursive Ledger
Tree
Ancillary
Custom Unit
Entry
Global Unit
Global Unit List
Ledger Row
Session
Side
Tx Version List
Tree Node
Type
User

Recursive Balance

A Recursive Balance represents the sum total value of all Entries party to an Account, and all of that Account's children.

The Recursive Balance Object

The Amatino API returns Recursive Balance objects with the following structure

Root Type

JSON Array

Object Structure

description An integer identifier of the Account this Balance describes
key "account_id"
example 42
type JSON Number
description Time of the balance, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC.
key "balance_time"
example "2017-01-01_17:22:16.40288"
type JSON String
description Time that this Balance was computed, in the format YYYY-MM-DD_HH24:MI:SS.US, UTC
key "generated_time"
example "2018-05-02_05:01:54.72941"
type JSON String
description A bool asserting that this is a Recursive Balance, as opposed to a Balance. Always true
key "recursive"
example True
type JSON Boolean
description The id of the Global Unit in which this Recursive Balance is denominated, if applicable
key "global_unit_denomination"
example 5
type JSON Number or JSON Null
description The id of the Custom Unit in which this Recursive Balance is denominated, if applicable.
key "custom_unit_denomination"
example null
type JSON Number or JSON Null
description The magnitude of the Account'ss recursive balance
key "balance"
example "23,125.95"
type JSON String

Retrieve Recursive Balance

API Path /accounts/balance/recursive
HTTP Method GET
Description Descr. Retrieve a Recursive Balance for an account or accounts

Required Headers

Key X-Signature
Value Your Session signature
Example "yxATCPRKAAXHNiPctNQPHEGGVJF"...
Key X-Session-ID
Value An an integer Session ID
Example 7449059267091272858

Required URL Parameters

Key entity_id
Type string
Description Descr. The entity id of the entity from which you wish to retrieve a Recursive Balance
Example oB3cjSNKXklkJ4Tb
Repeatable No

Required JSON Data

Root type

JSON Array

Max Array Length

10

Object Structure

description The unique integer identifier of the Account for which you would like to retrieve a Recursive Balance
key "account_id"
example 42
type JSON Number
description The time at which to balance the target Account. Specify JSON Null to compute the recursive balance at the time of the request
key "balance_time"
example "2018-01-01_00:00:00.00000"
type JSON String or JSON Null
description The id of the global unit denomination in which you would like to view the Ledger, if desired. Specify JSON Null both here and in the custom unit to retrieve the transaction in the target Account's native unit.
key "global_unit_denomination"
example 5
source /units/list
type JSON Number or JSON Null
description The id of the custom unit denomination in which you would like to view the Ledger, if desired. Specify JSON Null both here and in the custom unit to retrieve the transaction in the target Account's native unit.
key "custom_unit_denomination"
example null
source /custom_units/list
type JSON Number or JSON Null

Returns

Root Type

JSON Array

Object

Recursive Balance