GET /v1/statements/balance-sheet

Get Balance Sheet

Read an internal balance-sheet preview from posted canonical journal entries.

Requires API key OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader

Authorization: Bearer hc_...

Parameters

end_customer_idstringrequiredquery

Documented field.

fiscal_year_idstringrequiredquery

Documented field.

period_startstringrequiredquery

Documented field.

period_endstringrequiredquery

Documented field.

currencyenum<CHF | EUR>requiredquery

Documented field.

legal_entity_idstringoptionalquery

Documented field.

comparisonenum<none | prior_fiscal_year>optionalquery

Optional server-side comparison mode. Use prior_fiscal_year to include prior-period amounts in the same response.

comparison_fiscal_year_idstringoptionalquery

Explicit fiscal year id for comparison. Provide together with comparison_period_start and comparison_period_end.

comparison_period_startstringoptionalquery

Explicit comparison period start. Provide together with comparison_fiscal_year_id and comparison_period_end.

comparison_period_endstringoptionalquery

Explicit comparison period end. Provide together with comparison_fiscal_year_id and comparison_period_start.

granularityenum<month | quarter>optionalquery

Optional period series granularity. month or quarter adds ordered period_series buckets from the same posted-ledger statement logic. P&L buckets are period activity; balance-sheet buckets are as-of bucket end.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

200Successful response.

defaultStructured error response.

401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.

api_key_expiredDocumented HelvCore error code for this operation.

invalid_authDocumented HelvCore error code for this operation.

invalid_requestDocumented HelvCore error code for this operation.

validation_failedDocumented HelvCore error code for this operation.