Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

4 operations 2 paths 13 schemas 2 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.120.3
Base URL
https://api.embat.io
Authentication
HTTP Bearer
Resource Areas
1

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.

Forecasts 4

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…

GET
/forecasts/{companyId}
List forecasts
list_forecasts_forecasts__companyId__get 8 params → 200401404422
PATCH
/forecasts/{companyId}
Update forecasts in bulk
update_forecasts_bulk_forecasts__companyId__patch 1 param body → 200401404500422
GET
/forecasts/{companyId}/{id}
Retrieve forecast
retrieve_forecast_forecasts__companyId___id__get 2 params → 200401404422
PATCH
/forecasts/{companyId}/{id}
Update forecast
update_forecast_forecasts__companyId___id__patch 2 params body → 200401404500422

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.

ModifyForecastsResponseSchema
object
1 property 1 required
AuxBulkPatchForecastsRequestSchema
object
3 properties 1 required
CurrencyEnum
string
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
PatchForecastsRequestSchema
object
2 properties
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
PeriodicityEnum
string
GetForecastsResponseSchema
object
Forecasts response data schema
11 properties
ScenarioSchema
object
5 properties
BulkPatchForecastsRequestSchema
object
1 property 1 required
BulkModifyForecastsResponseSchema
object
1 property 1 required
ListForecastsResponseSchema
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-forecasts-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries API
Embat Attributes API
Embat Authentication API
Embat Balances API
Embat Banks API
Embat Categories API
Embat Companies API
Embat Contacts API
Embat DebtScheduleConfigs API
Embat Files API
Embat ForeignExchangeRates API