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

Balance

A Balance represents the sum total value of all Entries party to an Account.

The Balance Object

The Amatino API returns Balance objects with the following structure

Root Type

JSON Array

Object Structure

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

Retrieve Balance

API Path /accounts/balance
HTTP Method GET
Description Descr. Retrieve a 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 Balance
Example oB3cjSNKXklkJ4Tb
Repeatable No

Required JSON Data

Root type

JSON Array

Max Array Length

10

Object Structure

key "account_id"
description The unique integer identifier of the Account for which you would like to retrieve a Balance
type JSON Number
example 42
key "balance_time"
description The time at which to balance the target Account. Specify JSON Null to compute the balance at the time of the request
type JSON String or JSON Null
example "2018-01-01_00:00:00.00000"
key "global_unit_denomination"
description 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.
type JSON String or JSON Null
example "eur"
source /units/list
key "custom_unit_denomination"
description 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.
type JSON String or JSON Null
example "btc"
source /custom_units/list

Returns

Root Type

JSON Array

Object

Balance