Namirasoft ERP API V1

Namira Software Corporation ERP API Version 1 (1.4.7)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-erp-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-erp healthz get

Copied!

Health

Liveness

Returns the application liveness status

ns-erp health liveness

Copied!

Readiness

Returns the application readiness status

ns-erp health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-erp metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-erp value list {table} {column} {search} {field_id} {limit}

Copied!

Currency

List

Returns the currency list

ns-erp currency list {filters} {page} {size} {sorts}

Copied!

Get

Returns a currency by an id

ns-erp currency get {id}

Copied!

Create

Creates a new currency

ns-erp currency create

Copied!

--name (String)

--fraction_name (String)

--fraction_value (Integer)

--symbol (String)

--description (String)

--enabled (Boolean)

Update

Updates a currency by an id

ns-erp currency update {id}

Copied!

--name (String)

--fraction_name (String)

--fraction_value (Integer)

--symbol (String)

--description (String)

--enabled (Boolean)

Delete

Deletes a currency by an id

ns-erp currency delete {id}

Copied!

CurrencyExchange

List

Returns the currency exchange list

ns-erp currencyexchange list {filters} {page} {size} {sorts}

Copied!

Get

Returns a currency exchange by an id

ns-erp currencyexchange get {id}

Copied!

Create

Creates a new currency exchange

ns-erp currencyexchange create

Copied!

--date_time (DateTime)

--from_currency_id (String)

--to_currency_id (String)

--rate (Decimal)

Update

Updates a currency exchange by an id

ns-erp currencyexchange update {id}

Copied!

--date_time (DateTime)

--from_currency_id (String)

--to_currency_id (String)

--rate (Decimal)

Delete

Deletes a currency exchange by an id

ns-erp currencyexchange delete {id}

Copied!

Company

List

Returns the company list

ns-erp company list {filters} {page} {size} {sorts}

Copied!

Get

Returns a company by an id

ns-erp company get {id}

Copied!

Create

Creates a new company

ns-erp company create

Copied!

--name (String)

--description (String)

--enabled (Boolean)

Update

Updates a company by an id

ns-erp company update {id}

Copied!

--name (String)

--description (String)

--enabled (Boolean)

Delete

Deletes a company by an id

ns-erp company delete {id}

Copied!

Branch

List

Returns the branch list

ns-erp branch list {filters} {page} {size} {sorts}

Copied!

Get

Returns a branch by an id

ns-erp branch get {id}

Copied!

Create

Creates a new branch

ns-erp branch create

Copied!

--company_id (String)

--default_currency_id (String)

--name (String)

--country (String)

--description (String)

--enabled (Boolean)

Update

Updates a branch by an id

ns-erp branch update {id}

Copied!

--company_id (String)

--default_currency_id (String)

--name (String)

--country (String)

--description (String)

--enabled (Boolean)

Delete

Deletes a branch by an id

ns-erp branch delete {id}

Copied!

FiscalYear

List

Returns the fiscal year list

ns-erp fiscalyear list {filters} {page} {size} {sorts}

Copied!

Get

Returns a fiscal year by an id

ns-erp fiscalyear get {id}

Copied!

Create

Creates a new fiscal year

ns-erp fiscalyear create

Copied!

--company_id (String)

--name (String)

--date_start (Date)

--date_end (Date)

--description (String)

--enabled (Boolean)

Update

Updates a fiscal year by an id

ns-erp fiscalyear update {id}

Copied!

--company_id (String)

--name (String)

--date_start (Date)

--date_end (Date)

--description (String)

--enabled (Boolean)

Delete

Deletes a fiscal year by an id

ns-erp fiscalyear delete {id}

Copied!

ERPAccount

List

Returns the account list

ns-erp erpaccount list {filters} {page} {size} {sorts}

Copied!

Get

Returns an account by an id

ns-erp erpaccount get {id}

Copied!

Create

Creates a new account

ns-erp erpaccount create

Copied!

--company_id (String)

--branch_id (String)

--account_id (String)

--code (String)

--name (String)

--is_group (Boolean)

--type (Enum)

--description (String)

--enabled (Boolean)

--party_type_ids (Array)

Update

Updates an account by an id

ns-erp erpaccount update {id}

Copied!

--company_id (String)

--branch_id (String)

--account_id (String)

--code (String)

--name (String)

--is_group (Boolean)

