Embat Forecasts API
`Forecast` represents a treasury cash flow projection generated by Embat for a given date, classified under a `Category` and grouped into a `Scenario` (e.g. a base case or a stress scenario). Each scenario has its own currency and periodicity — `daily`, `weekly`, `monthly` or `yearly` — that determines how forecasted periods are spaced.Forecasts are generated in Embat; this API does not support creating or deleting them. Use it to read forecasted cash flows and, optionally, to mark them as synchronized with your own systems.**Typical flow:**1. **Read forecasts.** Pull the forecasted amounts for a company with `GET /forecasts/{companyId}`, optionally filtered by `scenarioId`, a date range, or synchronization status (`sync`).2. **Confirm them as synchronized.** Once you have processed a forecast on your side, mark it as synchronized with `PATCH /forecasts/{companyId}/{id}` (or the bulk variant `PATCH /forecasts/{companyId}`):```jsonPATCH /forecasts/{companyId}/{id}{ "sync": true}```
Embat Forecasts API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Forecasts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.
Requests are made against the base URL https://api.embat.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Embat Forecasts API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 2 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.
Forecast represents a treasury cash flow projection generated by Embat for a given date, classified under a Category and grouped into a Scenario (e.g. a base case or a stress scen…
Schemas 13
The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GetForecastsResponseSchema (11 properties), ValidationError (5 properties), ScenarioSchema (5 properties), AuxBulkPatchForecastsRequestSchema (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Embat 12
Other APIs Embat publishes across the network.