> ## 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. # Leia a exclusão que este gateway mantém para um contrato > Lê o resultado durável de excluir-consignado-trabalhador (Manual 003 v1.19 §3.3) mantido pelo gateway para um contrato. É uma leitura local: não chama a Dataprev nem inicia reconciliação, porque o registro persistido já é a autoridade para essa consulta. 404 significa que o gateway não possui registro para o contrato. 409 significa que existe um registro legado de autoridade que não pode ser apresentado. Esse caso não retorna 404, porque o silêncio seria interpretado incorretamente como "este contrato nunca foi excluído". ## OpenAPI ````yaml pt/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: >- Superfície OpenAPI 3.1 para Lerian Consignado — Dataprev. o API cobre credenciais tenant e configuração de rede, margem do trabalhador, leilões e licitações de empréstimos, registro e ciclo de vida do contrato, confirmação de desembolso, portabilidade, refinanciamento, renegociação, garantias FGTS, reconciliação, fundos, atribuições, uso, rendimento e assinaturas de eventos. o material secreto é gravado no armazenamento secreto tenant e nunca é devolvido por nenhuma operação. 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: >- Custódia de credenciais do Dataprev e configuração pública do rail por tenant (upload, status, rotação, revogação, código do solicitante e URL base do portal do trabalhador) name: Credentials - description: >- Uso do gateway consignado no escopo do tenant: agregação de unidades faturáveis ​​com preço por competência name: Consignado Usage - description: >- Per-tenant plano de controle de assinatura do streaming-hub (listar, criar, obter, girar, revogar e testar a entrega) name: Subscriptions - description: >- Superfície folha de pagamento da rail Dataprev: leituras de saldo e autorização FGTS, execução de garantias FGTS, suspensão de contrato, reativação e alteração de prazo, documentos contratuais próprios da rede e leituras sob demanda de transações, escriturações, repasses e rescisões trabalhistas name: Consignado Rail - description: >- Superfície de comando da rede síncrona: as operações que um bancarizador sem o credor realizam sobre HTTP. cada um compartilha sua implementação de comando com o gatilho de evento de credor equivalente. name: Consignado Rail Commands - description: >- Confirmação de desembolso de propriedade do gateway: um banco cliente registrando o dinheiro que ALREADY pagou a um trabalhador. ele não cruza nenhuma fronteira governamental e não representa nenhuma operação Dataprev. name: Consignado Disbursement - description: > Taxa de transferência da rail Dataprev de saída de autoatendimento per-tenant: leia e defina o próprio requests-per-second deste tenant, incluindo uma pausa deliberada em zero name: Consignado Throughput paths: /v1/consignado/contracts/{numero_contrato}/exclusion: get: tags: - Consignado Rail Commands summary: Leia a exclusão que este gateway mantém para um contrato description: >- Lê o resultado durável de excluir-consignado-trabalhador (Manual 003 v1.19 §3.3) mantido pelo gateway para um contrato. É uma leitura local: não chama a Dataprev nem inicia reconciliação, porque o registro persistido já é a autoridade para essa consulta. 404 significa que o gateway não possui registro para o contrato. 409 significa que existe um registro legado de autoridade que não pode ser apresentado. Esse caso não retorna 404, porque o silêncio seria interpretado incorretamente como "este contrato nunca foi excluído". 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 ````