latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Financial Forecasts

List Financial Forecasts

Supported for:

freshbooks quickbooks quickbooksDesktop xero dynamicsBusinessCentral zohoBooks byod

get/v2/analytics/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

countnumber required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
        "businessName": "Railz",
        "serviceName": "xero",
        "reportId": "5fad8a342a88364234392fb5",
        "financialStatementType": "balanceSheets",
        "reportFrequency": "month",
        "startDate": "2020-11-01T00:00:00Z",
        "endDate": "2022-03-31T00:00:00Z",
        "createdAt": "2020-11-25T01:02:03Z",
        "updatedAt": "2020-11-30T01:02:03Z"
      },
      "data": [
        {
          "section": "Assets",
          "subSection": "Current Assets",
          "group": "Cash And Cash Equivalents",
          "subGroup": "Checking",
          "account": "Bank of America",
          "endDate": "2022-03-31",
          "value": 1500000.5
        }
      ]
    }
  ]
}