Trial Balance Report API

The Get_TrialBalance_Report_Json API endpoint produces a Trial Balance report from the accounting journal.
It can be used for any account (General Account, Client, Supplier, Project), Access to salary accounts (hired workers) is blocked.
Each call queries the database and calculates the report on demand, so it should not be called more frequently than needed.

Function Input

The request can select accounts in one of two ways: Pass an explicit list of account numbers in ByAccountNumbers,
or ask Hyper to build the account list by account purpose using ByAccountPurpose. 

{
  "From_Date": "2026-01-01",
  "Until_Date": "2026-12-31",
  "From_CF_Date": "2026-01-01",
  "Until_CF_Date": "2026-12-31",
  "ByAccountNumbers": [
    79,
    80,
    81
  ],
  "Delete_Accounts": "Without Entries",
  "Philosophy": 0
}

Example using account purposes instead of explicit account numbers: 
{
  "Until_Date": "2026-12-31",
  "ByAccountPurpose": [
    "Clients",
    "Suppliers",
    "Revenue",
    "Expense"
  ],
  "Delete_Accounts": "None"
}

Field Type / Structure Required Description
ByAccountNumbers JSON Array of Integers One of two selection methods An array of Hyper account numbers to include in the report.
The numbers may belong to any supported accounting entity type: primary accounts, clients, suppliers, projects, or users.
The API queries the account names and returns only existing enabled accounts.
ByAccountPurpose JSON Array of Strings One of two selection methods Builds the account list by account purpose instead of explicit account numbers.
Supported values are case-insensitive:
  • Clients
  • Suppliers
  • Projects
  • General static
  • General
  • Revenue
  • Expense
  • Continuous Bank
  • Cash Income
  • Cheque Income
  • Electronic Income
  • Cash Payments
  • Cheque Payments
  • Electronic Payments
  • Settling of VAT
  • Institution
  • Hired Worker - need a special authorization to workPhilosophy
From_Date
Until_Date 		Date string No Filters journal entries by official bookkeeping entry date.
Format: YYYY-MM-DD.
From_CF_Date
Until_CF_Date 		Date string No Filters journal entries by cash flow date / value date.
Format: YYYY-MM-DD.
Philosophy Integer enum No Filters by the journal field
[Standard / Philosophy]
.
If a value greater than 0 is passed, the report ADD that requested accounting standard:
1 = GAAP / 2 = IFRS / 3 = Theory
Only one Standard can be selected. Entries with value 0 are always included.
Delete_Accounts String No Controls which output rows are removed from the report.
  • Default behavior removes rows where the calculated balance is zero.
  • 'Without Entries'
    removes rows that have no journal entries in the requested scope.
    An account/currency row that had entries and ended with zero balance can still appear.
  • 'None'
    disables this cleanup and returns rows for the requested accounts even when there are no entries.

Function Output

{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "TrialBalance":[
    {
      "AccountId":500001,
      "AccountName":"Fair Client Name",
      "Balance":238460.93,
      "Currency":"ILS",
      "BalanceLc":138460.93,
      "FloatingBalanceLc":138460.93,
      "EntriesAmount":58,
      "ExportAccountTo3rdParty":0,
      "LastBkEntryDate":"2026-06-16",
      "LastCashFlowDate":"2026-06-16",
      "LastDocTypeDate":"2026-06-14"
    },
    {
      "AccountId":500001,
      "AccountName":"Fair Client Name",
      "Balance":-27381.62,
      "Currency":"USD",
      "BalanceLc":-82115.35,
      "FloatingBalanceLc":-81642.68,
      "EntriesAmount":28,
      "ExportAccountTo3rdParty":0,
      "LastBkEntryDate":"2026-06-15",
      "LastCashFlowDate":"2026-06-15",
      "LastDocTypeDate":"2026-06-15"
    }
  ]
}

Field Description
ResponseCode Integer representing the execution result. A value of 0 indicates a successful query.
ResponseMsgEng A descriptive English message associated with the response code.
TrialBalance An array of calculated Trial Balance rows.
TrialBalance.AccountId The Hyper account number.
TrialBalance.AccountName The account title or entity "full name" returned by Hyper.
TrialBalance.Balance The calculated balance in the row currency.
TrialBalance.Currency Currency code for the balance row.
TrialBalance.BalanceLc Balance converted to the local bookkeeping currency using the static exchange rates saved in the journal entries.
TrialBalance.FloatingBalanceLc Balance revalued into the local bookkeeping currency using the live or most recent representative exchange rate.
TrialBalance.EntriesAmount Number of journal movements included in this account/currency row.
TrialBalance.LastBkEntryDate The latest bookkeeping entry date found in the journal movements included in the row.
TrialBalance.LastCashFlowDate The latest cash flow date found in the journal movements included in the row.
TrialBalance.LastDocTypeDate The latest date found where
[Reference Document Type]
IN [1..8,10]