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

`Product` represents a bank account, credit line, card or wallet held by the company — either aggregated automatically from a bank connection, or added manually in Embat. A product can optionally be linked to an accounting account via `accountingCode`, used to reconcile its balance against Embat's chart of accounts.Products are grouped under a `Bank` relationship (`bankId`), hold the end-of-day snapshots reported by `Balances` and the movements reported by `Transactions`, and are referenced by `Payments` (`productId`) to resolve the accounting code used for classification.**Typical flow:** retrieve the products of a company with `GET /products/{companyId}` (or a single one with `GET /products/{companyId}/{id}`) to obtain the `id` values used across other endpoints — for example to filter `Transactions` or `Balances`, or to set `productId` on a `Payment`. Once a product's accounting account is known, set it with `PATCH /products/{companyId}/{id}` (or the bulk variant `PATCH /products/{companyId}`).

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

Tagged areas include Products. 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 12 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 12 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 Products 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.

Products 4

Product represents a bank account, credit line, card or wallet held by the company — either aggregated automatically from a bank connection, or added manually in Embat. A product…

GET
/products/{companyId}
List products
list_products_products__companyId__get 2 params → 200401404422
PATCH
/products/{companyId}
Update products in bulk
update_products_bulk_products__companyId__patch 1 param body → 200401404422
GET
/products/{companyId}/{id}
Retrieve product
retrieve_product_products__companyId___id__get 2 params → 200401404422
PATCH
/products/{companyId}/{id}
Update product
update_product_products__companyId___id__patch 2 params body → 200401404422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GetProductsResponseSchema (25 properties), ValidationError (5 properties), AuxBulkPatchProductsRequestSchema (3 properties), PatchProductsRequestSchema (2 properties). Each schema is shown below with its type and property counts.

ReconciliationSchema
object
2 properties
PatchProductsRequestSchema
object
2 properties
CurrencyEnum
string
ModifyProductsResponseSchema
object
1 property 1 required
HTTPValidationError
object
1 property
BulkPatchProductsRequestSchema
object
1 property 1 required
ValidationError
object
5 properties 3 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
BulkModifyProductsResponseSchema
object
1 property 1 required
GetProductsResponseSchema
object
25 properties 7 required
AuxBulkPatchProductsRequestSchema
object
3 properties 1 required
ListProductsResponseSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-products-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 Forecasts API