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

10 operations 5 paths 21 schemas 3 DELETE2 GET2 PATCH3 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 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.

Attributes 10

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…

GET
/attributes/{companyId}
List attributes
list_attributes_attributes__companyId__get 1 param → 200401404422
POST
/attributes/{companyId}
Create attribute
create_attribute_attributes__companyId__post 1 param body → 200401404500422
PATCH
/attributes/{companyId}
Update attributes in bulk
update_attributes_bulk_attributes__companyId__patch 1 param body → 200401404500422
DELETE
/attributes/{companyId}
Delete attributes in bulk
delete_attributes_bulk_attributes__companyId__delete 1 param body → 200401404500422
GET
/attributes/{companyId}/{customId}
Retrieve attribute
retrieve_attribute_attributes__companyId___customId__get 2 params → 200401404422
PATCH
/attributes/{companyId}/{customId}
Update attribute
update_attribute_attributes__companyId___customId__patch 2 params body → 200401404500422
DELETE
/attributes/{companyId}/{customId}
Delete attribute
delete_attribute_attributes__companyId___customId__delete 2 params → 200401404500422
POST
/attributes/{companyId}/bulk
Create attributes in bulk
create_attributes_bulk_attributes__companyId__bulk_post 1 param body → 200401404500422
POST
/attributes/{companyId}/{customId}/values/bulk
Add values to an attribute
add_attribute_values_attributes__companyId___customId__values_bulk_post 2 params body → 200401404500422
DELETE
/attributes/{companyId}/{customId}/values
Remove values from an attribute
remove_attribute_values_attributes__companyId___customId__values_delete 2 params body → 200401404500422

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.

BulkDeleteAttributesRequestSchema
object
1 property 1 required
ValidationError
object
5 properties 3 required
BulkPostAttributesValuesRequestSchema
object
1 property 1 required
SourceEnum
string
DeleteAttributesRequestSchema
object
1 property 1 required
ModifyAttributesResponseSchema
object
1 property 1 required
GetAttributesResponseSchema
object
13 properties 5 required
BulkPostAttributesRequestSchema
object
1 property 1 required
BulkModifyAttributesResponseSchema
object
1 property 1 required
UpsertAttributesResponseSchema
object
2 properties 2 required
ListAttributesResponseSchema
object
1 property 1 required
AttributesStatusEnum
string
AttributesResponseValuesSchema
object
5 properties 2 required
AuxBulkPatchAttributesRequestSchema
object
5 properties 1 required
PatchAttributesRequestSchema
object
4 properties
PostAttributesRequestSchema
object
8 properties 3 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
HTTPValidationError
object
1 property
BulkPatchAttributesRequestSchema
object
1 property 1 required
BulkUpsertAttributesResponseSchema
object
1 property 1 required
AttributesRequestValuesSchema
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-attributes-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries 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
Embat ForeignExchangeRates API