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

Primary
Account
Object
Create
Retrieve
Update
Delete
Restore
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
Tree Node
Type
User

Entity

An Amatino entity is a economic unit to be described by accounting information. Entities are described by Accounts and Transactions.

Examples of an Entity include a legal company, a consolidated group of companies, a project, or even a person.

Users may be granted fine-grained permissions to read and or write to individual Accounts within an Entity.

The Entity Object

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

Root Type

JSON Array

Object Structure

description A unique Amatino identifier for this entity
key "entity_id"
example "oB3cjSNKXklkJ4Tb"
type JSON String
description The name of this entity
key "name"
example "Project Azorian"
type JSON String
description A unique, integer identifier of the Amatino user who owns this entity
key "owner"
example 9523413
type JSON Number
description A description of the entity
key "description"
example "A company devoted to creating great accounting products"
type JSON String
description The unique integer ID of the Region in which this Entity is physically stored
key "region_id"
example 3
type JSON Number
description A description of the permissions granted to Amatino users with respect to this entity.
key "permissions_graph"
example {'9523413': {'56': {'write': False, 'read': True}}, '5235891': {'56': {'write': True, 'read': True}, '725': {'write': False, 'read': True}}}
type JSON Object

Create Entity

API Path /entities
HTTP Method POST
Description Descr. Create a new 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.

Required JSON Data

Root type

JSON Array

Max Array Length

10

Object Structure

max char length 1024
description Friendly name of the entity
key "name"
example "Amatino Pty Ltd"
type JSON String
max char length 4096
description A friendly description of the entity
key "description"
example A company devoted to creating great accounting products
type JSON String or JSON Null
description The id of the region in which the entity's data will be stored
example 5
note Specify null to create the entity in the region geographically closest to you
key "region_id"
source /regions
type JSON Number or JSON Null

Returns

Root Type

JSON Array

Object

Entity

Retrieve Entity

API Path /entities
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

Key entity_id
Type string
Description Descr. An Amatino entity id
Example oB3cjSNKXklkJ4Tb
Repeatable Yes

Required JSON Data

None.

Returns

Root Type

JSON Array

Object

Entity

Update Entity

API Path /entities
HTTP Method PUT
Description Descr. Update metadata of an existing 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.

Required JSON Data

Root type

JSON Array

Max Array Length

10

Object Structure

max char length 1024
description Friendly name for the entity
key "name"
example "Amatino Pty Ltd"
type JSON String
max char length 4096
description A description of the entity
key "description"
example "A company devoted to creating great accounting products"
type JSON String
description The region in which the entity's data will be stored
key "region_name"
example "Australia East 1"
source /regions
type JSON String
description A graph describing permissions for this entity
key permissions_graph
example {'user_id_2': {'account_id_1': {'write': True, 'read': True}}, 'user_id_1': {'account_id_1': {'write': False, 'read': True}, 'account_id_2': {'write': True, 'read': True}}}
note Is null if no permissions have been granted
type JSON Object or JSON Null

Returns

Root Type

JSON Array

Object

Entity

Delete Entity

API Path /entities
HTTP Method DELETE
Description Descr. Delete 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

Key entity_id
Type string
Description Descr. An Amatino entity id
Example oB3cjSNKXklkJ4Tb
Repeatable Yes

Required JSON Data

None.

Returns

Root Type

JSON Array

Object Structure

description The ID of a deleted entity
key "entity_id"
example "oB3cjSNKXklkJ4Tb"
type JSON String

Restore Entity

API Path /entities
HTTP Method PATCH
Description Descr. Restore a deleted 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

Key entity_id
Type string
Description Descr. An Amatino entity id
Example oB3cjSNKXklkJ4Tb
Repeatable Yes

Required JSON Data

None.

Returns

Root Type

Object

Entity