> ## 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. # 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. ## OpenAPI ````yaml en/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: >- OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant credentials and rail configuration, worker margin, loan auctions and bids, contract registration and lifecycle, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, usage, throughput, and event subscriptions. Secret material is written to the tenant secret store and is never returned by any operation. 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: >- Per-tenant Dataprev credential custody and public rail configuration (upload, status, rotation, revoke, requester code, and worker portal base URL) name: Credentials - description: >- Tenant-scoped consignado gateway usage: priced billable-unit aggregation per competência name: Consignado Usage - description: >- Per-tenant streaming-hub subscription control-plane (list, create, get, rotate, revoke, and test delivery) name: Subscriptions - description: >- Dataprev payroll-rail surface: FGTS balance and authorization reads, the FGTS guarantee execution, contract suspension, reactivation and term changes, the rail's own contract documents, and the on-demand reads of leilão solicitações, escriturações, repasses and employment terminations name: Consignado Rail - description: >- Synchronous rail command surface: the operations a bancarizador without the lender drives over HTTP. Each shares its command implementation with the equivalent lender event trigger. name: Consignado Rail Commands - description: >- Gateway-owned disbursement confirmation: a client bank recording money it has ALREADY paid to a worker. It crosses no government boundary and proxies no Dataprev operation. name: Consignado Disbursement - description: >- Per-tenant self-service outbound Dataprev rail throughput: read and set this tenant's own requests-per-second, including a deliberate pause at zero name: Consignado Throughput paths: /v1/consignado/usage: get: tags: - Consignado Usage summary: Get consignado gateway usage for a competência description: >- 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. 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 ````