Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Reports

Retrieves trial balance report

Returns a trial balance report for the specified date range. Required parameters: from_date and to_date (ISO-8601 format YYYY-MM-DD). Both must be provided or the call will fail. Example: from_date=2024-01-01, to_date=2024-12-31.

get/reports/trial-balance

Query parameters

from_datestring date required

Start date for the report period. Uses ISO-8601 format (YYYY-MM-DD).

to_datestring date required

End date for the report period. Uses ISO-8601 format (YYYY-MM-DD).

subsidiary_idstring uuid

Subsidiary to be used when filtering data

Response

OK

currencystring required

Currency code following ISO-4217

Example response

{
  "period": {
    "from_date": "2024-01-01",
    "to_date": "2024-01-31"
  },
  "currency": "USD",
  "accounts": [
    {
      "code": "1000",
      "name": "Cash",
      "beginning_balance": {
        "amount": "1.01",
        "currency": "USD"
      },
      "debit_total": {
        "amount": "1.01",
        "currency": "USD"
      },
      "credit_total": {
        "amount": "1.01",
        "currency": "USD"
      },
      "debit_fx_total": {
        "amount": "1.01",
        "currency": "USD"
      },
      "credit_fx_total": {
        "amount": "1.01",
        "currency": "USD"
      },
      "ending_balance": {
        "amount": "1.01",
        "currency": "USD"
      }
    }
  ],
  "totals": {
    "beginning_balance": {
      "amount": "1.01",
      "currency": "USD"
    },
    "debit_total": {
      "amount": "1.01",
      "currency": "USD"
    },
    "credit_total": {
      "amount": "1.01",
      "currency": "USD"
    },
    "debit_fx_total": {
      "amount": "1.01",
      "currency": "USD"
    },
    "credit_fx_total": {
      "amount": "1.01",
      "currency": "USD"
    },
    "ending_balance": {
      "amount": "1.01",
      "currency": "USD"
    }
  }
}