> ## 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. # Lea la exclusión que tiene esta gateway para un contrato > Lee la exclusión que esta gateway mantiene de forma duradera para un contrato: el resultado de excluir-consignado-trabalhador (Manual 003 v1.19 §3.3). Es una lectura LOCAL: nunca llama a Dataprev y nunca inicia un pase de conciliación, porque la propia fila de la gateway ya responde y una operación M003 sin deshacer no justifica gastar el presupuesto de tarifas de la red en la pregunta. 404 significa que la gateway no tiene nada para este contrato. 409 significa que el contrato tiene una fila de autoridad heredada que no se puede informar: deliberadamente no un 404, porque el silencio se leería como "this contract was never excluded". ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/exclusion 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/contracts/{numero_contrato}/exclusion: get: tags: - Consignado Rail Commands summary: Lea la exclusión que tiene esta gateway para un contrato description: >- Lee la exclusión que esta gateway mantiene de forma duradera para un contrato: el resultado de excluir-consignado-trabalhador (Manual 003 v1.19 §3.3). Es una lectura LOCAL: nunca llama a Dataprev y nunca inicia un pase de conciliación, porque la propia fila de la gateway ya responde y una operación M003 sin deshacer no justifica gastar el presupuesto de tarifas de la red en la pregunta. 404 significa que la gateway no tiene nada para este contrato. 409 significa que el contrato tiene una fila de autoridad heredada que no se puede informar: deliberadamente no un 404, porque el silencio se leería como "this contract was never excluded". operationId: getConsignadoContractExclusion parameters: - description: The rail contract number whose exclusion is read. in: path name: numero_contrato required: true schema: description: The rail contract number whose exclusion is read. examples: - NC-000001 maxLength: 15 minLength: 2 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExclusionOperationResponse' description: The exclusion operation that describes the contract now. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: The gateway holds no exclusion operation for this contract. '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- The contract holds a legacy authority row that cannot be reported. Never a 404: silence would read as "this contract was never excluded". default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ExclusionOperationResponse: additionalProperties: false properties: evidenceSource: description: >- Which proof produced the terminal state: exclude_response, operator_evidence or m005_observation. Empty until one did. examples: - exclude_response type: string message: description: >- The refusal message the REGISTRY published. Present only on a rejected operation. examples: - motivo nao publicado type: string motivoExclusao: description: >- The client's declared Manual 003 §3.3.1 reason, echoed from the durable authority. enum: - '1' - '2' - '3' - '7' - '8' - '9' examples: - '1' type: string numeroContrato: description: The contract number the exclusion was addressed to. examples: - NC-000001 type: string outcomeAt: description: Instant the registry answered, RFC 3339 UTC. ABSENT until it did. examples: - '2026-08-05T12:00:00Z' format: date-time type: string providerReference: description: >- The registry's own receipt for the mutation. ABSENT when it minted none, which is the normal case under an m005_observation confirmation — absence is never a verdict. examples: - HASH-1 type: string reasonCode: description: >- The refusal code the REGISTRY published. Present only on a rejected operation. examples: - ME type: string status: description: >- Durable operation status. confirmed means the contract came off the payroll; rejected means the registry published a refusal; claimed, invoking and outcome_unknown all mean the effect at the registry is NOT known yet and M005 reconciliation has to close it — none of the three is a failure to retry blindly. enum: - claimed - invoking - confirmed - rejected - outcome_unknown examples: - confirmed type: string required: - numeroContrato - motivoExclusao - status 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 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 ````