Embat Payments API
`Payment` represents money moving between a bank transaction and the operations (invoices, bills) or accounting entries it settles. `customId` is the unique identifier of a payment: set your own value to use as your ERP payment ID, or let Embat auto-generate one.A payment links the bank world and the accounting world in Embat: it can represent the relationship between a `Transaction` (the bank movement) and one or more `Operations` (the invoices/bills being paid), a cash movement posted directly to an accounting account, or a movement involving a `Contact` (client or supplier). Payments can also reference a `Product` to resolve the accounting code used for classification, and a `Category` for reporting.**Typical flow:** payments synchronize accounting in both directions between your ERP and Embat.1. **Notify Embat of payments posted in your ERP.** When a payment is recorded in your ERP, create it in Embat with the operations it settles — each settled amount reduces the pending amount of the corresponding operation (invoice/bill) in Embat:```jsonPOST /payments/{companyId}{ "customId": "erp-payment-001", "date": "2024-01-15T00:00:00Z", "amount": 1250.50, "currency": "EUR", "operations": [ { "customId": "invoice-2024-001", "amount": 1250.50 } ]}```2. **Read payments created from Embat.** Periodically pull the payments generated in Embat that are pending on your side, using `GET /payments/{companyId}` with the `sync` filter (payments not yet synchronized) and `startUpdatedAt`/`endUpdatedAt` for incremental reads since your last poll. This endpoint never returns payments you created through `POST /payments/{companyId}` — retrieve those by `customId` with `GET /payments/{companyId}/{customId}`.3. **Confirm them back.** Once those payments are posted in your ERP, mark them as synchronized and registered (or record an `error`) with `PATCH /payments/{companyId}/{customId}` (or the bulk variant `PATCH /payments/{companyId}`).
Embat Payments API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. 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 33 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Embat Payments 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.
Payment represents money moving between a bank transaction and the operations (invoices, bills) or accounting entries it settles. customId is the unique identifier of a payment: s…
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are GetPaymentsResponseSchema (33 properties), BaseContactSchema-Output (15 properties), PostPaymentsRequestSchema (15 properties), ContactNewAccountDetails (13 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Embat 12
Other APIs Embat publishes across the network.