balance_sheets

Balance sheet, one row per filed period, with named fields. Fields are keyed on the AS-FILED account label (and, where one label is filed twice, its parent’s label), not on cd_conta and not on setor: CVM ships three balance-sheet charts and equity alone sits on 2.03, 2.07 or 2.08. A concept a chart does not file reads NULL — banks file no current/non-current split and no Empréstimos e Financiamentos, so those fields are NULL for them, never zero. chart says which layout the filing used. Values are absolute reais. p_as_of (a date, default NULL) makes the read point-in-time: only documents CVM had received (cia_filing.dt_receb) BEFORE that date are read, the highest remaining version of each is kept, and a document with no filing header is dropped. NULL reads the latest stored version of every document and is NOT point-in-time: a later filing or a restatement appears as if it had been known. Versions superseded before 2026 are not held, so an as-of read is stale for a restating company, never early.

Row cap. A window producing more than 1000 rows raises SQLSTATE 22023 naming this function. Nothing is trimmed to fit — PostgREST would silently cut the response at 1000 and a cut-short series is indistinguishable from one that simply ends. This function does not page — narrow the window instead.

POST /rpc/balance_sheets

balance_sheets

cURL

curl --request POST \
  --url https://zcjbtpxuhdekpwcxmepn.supabase.co/rest/v1/rpc/balance_sheets \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "p_id": "<string>",
  "p_from": "2023-12-25",
  "p_to": "2023-12-25",
  "p_scope": "con",
  "p_doc_type": "itr",
  "p_as_of": null
}
'

200

[
  {
    "id": "<string>",
    "id_type": "<string>",
    "cnpj": "<string>",
    "company": "<string>",
    "ticker": "<string>",
    "setor": "<string>",
    "segmento": "<string>",
    "doc_type": "<string>",
    "scope": "<string>",
    "ref_date": "2023-12-25",
    "chart": "<string>",
    "total_assets": 123,
    "current_assets": 123,
    "cash_and_equivalents": 123,
    "short_term_investments": 123,
    "receivables": 123,
    "inventories": 123,
    "noncurrent_assets": 123,
    "property_plant_equipment": 123,
    "intangible_assets": 123,
    "total_liabilities_and_equity": 123,
    "current_liabilities": 123,
    "noncurrent_liabilities": 123,
    "short_term_debt": 123,
    "long_term_debt": 123,
    "equity": 123,
    "share_capital": 123,
    "noncontrolling_interests": 123,
    "version": 123,
    "source": "<string>"
  }
]

Authorizations

apikey · string · header · required

The publishable key (sb_publishable_…), on every request. It is NOT a JWT — sending it as Authorization: Bearer is rejected as an invalid JWT. It identifies the project, not you, and maps to the Postgres anon role.

Body

application/json

p_id · string | null · required

p_from · string<date> | null

Defaults to (CURRENT_DATE - 1825).

p_to · string<date> | null

Defaults to CURRENT_DATE.

p_scope · string | null · default: con

Defaults to 'con'::text.

Examples:

"con"

"ind"

p_doc_type · string | null

Defaults to NULL::text.

Examples:

"itr"

"dfp"

p_as_of · string<date> | null

Defaults to NULL::date.

Response

200

application/json

The result set, oldest first. An unknown id is an empty array, not a 404 and never a guessed value.

id · string | null

id_type · string | null

cnpj · string | null

company · string | null

ticker · string | null

setor · string | null

segmento · string | null

doc_type · string | null

scope · string | null

ref_date · string<date> | null

chart · string | null

total_assets · number | null

current_assets · number | null

cash_and_equivalents · number | null

short_term_investments · number | null

receivables · number | null

inventories · number | null

noncurrent_assets · number | null

property_plant_equipment · number | null

intangible_assets · number | null

total_liabilities_and_equity · number | null

current_liabilities · number | null

noncurrent_liabilities · number | null

short_term_debt · number | null

long_term_debt · number | null

equity · number | null

share_capital · number | null

noncontrolling_interests · number | null

version · integer<int32> | null

source · string | null