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

Ledger Row

A Ledger Row is a specialised view of a Transaction, delivered as part of a Ledger or Recursive Ledger. The Ledger Row describes a Tranasction from the perspective of the Account targeted by the controlling Ledger or Recursive Ledger.

When consuming the Amatino API, you will never encounter a Ledger Row on its own. They are only ever delivered under the ledger_rows key as part of a Ledger or Recursive Ledger object.

The Ledger Row Object

Amatino will deliver Ledger Rows with the following object structure

Root Type

JSON Array

Object Structure

type JSON Number
example 320932
key "transaction_id"
description The integer identifier of the Transaction this Ledger Row describes.
type JSON String
example "2017-01-07_17:22:16.51245"
key "transaction_time"
description Time at which the described Transaction occured, or is to occur, in the format YYYY-MM-DD_HH24:MI:SS.US, at UTC
type JSON String
example Receipt of payment for exquisite accounting services
key "description"
description A friendly description of the Transaction
type JSON Number or JSON Null
example 42
key "opposing_account_id"
description The unique integer id of the Account debited or credited in opposition to the target Account
note If the Transaction described features more than two Entries, opposing_account_id will return null.
type JSON String
example Accounts Receivable
key "opposing_account_name"
description The name of the Account debited or credited in opposition to the target Account
note If the Transaction described features more than two Entries, opposing_account_name will return "[Split Transaction]".
type JSON String
example "0.00"
key "debit"
description The debit value of the described Transaction.
type JSON String
example "23,125.95"
key "credit"
description The credit value of the described Transaction.
type JSON String
example "12,492,532.33"
key "balance"
description The running total balance of the target Account, at the time of this Transaction