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

`Transaction` represents a movement recorded on one of your bank accounts (`Product`). Each transaction reports the balance of its product immediately after the movement, and can carry a classification (`type`), a breakdown across `Categories` for reporting, custom `Attributes`, and the IDs of any reconciliations it is part of.Transactions are the bank side of the money movements Embat tracks: `Payments` link a transaction to the `Operations` (invoices/bills) it settles, and accounting entries reconcile it against your ledger. Transactions are generated automatically as your bank accounts (`Products`) are connected to Embat; the only way to create transactions through this API is for products classified as "Manual" (accounts with no bank connection), via the bulk creation endpoint below.**Typical flow:** transactions synchronize in one direction, from Embat to your ERP.1. **Read transactions generated in Embat.** Periodically pull the transactions pending on your side with `GET /transactions/{companyId}`, using the `sync` filter (transactions not yet synchronized) and `startUpdatedAt`/`endUpdatedAt` for incremental reads since your last poll.2. **Confirm them back.** Once a transaction has been recorded in your ERP, mark it as synchronized with `PATCH /transactions/{companyId}/{id}` (or the bulk variant `PATCH /transactions/{companyId}`).3. **Manual accounts only.** For products classified as Manual, record their transactions yourself with `POST /transactions/{companyId}/{productId}/bulk`. See that endpoint's description for how it replaces same-day transactions.

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

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

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

5 operations 3 paths 19 schemas 2 GET2 PATCH1 POST

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

Paths & Operations 5

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

Transactions 5

Transaction represents a movement recorded on one of your bank accounts (Product). Each transaction reports the balance of its product immediately after the movement, and can carr…

GET
/transactions/{companyId}
List transactions
list_transactions_transactions__companyId__get 11 params → 200401404422
PATCH
/transactions/{companyId}
Update transactions in bulk
update_transactions_bulk_transactions__companyId__patch 1 param body → 200401404500422
GET
/transactions/{companyId}/{id}
Retrieve transaction
retrieve_transaction_transactions__companyId___id__get 2 params → 200401404422
PATCH
/transactions/{companyId}/{id}
Update transaction
update_transaction_transactions__companyId___id__patch 2 params body → 200401404500422
POST
/transactions/{companyId}/{productId}/bulk
Create manual transactions in bulk
create_manual_transactions_bulk_transactions__companyId___productId__bulk_post 2 params body → 201400401404500422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are GetTransactionsResponseSchema (28 properties), ProductBaseSchema (5 properties), ValidationError (5 properties), PostTransactionsRequestSchema (4 properties). Each schema is shown below with its type and property counts.

CurrencyEnum
string
ModifyTransactionsResponseSchema
object
1 property 1 required
ValidationError
object
5 properties 3 required
BulkPostTransactionsRequestSchema
object
1 property 1 required
TransactionCurrencyExchangeDataSchema
object
4 properties
AuxBulkPatchTransactionsRequestSchema
object
4 properties 1 required
PostTransactionsRequestSchema
object
Transactions request data schema
4 properties 4 required
PatchTransactionsRequestSchema
object
3 properties
AttributeValueRequestSchema
object
Attaches an attribute value to another entity (payment, contact, operation, transaction, accounting entry...).
4 properties 2 required
ProductBaseSchema
object
5 properties 3 required
GetTransactionsResponseSchema
object
Transactions response data schema
28 properties
ListTransactionsResponseSchema
object
2 properties 1 required
BulkPatchTransactionsRequestSchema
object
1 property 1 required
BulkModifyTransactionsResponseSchema
object
1 property 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
HTTPValidationError
object
1 property
TransactionTypeEnum
string
StatusEnum
string
TransactionsAnalyticsSchema
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-transactions-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