Embat Contacts API
`Contact` represents a client or supplier your company transacts with. `customId` is the unique identifier of a contact: set your own value to use as your ERP contact ID, or let Embat auto-generate one.A contact is referenced from other entities to identify who is involved in a transaction: `Operations` (invoices/bills) are billed to or from a contact, `Payments` can record a collection or payment made to a contact, and `AccountingEntries` can be linked to a contact for reconciliation. A contact also carries the bank account details (`accounts`, `paymentsAccounts`) Embat uses to execute payments to it.**Typical flow:** contacts are usually kept in sync from your ERP, since they are the master data referenced when creating operations and payments.1. **Create or update a contact from your ERP.** Whenever a client or supplier is created or edited in your ERP, upsert it in Embat with its identification and, if relevant, bank account details:```jsonPOST /contacts/{companyId}{ "customId": "erp-contact-001", "legalName": "Acme Supplies S.L.", "taxId": "B12345678", "type": "supplier", "paymentsAccounts": [ { "currency": "EUR", "default": true, "details": { "iban": "ES9121000418450200051332" } } ]}```2. **Reference the contact by `customId`.** Use the same `customId` in `Operations` and `Payments` to link them to this contact.3. **Keep it up to date.** Sending `POST /contacts/{companyId}` again with the same `customId` updates the existing contact instead of creating a duplicate; use `PATCH /contacts/{companyId}/{customId}` (or the bulk variant) to update specific fields only.
Embat Contacts API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contacts. 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 28 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 Contacts 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.
Contact represents a client or supplier your company transacts with. customId is the unique identifier of a contact: set your own value to use as your ERP contact ID, or let Embat…
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are GetContactsResponseSchema (19 properties), PostContactsRequestSchema (15 properties), AuxBulkPatchContactsRequestSchema (15 properties), PatchContactsRequestSchema (14 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.