Namirasoft Balance API V1
Namira Software Corporation Balance API Version 1 (1.5.2)
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}
Transaction
List
Returns the transaction list
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}
_CreateFor
Creates a new transaction for an user_id
ns-balance transaction _createfor {user_id}
--product_id (String)
--txn_id (String)
--asset_id_name (String)
--category (String)
--description (String)
--amount (Decimal)
_DeleteFor
Deletes an transaction by an id for an user_id
ns-balance transaction _deletefor {user_id} {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}
Schemas
Transaction
{ "name": "Transaction", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "txn_id": { "type": "String", "required": false, "max": 255 }, "asset_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "amount": { "type": "Decimal", "required": true, "precision": 2 }, "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 } }}
TransactionInput
{ "name": "TransactionInput", "type": "Object", "required": true, "fields": { "product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "txn_id": { "type": "String", "required": false, "max": 255 }, "asset_id_name": { "type": "String", "required": true }, "category": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "amount": { "type": "Decimal", "required": true, "precision": 2 } }}
Summary
{ "name": "Summary", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_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 } }}
Enums
AssetType
Count
Money
Time
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.