--type (Enum)

--description (String)

--enabled (Boolean)

--party_type_ids (Array)

Delete

Deletes an account by an id

ns-erp erpaccount delete {id}

Copied!

PartyType

List

Returns the party type list

ns-erp partytype list {filters} {page} {size} {sorts}

Copied!

Get

Returns a party type by an id

ns-erp partytype get {id}

Copied!

Create

Creates a new party type

ns-erp partytype create

Copied!

--company_id (String)

--branch_id (String)

--name (String)

--description (String)

--enabled (Boolean)

Update

Updates a party type by an id

ns-erp partytype update {id}

Copied!

--company_id (String)

--branch_id (String)

--name (String)

--description (String)

--enabled (Boolean)

Delete

Deletes a party type by an id

ns-erp partytype delete {id}

Copied!

AccountPartyType

List

Returns the account party type list

ns-erp accountpartytype list {filters} {page} {size} {sorts}

Copied!

Get

Returns an account party type by an id

ns-erp accountpartytype get {id}

Copied!

Party

List

Returns the party list

ns-erp party list {filters} {page} {size} {sorts}

Copied!

Get

Returns a party by an id

ns-erp party get {id}

Copied!

Create

Creates a new party

ns-erp party create

Copied!

--company_id (String)

--branch_id (String)

--party_type_id (String)

--name (String)

--description (String)

--enabled (Boolean)

Update

Updates a party by an id

ns-erp party update {id}

Copied!

--company_id (String)

--branch_id (String)

--party_type_id (String)

--name (String)

--description (String)

--enabled (Boolean)

Delete

Deletes a party by an id

ns-erp party delete {id}

Copied!

JournalEntry

List

Returns the journal entry list

ns-erp journalentry list {filters} {page} {size} {sorts}

Copied!

Get

Returns a journal entry by an id

ns-erp journalentry get {id}

Copied!

Create

Creates a new journal entry

ns-erp journalentry create

Copied!

--company_id (String)

--branch_id (String)

--fiscal_year_id (String)

--currency_id (String)

--number (String)

--date_time (DateTime)

--reference_number (String)

--reference_date_time (DateTime)

--description (String)

--enabled (Boolean)

--lines (Array)

Update

Updates a journal entry by an id

ns-erp journalentry update {id}

Copied!

--company_id (String)

--branch_id (String)

--fiscal_year_id (String)

--currency_id (String)

--number (String)

--date_time (DateTime)

--reference_number (String)

--reference_date_time (DateTime)

--description (String)

--enabled (Boolean)

--lines (Array)

Delete

Deletes a journal entry by an id

ns-erp journalentry delete {id}

Copied!

JournalEntryLine

List

Returns the journal entry line list

ns-erp journalentryline list {filters} {page} {size} {sorts}

Copied!

Get

Returns a journal entry line by an id

ns-erp journalentryline get {id}

Copied!

Report

GeneralLedger

Returns the General Ledger report for an account from enabled journal entries

ns-erp report generalledger {company_id} {branch_id} {fiscal_year_id} {date_time_from} {date_time_to} {account_id} {party_type_id} {party_id} {currency_id}

Copied!

BalanceSheet

Returns the Balance Sheet report from enabled journal entries

ns-erp report balancesheet {company_id} {branch_id} {fiscal_year_id} {as_of_date_time} {account_ids} {party_type_id} {party_id} {currency_id} {group_by_account} {group_by_party} {show_zero} {show_debit} {show_credit}

Copied!

Schemas


Currency

