Skip to main content
GET
Obter uso de gateway consignado para competência

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

competencia
string

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

Exemplo:

"202607"

Resposta

OK

period
string
obrigatório

Billing competência (yyyyMM) the figures cover.

Exemplo:

"202607"

scope
enum<string>
obrigatório

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

Opções disponíveis:
gateway,
full_stack
Exemplo:

"gateway"

tenant
string
obrigatório

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.

Exemplo:

"org-123"

total
string
obrigatório

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

Exemplo:

"36.00"

units
object[] | null
obrigatório

Per-unit-type priced breakdown.