Financial Forecasts

Overview

From the Financial Forecasts endpoint, you can retrieve a business's 36 months of financial statements forecasts. See Financial Forecasts endpoint for more details.

❗️

Data Dependencies

Financial forecasts are created for monthly, quarterly and yearly timeframes. Quarterly and yearly financial forecasts depend on the monthly financial forecast. Monthly financial forecasts are dependent on financial statements as a source.

Data Model

🚧

All financial forecasts are part of an array of reports. See Reports data type for more details on the report structure and its meta-data.

📘

Financial Statement Type

Each financial forecast report will contain the type of the financial statement being forecasted (financialStatementType). See Financial Forecasts endpoint for more details.

Field

Type

Description

section
sortable, filterable

string

Railz normalized account classification. See Accounts.

subSection
sortable, filterable

string

Railz normalized account classification. See Accounts.

group
sortable, filterable

string

Railz normalized account classification. See Accounts.

subGroup
sortable, filterable

string

Railz normalized account classification. See Accounts.

account
sortable, filterable

string

Name of the account in the accounting service provider.

subAccount

string

Name of the sub-account in the accounting service provider.

amount
sortable, filterable

decimal

Forecasted amount of the account.

endDate
sortable, filterable

string
See Date

The forecast date.

Example Data

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "reportId": "5fad8a342a88364234392fb5",
        "serviceName": "xero",
        "businessName": "Railz",
        "financialStatementType": "balanceSheets",
        "endDate": "2020-12-25T01:02:03Z",
        "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",
          "subAccount": "Bank of America",
          "endDate": "2022-03-31",
          "amount": 1500000.5
        }
      ]
    }
  ]
}

Did this page help you?