{
  "name": "Currency",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "fraction_name": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "fraction_value": {
      "type": "Integer",
      "required": false
    },
    "symbol": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

CurrencyInput

{
  "name": "CurrencyInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "fraction_name": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "fraction_value": {
      "type": "Integer",
      "required": false
    },
    "symbol": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

CurrencyExchange

{
  "name": "CurrencyExchange",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "date_time": {
      "type": "DateTime",
      "required": true
    },
    "from_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "to_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "rate": {
      "type": "Decimal",
      "required": true,
      "precision": 8
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

CurrencyExchangeInput

{
  "name": "CurrencyExchangeInput",
  "type": "Object",
  "required": true,
  "fields": {
    "date_time": {
      "type": "DateTime",
      "required": true
    },
    "from_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "to_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "rate": {
      "type": "Decimal",
      "required": true,
      "precision": 8
    }
  }
}

Company

{
  "name": "Company",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

CompanyInput

{
  "name": "CompanyInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

Branch

{
  "name": "Branch",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "default_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "country": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

BranchInput

{
  "name": "BranchInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "default_currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "country": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

FiscalYear

{
  "name": "FiscalYear",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "date_start": {
      "type": "Date",
      "required": true
    },
    "date_end": {
      "type": "Date",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

FiscalYearInput

{
  "name": "FiscalYearInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "date_start": {
      "type": "Date",
      "required": true
    },
    "date_end": {
      "type": "Date",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

Account

{
  "name": "Account",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "account_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "code": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "is_group": {
      "type": "Boolean",
      "required": true
    },
    "type": {
      "name": "AccountType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Asset",
        "Liability",
        "Equity",
        "Income",
        "Expense"
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

AccountFull

{
  "name": "AccountFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "account_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "code": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "is_group": {
      "type": "Boolean",
      "required": true
    },
    "type": {
      "name": "AccountType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Asset",
        "Liability",
        "Equity",
        "Income",
        "Expense"
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "party_type_ids": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "String",
          "required": true
        }
      ]
    }
  }
}

AccountInput

{
  "name": "AccountInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "account_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "code": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "is_group": {
      "type": "Boolean",
      "required": true
    },
    "type": {
      "name": "AccountType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Asset",
        "Liability",
        "Equity",
        "Income",
        "Expense"
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "party_type_ids": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "type": "String",
          "required": true
        }
      ]
    }
  }
}

PartyType

{
  "name": "PartyType",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

PartyTypeInput

{
  "name": "PartyTypeInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

AccountPartyType

{
  "name": "AccountPartyType",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "account_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "party_type_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "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
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "party_type_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

PartyInput

{
  "name": "PartyInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "party_type_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    }
  }
}

JournalEntry

{
  "name": "JournalEntry",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "fiscal_year_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "exchange_rate": {
      "type": "Decimal",
      "required": true,
      "precision": 8
    },
    "number": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "date_time": {
      "type": "DateTime",
      "required": true
    },
    "reference_number": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "reference_date_time": {
      "type": "DateTime",
      "required": false
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

JournalEntryFull

{
  "name": "JournalEntryFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "fiscal_year_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "exchange_rate": {
      "type": "Decimal",
      "required": true,
      "precision": 8
    },
    "number": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "date_time": {
      "type": "DateTime",
      "required": true
    },
    "reference_number": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "reference_date_time": {
      "type": "DateTime",
      "required": false
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "lines": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "JournalEntryLine",
          "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
            },
            "number": {
              "type": "Integer",
              "required": true
            },
            "account_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "party_type_id": {
              "type": "String",
              "required": false,
              "min": 20,
              "max": 20
            },
            "party_id": {
              "type": "String",
              "required": false,
              "min": 20,
              "max": 20
            },
            "debit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "credit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "created_at": {
              "type": "DateTime",
              "required": true
            },
            "updated_at": {
              "type": "DateTime",
              "required": true
            }
          }
        }
      ]
    }
  }
}

JournalEntryLine

{
  "name": "JournalEntryLine",
  "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
    },
    "number": {
      "type": "Integer",
      "required": true
    },
    "account_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "party_type_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "party_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

JournalEntryInput

{
  "name": "JournalEntryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "company_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "branch_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "fiscal_year_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "currency_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "number": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "date_time": {
      "type": "DateTime",
      "required": true
    },
    "reference_number": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "reference_date_time": {
      "type": "DateTime",
      "required": false
    },
    "description": {
      "type": "String",
      "required": false
    },
    "enabled": {
      "type": "Boolean",
      "required": true
    },
    "lines": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "JournalEntryLineInput",
          "type": "Object",
          "required": true,
          "fields": {
            "account_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "party_type_id": {
              "type": "String",
              "required": false,
              "min": 20,
              "max": 20
            },
            "party_id": {
              "type": "String",
              "required": false,
              "min": 20,
              "max": 20
            },
            "debit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "credit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            }
          }
        }
      ]
    }
  }
}

JournalEntryLineInput

{
  "name": "JournalEntryLineInput",
  "type": "Object",
  "required": true,
  "fields": {
    "account_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "party_type_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "party_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    }
  }
}

GeneralLedger

