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

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable.ReconcilingItem represents a single financial record — for example a POS sale, an order, or a settlement — that needs to be matched against a product `transaction`. `customId` is the unique identifier of a reconciling item: set your own value to use as your internal identifier.Every reconciling item belongs to a ReconcilingSource, referenced by `reconcilingSourceCustomId`, which identifies the origin system the item comes from (e.g. a POS, an internal system, or a CRM) and can define a `matchingMetadataKey`. When set, Embat uses the value stored under that key in the item's `metadata` to automatically associate the item with a transaction. `reconciled` and `isMatched` reflect the state of that process and are set by Embat — they cannot be updated through this API.**Typical flow:**1. **Register a reconciling source** (see ReconcilingSources) if one does not already exist for the origin system.2. **Notify Embat of records to reconcile.** Create a reconciling item for each record, including the metadata your reconciling source uses for matching:```jsonPOST /reconcilingitems/{companyId}{ "customId": "stripe-order-4821", "reconcilingSourceCustomId": "stripe-orders", "amount": 199.90, "currency": "EUR", "date": "2024-01-15T00:00:00Z", "description": "Stripe order #4821", "metadata": { "orderId": "ORD-48213" }}```Calling this again with the same `customId` updates the existing item instead of creating a duplicate, unless it has already been matched to a transaction.3. **Track reconciliation status.** Retrieve or list items with `GET /reconcilingitems/{companyId}/{customId}` or `GET /reconcilingitems/{companyId}` — filter by `reconcilingSourceCustomId` or `reconciled` and check `isMatched`/`reconciled` on each item to see whether Embat has matched and reconciled it.4. **Correct or remove items** while they are still unmatched: use `PATCH`/`DELETE /reconcilingitems/{companyId}/{customId}` (or their bulk variants), or resend the item with `POST` — creation is an upsert, so an existing `customId` is updated instead of duplicated.

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

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

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

8 operations 3 paths 17 schemas 2 DELETE2 GET2 PATCH2 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 ReconcilingItems API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 8

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

ReconcilingItems 8

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable. ReconcilingItem represents a single financial record — for example a POS sale,…

GET
/reconcilingitems/{companyId}
List reconciling items
list_operations_reconcilingitems__companyId__get 7 params → 200401404422
POST
/reconcilingitems/{companyId}
Create reconciling item
create_reconciling_item_reconcilingitems__companyId__post 1 param body → 200401404422
PATCH
/reconcilingitems/{companyId}
Update reconciling items in bulk
update_reconciling_items_bulk_reconcilingitems__companyId__patch 1 param body → 200401404422
DELETE
/reconcilingitems/{companyId}
Delete reconciling items in bulk
delete_reconciling_items_bulk_reconcilingitems__companyId__delete 1 param body → 200401404422
GET
/reconcilingitems/{companyId}/{customId}
Retrieve reconciling item
read_reconciling_item_reconcilingitems__companyId___customId__get 2 params → 200401404422
PATCH
/reconcilingitems/{companyId}/{customId}
Update reconciling item
update_reconciling_item_reconcilingitems__companyId___customId__patch 2 params body → 200401404422
DELETE
/reconcilingitems/{companyId}/{customId}
Delete reconciling item
delete_reconciling_item_reconcilingitems__companyId___customId__delete 2 params → 200401404422
POST
/reconcilingitems/{companyId}/bulk
Create reconciling items in bulk
create_reconciling_items_bulk_reconcilingitems__companyId__bulk_post 1 param body → 200401404422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are GetReconcilingItemsResponseSchema (14 properties), PostReconcilingItemSchema (8 properties), AuxBulkPatchReconcilingItemsRequestSchema (7 properties), PatchReconcilingItemSchema (6 properties). Each schema is shown below with its type and property counts.

PatchReconcilingItemSchema
object
6 properties
UpsertReconcilingItemsResponseSchema
object
2 properties 2 required
PostReconcilingItemSchema
object
8 properties 6 required
ListReconcilingItemsResponseSchema
object
2 properties 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
CurrencyEnum
string
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
GetReconcilingItemsResponseSchema
object
14 properties 10 required
BulkModifyReconcilingItemsResponseSchema
object
1 property 1 required
BulkPostReconcilingItemsRequestSchema
object
1 property 1 required
DeleteReconcilingItemsRequestSchema
object
1 property 1 required
AuxBulkPatchReconcilingItemsRequestSchema
object
7 properties 1 required
BulkUpsertReconcilingItemsResponseSchema
object
1 property 1 required
ModifyReconcilingItemsResponseSchema
object
1 property 1 required
BulkDeleteReconcilingItemsRequestSchema
object
1 property 1 required
BulkPatchReconcilingItemsRequestSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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