> ## 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. # Alter the mutable terms of an averbado contract > Proxies alterar-consignado-trabalhador (Manual 003 §3.2): instalment count, instalment amount, worker name, and optionally the first deduction competência. Same tenant-ownership proof and idempotency requirement as suspend. Money is a decimal string, never a float. ## OpenAPI ````yaml en/openapi/v3-current/consignado.yaml patch /v1/consignado/contracts/{numero_contrato}/terms 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/contracts/{numero_contrato}/terms: patch: tags: - Consignado Rail summary: Alter the mutable terms of an averbado contract description: >- Proxies alterar-consignado-trabalhador (Manual 003 §3.2): instalment count, instalment amount, worker name, and optionally the first deduction competência. Same tenant-ownership proof and idempotency requirement as suspend. Money is a decimal string, never a float. operationId: alterConsignadoContractTerms parameters: - description: >- Rail contract number of an averbação belonging to the authenticated tenant. in: path name: numero_contrato required: true schema: description: >- Rail contract number of an averbação belonging to the authenticated tenant. examples: - 99999999999AN1 maxLength: 15 minLength: 1 type: string - description: >- Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. in: header name: X-Idempotency required: true schema: description: >- Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. examples: - idem-terms-2026-07-30-0001 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ContratoTermsBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContratoOperationResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ContratoTermsBody: additionalProperties: false properties: codigoInscricaoEmpregador: description: 'Employer inscription type: 1 = CNPJ, 2 = CPF.' enum: - '1' - '2' examples: - '1' type: string competenciaInicioDesconto: description: >- First deduction competência, yyyyMM. Obrigatório=Não at the rail: omitted, the rail fills it automatically. Relayed verbatim — sending an empty string would be an invalid value rather than an absence, so an omitted field is dropped from the wire. examples: - '202608' type: string cpf: description: >- Worker CPF, exactly 11 digits. In the BODY, never a path or query parameter. examples: - '99999999999' pattern: ^[0-9]{11}$ type: string matricula: examples: - 99999999999-A minLength: 1 type: string nomeTrabalhador: examples: - Trabalhador 99999999999 minLength: 1 type: string numeroInscricaoEmpregador: examples: - '42422253000101' minLength: 1 type: string numeroParcelas: description: Number of instalments. examples: - 11 format: int64 minimum: 1 type: integer valorParcela: description: >- Instalment amount (decimal string, BRL, at most 2 decimals). A decimal string end to end — a money field never becomes a binary float on the way to the rail. examples: - '444.96' pattern: ^[0-9]+(\.[0-9]{1,2})?$ type: string required: - nomeTrabalhador - numeroParcelas - valorParcela - cpf - matricula - codigoInscricaoEmpregador - numeroInscricaoEmpregador type: object ContratoOperationResponse: additionalProperties: false properties: hashOperacao: description: >- The rail's own operation identity, surfaced as its exact decimal digits (the rail types it Numérico). Manual 003 publishes no response table for these operations, so it MAY be absent on a 2xx — a 2xx is itself the success signal, do not branch on this field being present. examples: - '33908101' type: string 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 ````