{
  "name": "GeneralLedger",
  "type": "Object",
  "required": true,
  "fields": {
    "opening": {
      "name": "GeneralLedgerMoney",
      "type": "Object",
      "required": true,
      "fields": {
        "debit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "credit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "balance": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        }
      }
    },
    "rows": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "GeneralLedgerRow",
          "type": "Object",
          "required": true,
          "fields": {
            "journal_entry_id": {
              "type": "String",
              "required": true
            },
            "journal_entry_number": {
              "type": "String",
              "required": true
            },
            "journal_entry_date_time": {
              "type": "DateTime",
              "required": true
            },
            "journal_entry_description": {
              "type": "String",
              "required": false
            },
            "currency_id": {
              "type": "String",
              "required": true
            },
            "company_id": {
              "type": "String",
              "required": true
            },
            "branch_id": {
              "type": "String",
              "required": true
            },
            "line_id": {
              "type": "String",
              "required": true
            },
            "account_id": {
              "type": "String",
              "required": true
            },
            "party_type_id": {
              "type": "String",
              "required": false
            },
            "party_id": {
              "type": "String",
              "required": false
            },
            "debit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "credit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "running_balance": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            }
          }
        }
      ]
    },
    "period": {
      "name": "GeneralLedgerMoney",
      "type": "Object",
      "required": true,
      "fields": {
        "debit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "credit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "balance": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        }
      }
    },
    "closing": {
      "name": "GeneralLedgerMoney",
      "type": "Object",
      "required": true,
      "fields": {
        "debit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "credit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "balance": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        }
      }
    }
  }
}

GeneralLedgerMoney

{
  "name": "GeneralLedgerMoney",
  "type": "Object",
  "required": true,
  "fields": {
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "balance": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    }
  }
}

GeneralLedgerRow

{
  "name": "GeneralLedgerRow",
  "type": "Object",
  "required": true,
  "fields": {
    "journal_entry_id": {
      "type": "String",
      "required": true
    },
    "journal_entry_number": {
      "type": "String",
      "required": true
    },
    "journal_entry_date_time": {
      "type": "DateTime",
      "required": true
    },
    "journal_entry_description": {
      "type": "String",
      "required": false
    },
    "currency_id": {
      "type": "String",
      "required": true
    },
    "company_id": {
      "type": "String",
      "required": true
    },
    "branch_id": {
      "type": "String",
      "required": true
    },
    "line_id": {
      "type": "String",
      "required": true
    },
    "account_id": {
      "type": "String",
      "required": true
    },
    "party_type_id": {
      "type": "String",
      "required": false
    },
    "party_id": {
      "type": "String",
      "required": false
    },
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "running_balance": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    }
  }
}

BalanceSheet

{
  "name": "BalanceSheet",
  "type": "Object",
  "required": true,
  "fields": {
    "rows": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "BalanceSheetRow",
          "type": "Object",
          "required": true,
          "fields": {
            "account_id": {
              "type": "String",
              "required": false
            },
            "party_type_id": {
              "type": "String",
              "required": false
            },
            "party_id": {
              "type": "String",
              "required": false
            },
            "debit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "credit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "balance_debit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            },
            "balance_credit": {
              "type": "Decimal",
              "required": true,
              "precision": 4
            }
          }
        }
      ]
    },
    "total": {
      "name": "BalanceSheetMoney",
      "type": "Object",
      "required": true,
      "fields": {
        "debit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "credit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "balance_debit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        },
        "balance_credit": {
          "type": "Decimal",
          "required": true,
          "precision": 4
        }
      }
    }
  }
}

BalanceSheetRow

{
  "name": "BalanceSheetRow",
  "type": "Object",
  "required": true,
  "fields": {
    "account_id": {
      "type": "String",
      "required": false
    },
    "party_type_id": {
      "type": "String",
      "required": false
    },
    "party_id": {
      "type": "String",
      "required": false
    },
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "balance_debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "balance_credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    }
  }
}

BalanceSheetMoney

{
  "name": "BalanceSheetMoney",
  "type": "Object",
  "required": true,
  "fields": {
    "debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "balance_debit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    },
    "balance_credit": {
      "type": "Decimal",
      "required": true,
      "precision": 4
    }
  }
}

Enums

AccountType

Asset

Liability

Equity

Income

Expense

Namira Software Corporation

©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.