> ## 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. # Excluir un contrato de esta institución porque el trabajador lo portó a otra > Esta operación actúa como proxy de excluir-portabilidade-trabalhador (Manual 008 v1.10 §4.1), la escritura de la institución de ORIGEN: el contrato nombrado en la ruta deja de estar consignado aquí porque el trabajador lo trasladó a la institución nombrada por codigoProponente. codigoOrigem nunca se acepta del llamador: es el propio COMPE/CBC del tenant autenticado. El contrato debe ser una averbação del tenant autenticado que la red reconoció; cualquier otra cosa es 404 antes de llamar a la red. La llamada se reclama de forma duradera antes de partir y se cierra de forma duradera después de que llega la respuesta, de modo que un reintento con la misma clave X-Idempotency se responde desde la respuesta retenida de la red en lugar de excluir por segunda vez, y una llamada cuyo desenlace nadie estableció se concilia contra el registro en lugar de perderse. El éxito publica consignado.portabilidade.efetivada y un rechazo publicado publica consignado.portabilidade.rejeitada. Una portabilidad que el cliente realiza FUERA de este gateway no publica nada: la consulta del Manual 008 §5.4 es solo para el proponente, por lo que la institución de origen no tiene ninguna vía de descubrimiento. Se requiere X-Idempotency. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao 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://br-consignado-gw.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}/portabilidade/exclusao: post: tags: - Consignado Rail summary: >- Excluir un contrato de esta institución porque el trabajador lo portó a otra description: >- Esta operación actúa como proxy de excluir-portabilidade-trabalhador (Manual 008 v1.10 §4.1), la escritura de la institución de ORIGEN: el contrato nombrado en la ruta deja de estar consignado aquí porque el trabajador lo trasladó a la institución nombrada por codigoProponente. codigoOrigem nunca se acepta del llamador: es el propio COMPE/CBC del tenant autenticado. El contrato debe ser una averbação del tenant autenticado que la red reconoció; cualquier otra cosa es 404 antes de llamar a la red. La llamada se reclama de forma duradera antes de partir y se cierra de forma duradera después de que llega la respuesta, de modo que un reintento con la misma clave X-Idempotency se responde desde la respuesta retenida de la red en lugar de excluir por segunda vez, y una llamada cuyo desenlace nadie estableció se concilia contra el registro en lugar de perderse. El éxito publica consignado.portabilidade.efetivada y un rechazo publicado publica consignado.portabilidade.rejeitada. Una portabilidad que el cliente realiza FUERA de este gateway no publica nada: la consulta del Manual 008 §5.4 es solo para el proponente, por lo que la institución de origen no tiene ninguna vía de descubrimiento. Se requiere X-Idempotency. operationId: excluirConsignadoPortabilidade parameters: - description: >- The contract leaving this institution. Must be an averbação of the authenticated tenant that the rail acknowledged. in: path name: numero_contrato required: true schema: description: >- The contract leaving this institution. Must be an averbação of the authenticated tenant that the rail acknowledged. examples: - 99999999999AP1 maxLength: 15 minLength: 2 type: string - description: >- Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. It is the durable replay identity of this command. in: header name: X-Idempotency required: true schema: description: >- Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. It is the durable replay identity of this command. examples: - idem-exclusao-portabilidade-0001 maxLength: 128 minLength: 1 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExclusaoPortabilidadeBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExclusaoPortabilidadeResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ExclusaoPortabilidadeBody: additionalProperties: false properties: codigoInscricaoEmpregador: description: 'Employer inscription type: 1 CNPJ, 2 CPF.' examples: - '1' pattern: ^[12]$ type: string codigoProponente: description: >- COMPE/CBC of the DESTINATION institution taking the contract. Caller input, because this gateway cannot know it. examples: - '994' maxLength: 3 minLength: 1 pattern: ^[0-9]{1,3}$ type: string cpfTrabalhador: description: Worker CPF, 11 digits. examples: - '99999999999' maxLength: 11 minLength: 11 pattern: ^[0-9]{11}$ type: string matricula: description: Matrícula assigned to the worker by the employer. examples: - 99999999999-A maxLength: 30 minLength: 1 type: string numeroInscricaoEmpregador: description: >- Employer inscription number, Texto per the manual (the mirrored Swagger still types this int64). examples: - '99999999999881' maxLength: 14 minLength: 1 type: string numeroUnico: description: >- Número único identificador da portabilidade (NSU oriundo da CIP). A digit STRING: Manual 008 publishes exactly 21 algarismos, which overflows every conventional numeric type, so it stays text end to end. examples: - '123456789012345678901' maxLength: 21 minLength: 21 pattern: ^[0-9]{21}$ type: string ultimaParcelaPaga: description: >- Last instalment already paid on the contract being excluded. Optional; omit it rather than sending 0 when unknown. examples: - 5 format: int64 maximum: 999 minimum: 0 type: integer required: - numeroUnico - codigoProponente - cpfTrabalhador - matricula - codigoInscricaoEmpregador - numeroInscricaoEmpregador type: object ExclusaoPortabilidadeResponse: additionalProperties: false properties: codigoSucesso: description: The rail's own success code. examples: - '00' type: string competenciaExclusao: description: Payroll competência in which the exclusion takes effect, yyyyMM. examples: - 202609 format: int64 type: integer hashOperacao: description: >- The rail's own identity for this operation. Texto on this operation, unlike the other exclusion operations where the same field name is Número. examples: - '34006311' type: string mensagem: description: The rail's own message. examples: - Exclusao realizada com sucesso type: string numeroContrato: description: The contract this exclusion removed from the origin institution. examples: - 99999999999AP1 type: string submittedAt: description: When this gateway durably authorized the rail call, RFC 3339 UTC. examples: - '2026-08-29T12:00:00Z' format: date-time type: string ultimaParcelaPaga: description: >- Last instalment the rail reports as paid on the excluded contract. Omitted when the acknowledgement carries no entry for the commanded contract: 0 is a live value (exclusion before any instalment was paid), so absence must not fabricate it. examples: - 5 format: int64 type: integer required: - numeroContrato - submittedAt - codigoSucesso - mensagem - competenciaExclusao - hashOperacao 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 ````