Guides
Figures and templates
Every line Genni reads becomes one figure per column: for example Group 2024, Group 2023, Company 2024 and Company 2023.
bash
curl "https://api.genni.scribblegreen.com/v1/documents/$DOCUMENT_ID/figures?statement=profit_or_loss" \
-H "Authorization: Bearer $GENNI_KEY"json
{
"id": "5b0c…",
"statement": "profit_or_loss",
"line_item_code": "revenue",
"label_as_printed": "Revenue",
"column_label": "Group 31/12/2024",
"value_as_printed": "3,580,123",
"value": "3580123000000",
"unit_multiplier": 1000000,
"currency": "NGN",
"period_end": "2024-12-31",
"is_prior_period": false,
"consolidated": true,
"source_page": 21,
"status": "auto"
}| Field | Meaning |
|---|---|
value | In full units of the currency, as a string (to avoid rounding). ₦'million statements are multiplied out. Per-share figures are never scaled. |
value_as_printed | Exactly what the report shows, brackets and all, so any figure can be checked by eye. |
line_item_code | The template line it maps to, or other for lines the template doesn't cover; those keep their printed label. |
source_page | The page of the uploaded file the figure came from. |
consolidated | true for Group/Consolidated columns, false for Company/Bank/Separate. |
status | auto passed its checks; flagged awaits review; approved, edited or rejected by a person (original_value keeps what Genni first read). |
Filter with statement, code, and include_other=false to keep only template lines.
Templates
Every figure maps to a standard template so companies and years compare like for like. There are two: general for companies and bank for banks (interest income, customer loans and deposits). Genni picks one from the statements, or you can set it at upload. GET /v1/templates lists every code with its label.
| Statement | Examples of codes |
|---|---|
| financial_position | total_assets, property_plant_equipment, cash_and_cash_equivalents, total_equity |
| profit_or_loss | revenue, gross_profit, profit_before_tax, profit_for_year, eps_basic |
| comprehensive_income | other_comprehensive_income, total_comprehensive_income |
| cash_flows | net_cash_from_operating, purchase_of_ppe, dividends_paid, cash_at_end |
| changes_in_equity | soce_opening_balance, soce_dividends, soce_closing_balance (total equity column) |
When several printed lines share a code, Genni uses a printed subtotal if there is one, and otherwise adds the lines together. Checks and datasets use that one value.