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

# Consignado module

> Operate CLT payroll loans on the Dataprev rail from the Consignado CLT section of the Lender module: origination, contracts, and portability.

The **Consignado CLT** section of the [Lender module](https://docs.lerian.studio/en/products/lender/console/lender-module.md) operates CLT payroll loans on the Dataprev rail through the Consignado gateway. For the product behind it, see [Consignado privado](https://docs.lerian.studio/en/products/lender/consignado-privado.md) and the [Consignado rail](https://docs.lerian.studio/en/rails/consignado/what-is-lerian-consignado.md).

The section appears in the Lender sidebar when an administrator turns on **Consignado CLT** in **Settings** › **Plugins**. Each screen also needs its own permission.

## On a contract

***

On a CLT contract, when the plugin is on and your role holds the permission, the loan application and loan account screens add these sections.

* **On the Dataprev rail** shows the averbação situation and the loan as the rail reports it. A menu holds the commands for the contract: send the documentation, suspend or reactivate the payroll deduction, resubmit the amount and installments, bring a competência forward or withdraw that early payment, exclude a portability at origin, refinance into a new contract or revert a refinancing, renegotiate into a new contract, exclude the contract from the payroll, and execute the FGTS guarantee.
* **Disbursement on the gateway** appears on a loan application that is approved or disbursed. It records a payment that you already made to the worker. Record it only after the payment left. The gateway records what you state and checks it against nothing downstream. The record cannot be edited or deleted.

## Origination

***

| Screen | What it shows | What you do there |
| - | - | - |
| **Auction** | The worker loan requests open on the Dataprev auction inside the window you choose. The rail answers for a window of at most 365 days that ends no later than now. | Answer a request with a bid. **Bid on behalf of** picks a registered originator. Left on your own account, the bid goes out for you. The bid is published to the worker. A proposal that the worker accepts becomes a contract you are bound by. |
| **Bids** | The bids your organization claimed on the auction, newest first, and whether the credit it won was ceded to a fund. | Filter by situation, by the cessão side, and by originator. |
| **Originators** | The originators that bid for your organization, with their reference, their portal address, and whether each is active. | **Register originator** with a reference and an optional portal address. **Deactivate** an originator, and its bids are refused from then on. **Reactivate** it to undo that. **Funds** opens the funds that the originator can quote for, its mandate. Add or remove funds, then **Save funds**. Saving an empty list asks for confirmation. |
| **Averbações** | The averbações your organization claimed on the rail, oldest claim first. | Register a **New averbação** at the rail. Filter by situation. |
| **Disbursement confirmations** | The payments your organization told the gateway it had already made to a worker, most recent first. | Read. |
| **Pre-auction** | Whether the pre-auction is on, and its quote window, selection criterion, preferred fund, closing and rotation. | **Configure**, or **Change settings** once it exists. Turning the pre-auction on or off asks for confirmation. A change applies to the loan requests that the gateway discovers from then on. |
| **Pre-auction funds** | The funds with a written policy: whether each takes part, its weight and share, its hours, and, for today in São Paulo time, the quotes and amount elected and the capital available. | **Details** opens the policy and the use of the fund today. **Configure another fund** sets the policy of a fund that has none: participation, weight, hours, daily limits, capital and restrictions. |
| **Pre-auctions** | The quote windows that the gateway opened, newest first: when it found the request, the quote deadline, the closing, the preferred fund, the status and the outcome. | **Details** opens a window: its quotes in rank order with their status, reserved and confirmed amount, earlier revisions and the reason a quote was not elected, the rotation computation, and the expected pairs. **Decline** a pair that has not answered while the window is open. |

When a request has a pre-auction window, the **Auction** form sends a quote and not a bid. It shows the quote deadline and adds **Quote fund**, the fund the quote is for. With **Bid on behalf of** set to an originator, the list holds the funds in the mandate of that originator. On your own account, it holds every fund. **Send quote** asks for confirmation, and says when the quote replaces a revision that the originator and the fund already hold. After the window closes, the form shows that it closed. A role without `leilao:read` on `consignado-preleilao` cannot read the window, so the form sends a bid. The gateway refuses that bid while the request has a window, and the Console says that the role cannot quote there.

The three pre-auction screens read with `config:read`, `fundos:read` and `leiloes:read` on `consignado-preleilao`. Changing the settings or the policy of a fund needs `config:write` or `fundo:write`. **Decline** needs `quote-decline:write` on `consignado-rail`. The **Funds** button of an originator reads with `fundos:read` and saves with `fundos:write` on `consignado-originadores`. See [Operate Lerian Consignado](https://docs.lerian.studio/en/rails/consignado/consignado-operations.md).

## Contracts

***

| Screen | What it shows | What you do there |
| - | - | - |
| **Exclusions** | The contract exclusions your organization requested, and where each one stands. It opens on the requests the provider never answered. | Choose **All** to read every request. Open one to read its transitions. |
| **Correction chains** | The corrections recorded against one contract, in the order each was chained. Type a contract number to read them. | **Record a correction**, with a PDF or ZIP file. The correction is appended to its chain and names what it supersedes. You cannot edit or delete it. |
| **Legacy loans** | No list. The screen does not show the loans already registered. Read **Rail commands** before you register a loan again. | Register, consolidate, and remove loans that your institution made before the Dataprev rail existed. |
| **Contract registrations** | The contract registrations that Dataprev confirmed for your organization, with the fact composed from it and whether that fact was published. | Read. |

Dataprev checks none of the values you send for a legacy loan. A wrong value is corrected by removing the legacy loan with reason 9 and registering it again.

## Portability

***

| Screen | What it shows | What you do there |
| - | - | - |
| **Portability requests** | The portabilities that your organization is the proponente of, as Dataprev answers now. | Filter by the portability number (NSU), by situation, and by origin institution code. **Averbar** puts the contract you ported in onto your payroll. Once the rail takes it, no command in the Console undoes it. Open a row to read the contracts excluded at the origin. |
| **Portability auction** | The workers who ask to bring a payroll loan from another institution to you. | Answer a request with a proposal. The proposal is published to the worker. |

Excluding a portability at origin tells the rail that the worker ported the contract out of your institution. The contract leaves your payroll. The rail publishes no operation that puts it back. A contract excluded in error has to be averbado again from the start.

## Payroll, employment, and the Dataprev rail

***

See [Payroll, employment, and rail operations](https://docs.lerian.studio/en/products/lender/console/consignado-rail.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.