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

`Logs` let your integration report execution events, warnings or errors observed while interacting with the Embat API, so Embat's support team can diagnose integration issues.Logs are write-only: there is no endpoint to list or retrieve the logs you send. Use `code` to classify the event by severity and, where available, by the entity it relates to (for example `PAYMENTS_ERROR` for an issue involving `Payments`, or `AUTHORIZATION_WARNING` for an authentication issue). Use the generic `INFO`, `WARNING` or `ERROR` codes for events not tied to one of those entities.**Typical flow:** report a log whenever your integration completes, skips or fails a step of its synchronization with Embat, for example after `POST /payments/{companyId}` returns an error:```jsonPOST /logs/{companyId}{ "erp": "netsuite", "erpVersion": "2024.1", "connectorVersion": "1.4.2", "level": "ERROR", "code": "PAYMENTS_ERROR", "message": "Failed to post payment: missing accounting account"}```Log delivery is best-effort: both endpoints return `204` as soon as the request is accepted, and any failure while recording a log afterwards is not reported back to the caller. To send several logs at once, use `POST /logs/{companyId}/bulk`.

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

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

This API exposes 2 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.

2 operations 2 paths 8 schemas 2 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 Logs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 2

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

Logs 2

Logs let your integration report execution events, warnings or errors observed while interacting with the Embat API, so Embat's support team can diagnose integration issues. Logs…

POST
/logs/{companyId}
Create log
create_log_logs__companyId__post 1 param body → 204401404422
POST
/logs/{companyId}/bulk
Create logs in bulk
create_logs_bulk_logs__companyId__bulk_post 1 param body → 204401404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PostLogRequestSchema (6 properties), ValidationError (5 properties), BulkPostLogsRequestSchema (1 property), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

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
ErspEnum
string
LogsCodesEnum
string
BulkPostLogsRequestSchema
object
1 property 1 required
LogsLevelsEnum
string
PostLogRequestSchema
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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