Client Account Ledger Report

The Get_Client_Ledger_Report_Json API endpoint dynamically calculates and retrieves the client's real-time account Ledger across all active currencies.
To request this data, you must authenticate by providing the ClientNumber and API_Password parameters in your JSON payload.

Function Input

{
  "ClientNumber": 500608,
  "API_Password": "8Lba7u5smABC",
  "FromBkEntryDate":"2026-03-15",
  "ContainStringInDescOrNotes":"BTC"
}
Field Description
ClientNumber The unique identifier for the client whose ledger report is being requested. (Integer)
API_Password The secret API password for authenticating the request. (String)
FromBkEntryDate
UntilBkEntryDate 		Date range for filtering ledger entries based on their official bookkeeping entry date.
Format: "YYYY-MM-DD". (String)
FromCashFlowDate
UntilCashFlowDate 		Date range for filtering ledger entries based on their cash flow date (value date).
Format: "YYYY-MM-DD". (String)
PointInTime An exact historical date and time to retrieve the ledger as it appeared at that specific moment.
Format: "YYYY-MM-DD HH:MM:SS". (String)
ContainStringInDescOrNotes A string to filter ledger entries where the description or internal notes contain this text.
Appending an asterisk (*) will perform a phonetic/sound match instead of an exact word match.
ByProject An integer representing a specific project or document ID to filter ledger entries by. (Integer)
CalcOpeningBalance An integer indicating how the opening balance should be calculated.
  • 0: No opening balance calculation.
  • 1: Calculate opening balance based on BkEntryDate.
  • 2: Calculate opening balance based on CashFlowDate.

Function Output

Here is an example of the corresponding response: 
{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "Request":{
    "AccountNumber":503104,
    "CalcOpeningBalance":2,
    "FromBkEntryDate":"2026-03-15",
    "UntilBkEntryDate":"",
    "FromCashFlowDate":"",
    "UntilCashFlowDate":"",
    "PointInTime":"",
    "ContainStringInDescOrNotes":"BTC",
    "ByProject":0
  },
  "DRAFT_Alert":true,
  "Entries":[
    {
      "EntryId":448807,
      "Description":"Crypto currency transaction, BUY BTC\/USD; Rate includes commission: 74,005.77257",
      "BkEntryDate":"2026-03-15",
      "CashFlowDate":"2026-03-15",
      "ReferenceDocumentType":0,
      "ReferenceDocument":127772,
      "Debit":163.33,
      "Credit":0,
      "CalculatedBalance":1069.53,
      "Currency":"USD",
      "ExchangeRate":3.147,
      "DebitLc":514.00,
      "CreditLc":0.00,
      "CalculatedBalanceLc":76853.99,
      "CreationTime":"2026-03-15 14:30:09",
      "CreatedBy":"very nice user",
      "ParentDocProject":0
    },
    {
      "EntryId":448807,
      "Description":"Crypto currency transaction, BUY BTC\/USD; Rate includes commission: 74,005.77257",
      "BkEntryDate":"2026-03-15",
      "CashFlowDate":"2026-03-15",
      "ReferenceDocumentType":0,
      "ReferenceDocument":127772,
      "Debit":0,
      "Credit":0.00220699,
      "CalculatedBalance":0.10790961,
      "Currency":"BTC",
      "ExchangeRate":232896.16627171,
      "DebitLc":0.00,
      "CreditLc":514.00,
      "CalculatedBalanceLc":77367.99,
      "CreationTime":"2026-03-15 14:30:09",
      "CreatedBy":"very nice user",
      "ParentDocProject":0
    }
  ],
  "Summary":[
    {
      "Currency":"USD",
      "TotalEntries":1,
      "TotalDebit":163.33,
      "TotalCredit":0,
      "CalculatedBalance":1069.53,
      "FloatingLc":3167.95,
      "StaticLc":3390.74,
      "ExchangeRate":2.962
    },
    {
      "Currency":"BTC",
      "TotalEntries":1,
      "TotalDebit":0,
      "TotalCredit":0.00220699,
      "CalculatedBalance":0.10790961,
      "FloatingLc":25177.20,
      "StaticLc":23436.10,
      "ExchangeRate":233317.4805
    },
    {
      "Currency":"ETH",
      "TotalEntries":0,
      "TotalDebit":0,
      "TotalCredit":0,
      "CalculatedBalance":2.47121843,
      "FloatingLc":17101.86,
      "StaticLc":23212.62,
      "ExchangeRate":6920.4168
    },
    {
      "Currency":"ADA",
      "TotalEntries":0,
      "TotalDebit":0,
      "TotalCredit":0,
      "CalculatedBalance":500,
      "FloatingLc":367.88,
      "StaticLc":705.70,
      "ExchangeRate":0.73576
    }
  ]
}
Field Description
ResponseCode Integer representing the execution result. A value of 0 indicates a successful query.
Values above 2 indicate an error or a restrictive account status.
ResponseMsgEng A descriptive English message associated with the response code, detailing the operational state (e.g., "Success").
Request An object mirroring the actual filtering parameters interpreted by the API (based on the internal AL_Report_Wheres table).
DRAFT_Alert A boolean flag. Returns true if the report is filtered (e.g., by text search, project, or skipped opening balance).
This indicates that the running balances might be chronologically incomplete and should be treated as a "draft" for display.

