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 Balances API

`Balance` represents the end-of-day balance of a bank product (account) for a given calendar day. Embat records one balance per product per day, expressed both in the product's own currency (`balance`) and, when available, in the company accounting currency (`accountingBalance`, converted using the exchange rate as of that day).Each balance is linked to a `Product` (a bank account, credit line, card...) held at one of the company's connected `Banks`. Balances whose linked product no longer exists in Embat are not returned.**Typical flow:** use `GET /balances/{companyId}` to read the daily balance history of a company's bank products, filtering by `productId` and by date range, or `GET /balances/{companyId}/{id}` to retrieve a single balance you already know the `id` of — for example after obtaining it from a previous list call.

Embat Balances API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 7 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.

2 operations 2 paths 7 schemas 2 GET

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 Balances API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Balances 2

Balance represents the end-of-day balance of a bank product (account) for a given calendar day. Embat records one balance per product per day, expressed both in the product's own…

GET
/balances/{companyId}
List balances
list_balances_balances__companyId__get 6 params → 200400401404422
GET
/balances/{companyId}/{id}
Retrieve balance
retrieve_balance_balances__companyId___id__get 2 params → 200401404422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetBalancesResponseSchema (10 properties), ProductBaseSchema (5 properties), ValidationError (5 properties), ListBalancesResponseSchema (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
CurrencyEnum
string
GetBalancesResponseSchema
object
10 properties
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
ProductBaseSchema
object
5 properties 3 required
ListBalancesResponseSchema
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-balances-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

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