Entities API

The Entities API returns transaction data aggregated by entity (the counterparty — vendor, payer, etc.). Entities have no separate model in the database — they are just a field on the transaction object — so this endpoint is read-only. To change an entity, edit the entity field on the affected transactions (see Transactions API).

Endpoints

MethodEndpointDescription
GET/api/v1/entitiesList entities with period aggregates

Permissions

Requires the reports:read permission — entities are analytics (aggregations), not an editable resource. This permission is included in the full_access and read_only permission presets.

Entity Detail

There is no separate "get one entity" endpoint. To see the transactions behind an entity (and recompute its own totals), filter transactions directly:

GET /api/v1/transactions?entity=<name>

Related