Namirasoft Balance API V1
Namira Software Corporation Balance API Version 1 (1.4.19)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-balance-api-v1
Commands
Healthz
Get
Returns the application health status
ns-balance healthz 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}
_Create
Creates a new transaction
ns-balance transaction _create
--user_id (String)
--product_id (String)
--txn_id (String)
--asset_id_name (String)
--category (String)
--description (String)
--amount (Integer)
_Delete
Deletes an transaction by an id
ns-balance transaction _delete {id}
Seen
Seens transaction
ns-balance transaction seen
Summary
List
Returns the summary list
ns-balance summary list {asset_id} {filters} {page} {size} {sorts}
Asset
List
Returns the asset list
ns-balance asset list {filters} {page} {size} {sorts}
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": "Integer", "required": true }, "seen": { "type": "Boolean", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TransactionInput
{ "name": "TransactionInput", "type": "Object", "required": true, "fields": { "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_name": { "type": "String", "required": true }, "category": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "amount": { "type": "Integer", "required": true } }}
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": "Integer", "required": true }, "total_debt": { "type": "Integer", "required": true }, "total_credit": { "type": "Integer", "required": true }, "final_balance": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
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 } }}
Enums
AssetType
Count
Money
Time
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.