DocsGetting startedConnection Status
104 operations ↓ OpenAPI JSON Get API key
Readiness contract

Connection Status

Call GET /v1/connection/status with the API key before source-fact submission. The response returns tenant_id, end_customer_id, current legal entity, current fiscal year, VAT setup, setup readiness, fiscal years, and blockers. Clients should read the active fiscal_year_id from setup.current_fiscal_year_id and should not hardcode tenant bookkeeping identifiers.

Canonical setup ids

GETRead current fiscal year
const status = await hc.get("/v1/connection/status");
const connectionId = status.connection_id;
const endCustomerId = status.end_customer_id;
const legalEntityId = status.setup.current_legal_entity_id;
const fiscalYearId = status.setup.current_fiscal_year_id;

Client apps should read current setup identifiers from this endpoint instead of hardcoding tenant bookkeeping ids. During onboarding, setup-token flows also expose the connection id, but after activation /v1/connection/status is the canonical production read.

Related API reference

Use the endpoint reference pages for request schemas, response bodies, status codes, and examples generated from the live OpenAPI contract.