Namirasoft Balance API V1
Namira Software Corporation Balance API Version 1 (1.5.4)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-balance-api-v1
Commands
Health
Liveness
Returns the application liveness status
ns-balance health liveness
Readiness
Returns the application readiness status
ns-balance health readiness
Metrics
Get
Returns the application metrics
ns-balance metrics get
Value
List
Returns the value list of a given table and column
ns-balance value list {table} {column} {search} {field_id} {limit}
Overview
Count
Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces
ns-balance overview count
--group_by_workspace (Boolean)
--workspace_ids (Array)
Transaction
List
Returns the transaction list for an asset (joined through journal entry)
ns-balance transaction list {asset_id} {filters} {page} {size} {sorts} {all_workspaces}
Balance
Returns the balance of all assets. Optionally filter by asset_id to return only that asset's balance.
ns-balance transaction balance {asset_id}
GeneralLedger
Returns the general ledger for a given asset. Optional from_date/to_date scope the ledger; opening balance is the sum of all transactions strictly before from_date, closing balance is opening plus the sum of transactions in range.
ns-balance transaction generalledger {asset_id} {from_date} {to_date}
Get
Returns a transaction by an id
ns-balance transaction get {id}
JournalEntry
List
Returns the journal entry list
ns-balance journalentry list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a journal entry by an id
ns-balance journalentry get {id}
_CreateFor
Creates a new journal entry with its transactions
ns-balance journalentry _createfor
--asset_id (String)
--datetime (DateTime)
--description (String)
--transactions (Array)
_DeleteFor
Deletes a journal entry (and cascades its transactions)
ns-balance journalentry _deletefor {id}
Summary
List
Returns the summary list
ns-balance summary list {asset_id} {filters} {page} {size} {sorts} {all_workspaces}
Last
Returns the last statement of each asset
ns-balance summary last {filters} {page} {size} {sorts} {all_workspaces} {asset_id}
Get
Returns a summary by an id
ns-balance summary get {id}
Asset
List
Returns the asset list
ns-balance asset list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns an asset by an id
ns-balance asset get {id}
Account
List
Returns the account list
ns-balance account list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns an account by an id
ns-balance account get {id}
Party
List
Returns the party list
ns-balance party list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a party by an id
ns-balance party get {id}
Schemas
OverviewCountInput
{ "name": "OverviewCountInput", "type": "Object", "required": true, "fields": { "group_by_workspace": { "type": "Boolean", "required": false }, "workspace_ids": { "type": "Array", "required": false, "items": [ { "type": "String", "required": true } ] } }}
OverviewCountRow
{ "name": "OverviewCountRow", "type": "Object", "required": true, "fields": { "database": { "type": "String", "required": true }, "table": { "type": "String", "required": true }, "total": { "type": "Integer", "required": true }, "by_workspace": { "type": "Array", "required": false, "items": [ { "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
OverviewCountByWorkspace
{ "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } }}
Transaction
{ "name": "Transaction", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "journal_entry_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "account_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "party_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "txn_id": { "type": "String", "required": false, "max": 255 }, "amount": { "type": "Decimal", "required": true, "precision": 2 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
BalanceItem
{ "name": "BalanceItem", "type": "Object", "required": true, "fields": { "asset": { "name": "Asset", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "name": "AssetType", "type": "Enum", "required": true, "valids": [ "Count", "Money", "Time" ] }, "overdraft": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "total_debit": { "type": "Integer", "required": true }, "total_credit": { "type": "Integer", "required": true }, "total_balance": { "type": "Integer", "required": true }, "count": { "type": "Integer", "required": true }, "min_date": { "type": "DateTime", "required": false }, "max_date": { "type": "DateTime", "required": false } }}
Asset
{ "name": "Asset", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "name": "AssetType", "type": "Enum", "required": true, "valids": [ "Count", "Money", "Time" ] }, "overdraft": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
JournalEntry
{ "name": "JournalEntry", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "asset_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "datetime": { "type": "DateTime", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
JournalEntryInput
{ "name": "JournalEntryInput", "type": "Object", "required": true, "fields": { "asset_id": { "type": "String", "required": true }, "datetime": { "type": "DateTime", "required": false }, "description": { "type": "String", "required": false }, "transactions": { "type": "Array", "required": true, "items": [ { "name": "JournalEntryTransactionInput", "type": "Object", "required": true, "fields": { "account_id": { "type": "String", "required": true }, "party_id": { "type": "String", "required": false }, "product_id": { "type": "String", "required": false }, "txn_id": { "type": "String", "required": false }, "amount": { "type": "Integer", "required": true }, "description": { "type": "String", "required": false } } } ] } }}
JournalEntryTransactionInput
{ "name": "JournalEntryTransactionInput", "type": "Object", "required": true, "fields": { "account_id": { "type": "String", "required": true }, "party_id": { "type": "String", "required": false }, "product_id": { "type": "String", "required": false }, "txn_id": { "type": "String", "required": false }, "amount": { "type": "Integer", "required": true }, "description": { "type": "String", "required": false } }}
JournalEntryCreateOutput
{ "name": "JournalEntryCreateOutput", "type": "Object", "required": true, "fields": { "journal_entry": { "name": "JournalEntry", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "asset_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "datetime": { "type": "DateTime", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "transactions": { "type": "Array", "required": true, "items": [ { "name": "Transaction", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "journal_entry_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "account_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "party_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "txn_id": { "type": "String", "required": false, "max": 255 }, "amount": { "type": "Decimal", "required": true, "precision": 2 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
Summary
{ "name": "Summary", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "party_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "asset_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "year": { "type": "Integer", "required": true }, "month": { "type": "Integer", "required": true }, "previous_balance": { "type": "Decimal", "required": true, "precision": 2 }, "total_debt": { "type": "Decimal", "required": true, "precision": 2 }, "total_credit": { "type": "Decimal", "required": true, "precision": 2 }, "final_balance": { "type": "Decimal", "required": true, "precision": 2 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Account
{ "name": "Account", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "account_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "entity": { "name": "AccountEntity", "type": "Enum", "required": true, "valids": [ "Asset", "Liability", "Equity", "Income", "Expense" ] }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Party
{ "name": "Party", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Enums
AssetType
Count
Money
Time
AccountEntity
Asset
Liability
Equity
Income
Expense
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.