> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Obtener el uso de la pasarela de consignado para una competencia > Devuelve la agregación de uso de la pasarela, con ámbito de tenant y precios, para una competencia de facturación: R$15 por averbação confirmada y R$2 por competencia de deducción activa, con precios independientes de las tarifas planas de fuente única e independientes del principal del préstamo. Omita competencia para el mes UTC actual. Un período sin uso devuelve 200 con recuentos de cero, no 404. El dinero se expresa como una cadena decimal, nunca como un valor de punto flotante. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/usage openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Superficie OpenAPI 3.1 para Lerian Consignado — Dataprev. API cubre las credenciales y la configuración de red de tenant, el margen de los trabajadores, las subastas y ofertas de préstamos, el registro y el ciclo de vida de los contratos, la confirmación de desembolsos, la portabilidad, la refinanciación, la renegociación, las garantías de FGTS, la conciliación, los fondos, las asignaciones, el uso, el rendimiento y las suscripciones a eventos. El material secreto se escribe en el almacén secreto tenant y ninguna operación lo devuelve nunca. license: name: Lerian Studio General License title: Lerian Consignado API version: v1.0.0 servers: - url: https://consignado.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Custodia de credenciales de Dataprev y configuración pública del rail por tenant (carga, estado, rotación, revocación, código del solicitante y URL base del portal del trabajador) name: Credentials - description: >- Uso de la gateway del consignado en el ámbito del tenant: agregación de unidades facturables con precio por competencia name: Consignado Usage - description: >- Plano de control de suscripción al hub de streaming per-tenant (enumerar, crear, obtener, rotar, revocar y probar la entrega) name: Subscriptions - description: >- Superficie de rail de nómina Dataprev: lecturas de saldo y autorización FGTS, ejecución de garantía FGTS, suspensión de contrato, reactivación y cambios de términos, documentos de contrato propios de la red y lecturas bajo demanda de leilão solicitações, escriturações, repasses y terminaciones de empleo. name: Consignado Rail - description: >- Superficie de comando de red síncrona: las operaciones de un bancarizador sin que el prestamista conduzca sobre HTTP. Cada uno comparte su implementación de comando con el activador de evento de prestamista equivalente. name: Consignado Rail Commands - description: >- Confirmación de desembolso propiedad de la gateway: un banco cliente que registra el dinero que ya pagó a un trabajador. No cruza ninguna frontera gubernamental y no representa ninguna operación Dataprev. name: Consignado Disbursement - description: > Rendimiento de red Dataprev saliente de autoservicio per-tenant: lea y configure el requests-per-second propio de este tenant, incluida una pausa deliberada en cero name: Consignado Throughput paths: /v1/consignado/usage: get: tags: - Consignado Usage summary: Obtener el uso de la pasarela de consignado para una competencia description: >- Devuelve la agregación de uso de la pasarela, con ámbito de tenant y precios, para una competencia de facturación: R$15 por averbação confirmada y R$2 por competencia de deducción activa, con precios independientes de las tarifas planas de fuente única e independientes del principal del préstamo. Omita competencia para el mes UTC actual. Un período sin uso devuelve 200 con recuentos de cero, no 404. El dinero se expresa como una cadena decimal, nunca como un valor de punto flotante. operationId: getConsignadoUsage parameters: - description: Billing competência (yyyyMM). Omit for the current UTC month. explode: false in: query name: competencia schema: description: Billing competência (yyyyMM). Omit for the current UTC month. examples: - '202607' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: UsageResponse: additionalProperties: false properties: period: description: Billing competência (yyyyMM) the figures cover. examples: - '202607' type: string scope: description: 'Aggregation scope: gateway (this service''s facts) vs full_stack.' enum: - gateway - full_stack examples: - gateway type: string tenant: description: >- 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. examples: - org-123 type: string total: description: Sum of all unit totals (decimal string, BRL). examples: - '36.00' type: string units: description: Per-unit-type priced breakdown. items: $ref: '#/components/schemas/UsageUnitLine' type: - array - 'null' required: - tenant - period - scope - units - total type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object UsageUnitLine: additionalProperties: false properties: count: description: Number of durable billable units in the period. examples: - 2 format: int64 type: integer total: description: count × unitAmount (decimal string, BRL). examples: - '30.00' type: string unitAmount: description: Flat fee per unit (decimal string, BRL). examples: - '15.00' type: string unitType: description: Billable unit type. enum: - averbacao - active_contract examples: - averbacao type: string required: - unitType - count - unitAmount - total type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````