latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Visualizations

List Financial Forecast report

Supported for:

freshbooks quickbooks quickbooksDesktop xero dynamicsBusinessCentral zohoBooks byod

get/v2/visualizations/financialForecasts

Query parameters

connectionUuidstring required

Unique connection identifier.

startDatestring
endDatestring
financialStatementType'balanceSheets' | 'incomeStatements' | 'cashflowStatements' required
reportFrequency'month' | 'quarter' | 'year' required
percentilenumber float
reconstruct'true' | 'false'

Railz reconstructed Financial Forecast

Response

Example response

{
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "endDate": "2020-12-25T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z",
    "reportFrequency": "month",
    "currency": [
      "USD"
    ]
  },
  "data": [
    {
      "period": {
        "year": 2020,
        "month": 8,
        "quarter": 3,
        "day": 31,
        "date": "2020-08-31T00:00:00.000Z"
      },
      "currentAssets": 345,
      "nonCurrentAssets": 345,
      "currentLiabilities": 345,
      "nonCurrentLiabilities": 345,
      "equity": 345,
      "operatingActivities": 345,
      "financingActivities": 345,
      "investingActivities": 345,
      "netCash": 345,
      "operatingIncome": 345,
      "operatingExpenses": 345,
      "costOfGoodsSold": 345,
      "otherIncome": 345,
      "otherExpenses": 345,
      "netIncome": 345
    }
  ]
}