> ## 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.

# Remover um contrato averbado do registro da folha de pagamento

> Remove um contrato averbado do registro Dataprev por meio de excluir-consignado-trabalhador (Manual 003 v1.19 §3.3). Não há reversão; por isso, a operação está marcada como x-money-path: true.

O corpo contém apenas a chave de negócio. codigoSolicitante, cpfTrabalhador, matricula, codigoInscricaoEmpregador e numeroInscricaoEmpregador vêm do instantâneo imutável da reserva local e nunca são aceitos do chamador. Assim, o cliente não pode endereçar a exclusão de um trabalhador que sua própria reserva não cobriu.

a resposta distingue os três resultados que um chamador deve ser capaz de distinguir:

| estado | significado |
|---|---|
| 201 | esta chamada criou a tentativa e ela atingiu um estado terminal - confirmada (o contrato saiu da folha de pagamento) ou rejeitada (o registro recusou e seu próprio código e mensagem estão no corpo) |
| 200 | repetição de uma tentativa já terminal; o corpo contém o resultado anterior e esta chamada não invocou o trilho |
| 202 | o gateway reteve a solicitação, mas o efeito no registro ainda é desconhecido; a reconciliação M005 converge. Uma repetição não terminal também retorna 202; X-Idempotency-Replayed indica se houve nova invocação |

Uma tentativa rejeitada é uma resposta de negócio, não um erro de transporte: o registro publicou uma recusa que o cliente deve interpretar.



## OpenAPI

````yaml pt/openapi/v3-current/consignado.yaml post /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:
    post:
      tags:
        - Consignado Rail Commands
      summary: Remover um contrato averbado do registro da folha de pagamento
      description: >-
        Remove um contrato averbado do registro Dataprev por meio de
        excluir-consignado-trabalhador (Manual 003 v1.19 §3.3). Não há reversão;
        por isso, a operação está marcada como x-money-path: true.


        O corpo contém apenas a chave de negócio. codigoSolicitante,
        cpfTrabalhador, matricula, codigoInscricaoEmpregador e
        numeroInscricaoEmpregador vêm do instantâneo imutável da reserva local e
        nunca são aceitos do chamador. Assim, o cliente não pode endereçar a
        exclusão de um trabalhador que sua própria reserva não cobriu.


        a resposta distingue os três resultados que um chamador deve ser capaz
        de distinguir:


        | estado | significado |

        |---|---|

        | 201 | esta chamada criou a tentativa e ela atingiu um estado terminal
        - confirmada (o contrato saiu da folha de pagamento) ou rejeitada (o
        registro recusou e seu próprio código e mensagem estão no corpo) |

        | 200 | repetição de uma tentativa já terminal; o corpo contém o
        resultado anterior e esta chamada não invocou o trilho |

        | 202 | o gateway reteve a solicitação, mas o efeito no registro ainda é
        desconhecido; a reconciliação M005 converge. Uma repetição não terminal
        também retorna 202; X-Idempotency-Replayed indica se houve nova
        invocação |


        Uma tentativa rejeitada é uma resposta de negócio, não um erro de
        transporte: o registro publicou uma recusa que o cliente deve
        interpretar.
      operationId: excluirConsignadoContract
      parameters:
        - description: >-
            The rail contract number (Manual 003 §3.3.1 p.15: Texto, 2 to 15
            characters of free choice). Exact, control-free UTF-8: no trimming
            and no case folding.
          in: path
          name: numero_contrato
          required: true
          schema:
            description: >-
              The rail contract number (Manual 003 §3.3.1 p.15: Texto, 2 to 15
              characters of free choice). Exact, control-free UTF-8: no trimming
              and no case folding.
            examples:
              - NC-000001
            maxLength: 15
            minLength: 2
            type: string
        - description: >-
            Mandatory opaque replay key, 1..128 bytes of valid UTF-8, preserved
            byte for byte. There is no X-Idempotency-Key alias, no case folding
            and no normalization: two keys differing in one byte are two keys.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Mandatory opaque replay key, 1..128 bytes of valid UTF-8,
              preserved byte for byte. There is no X-Idempotency-Key alias, no
              case folding and no normalization: two keys differing in one byte
              are two keys.
            examples:
              - idem-exclusao-0001
            maxLength: 128
            minLength: 1
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExclusionCommandRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExclusionOperationResponse'
          description: >-
            A replay of an attempt that is already terminal: the outcome in the
            body is the earlier attempt's, and this call invoked nothing.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExclusionOperationResponse'
          description: >-
            This call created the attempt and it reached a terminal state —
            confirmed, or rejected carrying the registry's own code and message.
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  True when the durable record supplied the answer without
                  another rail invocation.
                type: string
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExclusionOperationResponse'
          description: >-
            The gateway holds the request and the effect at the registry is not
            known yet, whether or not this call invoked anything.
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            The same key names a divergent request, or the contract holds an
            immutable authority that conflicts.
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: The raw body exceeds the 1 KiB wire guard.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            The body, the reason code or the contract number is refused locally,
            before anything reaches Dataprev.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ExclusionCommandRequest:
      additionalProperties: false
      properties:
        motivo_exclusao:
          description: >-
            The client's declared reason for removing the contract from the
            rail, as one of the closed codes Manual 003 §3.3.1 publishes: 1
            desistência do empréstimo, 2 falecimento, 3 liquidação antecipada, 7
            ação judicial, 8 exclusão por fraude, 9 outros. A string, never a
            JSON number. Mandatory on every request: the gateway never declares
            a reason on the client's behalf, and an absent or unpublished code
            is refused locally before the rail is called.
          enum:
            - '1'
            - '2'
            - '3'
            - '7'
            - '8'
            - '9'
          examples:
            - '1'
          type: string
      required:
        - motivo_exclusao
      type: object
    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: <SERVICE>-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

````