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

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

Performance

A Performance is a hierarchical collection of Account balances describing the financial performance of an Entity over a period of time. They are generic representations of popular accounting constructs known as the 'Income Statement', 'Profit & Loss', or 'Statement of Financial Performance'.

The Peformance object is jurisdiction agnostic, and obeys simple double-entry accounting rules. They list income and expense, each nesting its own children.

You can retrieve a Performance denominated in an arbitrary Global Unit or Custom Unit. Amatino will automatically calculate the implicit gain or loss relative to each Account's underlying denomination and include those gains and losses in each Account balance.

A Performance may be retrieved to an arbitrary depth. Depth in the Performance context is the number of levels down the Account hierarchy Amatino should go when retrieving the Performance. For example, if a top-level Account has child accounts three layers deep, then specifying a depth of three will retrieve all those children.

Regardless of the depth you specify, Amatino will calculate recursive balances at full depth.

The Performance Object

Performance objects are returned with the following structure

Root Type

JSON Object

Object Structure

description The identifer of the Entity this Performance describes
key "entity_id"
example "oB3cjSNKXklkJ4Tb"
type JSON String
description Beginning of the period over which performance is measured, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC.
key "start_time"
example "2017-01-01_00:00:00.00000"
type JSON String
description End of the period over which performance is measured, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC.
key "end_time"
example "2018-01-01_00:00:00.00000"
type JSON String
description Time that this Performance was computed, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC
key "generated_time"
example "2018-05-02_05:01:54.72941"
type JSON String
description The id of the global unit in which this Performance 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 Performance is denominated, if applicable.
key "custom_unit_denomination"
example null
type JSON Number or JSON Null
example See Tree Nodes
description A list of Tree Node objects representing income Accounts
key "income"
list objects Tree Node
type JSON Array
example See Tree Nodes
description A list of Tree Node objects representing expense Accounts
key "expenses"
list objects Tree Node
type JSON Array
description The maximum Account depth to which this Performance recurses
key "depth"
example 3
type JSON Number

Retrieve Performance

API Path /performances
HTTP Method GET
Description Descr. Retrieve a Performance

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 for which you wish to retrieve a Performance
Example oB3cjSNKXklkJ4Tb
Repeatable No

Required JSON Data

Root type

Object Structure

description Beginning of the period over which performance is measured, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC, exclusive (>)
key "start_time"
example "2017-01-01_00:00:00.00000"
type JSON String
description End of the period over which performance is measured, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC, inclusive (<=)
key "end_time"
example "2018-01-01_00:00:00.00000"
type JSON String
description The id of the global unit denomination in which you would like to view the Tree. Specify either global or custom unit denomination.
key "global_unit_denomination"
example 5
source /units/list
type JSON Number or JSON Null
description The id of the custom unit in which you would like to view the Ledger, if desired. Specify either global or custom unit denomination
key "custom_unit_denomination"
example null
source /custom_units/list
type JSON Number or JSON Null
description The number of levels of Accounts you wish the Position to include. Specify null for full depth.
example 3
max value 4096
key "depth"
min value 1
type JSON Number or JSON Null

Returns

Root Type

JSON Object

Object

Performance