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

# Read the loans closed by employment-link termination

> Reads one page of the rail's consultar-emprestimo-encerrado-termino-vinculo feed (Manual 006 v1.12 §2.1): the loans closed because the worker's employment link ended. Paginate with the opaque continuation token; omit it to start a fresh window. The read writes nothing — the poller's checkpoint advances only through its own compare-and-set persistence, so on-demand paging cannot make the job skip a page. When this deployment has no real termination-feed client plugged, the route answers 501 instead of returning fabricated records.



## OpenAPI

````yaml en/openapi/v3-current/consignado.yaml get /v1/consignado/employment-status/terminations
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/employment-status/terminations:
    get:
      tags:
        - Consignado Rail
      summary: Read the loans closed by employment-link termination
      description: >-
        Reads one page of the rail's
        consultar-emprestimo-encerrado-termino-vinculo feed (Manual 006 v1.12
        §2.1): the loans closed because the worker's employment link ended.
        Paginate with the opaque continuation token; omit it to start a fresh
        window. The read writes nothing — the poller's checkpoint advances only
        through its own compare-and-set persistence, so on-demand paging cannot
        make the job skip a page. When this deployment has no real
        termination-feed client plugged, the route answers 501 instead of
        returning fabricated records.
      operationId: listConsignadoEmploymentTerminations
      parameters:
        - description: >-
            OPTIONAL opaque pagination handle returned as
            next_continuation_token by a previous call. Omit it to start a fresh
            window. It is minted by this gateway and refused (422) when it is
            not one of ours.
          explode: false
          in: query
          name: continuation_token
          schema:
            description: >-
              OPTIONAL opaque pagination handle returned as
              next_continuation_token by a previous call. Omit it to start a
              fresh window. It is minted by this gateway and refused (422) when
              it is not one of ours.
            examples:
              - ''
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmploymentTerminationsResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ListEmploymentTerminationsResponse:
      additionalProperties: false
      properties:
        next_continuation_token:
          description: >-
            Opaque handle for the next page. EMPTY means the current snapshot is
            drained — stop paging. Pass it back as continuation_token to fetch
            the next page; it is minted by this gateway and refused (422) if it
            is not one of ours.
          examples:
            - ''
          type: string
        records:
          description: The termination records on this page.
          items:
            $ref: '#/components/schemas/EmploymentTerminationRecord'
          type:
            - array
            - 'null'
      required:
        - records
        - next_continuation_token
      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
    EmploymentTerminationRecord:
      additionalProperties: false
      properties:
        effective_at:
          description: When the status took effect (UTC).
          examples:
            - '2026-07-15T00:00:00Z'
          format: date-time
          type: string
        numero_contrato:
          description: The contract whose employment link ended.
          examples:
            - '199971600000'
          type: string
        reason_code:
          description: The rail's reason code, when it published one.
          examples:
            - ''
          type: string
        record_id:
          description: >-
            Per-record identity inside the channel; (report_ref, record_id) is
            the idempotency subject.
          examples:
            - '199971600000'
          type: string
        report_ref:
          description: The logical feed channel this record came from.
          examples:
            - terminacao-vinculo
          type: string
        status:
          description: The employment status the record reports.
          enum:
            - suspended
            - terminated
          examples:
            - terminated
          type: string
      required:
        - report_ref
        - record_id
        - numero_contrato
        - status
        - effective_at
      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

````