Live Client Account Balance

The Get_Client_Balance_json API endpoint dynamically calculates and retrieves the client's real-time account balance across all active currencies, alongside their current account status.
To request this data, you must authenticate by providing the ClientNumber and API_Password parameters in your JSON payload.
Here is an example of the request and the corresponding response: 
// Function Input:
{
  "ClientNumber": 500608,
  "API_Password": "8Lba7u5smABC"
}
// Function Output:
{
  "ResponseCode": 0,
  "ResponseMsgEng": "Client account is OK",
  "ERP_Account_Status": 5,
  "ERP_Account_Status_Text": "לקוח אמיתי",
  "Web_Account_Status": 2,
  "Web_Account_Status_Text": "מאושר / פעיל",
  "Agency": 0,
  "Data": [
    {
      "Currency": "BTC",
      "Balance": 0.10790961,
      "Value_ILS": 25133.8,
      "Cash": 0.10790961
    },
    {
      "Currency": "ETH",
      "Balance": 2.47121843,
      "Value_ILS": 17208.41,
      "Cash": 2.47121843
    },
    {
      "Currency": "ILS",
      "Balance": 27354.00,
      "Value_ILS": 27354.00,
      "Cash": 25354.00            // -2000 ILS for Margin (V.A.R) or Tax Deduction
    },
    {
      "Currency": "USD",
      "Balance": 1064.15,
      "Value_ILS": 3192.44,
      "Cash": 1064.15
    }
  ],
  "Total_Floating_Balance_ILS": 72888.65
}
* In this example, in the system settings "ILS" is the accounting currency. The currency varies depending on the country in which the company is registered.

Field Description
ResponseCode Integer representing the execution result. A value of 0 indicates a successful query, while non-zero values indicate an error or a restrictive account status.
ResponseMsgEng A descriptive English message associated with the response code, detailing the account's operational state (e.g., "Client account is OK").
ERP_Account_Status
ERP_Account_Status_Text 		Integer and its localized string representation indicating the client's internal handling status within the Hyper ERP system.
Restrictive statuses may prevent certain operations.
0 = New
1 = Follow up
2 = Follow up + Meeting / P.Offer
3 = Client Not Interested
4 = Approved Client
5 = Real Client
6 = InActive / Suspended (Read Notes)
Web_Account_Status
Web_Account_Status_Text 		Integer and its localized string representation indicating the client's website API operational status.
0 = Blocked (cannot Sign-in)
1 = Pending Approval
2 = Approved
3 = On Hold (Readonly)
Agency Integer representing the internal Agency (or Branch) ID associated with this client.
Data An array of objects, where each object represents a specific currency (fiat or cryptocurrency) holding a balance different from zero.
Data.Currency String field (up to 5 characters) containing the ISO code of the fiat currency (like USD, ILS) or cryptocurrency (like BTC, ETH).
Data.Balance Real number representing the calculated accounting balance. Precision is up to 8 decimal places for crypto assets and 2 for fiat.
Note that in the case of a debt, this may be a negative value.
Data.Value_ILS Real number (up to 2 decimal places) representing the floating revaluation of the specific currency balance converted into the base bookkeeping currency (e.g., ILS).
Divide this field by the previous [Balance] field to calculate the currency conversion rate.
Data.Cash Real number representing the actual available funds.
This is derived by taking the accounting Balance and deducting any secured limits, such as pending withdrawals, open limit orders (e.g., BUY/SELL Limit), or margin requirements.
Total_Floating_Balance_ILS This is a sum of all "Data.Value_ILS" fields. This is not the CASH field!

Please note that a successful technical execution of the API query may still yield different response codes depending on the client's business status within the ERP system:
  • ResponseCode 0 (Client account is OK): Returned when the client account is fully verified and approved for activity.
    This requires the "Locked Name & ID" field to be verified, and the account handling status to be either "Approved Client" (4) or "Real Client" (5).
  • ResponseCode 1 (Restrictive status): Returned when the client has a restricted handling status in the system (e.g., Suspended, New, or Not Interested).
    In this scenario, the API will prompt the user to review the specific case details directly within the Hyper ERP application.