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

Entity List

An Entity List enumerates the Entities that may be accessed by the retreiving User.

Amatino will return a maximum of 100 Entities per Entity List page.

The Entity List Object

When returning an Entity List to you, Amatino uses the following JSON object structure.

Root Type

JSON Object

Object Structure

type JSON Number
example 1
key "page"
description The page number covered by this Entity List object
type JSON Number
example 2
key number_of_pages
description The number of pages available for retrieval
type JSON String
example "2018-05-02_05:01:54.72941"
key generated_time
description The time at which this Entity List was computed, in the format YYYY-MM-DD_HH24:MI:SS.US
type JSON Array
example See Entity
key "entities"
description A list of Entity objects
list_objects Entity

Retrieve Entity List

API Path /entities/list
HTTP Method GET
Description Descr. Retrieve metadata describing an entity or entities

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

None.

Optional URL Parameters

Key state
Type string
Description Descr. The state of the entities you wish to retrieve, "active", "deleted", or "all"
Example active
Repeatable No

Required JSON Data

None.

Returns

Root Type

JSON Array

Object

Entity List