---
title: "Trial Balance"
method: GET
path: "/reports/trial-balance/"
tags: ["Reports"]
---

# Trial Balance

`GET /reports/trial-balance/`

Generate trial balance report from `from_date` to `to_date` optionally with PNL openings `with_pnl_openings` and accounts with zero balances `include_zero_balances`.

## Query parameters

- `branch__in` string[]
- `contact__in` string[]
- `cost_center__in` string[]
- `from_date` string, date
- `include_zero_balances` boolean
- `project__in` string[]
- `to_date` string, date
- `with_pnl_openings` boolean

## Response `200`

- ApiV1ExternalReportsTrialBalanceGroupedRead[]
  - `overview` ApiV1ExternalReportsTrialBalanceOverviewRead, required
    - `count` integer, required — The total number of accounts
    - `created_ts` string, date-time, required — The timestamp in UTC when the report was created
    - `filters` object, required — The filters of the report
    - `from_date` string, date, required — The start date of the report
    - `id` string, required — The id of the report
    - `include_zero_balances` boolean, required — Whether the report includes the accounts with zero balances
    - `label` string, required — The title of the report
    - `to_date` string, date, required — The end date of the report
    - `with_pnl_openings` boolean, required — Whether the report includes the Profit and Loss openings
  - `rows` ApiV1ExternalReportsTrialBalanceSectionRead[], required — The rows of the report
    - `children` object[], required — The children of the section
    - `group` string, required — The group of the section
    - `id` string, required — The id of the section
    - `label` string, required — The label of the section
    - `metadata` object, required — The metadata of the section
    - `summary` ApiV1ExternalReportsTrialBalanceSectionSummaryRead, required
      - `id` string, required — The id of the summary
      - `label` string, required — The label of the summary
      - `metadata` object — The metadata of the summary
      - `sub_totals` TrialBalanceTotalsRead, required
        - `credit_to_bcy` number, double, required — Credits in base currency
        - `debit_to_bcy` number, double, required — Debits in base currency
        - `opening_balance_to_bcy` number, double, required — Opening balance in base currency
        - `running_balance_to_bcy` number, double, required — Running balance in base currency
  - `summary` ApiV1ExternalReportsTrialBalanceSummaryRead, required
    - `id` string, required — The id of the summary
    - `label` string, required — The label of the summary
    - `metadata` object — The metadata of the summary
    - `totals` TrialBalanceTotalsRead, required
      - `credit_to_bcy` number, double, required — Credits in base currency
      - `debit_to_bcy` number, double, required — Debits in base currency
      - `opening_balance_to_bcy` number, double, required — Opening balance in base currency
      - `running_balance_to_bcy` number, double, required — Running balance in base currency

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/revisions/36816b4fce7f/schema)
