VUZDevelopers

Generate Trial Balance Report (מאזן בוחן)

GET
/reports/trial-balance

Generate a Trial Balance (מאזן בוחן) showing opening balances, period movements, and closing balances. Accounts are grouped by category with subtotals. Supports variants: combined (default), balances (closing only), movements (period only).

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

startDate?string

Period start date (ISO 8601). Defaults to Jan 1 of current year.

endDate?string

Period end date (ISO 8601). Defaults to today.

fiscalYear?number

Fiscal year (alternative to date range)

hideZeroBalances?boolean

Hide accounts with zero balance and zero movements

variant?string

Report variant: combined (3-column, default), balances (closing only), movements (period only)

Value in

  • "combined"
  • "balances"
  • "movements"
accountCategory?string

Filter by account category

Value in

  • "ASSET"
  • "LIABILITY"
  • "EQUITY"
  • "REVENUE"
  • "EXPENSE"
locale?string

Display locale for report line labels (Cash Flow section item names). Defaults to Hebrew.

Value in

  • "he"
  • "en"

Header Parameters

X-Business-Id*string

Response Body

application/json

curl -X GET "https://example.com/reports/trial-balance" \  -H "X-Business-Id: string"
{  "businessId": "string",  "variant": "combined",  "startDate": "2025-01-01",  "endDate": "2025-12-31",  "reportDate": "2025-12-31",  "categoryGroups": [    {      "category": "ASSET",      "categoryNameHe": "נכסים",      "categoryNameEn": "Assets",      "accounts": [        {          "accountCode": "1000",          "accountName": "קופה",          "accountNameEnglish": "Cash",          "accountCategory": "ASSET",          "openingDebit": 5000,          "openingCredit": 0,          "periodDebit": 12000,          "periodCredit": 10000,          "closingDebit": 7000,          "closingCredit": 0        }      ],      "subtotalOpeningDebit": 30000,      "subtotalOpeningCredit": 0,      "subtotalPeriodDebit": 62000,      "subtotalPeriodCredit": 55000,      "subtotalClosingDebit": 37000,      "subtotalClosingCredit": 0    }  ],  "totals": {    "openingDebit": 500000,    "openingCredit": 500000,    "periodDebit": 150000,    "periodCredit": 150000,    "closingDebit": 650000,    "closingCredit": 650000  },  "isOpeningBalanced": true,  "isMovementsBalanced": true,  "isClosingBalanced": true,  "isBalanced": true,  "accountCount": 35,  "activeAccountCount": 12,  "generatedAt": "2019-08-24T14:15:22Z",  "accounts": [    "string"  ],  "totalDebits": 0,  "totalCredits": 0,  "balanceCheck": 0}