HTTP API reference

This reference is generated from the same code-owned registry as /openapi.json. It covers every operation in that public document, including response bodies and errors. Each operation has its own page and Markdown mirror. The command reference and report reference explain each operation variant in detail. Download the full Markdown export.

For an end-to-end call, use the direct API walkthrough. For the model behind the fields, read concepts. Authentication and recovery explain the shared request rules.

This public contract grants no access. Obtain a bearer for the OAuth resource https://economi.co/mcp, select a business with X-Economico-Business, and use GET /v1/openapi.json to discover that connection’s permitted operations. Commands marked browser require a signed-in human. Never paste credentials into documentation prompts. Practice writes only in a disposable sandbox.

Agents: use the agent entry point and agent concepts. For POST /v1/commands, choose the request variant whose name constant is the command you need. Describe it through GET /v1/catalog/commands/{name} first. For POST /v1/reports, choose the variant whose kind constant matches the report. Resolve local $ref values in the reusable schemas below. Keep exact integer-string amounts and stable idempotency keys.

HTTP operations

• POST /v1/platform/purchases
• POST /v1/platform/purchases/{offerId}/payment
• GET /v1/plan-publications
• POST /v1/plan-publications
• POST /v1/plan-publications/preview
• POST /v1/plan-publications/withdrawals
• POST /v1/commands
• GET /v1/commands/{id}
• GET /v1/documents
• POST /v1/documents
• GET /v1/events
• GET /v1/events/head
• GET /v1/subjects
• GET /v1/ledgers
• GET /v1/people
• GET /v1/people/memberships
• GET /v1/people/arrangements
• GET /v1/people/identities
• GET /v1/parties
• GET /v1/parties/categories
• GET /v1/accounts
• GET /v1/accounts/summaries
• GET /v1/payment_routes/quote
• GET /v1/categories
• GET /v1/tax_codes
• GET /v1/shared_views
• GET /v1/business
• GET /v1/business/fiscal-year-change-preview
• GET /v1/business/sales-tax-regimes
• GET /v1/business/plan
• GET /v1/business/meter
• GET /v1/business/event-totals
• GET /v1/business/imports
• GET /v1/ingestions/{id}
• GET /v1/documents/{id}
• GET /v1/documents/{id}/relations
• GET /v1/events/{id}
• GET /v1/subjects/{type}
• GET /v1/ledgers/{ledger_id}
• GET /v1/ledgers/{ledger_id}/balances
• GET /v1/ledgers/{ledger_id}/statement
• GET /v1/ledgers/{ledger_id}/currencies
• GET /v1/ledgers/{ledger_id}/transaction
• GET /v1/ledgers/{ledger_id}/footprint
• GET /v1/parties/{id}
• GET /v1/accounts/{id}
• GET /v1/accounts/{id}/activity
• GET /v1/accounts/{id}/overview
• GET /v1/accounts/{id}/summary
• GET /v1/categories/{id}
• GET /v1/tax_codes/{id}
• GET /v1/shared_views/{id}
• GET /v1/subjects/{type}/{id}
• GET /v1/logos
• POST /v1/logos
• DELETE /v1/logos/{cid}
• POST /v1/reports
• GET /v1/reports
• GET /v1/reports/definitions
• POST /v1/reports/definitions/run
• GET /v1/reports/definitions/guide
• POST /v1/reports/definitions/check
• POST /v1/reports/definitions/preview
• POST /v1/reports/definitions/source
• POST /v1/reports/definitions/versions
• POST /v1/reports/query
• GET /v1/reports/schema
• GET /v1/catalog
• GET /v1/catalog/permissions
• GET /v1/export
• GET /v1/openapi.json
• GET /v1/documents/{id}/download
• GET /v1/catalog/commands/{name}
• POST /v1/events/verify
• GET /v1/vendor-catalog
• GET /v1/vendor-catalog/vendors/{slug}
• GET /v1/vendor-catalog/plans
• GET /v1/vendor-catalog/vendors/{slug}/plans
• GET /v1/vendor-catalog/vendors/{slug}/plans/{plan}/history
• GET /v1/vendor-catalog/vendors/{slug}/agreements
• GET /v1/vendor-catalog/{cid}
• GET /v1/vendor-catalog/{cid}/raw
• GET /v1/vendor-catalog/{cid}/history
• GET /v1/vendor-catalog/supersession
• GET /v1/vendor-catalog/publications
• GET /v1/businesses

Reusable schemas

• Reusable schemas and security schemes