Embat Attributes API
`Attribute` represents a custom field that you can define once and then use to tag records across Embat, such as an ERP dimension, a cost center or any other analytic field you want available as a filter in tables, charts and reports. `customId` is the unique identifier of an attribute: set your own value to use as your ERP dimension ID, or let Embat auto-generate one.An attribute has a `type` — `list` (a fixed set of `values` to choose from), `string` or `number` (free-form value) — and can optionally be nested under a parent attribute via `parentCustomId` to model hierarchies (e.g. a "City" attribute whose values are nested under a "Country" attribute's values).Attribute values are attached to other entities — `Payments`, `Contacts`, `Operations`, `Transactions` and `AccountingEntries` — by sending the attribute's `customId` together with the chosen `value`/`valueCustomId` in that entity's `attributes` field.**Typical flow:**1. **Create the attribute** with `POST /attributes/{companyId}`, defining its `type` and, for `list` attributes, its `values`:```jsonPOST /attributes/{companyId}{ "customId": "cost-center", "source": "erp", "name": "Cost Center", "type": "list", "values": [ { "customId": "marketing", "name": "Marketing" }, { "customId": "sales", "name": "Sales" } ]}```2. **Tag other entities with the attribute.** When creating or updating a payment, contact, operation, transaction or accounting entry, reference the attribute in its `attributes` field:```json{ "customId": "marketing", "value": "Marketing"}```3. **Maintain the value list** with `POST /attributes/{companyId}/{customId}/values/bulk` to add values without touching the rest of the attribute, or update the attribute directly to replace its full value list.
Embat Attributes API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Attributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 10 operations across 5 paths, and defines 21 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 Attributes API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
Paths & Operations 10
Across 5 paths, the API surfaces 10 operations — 3 DELETE, 2 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Attribute represents a custom field that you can define once and then use to tag records across Embat, such as an ERP dimension, a cost center or any other analytic field you want…
Schemas 21
The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are GetAttributesResponseSchema (13 properties), PostAttributesRequestSchema (8 properties), AuxBulkPatchAttributesRequestSchema (5 properties), ValidationError (5 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.