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 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.

8 operations 3 paths 33 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 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.

Payments 8

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…

GET
/payments/{companyId}
List payments
list_payments_payments__companyId__get 11 params → 200400401404422
POST
/payments/{companyId}
Create payment
create_payment_payments__companyId__post 1 param body → 200401404500422
PATCH
/payments/{companyId}
Update payments in bulk
update_payments_bulk_payments__companyId__patch 1 param body → 200401404500422
DELETE
/payments/{companyId}
Delete payments in bulk
delete_payments_bulk_payments__companyId__delete 1 param body → 200401404500422
GET
/payments/{companyId}/{customId}
Retrieve payment
retrieve_payment_payments__companyId___customId__get 2 params → 200401404422
PATCH
/payments/{companyId}/{customId}
Update payment
update_payment_payments__companyId___customId__patch 2 params body → 200401404500422
DELETE
/payments/{companyId}/{customId}
Delete payment
delete_payment_payments__companyId___customId__delete 2 params → 200401404500422
POST
/payments/{companyId}/bulk
Create payments in bulk
create_payments_bulk_payments__companyId__bulk_post 1 param body → 200401404500422

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.

ContactTypeEnum
string
ContactContactTypeEnum
string
CurrencyEnum
string
ContactNewAccount
object
3 properties
BaseContactSchema-Output
object
15 properties
BulkDeletePaymentsRequestSchema
object
1 property 1 required
ValidationError
object
5 properties 3 required
BulkUpsertPaymentsResponseSchema
object
1 property 1 required
ContactAccounts
object
3 properties
app__schemas__contacts__ContactSchema
object
4 properties
SourceEnum
string
GetPaymentsResponseSchema
object
33 properties 6 required
ContactAddressSchema
object
5 properties
BulkModifyPaymentsResponseSchema
object
1 property 1 required
ISOCountryCodes
string
PostPaymentsRequestSchema
object
15 properties 3 required
ContactNewAccountDetails
object
13 properties
BulkPatchPaymentsRequestSchema
object
1 property 1 required
AttributeValueRequestSchema
object
Attaches an attribute value to another entity (payment, contact, operation, transaction, accounting entry...).
4 properties 2 required
PatchPaymentsRequestSchema
object
4 properties
OperationPaymentResponseSchema
object
12 properties 2 required
AccountTypeEnum
string
BulkPostPaymentsRequestSchema
object
1 property 1 required
UpsertPaymentsResponseSchema
object
2 properties 2 required
DeletePaymentsRequestSchema
object
1 property 1 required
OperationPaymentRequestSchema
object
2 properties 2 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
AuxBulkPatchPaymentsRequestSchema
object
5 properties 1 required
HTTPValidationError
object
1 property
PaymentShortTypeEnum
string
ModifyPaymentsResponseSchema
object
1 property 1 required
ListPaymentsResponseSchema
object
2 properties 1 required
IntercompanyPaymentSchema
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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