Reports

One card of the report (Officina, Economico)

Returns one card of Report v2 — the data the web Report page renders on its Officina and Economico tabs, computed by the same code. One request per card.

Period: preset or from/to (no params = last 12 months; on the mobile app the sticky report filter shared with the web). grain picks the chart buckets (default weeks up to 62 days, months above).

A card with nothing to show for the company or the period answers visible: false and data: null — hide it. Amounts are euro, IVA excluded unless the field says otherwise; a null figure is not meaningful (no previous period, below the minimum count, permission missing). Percentages are 0–100.

Permissions: cards with amounts also need prices.read; quote-funnel needs quotes.read, top-customers-fatturato also customers.read, the time cards settings_company.read; otherwise 403. In receivables debtor names need customers.read (debtors_shown).

The cards kept from the first report (worksheet-status, top-services, worksheet-margin-chart, worksheet-margins, sales-chart, outstanding-worksheets) keep their /v1/report/{widget} data shapes.

get/v1/reports/{widget}

Request

  • Base URL: https://api.officina.it
  • URL: https://api.officina.it/v1/reports/{widget}
  • Auth: HTTP bearer

Query parameters

preset'rel30' | 'rel90' | 'rel365' | 'year' | 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'month' | 'custom' | 'all'

Date filter preset. Relative presets (rel30/rel90/rel365) are resolved server-side from "now" and ignore from/to. Absolute presets (year, Q1-Q4, month, custom) require both from and to. all returns everything (no time bound). Unknown values are rejected with 422.

Omitting from/to/preset gives the default window, the last 12 months. This tier is stateless: a selection applies to the request that carries it and is never stored, so the same request always covers the same range. The effective range is echoed back in date_filter.

fromstring date

Period start (default: 12 months ago).

tostring date

Period end, inclusive (default: today).

grain'week' | 'month'

Chart buckets. Default: week up to 62 days, month above.

limitinteger

top-services, outstanding-worksheets, worksheet-margins — rows returned. Default 5, max 50.

metric'eur' | 'pct'

worksheet-margins only — ranking metric.

direction'best' | 'worst'

worksheet-margins only.

Response

The card (visible or hidden).

object'report_widget' required
widgetstring required
tab'officina' | 'economico' required
presetstring required

The applied date filter preset.

fromstring date required
tostring date required
grain'week' | 'month' required
visibleboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.