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

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable.ReconcilingSource represents the origin of financial records that need to be matched against product transactions — for example a point-of-sale system, an internal financial system, or a CRM. customId is the unique identifier of a reconciling source: set your own value to use as your internal source ID.A reconciling source is the parent of one or more ReconcilingItems: each item references its source through reconcilingSourceCustomId. The source's matchingMetadataKey names the field within its items' metadata that Embat uses to associate each item with a product transaction. A reconciling source does not carry financial data itself — amounts, currencies and dates live on its ReconcilingItems.**Typical flow:**1. **Register a reconciling source.** Create one for each origin system you want to reconcile from, defining the metadata key used to match its items to transactions:```jsonPOST /reconcilingsources/{companyId}{ "customId": "stripe-orders", "name": "Stripe orders feed", "matchingMetadataKey": "orderId"}```Calling this again with the same `customId` updates the existing source instead of creating a duplicate.2. **Create the reconciling items** for that source (see ReconcilingItems), each carrying the metadata value that will later be matched against product transactions.3. **Retrieve or list sources** with `GET /reconcilingsources/{companyId}/{customId}` or `GET /reconcilingsources/{companyId}`.4. **Update or delete a source** as your origin systems change: use `PATCH`/`DELETE /reconcilingsources/{companyId}/{customId}`, or resend the source with `POST` — creation is an upsert, so an existing `customId` is updated instead of duplicated.

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

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

This API exposes 5 operations across 2 paths, and defines 8 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 2 paths 8 schemas 1 DELETE2 GET1 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 ReconcilingSources API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 5

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

ReconcilingSources 5

⚠️ Warning: This API section is in BETA. It might undergo significant changes and may not be stable. ReconcilingSource represents the origin of financial records that need to be m…

GET
/reconcilingsources/{companyId}
List reconciling sources
list_reconciling_sources_reconcilingsources__companyId__get 1 param → 200401404422
POST
/reconcilingsources/{companyId}
Create reconciling source
create_reconciling_source_reconcilingsources__companyId__post 1 param body → 200401404422
GET
/reconcilingsources/{companyId}/{customId}
Retrieve reconciling source
retrieve_reconciling_source_reconcilingsources__companyId___customId__get 2 params → 200401404422
PATCH
/reconcilingsources/{companyId}/{customId}
Update reconciling source
update_reconciling_source_reconcilingsources__companyId___customId__patch 2 params body → 200401404422
DELETE
/reconcilingsources/{companyId}/{customId}
Delete reconciling source
delete_reconciling_source_reconcilingsources__companyId___customId__delete 2 params → 200401404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are GetReconcilingSourceResponseSchema (8 properties), ValidationError (5 properties), PostReconcilingSourceSchema (4 properties), PatchReconcilingSourceSchema (3 properties). Each schema is shown below with its type and property counts.

PostReconcilingSourceSchema
object
4 properties 2 required
ModifyReconcilingSourceResponseSchema
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
GetReconcilingSourceResponseSchema
object
8 properties 6 required
ListReconcilingSourcesResponseSchema
object
1 property 1 required
PatchReconcilingSourceSchema
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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