> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/emprestimos/importacao-dos-arquivos-de-econsignado/aba-via-api.md).

# Aba Via API

Programa: CCRHE700TAB2

{% hint style="success" %}
*Esta documentação é válida para todas as versões do Consistem ERP.*
{% endhint %}

### Pré-Requisitos

***

Não há.

### Acesso

***

Módulo: RH Folha de Pagamento\
Grupo: Empréstimos\
[Manutenção dos Contratos de eConsignado (CCRHE330)](/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/emprestimos/manutencao-dos-contratos-de-econsignado.md)\
Botão **Atualizar Contratos**\
[Importação dos Arquivos de eConsignado (CCRHE700)](/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/emprestimos/importacao-dos-arquivos-de-econsignado.md)

### Visão Geral

***

O objetivo deste programa é permitir a importação automatizada dos dados de contrato do eConsignado, utilizando a API do governo, eliminando a necessidade de upload manual de arquivos. Para viabilizar essa funcionalidade, é necessário realizar a configuração do certificado digital na [Aba Integração eConsignado (CSWMEN180TAB5)](/modulos/componentes/manuais-de-telas/configuracao-dos-componentes/configuracoes-de-integracoes/aba-integracao-econsignado.md). Neste local, os certificados digitais devem ser vinculados aos empregadores que terão permissão para importar os dados do eConsignado diretamente via API.

### Campos

***

*Campos assinalados com* <mark style="color:red;">**|**</mark> *são de preenchimento obrigatório.*

#### Mês/Ano<mark style="color:red;">**|**</mark>

Informar a competência pertinente ao arquivo de eConsignado que será importado, para o sistema saber quais contratos deve encerrar ou manter aberto.

### Colunas do Grid

***

#### Código do Empregador

Exibe o código único que identifica a entidade empregadora.

#### Descrição do Empregador

Exibe o nome ou descrição completa da entidade empregadora.

#### Código do Certificado

Exibe o identificador único do certificado de consignação ou do registro que está sendo gerenciado.

#### Descrição do Certificado

Exibe detalhes adicionais sobre o certificado.

#### Data Última Importação

Exibe a data em que o registro específico foi importado pela última vez.

### Botões

***

#### Consultar

Exibe os dados da consulta conforme filtros informados.

#### Obter Contratos

Este botão exibe os contratos consignados detalhados buscados via API do DataPrev para os certificados digitais selecionados. Ele serve como uma forma mais prática de importar os contratos, pois realiza uma consulta direta ao portal do DataPrev para obter os dados e, em seguida, apresenta o programa [Seleção dos Contratos eConsignado para Importação (CCRHE700A)](/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/emprestimos/selecao-dos-contratos-econsignado-para-importacao.md) para a conferência de contratos antes da importação, a mesma que é aberta quando o arquivo .JSON é importado manualmente.

{% hint style="warning" %} <mark style="color:orange;">**Importante**</mark>

Este botão será habilitado se houver a configuração de pelo menos um certificado digital para um empregador na [Aba Integração eConsignado (CSWMEN180TAB5)](/modulos/componentes/manuais-de-telas/configuracao-dos-componentes/configuracoes-de-integracoes/aba-integracao-econsignado.md).
{% endhint %}

#### Arquivos Rescisões

Apresenta o programa [Anexos (CSWANEXO)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/anexos.md) com o histórico dos arquivos de extrato dos empréstimos em andamento obtidos pela consulta de API com o Portal do Trabalhador, consultados diretamente de forma automática durante uma rescisão de contrato no cálculo do programa [Cálculo de Rescisão (CCRHR090)](/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/rescisoes/calculo-de-rescisao.md).

#### Arquivos Mensais

Apresenta o programa [Anexos (CSWANEXO)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/anexos.md) com o histórico dos arquivos mensais obtidos pela comunicação via API com o Portal do Trabalhador.

### Perguntas Frequentes

***

[Como o sistema realiza o cálculo do desconto rescisório do Crédito do Trabalhador e onde consultar o histórico desses arquivos?](https://movidesk.consistem.com.br/kb/pt-br/article/596438)

***

{% hint style="danger" %} <mark style="color:red;">**Atenção**</mark>

As descrições das principais funcionalidades do sistema estão disponíveis na documentação de [Componentes](/tecnologia/erp/componentes.md).\
A utilização incorreta deste programa pode ocasionar problemas no funcionamento do sistema e nas integrações entre módulos.
{% endhint %}

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ajuda.consistem.com.br/modulos/rh/manuais-de-telas/rh-folha-de-pagamento/emprestimos/importacao-dos-arquivos-de-econsignado/aba-via-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
