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

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

Contacts 8

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…

GET
/contacts/{companyId}
List contacts
list_contacts_contacts__companyId__get 3 params → 200401404422
POST
/contacts/{companyId}
Create contact
create_contact_contacts__companyId__post 1 param body → 200401404500422
PATCH
/contacts/{companyId}
Update contacts in bulk
update_contacts_bulk_contacts__companyId__patch 1 param body → 200401404500422
DELETE
/contacts/{companyId}
Delete contacts in bulk
delete_contacts_bulk_contacts__companyId__delete 1 param body → 200401404500422
GET
/contacts/{companyId}/{customId}
Retrieve contact
retrieve_contact_contacts__companyId___customId__get 2 params → 200401404422
PATCH
/contacts/{companyId}/{customId}
Update contact
update_contact_contacts__companyId___customId__patch 2 params body → 200401404500422
DELETE
/contacts/{companyId}/{customId}
Delete contact
delete_contact_contacts__companyId___customId__delete 2 params → 200401404500422
POST
/contacts/{companyId}/bulk
Create contacts in bulk
create_contacts_bulk_contacts__companyId__bulk_post 1 param body → 200401404500422

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.

DeleteContactsRequestSchema
object
1 property 1 required
ContactTypeEnum
string
ContactContactTypeEnum
string
ContactNewAccount
object
3 properties
CurrencyEnum
string
PostContactsRequestSchema
object
15 properties 2 required
BulkDeleteContactsRequestSchema
object
1 property 1 required
ValidationError
object
5 properties 3 required
ContactAccounts
object
3 properties
app__schemas__contacts__ContactSchema
object
4 properties
PatchContactsRequestSchema
object
14 properties
ContactAddressSchema
object
5 properties
AuxBulkPatchContactsRequestSchema
object
15 properties 1 required
BulkPostContactsRequestSchema
object
1 property 1 required
ListContactsResponseSchema
object
2 properties 1 required
ISOCountryCodes
string
BulkPatchContactsRequestSchema
object
1 property 1 required
ContactNewAccountDetails
object
13 properties
ModifyContactsResponseSchema
object
1 property 1 required
AttributeValueRequestSchema
object
Attaches an attribute value to another entity (payment, contact, operation, transaction, accounting entry...).
4 properties 2 required
AccountTypeEnum
string
ContactSchema-Input
object
4 properties
BulkUpsertContactsResponseSchema
object
1 property 1 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
HTTPValidationError
object
1 property
BulkModifyContactsResponseSchema
object
1 property 1 required
UpsertContactsResponseSchema
object
2 properties 2 required
GetContactsResponseSchema
object
19 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-contacts-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 DebtScheduleConfigs API
Embat Files API
Embat Forecasts API
Embat ForeignExchangeRates API