Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
Forecasts

List forecasts

Returns the treasury forecasts of a company. Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page. startDate is inclusive and endDate is exclusive; either bound can be used on its own to leave the other end of the range unbounded. Only forecasts linked to a scenario that is currently visible are returned.

get/forecasts/{companyId}

Path parameters

companyIdstring required

Query parameters

scenarioIdstring

Filter forecasts belonging to a given scenario, by its Embat scenario ID.

Filter forecasts belonging to a given scenario, by its Embat scenario ID.

syncboolean

Filter by synchronization status. false also matches forecasts where the value is not set.

Filter by synchronization status. false also matches forecasts where the value is not set.

operationsboolean

Reserved for future use; currently has no effect on the results.

Reserved for future use; currently has no effect on the results.

startDatestring date

Only return forecasts dated on or after this date (inclusive).

Only return forecasts dated on or after this date (inclusive).

endDatestring date

Only return forecasts dated before this date (exclusive).

Only return forecasts dated before this date (exclusive).

limitinteger

Maximum number of objects to return in the response. Default 500, maximum 2000.

Maximum number of objects to return in the response. Default 500, maximum 2000.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "id": "fct_00123",
      "amount": 15000,
      "accountingAmount": 13850.25,
      "exchangeRate": 1.083,
      "scenario": {
        "id": "scn_00045",
        "name": "Base case",
        "description": "Baseline treasury projection for FY2026"
      }
    }
  ]
}