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

`Category` represents a treasury or cashflow classification in Embat, used to group transactions, forecasts and operations for reporting (e.g. "Providers", "Payroll", "Subscriptions"). Categories are created and managed in the Embat application; this API only lists and retrieves them. `parentId` is the Embat ID of the parent category, letting you build a category tree such as:- Payments - Providers - Europe - Latam - Payroll- Collections - SubscriptionsA category has no `parentId` when it is a top-level category.Categories are referenced by `categoryId` on `Transactions`, `Forecasts` and `Operations` to classify each movement. In the Embat application you can also map an ERP ledger account to a category, so operations posted against that account are categorized automatically.**Typical flow:** look up the categories configured for a company with `GET /categories/{companyId}` (or a single one with `GET /categories/{companyId}/{id}`) and use their `id` as the `categoryId` when creating or reading transactions, forecasts or operations through the corresponding endpoints.

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

Tagged areas include Categories. 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 5 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 5 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 Categories 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.

Categories 2

Category represents a treasury or cashflow classification in Embat, used to group transactions, forecasts and operations for reporting (e.g. "Providers", "Payroll", "Subscriptions…

GET
/categories/{companyId}
List categories
list_categories_categories__companyId__get 1 param → 200401404422
GET
/categories/{companyId}/{id}
Retrieve category
get_category_categories__companyId___id__get 2 params → 200401404422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GetCategoriesResponseSchema (6 properties), ValidationError (5 properties), HTTPValidationError (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ListCategoriesResponseSchema
object
1 property 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
GetCategoriesResponseSchema
object
Category response data schema
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-categories-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 Companies API
Embat Contacts API
Embat DebtScheduleConfigs API
Embat Files API
Embat Forecasts API
Embat ForeignExchangeRates API