Entries

An array of objects, where each object represents a detailed ledger line (Journal Entry) for the client.
Entries.EntryId The unique internal serial number for the journal entry in the ERP system. (Integer)
Entries.Description A textual description of the ledger entry, including any private notes appended to the row. (String)
Entries.ReferenceDocumentType An integer indicating the classification of the source document:
1 = Tax Invoice, 2 = Receipt, 3 = Credit Invoice, 4 = Refund, 6 = Supplier Invoice, 10 = Exportation Log, etc.
Entries.ReferenceDocument The reference number or identifier of the source document (e.g., Invoice or Receipt number). (Integer)
Entries.Debit
Entries.Credit 		The debit or credit amount of the entry in its original currency. (Number)
Entries.CalculatedBalance The running balance of the account in its original currency after this entry is applied. (Number)
Entries.ExchangeRate The specific exchange rate used to convert the entry amount to the local accounting currency at the time of creation. (Number)
Entries.DebitLc
Entries.CreditLc 		The debit or credit amount of the entry converted to the local accounting currency (LC). (Number)
Entries.CalculatedBalanceLc The Static running balance of the account in the local accounting currency. (Number)
Entries.CreationTime The exact timestamp when the journal entry was physically created. (String)
Entries.ParentDocProject The ID of the parent document, project, or loan associated with this entry. (Integer)

Summary

An array of objects providing an aggregated summary of movements and balances, grouped by Currency.
Summary.TotalDebit
Summary.TotalCredit 		The total accumulated debit and credit amounts for this currency within the queried parameters. (Number)
Summary.CalculatedBalance The final calculated balance for this currency. (Number)
Summary.FloatingLc The floating revaluation of the currency balance.
Converted into the base bookkeeping currency using the Live or most recent exchange rate. (Number)
Summary.StaticLc The static revaluation of the currency balance.
Converted into the base bookkeeping currency using the historical exchange rates saved at the time the entries were created. (Number)
Summary.ExchangeRate The live or closing exchange rate used for the FloatingLc summary calculation. (Number)

Global Account Ledger Report (API)

The Get_Account_Ledger_Report_Json API endpoint serves as an administrative or backend integration tool.

Unlike the client-specific endpoint, it allows an authorized calling server to request the ledger for any valid account without requiring a personal [API_Password].
Note: This endpoint is only available if the
'Unprotected Accounting API'
flag is turned on in hyper's
[Website Features]
.

Instead of passing client credentials, you simply provide the AccountNumber (Client, Supplier, General Account, Project, Employee).
All other input filtering parameters and the entire Function Output JSON structure are exactly identical to the Get_Client_Ledger_Report_Json documentation detailed above.

Here is an example of the request and the corresponding response: 
// Function Input  (without any filtering parameter)
{"AccountNumber":44}
// Function Output:
{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "Request":{
    "AccountNumber":44,
    "CalcOpeningBalance":2,
    "FromBkEntryDate":"",
    "UntilBkEntryDate":"",
    "FromCashFlowDate":"",
    "UntilCashFlowDate":"",
    "PointInTime":"",
    "ContainStringInDescOrNotes":"",
    "ByProject":0
  },
  "DRAFT_Alert":false,		// no filters = full report
  "Entries":[
    {
      "EntryId":122746,
      "Description":"Fix client trade PnL #123",
      "BkEntryDate":"2024-04-09",
      "CashFlowDate":"2024-04-09",
      "ReferenceDocumentType":0,
      "ReferenceDocument":0,
      "Debit":60.96,
      "Credit":0,
      "CalculatedBalance":-60.96,
      "Currency":"ILS",
      "ExchangeRate":1,
      "DebitLc":60.96,
      "CreditLc":0.00,
      "CalculatedBalanceLc":-60.96,
      "CreationTime":"2024-08-18 10:42:49",
      "CreatedBy":"very nice user",
      "ParentDocProject":0
    },
    {
      "EntryId":122745,
      "Description":"Fix client trade PnL #123",
      "BkEntryDate":"2024-08-11",
      "CashFlowDate":"2024-08-11",
      "ReferenceDocumentType":0,
      "ReferenceDocument":0,
      "Debit":319.35,
      "Credit":0,
      "CalculatedBalance":-380.31,
      "Currency":"ILS",
      "ExchangeRate":1,
      "DebitLc":319.35,
      "CreditLc":0.00,
      "CalculatedBalanceLc":-380.31,
      "CreationTime":"2024-08-18 10:40:53",
      "CreatedBy":"very nice user",
      "ParentDocProject":0
    }
  ],
  "Summary":[
    {
      "Currency":"ILS",
      "TotalEntries":2,
      "TotalDebit":380.31,
      "TotalCredit":0,
      "CalculatedBalance":-380.31,
      "FloatingLc":-380.31,
      "StaticLc":-380.31,
      "ExchangeRate":1
    }
  ]
}