Skip to content

LedgerRow

Hugh Jeremy edited this page Oct 4, 2018 · 2 revisions

Documentation > LedgerRow

A Ledger Row is a specialised view of a Transaction, delivered as part of a Ledger or Recursive Ledger. The Ledger Row describes a Transaction 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.

Properties

.transaction_id - int

The integer identifier of the Transaction this LedgerRow summarises

Example: 5346254


.transaction_time - datetime.datetime

The time at which the summarised Transaction was or is to be executed


.description - str

The description of the summarised Transaction

Example: 'Recognise receipt of sweet loot'


.opposing_account_id - Optional[int]

The integer identifier of the Account to which the opposing Entry allocates value. Or, if there are more than two Entries party to the summarised Transaction, None.

Example: None


.opposing_account_name - str

The string name of the Account to which the opposing Entry allocates value. If more than two Entries are party to the summarised Transaction, the special reserved word '[Split Transaction] is returned.

Example: 'Current Assets'


.debit - decimal.Decimal

The magnitude of the debit allocated by the Entry party to the Account of the controlling Ledger. If the Entry was a credit, a zero Decimal is returned.

Example: 42.20


.credit - decimal.Decimal

The magnitude of the credit allocated by the Entry party to the Account of the controlling Ledger. If the Entry was a debit, a zero Decimal is returned.

Example: 0


.balance - decimal.Decimal

The sum of all previous debits and credits party to the Ledger's controlling Account up until the time of the summarised Transaction, from the beginning of time.

Example: 1,000,420

Methods

None

Clone this wiki locally