Skip to main content
GET
Obtener el uso de la pasarela de consignado para una competencia

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

competencia
string

Billing competência (yyyyMM). Omit for the current UTC month.

Ejemplo:

"202607"

Respuesta

OK

period
string
requerido

Billing competência (yyyyMM) the figures cover.

Ejemplo:

"202607"

scope
enum<string>
requerido

Aggregation scope: gateway (this service's facts) vs full_stack.

Opciones disponibles:
gateway,
full_stack
Ejemplo:

"gateway"

tenant
string
requerido

Tenant (organization) id the figures belong to, echoed from the authenticated identity — server-derived, NEVER worker PII and NEVER taken from client input. Lets a client-built B2B export key on the tenant without ever sending or choosing one.

Ejemplo:

"org-123"

total
string
requerido

Sum of all unit totals (decimal string, BRL).

Ejemplo:

"36.00"

units
object[] | null
requerido

Per-unit-type priced breakdown.