FluentaAPI

Get billing by module

getBillingByModulePermiso read

«Facturación por módulo» for one plant day: each módulo’s billed units and amount, in the plant’s currency.

GET/v1/external/organizations/{organizationId}/analytics/billing/modules

What it is: «Facturación por módulo», the table of the dashboard’s «Reportes», tab «Facturación», for one plant day: one row per «módulo» that billed, with the units it bills (billableUnits) and what they are worth (billedAmount). A «módulo» that billed nothing that day is no row.

How it is computed: the units of the «módulo»’s «puestos de salida» (the «puestos» whose output the plant invoices its client for), each at the price per unit of its «referencia» that day, plus an hour whose «conteo manual» was typed while no «puesto» held that role, at the price its «referencia» billed at that day. Summed per «módulo», then rounded to 2 decimals once.

Money is «Facturación»: the units of the «puestos de salida» × the price per unit each was billed at, in the plant’s currency (currency, ISO 4217: EUR for a plant in España, COP for every other), in whole currency units with up to 2 decimals, never cents. Whether a money figure reads null or 0 where nothing was priced is stated on each field.

Days and hours are the plant’s own: a plant day is a calendar day YYYY-MM-DD in the organization’s timezone (getOrganization timezone), never UTC, and an hour is the clock hour 0–23 that starts at it in that zone. day is optional: without it, the plant’s today on the organization’s own clock, as on every single-day route of the API externa; the answer’s day says which day was read.

Plan: needs the plan feature billingAnalytics («Facturación»), the one its dashboard screen is gated by. Pro, a trial of Pro and an «exenta» organization answer it; a Light organization, of either plan version, does not: 403 PLAN_LIMIT with feature: "billingAnalytics". getPlan features lists what the organization’s plan has.

See also: getBilling for «Facturación» over a range, by day, «módulo», «operario» or «puesto»; getMonth for the last 30 days in one call.

Autorización

apiToken
AutorizaciónBearer <token>

An API token created in Configuración › Tokens de API, or a connected app’s access token

En: header

Parámetros de ruta

organizationId*integer

The organization, from getMe or listOrganizations.

Parámetros de consulta

day?string

Plant day, YYYY-MM-DD on the plant’s clock. Omitted: the plant’s today, on its own clock.

Patrón^\d{4}-\d{2}-\d{2}$
Longitudlength <= 10

Respuestas

application/json

application/json

curl -X GET "https://api.fluenta.io/v1/external/organizations/0/analytics/billing/modules" \  -H "Authorization: Bearer fluenta_live_XXXX"
{  "day": "string",  "currency": "string",  "modules": [    {      "moduleId": 0,      "moduleName": "string",      "billableUnits": 0,      "billedAmount": 0    }  ]}