Get consignado gateway usage for a competência

Returns the tenant’s gateway-scoped, priced usage aggregation for a billing competência: R$15 per confirmed averbação and R$2 per active deduction competência, priced SEPARATELY from single-source flat fees (independent of the loan principal). Omit competencia for the current UTC month. A period with no usage returns 200 with zero counts, NOT 404. Money is a decimal string, never a float.

GET /v1/consignado/usage

Get consignado gateway usage for a competência

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/usage \
  --header 'Authorization: Bearer <token>'

200

{
  "period": "202607",
  "scope": "gateway",
  "tenant": "org-123",
  "total": "36.00",
  "units": [
    {
      "count": 2,
      "total": "30.00",
      "unitAmount": "15.00",
      "unitType": "averbacao"
    }
  ]
}

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

200

application/json

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.

Show child attributes